Skip to main content
Respostas compatíveis com OpenAI

Retrieve a response

Recupere uma resposta concluída do modelo pelo ID da resposta.

Substitua {WorkspaceId} pelo seu ID do workspace real.

China (Beijing)

O base_url para chamadas de SDK é: https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/compatible-mode/v1 URL da requisição HTTP: GET https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/compatible-mode/v1/responses/{response_id}
  • China (Beijing)
O base_url para chamadas de SDK é: https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/compatible-mode/v1URL da requisição HTTP: GET https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/compatible-mode/v1/responses/{response_id}

Parâmetros de caminho

response_idstring(obrigatório)ID da resposta a recuperar. Formato: resp_xxx. Obtenha esse valor na resposta da API Criar resposta. Apenas IDs de resposta retornados com store=true na requisição de criação original podem ser recuperados.
Python
import os
from openai import OpenAI

client = OpenAI(
    # If you have not configured an environment variable, replace the following line with: api_key="sk-xxx"
    api_key=os.getenv("DASHSCOPE_API_KEY"),
    base_url="https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/compatible-mode/v1",
)

response = client.responses.retrieve("resp_xxx")
print(response)

Resposta

Retorna o mesmo objeto Response da API Criar resposta. Os campos estão descritos abaixo:
{
    "background": false,
    "completed_at": 1778676420,
    "created_at": 1778676418,
    "frequency_penalty": 0.0,
    "id": "resp_801bc2c4-93d9-910f-b35d-5274f5a737c1",
    "metadata": {},
    "model": "qwen-plus",
    "object": "response",
    "output": [
        {
            "content": [
                {
                    "annotations": [],
                    "text": "Hello! Nice to meet you. How can I help you?",
                    "type": "output_text"
                }
            ],
            "id": "msg_8c54756c-9b65-4a95-81d7-4276d91406db",
            "role": "assistant",
            "status": "completed",
            "type": "message"
        }
    ],
    "parallel_tool_calls": true,
    "presence_penalty": 0.0,
    "service_tier": "default",
    "status": "completed",
    "store": true,
    "temperature": 1.0,
    "tool_choice": "auto",
    "tools": [],
    "top_logprobs": 0,
    "top_p": 1.0,
    "usage": {
        "input_tokens": 45,
        "input_tokens_details": {
            "cached_tokens": 0
        },
        "output_tokens": 63,
        "output_tokens_details": {
            "reasoning_tokens": 0
        },
        "total_tokens": 108,
        "x_details": [
            {
                "input_tokens": 45,
                "output_tokens": 63,
                "prompt_tokens_details": {
                    "cached_tokens": 0
                },
                "total_tokens": 108,
                "x_billing_type": "response_api"
            }
        ]
    }
}
id stringIdentificador exclusivo desta resposta, no formato resp_xxx.
object stringTipo do objeto. Sempre response.
status stringStatus da resposta. Valores possíveis: completed, failed, in_progress, cancelled, queued, incomplete.
created_at integerTimestamp Unix (em segundos) de criação da resposta.
completed_at integerTimestamp Unix (em segundos) em que a geração da resposta foi concluída. Retorna null se a resposta não estiver completa.
error objectObjeto de erro retornado quando o modelo falha ao gerar uma resposta. Retorna null em caso de sucesso.
model stringID do modelo usado para gerar a resposta.
output arrayItens de saída gerados pelo modelo. O tipo e a ordem dos elementos dependem da resposta do modelo.
type stringTipo do item de saída. Valores possíveis:
  • message: Mensagem contendo a resposta final do modelo.
  • reasoning: Saída de raciocínio. Retornada quando reasoning.effort tem valor diferente de none ou quando o modo de pensamento está ativado. Os tokens de raciocínio são contabilizados em output_tokens_details.reasoning_tokens e faturados adequadamente.
  • function_call: Saída de chamada de função. Retornada ao usar uma ferramenta function personalizada. Processe a chamada de função e retorne um resultado.
  • web_search_call: Saída de chamada de busca na web. Retornada ao usar a ferramenta web_search.
  • code_interpreter_call: Saída de execução de código. Retornada ao usar a ferramenta code_interpreter.
  • web_extractor_call: Saída de extração da web. Retornada ao usar a ferramenta web_extractor. Use em conjunto com a ferramenta web_search.
  • web_search_image_call: Saída de chamada de busca de texto para imagem. Retornada ao usar a ferramenta web_search_image. Contém uma lista de imagens encontradas.
  • image_search_call: Saída de chamada de busca de imagem por similaridade. Retornada ao usar a ferramenta image_search. Contém uma lista de imagens semelhantes encontradas.
  • mcp_call: Saída de chamada MCP. Retornada ao usar a ferramenta mcp. Contém o resultado do serviço MCP.
  • file_search_call: Saída de chamada de busca em base de conhecimento. Retornada ao usar a ferramenta file_search. Contém consultas de recuperação e resultados da base de conhecimento.
