Obtener conocimiento referenciado

Recuperar los datos de fragmentos de la base de conocimientos referenciados en la respuesta del agente, incluidos el contenido del fragmento, el ID del documento, el nombre del documento, la URL de origen y la puntuación de relevancia.

Método de solicitud

GET

URL de la solicitud

https://api-${endpoint}.gptbots.ai/v1/correlate/dataset

Autenticación de la solicitud

Para obtener instrucciones de autenticación, consúltese Visión general de la API.

Solicitud

Ejemplo de solicitud

curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/correlate/dataset?message_id=65e04591a0e1e42392696d78' \ -H 'Authorization: Bearer ${API Key}' \

                      
                      curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/correlate/dataset?message_id=65e04591a0e1e42392696d78' \
-H 'Authorization: Bearer ${API Key}' \

Este bloque de código en una ventana flotante

Cabeceras de la solicitud

Campo	Tipo	Descripción
Authorization	Bearer ${API Key}	Se utiliza `Authorization: Bearer ${API Key}` para la autenticación. La clave de API se obtiene en la página «API Key».

Parámetros de la solicitud

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

Respuesta

Ejemplo de respuesta

{ "conversation_id": "65dc320df07244300b25b993", "question_id": "65dc323ef07244300b25b9c5", "answer_id": "65dc323ef07244300b25b9c6", "correlate_dataset": [ { "content": "The Great Wall of China was built to resist the invasion of northern nomadic tribes.", "data_id": "65dc3234f07244300b25b9b9", "data_name": "Chinese History", "source_url": "https://www.example.com/chinese-history", "score": 0.93492633 } ] }

                      
                      {
    "conversation_id": "65dc320df07244300b25b993",
    "question_id": "65dc323ef07244300b25b9c5",
    "answer_id": "65dc323ef07244300b25b9c6",
    "correlate_dataset": [
        {
            "content": "The Great Wall of China was built to resist the invasion of northern nomadic tribes.",
            "data_id": "65dc3234f07244300b25b9b9",
            "data_name": "Chinese History",
            "source_url": "https://www.example.com/chinese-history",
            "score": 0.93492633
        }
    ]
}

Este bloque de código en una ventana flotante

Respuesta correcta

Campo	Tipo	Descripción
conversation_id	string	ID de la conversación
question_id	string	ID del mensaje de la pregunta del usuario.
answer_id	string	ID del mensaje de la respuesta del agente
correlate_dataset	JSON Array	Conjunto de datos correlacionado
content	string	Contenido del fragmento de conocimiento
data_id	string	ID del documento
data_name	string	Nombre del documento
source_url	string	URL de origen del documento
score	number	Relevancia semántica entre los fragmentos de conocimiento y la pregunta.

Respuesta de fallo

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

Códigos de error

Código	Mensaje
40000	Parámetro no válido
40379	Créditos insuficientes
200222	La configuración del agente no admite esta función.
40378	Agente eliminado
20055	La API está prohibida
40127	Error de autenticación del desarrollador