Skip to main content

Recuperar una respuesta

Recupere una respuesta completada del modelo mediante su ID de respuesta.

Reemplace {WorkspaceId} con su ID de espacio de trabajo real.
  • China (Beijing)
El base_url para llamadas SDK es: https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/compatible-mode/v1URL de solicitud HTTP: GET https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/compatible-mode/v1/responses/{response_id}

Parámetros de ruta

response_idstring(obligatorio)El ID de respuesta a recuperar. El formato es resp_xxx. Puede obtenerlo de la respuesta de la API Crear respuesta. Solo se pueden recuperar los IDs de respuesta devueltos cuando se estableció store=true en la solicitud de creación original.
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)

Respuesta

Devuelve el mismo objeto Response que la API Crear respuesta. Los campos se describen a continuación:id stringIdentificador único para esta respuesta, en el formato resp_xxx.object stringTipo de objeto. Siempre response.status stringEstado de la respuesta. Valores posibles: completed, failed, in_progress, cancelled, queued, incomplete.created_at integerMarca de tiempo Unix (en segundos) en la que se creó la respuesta.completed_at integerMarca de tiempo Unix (en segundos) cuando se terminó de generar la respuesta. null si la respuesta no está completa.error objectObjeto de error devuelto cuando el modelo no logra generar una respuesta. null en caso de éxito.model stringID del modelo utilizado para generar la respuesta.output arrayElementos de salida generados por el modelo. El tipo y el orden de los elementos dependen de la respuesta del modelo.
type stringTipo de elemento de salida. Valores posibles:
  • message: Mensaje que contiene la respuesta final del modelo.
  • reasoning: Salida de razonamiento. Devuelta cuando reasoning.effort se establece en un valor distinto de none o cuando el modo de pensamiento está habilitado. Los tokens de razonamiento se cuentan en output_tokens_details.reasoning_tokens y se facturan en consecuencia.
  • function_call: Salida de llamada de función. Devuelta al utilizar una herramienta function personalizada. Debe manejar la llamada de función y devolver un resultado.
  • web_search_call: Salida de llamada de búsqueda web. Devuelta al utilizar la herramienta web_search.
  • code_interpreter_call: Salida de ejecución de código. Devuelta al utilizar la herramienta code_interpreter.
  • web_extractor_call: Salida de extracción web. Devuelta al utilizar la herramienta web_extractor. Debe usarse junto con la herramienta web_search.
  • web_search_image_call: Salida de llamada de búsqueda de texto a imagen. Devuelta al utilizar la herramienta web_search_image. Contiene una lista de imágenes encontradas.
  • image_search_call: Salida de llamada de búsqueda de imagen a imagen. Devuelta al utilizar la herramienta image_search. Contiene una lista de imágenes similares encontradas.
  • mcp_call: Salida de llamada MCP. Devuelta al utilizar la herramienta mcp. Contiene el resultado del servicio MCP.
  • file_search_call: Salida de llamada de búsqueda en base de conocimientos. Devuelta al utilizar la herramienta file_search. Contiene consultas de recuperación y resultados de la base de conocimientos.
id stringIdentificador único del elemento de salida. Presente en todos los tipos de salida.role stringRol del mensaje. Siempre assistant. Presente solo cuando type es message.status stringEstado del elemento de salida. Valores posibles: completed, in_progress. Presente cuando type no es reasoning.name stringNombre de la herramienta o función. Presente cuando type es function_call, web_search_image_call, image_search_call o mcp_call.Para web_search_image_call y image_search_call, el valor se fija como "web_search_image" y "image_search", respectivamente.Para mcp_call, el valor es el nombre específico de la función llamada en el servicio MCP (por ejemplo, amap-maps-maps_geo).arguments stringArgumentos de llamada de herramienta, formateados como una cadena JSON. Presente cuando type es function_call, web_search_image_call, image_search_call o mcp_call. Analícelo usando JSON.parse() antes de usarlo. El contenido varía según el tipo de herramienta:
  • web_search_image_call: {"queries": ["search keyword 1", "search keyword 2"]}. El campo queries contiene una lista de palabras clave de búsqueda generadas automáticamente por el modelo basándose en la entrada del usuario.
  • image_search_call: {"img_idx": 0, "bbox": [0, 0, 1000, 1000]}. El campo img_idx es el índice de la imagen de entrada (comenzando desde 0). El campo bbox contiene las coordenadas del cuadro delimitador [x1, y1, x2, y2] del área de búsqueda, con valores que van de 0 a 1000.
  • function_call: Un objeto de argumentos generado según el esquema de parámetros de función definido por el usuario.
  • mcp_call: Un objeto de argumentos para la función llamada en el servicio MCP.
