Skip to content

CreateVectorStoreFileBatchRequest

Request body for creating a vector store file batch.

Example Usage

typescript
import { CreateVectorStoreFileBatchRequest } from "@meetkai/mka1/models/components";

let value: CreateVectorStoreFileBatchRequest = {
  fileIds: [
    "file-abc123",
    "file-def456",
    "file-ghi789",
  ],
  attributes: {
    "batch_id": "import-2024-01",
  },
};

Fields

FieldTypeRequiredDescription
fileIdsstring[]A list of File IDs that the vector store should use. If attributes or chunking_strategy are provided at the root level, they will be applied to all files in the batch. Mutually exclusive with 'files'.
filescomponents.FileWithMetadata[]A list of objects that each include a file_id plus optional attributes or chunking_strategy. Use this when you need to override metadata for specific files. The global attributes or chunking_strategy will be ignored. Mutually exclusive with 'file_ids'.
attributesRecord<string, components.CreateVectorStoreFileBatchRequestAttributes>Global attributes to apply to all files if using 'file_ids'. Ignored if using 'files'.
chunkingStrategycomponents.CreateVectorStoreFileBatchRequestChunkingStrategyGlobal chunking strategy to apply to all files if using 'file_ids'. Ignored if using 'files'.