id stringIdentificador exclusivo do item de saída. Presente em todos os tipos de saída.role stringFunção da mensagem. Sempre assistant. Presente apenas quando type for message.status stringStatus do item de saída. Valores possíveis: completed, in_progress. Presente quando type não for reasoning.name stringNome da ferramenta ou função. Presente quando type for function_call, web_search_image_call, image_search_call ou mcp_call.Para web_search_image_call e image_search_call, o valor é fixo como "web_search_image" e "image_search", respectivamente.Para mcp_call, o valor corresponde ao nome específico da função chamada no serviço MCP (por exemplo, amap-maps-maps_geo).arguments stringArgumentos da chamada de ferramenta, formatados como string JSON. Presente quando type for function_call, web_search_image_call, image_search_call ou mcp_call. Analise-o com JSON.parse() antes do uso. O conteúdo varia conforme o tipo de ferramenta:
  • web_search_image_call: {"queries": ["search keyword 1", "search keyword 2"]}. O campo queries contém uma lista de palavras-chave de busca geradas automaticamente pelo modelo com base na entrada do usuário.
  • image_search_call: {"img_idx": 0, "bbox": [0, 0, 1000, 1000]}. O campo img_idx representa o índice da imagem de entrada (começando em 0). O campo bbox contém as coordenadas da caixa delimitadora [x1, y1, x2, y2] da área de busca, com valores variando de 0 a 1000.
  • function_call: Objeto de argumento gerado conforme o esquema de parâmetros da função definida pelo usuário.
  • mcp_call: Objeto de argumento para a função chamada no serviço MCP.
call_id stringIdentificador exclusivo da chamada de função. Presente apenas quando type for function_call. Use este ID para associar a requisição à resposta ao retornar resultados de chamadas de função.content arrayArray de conteúdo da mensagem. Presente apenas quando type for message.
type stringTipo de conteúdo. Sempre output_text.text stringConteúdo de texto gerado pelo modelo.annotations arrayAnotações de texto. Geralmente um array vazio.
summary arrayResumos de raciocínio. Presente apenas quando type for reasoning. Cada elemento contém um campo type (valor summary_text) e um campo text (texto do resumo).action objectInformações da ação de busca. Presente apenas quando type for web_search_call.
query stringPalavra-chave da consulta de busca.type stringTipo de busca. Sempre search.sources arrayFontes da busca. Cada elemento contém um campo type e um campo url.
code stringCódigo gerado e executado pelo modelo. Presente apenas quando type for code_interpreter_call.outputs arraySaídas da execução de código. Presente apenas quando type for code_interpreter_call. Cada elemento contém um campo type (valor logs) e um campo logs (logs de execução do código).container_id stringIdentificador do contêiner do interpretador de código. Presente apenas quando type for code_interpreter_call. Use-o para associar múltiplas execuções de código na mesma sessão.goal stringDescrição do objetivo de extração, especificando quais informações extrair da página da web. Presente apenas quando type for web_extractor_call.output stringResultado da chamada de ferramenta, formatado como string.
  • Quando type for web_extractor_call, este campo contém um resumo do conteúdo extraído da página da web.
  • Quando type for web_search_image_call ou image_search_call, este campo é uma string JSON contendo um array de resultados de busca de imagens. Cada resultado inclui os campos title (título da imagem), url (URL da imagem) e index (número ordinal).
  • Quando type for mcp_call, este campo é uma string JSON resultante retornada pelo serviço MCP.
