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


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

    res = sdk.llm.vector_stores.cancel_file_batch(vector_store_id="vs_abc123", batch_id="vsfb_abc123")

    # Handle response
    print(res)
{
  "id": "vsfb_abc123",
  "object": "vector_store.file_batch",
  "created_at": 1704067200,
  "vector_store_id": "vs_abc123",
  "status": "cancelled",
  "file_counts": {
    "in_progress": 0,
    "completed": 0,
    "failed": 0,
    "cancelled": 3,
    "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>.

Parâmetros de caminho

vector_store_id
string
obrigatório

O ID do armazenamento de vetores ao qual o lote de arquivos pertence.

batch_id
string
obrigatório

O ID do lote de arquivos a ser cancelado.

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 da 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) para 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.