Saltar al contenido principal
GET
/
api
/
v1
/
llm
/
vector_stores
/
{vector_store_id}
Python (SDK)
from mka1 import SDK


with SDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as sdk:

    res = sdk.llm.vector_stores.get(vector_store_id="vs_abc123")

    # Handle response
    print(res)
{
  "id": "vs_abc123",
  "object": "vector_store",
  "created_at": 1704067200,
  "name": "Product Documentation",
  "usage_bytes": 1024000,
  "embedding_model": "auto",
  "embedding_dimensions": 1536,
  "file_counts": {
    "in_progress": 0,
    "completed": 5,
    "failed": 0,
    "cancelled": 0,
    "total": 5
  },
  "status": "completed",
  "last_active_at": 1704153600,
  "last_used_at": 1704153600,
  "metadata": {
    "department": "engineering"
  },
  "description": "Vector store for product manuals and docs",
  "expires_at": null
}

Documentation Index

Fetch the complete documentation index at: https://docs.mka1.com/llms.txt

Use this file to discover all available pages before exploring further.

Autorizaciones

​
Authorization
string
header
requerido

Gateway auth: send Authorization: Bearer <mka1-api-key>. For multi-user server-side integrations, you can also send X-On-Behalf-Of: <external-user-id>.

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 tienda de vectores a recuperar.

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 para los vectores de incrustación en esta tienda de vectores. Nulo para las tiendas de vectores heredadas.

Rango requerido: 0 < x <= 9007199254740991
​
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 cuando la tienda de vectores estuvo activa por última vez.

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
​
expires_after
object

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

​
expires_at
integer | null

El timestamp de Unix (en segundos) para cuando expirará el almacén de vectores.

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.