urls arrayURLs das páginas da web extraídas. Presente apenas quando type for web_extractor_call.server_label stringRótulo do serviço MCP. Presente apenas quando type for mcp_call. Identifica o serviço MCP usado nesta chamada.queries arrayConsultas usadas para recuperação na base de conhecimento. Presente apenas quando type for file_search_call. Cada elemento é uma consulta de busca gerada pelo modelo.results arrayResultados da recuperação da base de conhecimento. Presente apenas quando type for file_search_call.
file_id stringID do arquivo do documento correspondente.filename stringNome do arquivo do documento correspondente.score floatPontuação de relevância, variando de 0 a 1. Valores mais altos indicam maior relevância.text stringTrecho do conteúdo do documento correspondente.
usage objectInformações de uso de tokens para esta requisição.
input_tokens integerNúmero de tokens de entrada.output_tokens integerNúmero de tokens de saída gerados pelo modelo.total_tokens integerTotal de tokens usados (input_tokens + output_tokens).input_tokens_details objectDetalhamento dos tokens de entrada.
cached_tokens integerNúmero de tokens em cache.
output_tokens_details objectDetalhamento dos tokens de saída.
reasoning_tokens integerNúmero de tokens de raciocínio.
x_details arrayDetalhes de faturamento.
input_tokens integerTokens de entrada para este tipo de faturamento.output_tokens integerTokens de saída para este tipo de faturamento.total_tokens integerTotal de tokens para este tipo de faturamento.x_billing_type stringSempre response_api.prompt_tokens_details objectRetornado quando o cache de sessão está ativado. Contém um campo cached_tokens (número de tokens em cache).
x_tools objectEstatísticas de uso de ferramentas. Quando ferramentas integradas são utilizadas, este campo contém a contagem de chamadas para cada ferramenta. Exemplo: {"web_search": {"count": 1}}
tools arrayReflete o parâmetro tools da requisição de criação. A estrutura corresponde ao parâmetro tools no corpo da requisição. Array vazio [] se nenhuma ferramenta tiver sido usada.
tool_choice stringReflete o parâmetro tool_choice da requisição de criação. Valores possíveis: auto, none, required.
parallel_tool_calls booleanReflete o parâmetro parallel_tool_calls da requisição de criação. Indica se o modelo pode chamar múltiplas ferramentas em paralelo.
temperature floatReflete o parâmetro temperature da requisição de criação. Controla a diversidade da saída do modelo. Faixa válida: [0, 2). Retorna o padrão do modelo se não definido.
top_p floatReflete o parâmetro top_p da requisição de criação. Limiar de probabilidade para amostragem de núcleo. Faixa válida: (0, 1,0]. Retorna o padrão do modelo se não definido.
frequency_penalty floatReflete o parâmetro frequency_penalty da requisição de criação. Valores positivos reduzem a probabilidade de repetição de palavras.
presence_penalty floatReflete o parâmetro presence_penalty da requisição de criação. Valores positivos aumentam a probabilidade de introdução de novos tópicos.
top_logprobs integerReflete o parâmetro top_logprobs da requisição de criação. Número de tokens mais prováveis retornados em cada posição. 0 se não habilitado.
store booleanReflete o parâmetro store da requisição de criação. true significa que a resposta é armazenada e referenciável por previous_response_id. false indica que ela não é armazenada.
service_tier stringNível de serviço. Sempre default.
background booleanIndica se a resposta foi executada de forma assíncrona. O Model Studio atualmente suporta apenas chamadas síncronas, portanto, este valor é sempre false.
metadata objectReflete o parâmetro metadata da requisição de criação. Pares chave-valor personalizados anexados à resposta. Objeto vazio {} se não definido.

Resposta de erro

Retornada quando o ID da resposta especificado não existe:
{
    "error": {
        "message": "Response with id 'resp_xxx' not found.",
        "type": "InvalidParameter"
    }
}
Geração de Imagens
  • FAQ
Geração de Vídeo
Áudio
API em tempo real
Incorporação de Texto
Produção de Modelos
Retrieve a response - Alibaba Cloud Model Studio