Actualizar documentos de texto (archivo)
Se pueden actualizar por lotes documentos de tipo texto. El sistema realiza de forma secuencial la fragmentación (chunking) o segmentación (slicing), la generación de embeddings (vectorización) y, por último, se sustituye el contenido del documento antiguo por el nuevo, manteniendo el ID del documento sin cambios.
Nota:
El modelo de embeddings utiliza el modelo predeterminado y no se puede definir dentro de la API.
Solo se devuelven los resultados de la carga, no los resultados finales de embeddings. Los resultados finales se pueden obtener mediante la API «Consultar el estado del documento» (Query Document Status).
Método de solicitud
PUT
URL de la solicitud
https://api-${endpoint}.gptbots.ai/v1/bot/doc/text/update
Autenticación de la solicitud
Consulte la sección «Visión general» para obtener información detallada sobre la autenticación.
Solicitud
Ejemplo de solicitud
curl -X PUT 'https://api-${endpoint}.gptbots.ai/v1/bot/doc/text/update' \
-H 'Authorization: Bearer ${API Key}' \
-H 'Content-Type: application/json' \
-d '{
"knowledge_base_id": "67457fea6f658672d6482542",
"chunk_token": 600,
"splitter": "\n",
"files": [
{
"doc_id": "675158a5af12af632a4f63f6",
"file_url": "https://www.gptbots.ai/doc/article_1.pdf",
"source_url": "https://www.gptbots.ai/doc/article_1.pdf",
"file_name": "article_1.pdf"
}
]
}'
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». |
| Content-Type | application/json | Tipo de datos; se establece en application/json. |
Parámetros de la solicitud
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| files | Array | Sí | Lista de documentos que se van a actualizar. Permite actualizar hasta 200 documentos simultáneamente. |
| doc_id | String | Sí | ID del documento que se va a actualizar. |
| file_url | String | No | URL del documento que se va a actualizar. Formatos compatibles: pdf/txt/md/doc/docx. El tamaño máximo para documentos PDF es de 30 MB y, para otros formatos, de 10 MB. Nota: Se debe proporcionar file_url o file_base64. Si se proporcionan ambos, base64 tiene prioridad. |
| file_base64 | String | No | Base64 del documento que se va a actualizar. Formatos compatibles: pdf/txt/md/doc/docx. El tamaño máximo para documentos PDF es de 30 MB y, para otros formatos, de 10 MB. Nota: Se debe proporcionar file_url o file_base64. Si se proporcionan ambos, base64 tiene prioridad. |
| source_url | String | No | URL de origen del documento que se va a actualizar. Debe cumplir las especificaciones de formato de URL. Si está vacío, el sistema no actualizará este valor. Para establecer este valor como vacío, introducir NULL. |
| file_name | String | No | Nombre del archivo. |
| chunk_token | Integer | No | Número máximo de tokens de un único fragmento de conocimiento durante el fragmentado. El valor predeterminado es 600. Rango: 1-1000. Nota: Se debe proporcionar el recuento máximo de tokens o el separador. Si se proporcionan ambos, el separador tiene prioridad. |
| splitter | String | No | Delimitador utilizado durante el fragmentado. El valor predeterminado está vacío. Se puede usar "\n" como delimitador de salto de línea. Nota: Se debe proporcionar el recuento máximo de tokens o el separador. Si se proporcionan ambos, el separador tiene prioridad. |
Respuesta
Ejemplo de respuesta
{
"doc": [
{
"doc_id": "xxxxxx",
"doc_name": "test_1.txt"
},
{
"doc_id": "xxxxxx",
"doc_name": "test_2.pdf"
}
],
"failed": [
"xxxxxx",
"xxxxxx"
]
}
Respuesta de éxito
| Campo | Tipo | Descripción |
|---|---|---|
| doc | Array | Lista de documentos que se van a actualizar. |
| doc_id | String | ID del documento que se va a actualizar. |
| doc_name | String | Nombre del documento que se va a actualizar. |
| failed | Array |
Lista de ID de documentos cuya actualización ha fallado. |
Respuesta de error
| Campo | Tipo | Descripción |
|---|---|---|
| code | Int | Código de error. |
| message | String | Detalles del error. |
