Retrieve a response - Alibaba Cloud Model Studio - Centre de documentation Alibaba Cloud

Récupérez une réponse de modèle terminée à l'aide de son Response ID.

Remplacez {WorkspaceId} par votre véritable workspace ID.

China (Beijing)

La valeur base_url pour les appels SDK est : https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/compatible-mode/v1

URL de la requête HTTP : GET https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/compatible-mode/v1/responses/{response_id}

China (Beijing)

La valeur base_url pour les appels SDK est : https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/compatible-mode/v1

URL de la requête HTTP : GET https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/compatible-mode/v1/responses/{response_id}

Paramètres de chemin

response_idstring(obligatoire)

Response ID à récupérer, au format resp_xxx. Obtenez-le via la réponse de l'API Create response. Seuls les Response ID retournés lorsque store=true était défini dans la requête de création initiale sont récupérables.

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)

Node.js

import OpenAI from "openai";

const openai = new OpenAI({
    // If you have not configured an environment variable, replace the following line with: apiKey: "sk-xxx"
    apiKey: process.env.DASHSCOPE_API_KEY,
    baseURL: "https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/compatible-mode/v1"
});

async function main() {
    const response = await openai.responses.retrieve("resp_xxx");
    console.log(response);
}

main();

curl

curl https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/compatible-mode/v1/responses/resp_xxx \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY"

Réponse

Retourne le même objet Response que l'API Create response. Les champs sont décrits ci-dessous :

