Pular para o conteúdo principal
GET
/
api
/
v1
/
llm
/
vector_stores
/
{vector_store_id}
Python (SDK)
from openapi 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
}

Autorizações

Authorization
string
header
obrigatório

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

Parâmetros de caminho

vector_store_id
string
obrigatório

O ID do armazenamento de vetores a ser recuperado.

Resposta

200 - application/json

OK

Um armazenamento de vetores é uma coleção de arquivos processados que podem ser usados pela ferramenta de busca de arquivos.

id
string
obrigatório

O identificador, que pode ser referenciado em endpoints da API.

object
any
obrigatório

O tipo de objeto, que é sempre 'vector_store'.

created_at
integer
obrigatório

O timestamp Unix (em segundos) para quando o armazenamento de vetores foi criado.

Intervalo obrigatório: -9007199254740991 <= x <= 9007199254740991
name
string | null
obrigatório

O nome do armazenamento de vetores.

usage_bytes
integer
obrigatório

O número total de bytes utilizados pelos arquivos no armazenamento vetorial.

Intervalo obrigatório: -9007199254740991 <= x <= 9007199254740991
embedding_model
string | null
obrigatório

O modelo de incorporação utilizado para este armazenamento de vetores. Resolvido no momento da criação a partir do modelo solicitado ou automático. Nulo para armazenamentos de vetores legados.

embedding_dimensions
integer | null
obrigatório

O número de dimensões para os vetores de incorporação neste armazenamento de vetores. Nulo para armazéns de vetores legados.

Intervalo obrigatório: 0 < x <= 9007199254740991
file_counts
object
obrigatório

Contagens de status de processamento de arquivos.

status
enum<string>
obrigatório

O status do armazenamento de vetores. 'expirado' significa que o armazenamento expirou, 'em andamento' significa que os arquivos ainda estão sendo processados, 'concluído' indica que o armazenamento de vetores está pronto para uso.

Opções disponíveis:
expired,
in_progress,
completed
last_active_at
integer | null
obrigatório

O timestamp Unix (em segundos) de quando o armazenamento de vetores esteve ativo pela última vez.

Intervalo obrigatório: -9007199254740991 <= x <= 9007199254740991
metadata
object
obrigatório

Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. As chaves são strings com um comprimento máximo de 64 caracteres. Os valores são strings com um comprimento máximo de 512 caracteres, booleanos ou números.

last_used_at
integer | null
obrigatório

O carimbo de data/hora Unix (em segundos) de quando o banco de vetores foi utilizado pela última vez.

Intervalo obrigatório: -9007199254740991 <= x <= 9007199254740991
expires_after
object

A política de expiração para um armazenamento vetorial.

expires_at
integer | null

O timestamp Unix (em segundos) para quando o armazenamento de vetores irá expirar.

Intervalo obrigatório: -9007199254740991 <= x <= 9007199254740991
description
string | null

Uma descrição para o armazenamento de vetores. Pode ser usada para descrever o propósito do armazenamento de vetores.