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

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

Parámetros de ruta

vector_store_id
string
requerido

El ID de la tienda de vectores para la cual crear un Lote de Archivos.

Cuerpo

application/json

Cuerpo de la solicitud para crear un lote de archivos de almacenamiento vectorial.

file_ids
string[]

Una lista de IDs de archivos que el almacén de vectores debe usar. Si se proporcionan atributos o estrategia de fragmentación a nivel raíz, se aplicarán a todos los archivos en el lote. Excluyente de 'archivos'.

files
object[]

Una lista de objetos que incluye un file_id y atributos opcionales o una estrategia de fragmentación. Utiliza esto cuando necesites sobrescribir los metadatos para archivos específicos. Los atributos globales o la estrategia de fragmentación serán ignorados. Mutuamente exclusivo con 'file_ids'.

attributes
object

Atributos globales que se aplicarán a todos los archivos si se utilizan 'file_ids'. Ignorado si se utilizan 'files'.

chunking_strategy
object

Estrategia de agrupamiento global a aplicar a todos los archivos si se utilizan 'file_ids'. Ignorado si se utilizan 'files'.

Respuesta

200 - application/json

Está bien

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

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 de la tienda de vectores.

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

El ID de la tienda de vectores a la que está adjunto el archivo.

status
enum<string>
requerido

El estado del lote de archivos de la tienda de vectores. 'en_proceso' 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

Contadores de estado de procesamiento de archivos.