{
    "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 string

Identifiant unique de cette réponse, au format resp_xxx.

object string

Type d'objet. Toujours response.

status string

État de la réponse. Valeurs possibles : completed, failed, in_progress, cancelled, queued, incomplete.

created_at integer

Horodatage Unix (en secondes) indiquant la date de création de la réponse.

completed_at integer

Horodatage Unix (en secondes) marquant la fin de la génération de la réponse. Valeur null si la réponse n'est pas terminée.

error object

Objet d'erreur retourné lorsque le modèle ne parvient pas à générer une réponse. Valeur null en cas de succès.

model string

ID du modèle utilisé pour produire la réponse.

output array

Éléments de sortie générés par le modèle. Le type et l'ordre des éléments dépendent de la réponse du modèle.

Propriétés des éléments du tableau

type string

Type d'élément de sortie. Valeurs possibles :

message : message contenant la réponse finale du modèle.
reasoning : sortie de raisonnement. Retournée lorsque reasoning.effort est défini sur une valeur autre que none ou lorsque le mode de réflexion est activé. Les tokens de raisonnement sont comptabilisés dans output_tokens_details.reasoning_tokens et facturés en conséquence.
function_call : sortie d'appel de fonction. Retournée lors de l'utilisation d'un outil function personnalisé. Traitez l'appel de fonction et retournez un résultat.
web_search_call : sortie d'appel de recherche web. Retournée lors de l'utilisation de l'outil web_search.
code_interpreter_call : sortie d'exécution de code. Retournée lors de l'utilisation de l'outil code_interpreter.
web_extractor_call : sortie d'extraction web. Retournée lors de l'utilisation de l'outil web_extractor. À utiliser conjointement avec l'outil web_search.
web_search_image_call : sortie d'appel de recherche texte-vers-image. Retournée lors de l'utilisation de l'outil web_search_image. Contient une liste d'images trouvées.
image_search_call : sortie d'appel de recherche image-vers-image. Retournée lors de l'utilisation de l'outil image_search. Contient une liste d'images similaires trouvées.
mcp_call : sortie d'appel MCP. Retournée lors de l'utilisation de l'outil mcp. Contient le résultat provenant du service MCP.
file_search_call : sortie d'appel de recherche dans la base de connaissances. Retournée lors de l'utilisation de l'outil file_search. Contient les requêtes de récupération et les résultats issus de la base de connaissances.

id string

Identifiant unique de l'élément de sortie. Présent pour tous les types de sortie.

role string

Rôle du message. Toujours assistant. Présent uniquement lorsque type vaut message.

status string

État de l'élément de sortie. Valeurs possibles : completed, in_progress. Présent lorsque type diffère de reasoning.

name string

Nom de l'outil ou de la fonction. Présent lorsque type vaut function_call, web_search_image_call, image_search_call ou mcp_call.

Pour web_search_image_call et image_search_call, la valeur est fixée respectivement à "web_search_image" et "image_search".

Pour mcp_call, la valeur correspond au nom spécifique de la fonction appelée dans le service MCP (par exemple, amap-maps-maps_geo).

arguments string

Arguments de l'appel d'outil, formatés sous forme de chaîne JSON. Présent lorsque type vaut function_call, web_search_image_call, image_search_call ou mcp_call. Analysez-les avec JSON.parse() avant utilisation. Le contenu varie selon le type d'outil :

web_search_image_call : {"queries": ["search keyword 1", "search keyword 2"]}. Le champ queries contient une liste de mots-clés de recherche générés automatiquement par le modèle à partir de l'entrée utilisateur.
image_search_call : {"img_idx": 0, "bbox": [0, 0, 1000, 1000]}. Le champ img_idx représente l'index de l'image d'entrée (commençant à 0). Le champ bbox contient les coordonnées [x1, y1, x2, y2] de la zone de recherche, avec des valeurs comprises entre 0 et 1000.
function_call : objet d'argument généré conformément au schéma de paramètres de la fonction définie par l'utilisateur.
mcp_call : objet d'argument pour la fonction appelée dans le service MCP.

call_id string

Identifiant unique de l'appel de fonction. Présent uniquement lorsque type vaut function_call. Utilisez cet ID pour associer la requête à la réponse lors du retour des résultats d'appel de fonction.

content array

Tableau du contenu du message. Présent uniquement lorsque type vaut message.

Propriétés des éléments du tableau

type string

Type de contenu. Toujours output_text.

text string

Contenu textuel généré par le modèle.

annotations array

Annotations de texte. Généralement un tableau vide.

summary array

Résumés de raisonnement. Présents uniquement lorsque type vaut reasoning. Chaque élément contient un champ type (valeur summary_text) et un champ text (le texte du résumé).

action object

Informations sur l'action de recherche. Présentes uniquement lorsque type vaut web_search_call.

Propriétés

query string

Mot-clé de la requête de recherche.

type string

Type de recherche. Toujours search.

sources array

Sources de la recherche. Chaque élément contient un champ type et un champ url.

code string

Code généré et exécuté par le modèle. Présent uniquement lorsque type vaut code_interpreter_call.

outputs array

Sorties de l'exécution du code. Présentes uniquement lorsque type vaut code_interpreter_call. Chaque élément contient un champ type (valeur logs) et un champ logs (journaux d'exécution du code).

container_id string

Identifiant du conteneur de l'interpréteur de code. Présent uniquement lorsque type vaut code_interpreter_call. Utilisez-le pour associer plusieurs exécutions de code au sein de la même session.

goal string

Description de l'objectif d'extraction, précisant les informations à extraire de la page web. Présent uniquement lorsque type vaut web_extractor_call.

output string

Résultat de l'appel d'outil, formaté sous forme de chaîne.

