Pular para o conteúdo principal
POST
Typescript (SDK)

Autorizações

Authorization
string
header
obrigatório

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.

Cabeçalhos

X-On-Behalf-Of
string

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

Parâmetros de caminho

vector_store_id
string
obrigatório

O ID do armazenamento de vetores a ser modificado.

Corpo

application/json

Corpo da solicitação para modificar um repositório vetorial. Apenas name, description, expires_after e metadata podem ser alterados; embedding_model, embedding_dimensions, retrieval_mode, extraction_model e max_hops são definidos na criação, chunking_strategy é definido por arquivo anexado, e qualquer um desses campos (ou um desconhecido) é rejeitado com 400.

name
string | null

O nome do armazenamento de vetores.

Maximum string length: 255
description
string | null

Uma descrição para o repositório vetorial. Defina como nulo (ou vazio) para limpá-lo.

expires_after
object | null

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

metadata
object

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.

Resposta

200 - application/json

OK

Um repositório 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 de API.

object
any
obrigatório

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

created_at
integer
obrigatório

O timestamp Unix (em segundos) de 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 usados pelos arquivos no armazenamento de vetores.

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 armazéns de vetores legados.

embedding_dimensions
integer | null
obrigatório

O número de dimensões para os vetores de incorporação neste armazenamento vetorial. Nulo para armazenamentos vetoriais legados. Se as dimensões declaradas do modelo de incorporação deixarem de incluir esse tamanho, ou se o modelo retornar incorporações de outra largura, a busca falha com 412 e novos arquivos falham ao serem ingeridos.

Intervalo obrigatório: 0 < x <= 9007199254740991
retrieval_mode
enum<string>
obrigatório

Modo de recuperação, fixado na criação. 'hybrid' (o padrão para novos armazenamentos): similaridade vetorial e busca por palavras-chave em texto completo sobre o texto do chunk, combinadas por fusão de classificação recíproca. 'vector': apenas busca por similaridade vetorial. 'graph': GraphRAG — entidades e relações são extraídas na ingestão e as consultas percorrem o grafo de conhecimento.

Opções disponíveis:
vector,
hybrid,
graph
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 vetorial esteve ativo pela última vez: pesquisado (diretamente ou via file_search), modificado, ou quando arquivos foram ingeridos, reagendados ou removidos. As buscas o atualizam no máximo uma vez por minuto; a própria limpeza do serviço, como remover um arquivo expirado, não conta.

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 timestamp Unix (em segundos) para quando o armazenamento de vetores foi utilizado pela última vez.

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

O modelo usado para extração de entidades/relações em armazenamentos de grafo. Nulo para armazenamentos que não são de grafo.

max_hops
integer | null

Profundidade de expansão do grafo para consultas em modo grafo. Nulo para armazenamentos não orientados a grafos.

Intervalo obrigatório: 1 <= x <= 4
expires_after
object

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

expires_at
integer | null

O timestamp Unix (em segundos) de quando o armazenamento vetorial expirará: last_active_at mais expires_after.days.

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

Uma descrição para a loja de vetores. Pode ser usada para descrever o propósito da loja de vetores.