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


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

    res = sdk.llm.vector_stores.create_file(vector_store_id="vs_abc123", file_id="file-abc123", attributes={
        "category": "manual",
        "version": "2.0",
    })

    # Handle response
    print(res)
{
  "id": "file-abc123",
  "object": "vector_store.file",
  "usage_bytes": 0,
  "created_at": 1704067200,
  "vector_store_id": "vs_abc123",
  "status": "in_progress",
  "last_error": null,
  "chunking_strategy": {
    "type": "auto"
  },
  "attributes": {
    "category": "manual",
    "version": "2.0"
  }
}

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.

Parâmetros de caminho

​
vector_store_id
string
obrigatório

O ID do armazenamento de vetores para o qual criar um arquivo.

Corpo

application/json

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

​
file_id
string
obrigatório

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

​
attributes
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, booleanos ou números.

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

Resposta

200 - application/json

OK

Uma lista de arquivos anexados a um armazenamento vetorial.

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

​
usage_bytes
integer
obrigatório

O uso total do armazenamento vetor em bytes. Observe que isso pode ser diferente do tamanho original do arquivo.

Intervalo obrigatório: -9007199254740991 <= x <= 9007199254740991
​
created_at
integer
obrigatório

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

Intervalo obrigatório: -9007199254740991 <= x <= 9007199254740991
​
vector_store_id
string
obrigatório

O ID do armazenamento de vetores ao qual o arquivo está anexado.

​
status
enum<string>
obrigatório

O status do arquivo da loja de vetores. 'em_andamento' significa que está em processamento, 'concluído' indica que o arquivo está pronto para uso, 'cancelado' significa que o processamento foi cancelado, 'falhou' significa que ocorreu um erro.

Opções disponíveis:
in_progress,
completed,
cancelled,
failed
​
last_error
object
obrigatório

O último erro associado a este arquivo de armazenamento de vetores. Será nulo se não houver erros.

​
chunking_strategy
object

A estratégia utilizada para dividir o arquivo.

​
attributes
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, booleanos ou números.