Pular para o conteúdo principal
POST
/
api
/
v1
/
llm
/
vector_stores
Python (SDK)
from mka1 import SDK


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

    res = sdk.llm.vector_stores.create(name="Product Documentation", description="Vector store for product manuals and documentation", file_ids=[
        "file-abc123",
    ], expires_after={
        "anchor": "last_active_at",
        "days": 30,
    })

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

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

Cabeçalhos

​
X-On-Behalf-Of
string

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

Corpo

application/json

Corpo da solicitação para criar um armazenamento de vetores.

​
name
string

O nome do armazenamento de vetores.

​
description
string

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

​
file_ids
string[]

Uma lista de IDs de arquivos que o armazenamento de vetores deve usar. Útil para ferramentas como file_search que podem acessar arquivos.

​
expires_after
object

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

​
chunking_strategy
object

A estratégia de divisão usada para dividir o(s) arquivo(s). Se não definida, usará a estratégia automática. Aplicável apenas se file_ids não estiver vazio.

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

​
embedding_model
string

O modelo de incorporação a ser usado. Padrão para o modelo configurado automaticamente se não especificado.

​
embedding_dimensions
integer

O número de dimensões para os vetores de embedding. Suportado apenas para modelos com dimensões flexíveis. Se não especificado, utiliza as dimensões padrão do modelo.

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

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 de vetores. Nulo para armazenamento 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 foi ativado 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 timestamp Unix (em segundos) para quando o armazenamento 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 de vetores.

​
expires_at
integer | null

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

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.