Obtener documento correlacionado

Recupera los datos de los documentos referenciados que el agente utilizó al responder a un mensaje, a partir del message_id proporcionado. La respuesta incluye información como los ID de los documentos, los nombres y las URL de origen de los materiales referenciados.

Método de solicitud

POST

URL de solicitud

https://api-${endpoint}.gptbots.ai/v1/bot/data/references

Autenticación de la solicitud

Consulte Visión general para conocer los detalles de autenticación.

Solicitud

Ejemplo de solicitud

curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/bot/data/references' \ -H 'Authorization: Bearer ${token}' \ -H 'Content-Type: application/json' \ -d '{ "message_id": "xxxxx" }'

                      
                      curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/bot/data/references' \
-H 'Authorization: Bearer ${token}' \
-H 'Content-Type: application/json' \
-d '{
    "message_id": "xxxxx"
}'

Este bloque de código en una ventana flotante

Encabezados de solicitud

Campo	Tipo	Descripción
Authorization	Bearer ${token}	Para autenticarse, se usa `Authorization: Bearer ${token}`. Obtenga la clave en la página API Keys como `token`.
Content-Type	application/json	Tipo de contenido. El valor es `application/json`.

Cuerpo de la solicitud

Campo	Tipo	Obligatorio	Descripción
message_id	string	true	ID del mensaje de la respuesta del agente.

Respuesta

Ejemplo de respuesta

{ "code": 0, "msg": "success", "data": { "conversationId": "65dc320df07244300b25b993", "questionId": "65dc323ef07244300b25b9c5", "answerId": "65dc323ef07244300b25b9c6", "refDoc": [ { "dataId": "65dc3234f07244300b25b9b9", "dataName": "中国的历史", "sourceUrl": "https://www.example.com/chinese-history" } ] } }

                      
                      {
    "code": 0,
    "msg": "success",
    "data": {
        "conversationId": "65dc320df07244300b25b993",
        "questionId": "65dc323ef07244300b25b9c5",
        "answerId": "65dc323ef07244300b25b9c6",
        "refDoc": [
            {
                "dataId": "65dc3234f07244300b25b9b9",
                "dataName": "中国的历史",
                "sourceUrl": "https://www.example.com/chinese-history"
            }
        ]
    }
}

Este bloque de código en una ventana flotante

Respuesta correcta

Campo	Tipo	Descripción
conversationId	string	ID de conversación
questionId	string	ID del mensaje de la pregunta del usuario
answerId	string	ID del mensaje de la respuesta del agente
refDoc	JSON Array	Datos del documento referenciado
refDoc[].dataId	string	ID del documento
refDoc[].dataName	string	Nombre del documento
refDoc[].sourceUrl	string	URL de origen del documento

Respuesta de error

Campo	Tipo	Descripción
code	int	Código de error.
msg	string	Detalles del error.

Códigos de error

Código	Mensaje
40000	Parámetro no válido
40379	Crédito insuficiente
40378	Agente eliminado
20055	Acceso a la API prohibido
40127	Error de autenticación del desarrollador