Lorsque type vaut web_extractor_call, ce champ contient un résumé du contenu de la page web extraite.
Lorsque type vaut web_search_image_call ou image_search_call, ce champ est une chaîne JSON contenant un tableau de résultats de recherche d'images. Chaque résultat inclut un champ title (titre de l'image), url (URL de l'image) et index (numéro ordinal).
Lorsque type vaut mcp_call, ce champ contient la chaîne JSON résultante retournée par le service MCP.

urls array

URL des pages web extraites. Présentes uniquement lorsque type vaut web_extractor_call.

server_label string

Libellé du service MCP. Présent uniquement lorsque type vaut mcp_call. Identifie le service MCP utilisé pour cet appel.

queries array

Requêtes utilisées pour la récupération dans la base de connaissances. Présentes uniquement lorsque type vaut file_search_call. Chaque élément est une requête de recherche générée par le modèle.

results array

Résultats de la récupération depuis la base de connaissances. Présents uniquement lorsque type vaut file_search_call.

Propriétés des éléments du tableau

file_id string

ID du fichier correspondant au document.

filename string

Nom du fichier correspondant au document.

score float

Score de pertinence, compris entre 0 et 1. Une valeur plus élevée indique une meilleure pertinence.

text string

Extrait du contenu du document correspondant.

usage object

Informations sur l'utilisation des tokens pour cette requête.

Propriétés

input_tokens integer

Nombre de tokens d'entrée.

output_tokens integer

Nombre de tokens de sortie générés par le modèle.

total_tokens integer

Total des tokens utilisés (input_tokens + output_tokens).

input_tokens_details object

Détail des tokens d'entrée.

Propriétés

cached_tokens integer

Nombre de tokens mis en cache.

output_tokens_details object

Détail des tokens de sortie.

Propriétés

reasoning_tokens integer

Nombre de tokens de raisonnement.

x_details array

Détails de facturation.

Propriétés

input_tokens integer

Tokens d'entrée pour ce type de facturation.

output_tokens integer

Tokens de sortie pour ce type de facturation.

total_tokens integer

Total des tokens pour ce type de facturation.

x_billing_type string

Toujours response_api.

prompt_tokens_details object

Retourné lorsque la mise en cache de session est activée. Contient un champ cached_tokens (nombre de tokens mis en cache).

x_tools object

Statistiques d'utilisation des outils. Lorsque des outils intégrés sont utilisés, ce champ contient le nombre d'appels pour chaque outil. Exemple : {"web_search": {"count": 1}}

tools array

Reprend le paramètre tools de la requête de création. La structure correspond au paramètre tools du corps de la requête. Tableau vide [] si aucun outil n'a été utilisé.

tool_choice string

Reprend le paramètre tool_choice de la requête de création. Valeurs possibles : auto, none, required.

parallel_tool_calls boolean

Reprend le paramètre parallel_tool_calls de la requête de création. Indique si le modèle peut appeler plusieurs outils en parallèle.

temperature float

Reprend le paramètre temperature de la requête de création. Contrôle la diversité de la sortie du modèle. Plage valide : [0, 2). Retourne la valeur par défaut du modèle si non défini.

top_p float

Reprend le paramètre top_p de la requête de création. Seuil de probabilité pour l'échantillonnage par noyau. Plage valide : (0, 1,0]. Retourne la valeur par défaut du modèle si non défini.

frequency_penalty float

Reprend le paramètre frequency_penalty de la requête de création. Des valeurs positives réduisent la probabilité de répétition des mots.

presence_penalty float

Reprend le paramètre presence_penalty de la requête de création. Des valeurs positives augmentent la probabilité d'introduire de nouveaux sujets.

top_logprobs integer

Reprend le paramètre top_logprobs de la requête de création. Nombre de tokens les plus probables retournés à chaque position. Valeur 0 si non activé.

store boolean

Reprend le paramètre store de la requête de création. La valeur true signifie que la réponse est stockée et peut être référencée par previous_response_id. La valeur false signifie qu'elle n'est pas stockée.

service_tier string

Niveau de service. Toujours default.

background boolean

Indique si la réponse a été exécutée de manière asynchrone. Model Studio ne prenant actuellement en charge que les appels synchrones, cette valeur est toujours false.

metadata object

Reprend le paramètre metadata de la requête de création. Paires clé-valeur personnalisées attachées à la réponse. Objet vide {} si non défini.

Réponse d'erreur

Retournée lorsque le Response ID spécifié n'existe pas :

{
    "error": {
        "message": "Response with id 'resp_xxx' not found.",
        "type": "InvalidParameter"
    }
}