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


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

    res = sdk.llm.vector_stores.create_file_batch(vector_store_id="vs_abc123", file_ids=[
        "file-abc123",
        "file-def456",
        "file-ghi789",
    ], attributes={
        "batch_id": "import-2024-01",
    })

    # Handle response
    print(res)
{
  "id": "vsfb_abc123",
  "object": "vector_store.file_batch",
  "created_at": 1704067200,
  "vector_store_id": "vs_abc123",
  "status": "in_progress",
  "file_counts": {
    "in_progress": 3,
    "completed": 0,
    "failed": 0,
    "cancelled": 0,
    "total": 3
  }
}

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 Lote de Arquivos.

Corpo

application/json

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

​
file_ids
string[]

Uma lista de IDs de arquivos que o armazenamento vetorial deve usar. Se atributos ou chunking_strategy forem fornecidos no nível raiz, eles serão aplicados a todos os arquivos no lote. Mutuamente exclusivo com 'files'.

​
files
object[]

Uma lista de objetos que inclui cada um um file_id, além de atributos opcionais ou estratégia de divisão. Use isso quando você precisar sobrescrever metadados para arquivos específicos. Os atributos globais ou a estratégia de divisão serão ignorados. Exclui mutuamente 'file_ids'.

​
attributes
object

Atributos globais a serem aplicados a todos os arquivos se usar 'file_ids'. Ignorado se usar 'files'.

​
chunking_strategy
object

Estratégia de divisão global a ser aplicada a todos os arquivos se utilizar 'file_ids'. Ignorado se utilizar 'files'.

Resposta

200 - application/json

OK

Um lote 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_batch'.

​
created_at
integer
obrigatório

O timestamp Unix (em segundos) de quando o lote de arquivos do 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 lote de arquivos do vetor. 'em_andamento' significa que os arquivos estão sendo processados, 'concluído' significa que todos os arquivos foram processados, 'cancelado' significa que o lote foi cancelado, 'falhou' significa que o lote falhou.

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

Contagens de status de processamento de arquivos.