Saltar al contenido principal
POST
/
api
/
v1
/
llm
/
vector_stores
/
{vector_store_id}
/
file_batches
/
{batch_id}
/
cancel
Python (SDK)
from mka1 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
  }
}

Autorizaciones

​
Authorization
string
header
requerido

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

Encabezados

​
X-On-Behalf-Of
string

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

Parámetros de ruta

​
vector_store_id
string
requerido

El ID de la tienda de vectores a la que pertenece el lote de archivos.

​
batch_id
string
requerido

El ID del lote de archivos a cancelar.

Respuesta

200 - application/json

Está bien

Un lote de archivos adjuntos a un almacén de vectores.

​
id
string
requerido

El identificador, que se puede referenciar en los puntos finales de la API.

​
object
any
requerido

El tipo de objeto, que siempre es 'vector_store.file_batch'.

​
created_at
integer
requerido

La marca de tiempo de Unix (en segundos) para cuando se creó el lote de archivos del almacén de vectores.

Rango requerido: -9007199254740991 <= x <= 9007199254740991
​
vector_store_id
string
requerido

La ID del almacén de vectores al que está adjunto el archivo.

​
status
enum<string>
requerido

El estado de los archivos del lote de la tienda de vectores. 'en_progreso' significa que los archivos están siendo procesados, 'completado' significa que todos los archivos han sido procesados, 'cancelado' significa que el lote fue cancelado, 'fallido' significa que el lote falló.

Opciones disponibles:
in_progress,
completed,
cancelled,
failed
​
file_counts
object
requerido

Conteos de estado de procesamiento de archivos.