Saltar al contenido principal
POST
Typescript (SDK)

Autorizaciones

Authorization
string
header
requerido

Send Authorization: Bearer , using an MKA1 API key for automation or an OAuth API access token for a signed-in application. Use a dynamic security callback to refresh OAuth access tokens. Browser session-only operations still require their declared cookie.

Encabezados

X-On-Behalf-Of
string

Optional external end-user identifier forwarded by the API gateway.

Parámetros de ruta

vector_store_id
string
requerido

El ID de la base de datos de vectores a la que pertenece el archivo.

file_id
string
requerido

La ID del archivo para actualizar atributos.

Cuerpo

application/json

Cuerpo de la solicitud para actualizar los atributos del archivo de la tienda de vectores.

attributes
object
requerido

Conjunto de 16 pares clave-valor que se pueden adjuntar a un objeto. Las claves son cadenas con una longitud máxima de 64 caracteres. Los valores son cadenas con una longitud máxima de 512 caracteres, booleanos o números.

Respuesta

200 - application/json

Está bien

Una lista de archivos adjuntos a un almacén de vectores.

id
string
requerido

El identificador, que se puede referenciar en los puntos finales de la API.

object
any
requerido

El tipo de objeto, que siempre es 'vector_store.file'.

usage_bytes
integer
requerido

El uso total del almacén de vectores en bytes. Tenga en cuenta que esto puede ser diferente del tamaño original del archivo.

Rango requerido: -9007199254740991 <= x <= 9007199254740991
created_at
integer
requerido

La marca de tiempo de Unix (en segundos) para cuando se creó el archivo de la almacén de vectores.

Rango requerido: -9007199254740991 <= x <= 9007199254740991
vector_store_id
string
requerido

La ID del almacén de vectores al que está adjunto el archivo.

status
enum<string>
requerido

El estado del archivo del almacén de vectores. 'en_proceso' significa que se está procesando actualmente, 'completado' indica que el archivo está listo para su uso, 'cancelado' significa que el procesamiento fue cancelado, 'fallido' significa que ocurrió un error.

Opciones disponibles:
in_progress,
completed,
cancelled,
failed
last_error
object | null
requerido

El último error asociado con este archivo de almacenamiento de vectores. Será nulo si no hay errores.

filename
string

El nombre del archivo subyacente. El campo de extensión no está presente en la API de OpenAI; se omite en las respuestas de creación.

chunking_strategy
object

La estrategia que ejecutó la ingestión para este archivo, tal como se ejecutó: auto se informa como los tamaños estáticos a los que resuelve. Se omite mientras una primera ingestión aún está en curso; other para archivos indexados antes de que se registrara la estrategia.

chunk_count
integer | null

Cuántos fragmentos produjo la ingesta para este archivo. Campo de extensión no presente en la API de OpenAI. Se establece en cuanto el archivo ha sido fragmentado (null antes de eso, y para archivos indexados antes de que se registrara); con processed_chunk_count se lee como el progreso de indexación mientras el archivo está en progreso.

Rango requerido: -9007199254740991 <= x <= 9007199254740991
processed_chunk_count
integer | null

Cuántos fragmentos del archivo ha procesado hasta ahora la ingestión en curso: incrustados para almacenes vectoriales, extraídos de entidades para almacenes de grafos. Campo de extensión no presente en la API de OpenAI. Nulo hasta que el archivo haya sido fragmentado; es igual a chunk_count una vez que el archivo se completa. El archivo se vuelve buscable cuando su estado es completed, no antes.

Rango requerido: -9007199254740991 <= x <= 9007199254740991
page_count
integer | null

Para un archivo leído a través del canal de documentos (PDF, Office, imágenes): cuántas páginas tenía el documento, hasta el límite de páginas por documento. Campo de extensión no presente en la API de OpenAI. Nulo para archivos de texto sin formato, antes de que se haya leído el archivo y para archivos indexados antes de que se registrara.

Rango requerido: -9007199254740991 <= x <= 9007199254740991
processed_page_count
integer | null

Cuántas de esas páginas produjeron texto. Una página que el OCR no pudo leer se indexa como un marcador de posición y el archivo aun así se completa, por lo que un valor inferior a page_count significa que faltan algunas páginas en el índice. Campo de extensión no presente en la API de OpenAI. Nulo siempre que page_count sea nulo.

Rango requerido: -9007199254740991 <= x <= 9007199254740991
attributes
object

Conjunto de 16 pares clave-valor que se pueden adjuntar a un objeto. Las claves son cadenas con una longitud máxima de 64 caracteres. Los valores son cadenas con una longitud máxima de 512 caracteres, booleanos o números.