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.

Cuerpo

application/json

Cuerpo de la solicitud para crear un almacén de vectores.

name
string

El nombre del almacén de vectores.

Maximum string length: 255
description
string

Una descripción para la tienda de vectores. Se puede utilizar para describir el propósito de la tienda de vectores.

file_ids
string[]

Una lista de IDs de archivo que el almacén vectorial debe usar. Útil para herramientas como file_search que pueden acceder a archivos. Como máximo 500 por solicitud.

Maximum array length: 500
expires_after
object

La política de expiración para un almacén de vectores.

chunking_strategy
object

La estrategia de agrupación utilizada para agrupar el(s) archivo(s). Si no se establece, se utilizará la estrategia automática. Solo es aplicable si file_ids no está vacío.

metadata
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.

embedding_model
string

El modelo de incrustación a utilizar. Por defecto, se utiliza el modelo configurado automáticamente si no se especifica.

embedding_dimensions
integer

El número de dimensiones de los vectores de embedding. Debe ser igual al tamaño del modelo cuando este sea fijo, o estar dentro de su rango (embedding_dimension_range en GET /models/{model_id}). Si no se especifica, usa las dimensiones predeterminadas del modelo. El almacén sigue siendo consultable solo mientras las dimensiones declaradas del modelo sigan incluyendo este tamaño y el modelo devuelva embeddings de esta anchura.

Rango requerido: -9007199254740991 < x <= 9007199254740991
retrieval_mode
enum<string>

Modo de recuperación, congelado al crearse (no puede cambiarse posteriormente). 'hybrid' (predeterminado): similitud vectorial y búsqueda de palabras clave de texto completo sobre el texto del fragmento, fusionadas mediante fusión recíproca de rangos; el índice de palabras clave coincide con palabras en su forma escrita en cualquier idioma. 'vector': solo búsqueda por similitud vectorial. 'graph': GraphRAG: las entidades y relaciones se extraen de cada fragmento durante la ingesta (medido según su uso) y la búsqueda recorre el grafo de conocimiento.

Opciones disponibles:
vector,
hybrid,
graph
extraction_model
string

Modelo utilizado para la extracción de entidades/relaciones en almacenes de grafos (extracción de tripletes en tiempo de ingestión y extracción de entidades en consultas). Por defecto, el modelo auto-configurado, resuelto en el momento de creación, con el mismo contrato que embedding_model. Solo es válido cuando retrieval_mode es 'graph'.

max_hops
integer

Profundidad de expansión del grafo para consultas en modo grafo (1-4, valor predeterminado del motor 2). Solo válido para almacenes de grafos.

Rango requerido: 1 <= x <= 4

Respuesta

200 - application/json

Está bien

Una tienda de vectores es una colección de archivos procesados que pueden ser utilizados por la herramienta de búsqueda de archivos.

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'.

created_at
integer
requerido

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

Rango requerido: -9007199254740991 <= x <= 9007199254740991
name
string | null
requerido

El nombre del almacén de vectores.

usage_bytes
integer
requerido

El número total de bytes utilizados por los archivos en el almacenamiento vectorial.

Rango requerido: -9007199254740991 <= x <= 9007199254740991
embedding_model
string | null
requerido

El modelo de incrustación utilizado para esta tienda de vectores. Resuelto en el momento de la creación a partir del modelo solicitado o automático. Nulo para tiendas de vectores heredadas.

embedding_dimensions
integer | null
requerido

El número de dimensiones de los vectores de incrustación en este almacén vectorial. Nulo para almacenes vectoriales heredados. Si las dimensiones declaradas del modelo de incrustación dejan de incluir este tamaño, o el modelo devuelve incrustaciones de otro ancho, la búsqueda falla con 412 y los nuevos archivos no se pueden ingerir.

Rango requerido: 0 < x <= 9007199254740991
retrieval_mode
enum<string>
requerido

Modo de recuperación, congelado en la creación. 'hybrid' (el valor predeterminado para los nuevos almacenes): similitud vectorial y búsqueda de palabras clave de texto completo sobre el texto del fragmento, fusionadas mediante fusión recíproca de rangos. 'vector': solo búsqueda por similitud vectorial. 'graph': GraphRAG: las entidades y las relaciones se extraen durante la ingesta y las consultas atraviesan el grafo de conocimiento.

Opciones disponibles:
vector,
hybrid,
graph
file_counts
object
requerido

Conteos de estado de procesamiento de archivos.

status
enum<string>
requerido

El estado del almacén de vectores. 'caducado' significa que el almacén ha caducado, 'en_proceso' significa que los archivos aún se están procesando, 'completado' indica que el almacén de vectores está listo para usar.

Opciones disponibles:
expired,
in_progress,
completed
last_active_at
integer | null
requerido

La marca de tiempo de Unix (en segundos) de la última vez que el almacén vectorial estuvo activo: buscado (directamente o mediante file_search), modificado, o cuando se ingirieron, se volvieron a etiquetar o se eliminaron archivos. Las búsquedas la actualizan como máximo una vez por minuto; la limpieza propia del servicio, como eliminar un archivo caducado, no cuenta.

Rango requerido: -9007199254740991 <= x <= 9007199254740991
metadata
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.

last_used_at
integer | null
requerido

La marca de tiempo de Unix (en segundos) de cuando se utilizó por última vez el almacén de vectores.

Rango requerido: -9007199254740991 <= x <= 9007199254740991
extraction_model
string | null

El modelo utilizado para la extracción de entidades/relaciones en almacenes de grafos. Nulo para almacenes que no son de grafos.

max_hops
integer | null

Profundidad de expansión del grafo para consultas en modo grafo. Nulo para almacenes que no son de grafo.

Rango requerido: 1 <= x <= 4
expires_after
object

La política de expiración para un almacén de vectores.

expires_at
integer | null

La marca de tiempo Unix (en segundos) de cuándo caducará el almacén de vectores: last_active_at más expires_after.days.

Rango requerido: -9007199254740991 <= x <= 9007199254740991
description
string | null

Una descripción para la tienda de vectores. Se puede utilizar para describir el propósito de la tienda de vectores.