call_id stringIdentificador único para la llamada de función. Presente solo cuando type es function_call. Utilice este ID para asociar la solicitud con la respuesta al devolver resultados de llamadas de función.content arrayMatriz de contenido del mensaje. Presente solo cuando type es message.
type stringTipo de contenido. Siempre output_text.text stringContenido de texto generado por el modelo.annotations arrayAnotaciones de texto. Generalmente es una matriz vacía.
summary arrayResúmenes de razonamiento. Presentes solo cuando type es reasoning. Cada elemento contiene un campo type (valor summary_text) y un campo text (el texto del resumen).acción objectInformación de la acción de búsqueda. Presente solo cuando type es web_search_call.
query stringPalabra clave de consulta de búsqueda.type stringTipo de búsqueda. Siempre search.sources arrayFuentes de búsqueda. Cada elemento contiene un campo type y un campo url.
code stringCódigo generado y ejecutado por el modelo. Presente solo cuando type es code_interpreter_call.outputs arraySalidas de ejecución de código. Presentes solo cuando type es code_interpreter_call. Cada elemento contiene un campo type (valor logs) y un campo logs (registros de ejecución de código).container_id stringIdentificador del contenedor del intérprete de código. Presente solo cuando type es code_interpreter_call. Úselo para asociar múltiples ejecuciones de código dentro de la misma sesión.goal stringDescripción del objetivo de extracción, que especifica qué información extraer de la página web. Presente solo cuando type es web_extractor_call.output stringResultado de salida de la llamada a la herramienta, formateado como una cadena.
  • Cuando type es web_extractor_call, este campo contiene un resumen del contenido de la página web extraída.
  • Cuando type es web_search_image_call o image_search_call, este campo es una cadena JSON que contiene una matriz de resultados de búsqueda de imágenes. Cada resultado incluye un campo title (título de la imagen), url (URL de la imagen) y index (número ordinal).
  • Cuando type es mcp_call, este campo es un resultado en cadena JSON devuelto por el servicio MCP.
urls arrayURLs de las páginas web extraídas. Presente solo cuando type es web_extractor_call.server_label stringEtiqueta del servicio MCP. Presente solo cuando type es mcp_call. Identifica el servicio MCP utilizado para esta llamada.queries arrayConsultas utilizadas para la recuperación de la base de conocimientos. Presente solo cuando type es file_search_call. Cada elemento es una consulta de búsqueda generada por el modelo.results arrayResultados de recuperación de la base de conocimientos. Presente solo cuando type es file_search_call.
file_id stringID de archivo del documento coincidente.filename stringNombre de archivo del documento coincidente.score floatPuntuación de relevancia, que varía de 0 a 1. Los valores más altos indican mayor relevancia.text stringFragmento del contenido del documento coincidente.
usage objectInformación de uso de tokens para esta solicitud.
input_tokens integerNúmero de tokens de entrada.output_tokens integerNúmero de tokens de salida generados por el modelo.total_tokens integerTotal de tokens utilizados (input_tokens + output_tokens).input_tokens_details objectDesglose de tokens de entrada.
cached_tokens integerNúmero de tokens en caché.
output_tokens_details objectDesglose de tokens de salida.
reasoning_tokens integerNúmero de tokens de razonamiento.
x_details arrayDetalles de facturación.
input_tokens integerTokens de entrada para este tipo de facturación.output_tokens integerTokens de salida para este tipo de facturación.total_tokens integerTotal de tokens para este tipo de facturación.x_billing_type stringSiempre response_api.prompt_tokens_details objectDevuelto cuando el almacenamiento en caché de sesión está habilitado. Contiene un campo cached_tokens (número de tokens en caché).
x_tools objectEstadísticas de uso de herramientas. Cuando se utilizan herramientas integradas, este campo contiene el recuento de llamadas para cada herramienta. Ejemplo: {"web_search": {"count": 1}}
tools arrayRepite el parámetro tools de la solicitud de creación. La estructura coincide con el parámetro tools en el cuerpo de la solicitud. Matriz vacía [] si no se utilizaron herramientas.tool_choice stringRepite el parámetro tool_choice de la solicitud de creación. Valores posibles: auto, none, required.parallel_tool_calls booleanRepite el parámetro parallel_tool_calls de la solicitud de creación. Indica si el modelo puede llamar a múltiples herramientas en paralelo.temperature floatRepite el parámetro temperature de la solicitud de creación. Controla la diversidad de la salida del modelo. Rango válido: [0, 2). Devuelve el valor predeterminado del modelo si no se establece.top_p floatRepite el parámetro top_p de la solicitud de creación. Umbral de probabilidad de muestreo de núcleo. Rango válido: (0, 1.0]. Devuelve el valor predeterminado del modelo si no se establece.frequency_penalty floatRepite el parámetro frequency_penalty de la solicitud de creación. Los valores positivos reducen la probabilidad de repetir palabras.presence_penalty floatRepite el parámetro presence_penalty de la solicitud de creación. Los valores positivos aumentan la probabilidad de introducir nuevos temas.top_logprobs integerRepite el parámetro top_logprobs de la solicitud de creación. Número de tokens más probables devueltos en cada posición. 0 si no está habilitado.store booleanRepite el parámetro store de la solicitud de creación. true significa que la respuesta se almacena y puede ser referenciada por previous_response_id. false significa que no se almacena.service_tier stringNivel de servicio. Siempre default.background booleanIndica si la respuesta se ejecutó de forma asíncrona. Model Studio actualmente solo admite llamadas síncronas, por lo que esto siempre es false.metadata objectRepite el parámetro metadata de la solicitud de creación. Pares clave-valor personalizados adjuntos a la respuesta. Objeto vacío {} si no se establece.
{
    "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"
            }
        ]
    }
}

Respuesta de error

Se devuelve cuando el ID de respuesta especificado no existe:
{
    "error": {
        "message": "Response with id 'resp_xxx' not found.",
        "type": "InvalidParameter"
    }
}