Oracle Cloud Infrastructure Documentation

Vector Store File Batches API

Vector store file batches are for managing many files at the same time.

Note

The OCI Vector Store File Batch Batches API uses the same format as the OpenAI Vector Store File Batch Batches API with the OCI OpenAI-compatible endpoint. For syntax and request details, see the OpenAI Vector Store File Batch Batches API documentation.

Supported API Endpoint

Base URL Endpoint Path Authentication
https://inference.generativeai.${region}.oci.oraclecloud.com/openai/v1 /vector_stores/{id}/file_batches API key or IAM session

Replace ${region} with a supported OCI region such as us-chicago-1.

Although the request format is OpenAI-compatible, authentication uses OCI credentials, requests are routed through OCI Generative AI inference endpoints, and resources and execution remain in OCI.

Tip

For steps to perform before using this API, see the QuickStart.

Creating a Vector Store File Batch

POST /vector_stores/{vector_store_id}/file_batches

Reference

Create vector store file batch

Example:

# create vector store file batch

vector_store_file_batch = client.vector_stores.file_batches.create(
  vector_store_id="xxx",
  files=[
    ...
)
print(vector_store_file_batch)

Listing Vector Store File Batches

GET /vector_stores/{vector_store_id}/file_batches

Reference

List vector store file batches

Example:

# list vector store file batches

vector_store_files = client.vector_stores.file_batches.list_files(
    vector_store_id="xxx"
    batch_id="xxx"
)
print(vector_store_files)

Retrieving Vector Store File Batch Information

GET /vector_stores/{vector_store_id}/file_batches/{batch_id}

Reference

Retrieve vector store file batch

Example:

# retrieve vector store file batch

vector_store_file_batch = client.vector_stores.file_batches.retrieve(
  vector_store_id="xxx",
  batch_id="xxx"
)
print(vector_store_file_batch)

Canceling a Vector Store File Batch

POST /vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel

Reference

Cancel vector store file batch

Example:

# cancle a vector store file batch

canceled_vector_store_file_batch = client.vector_stores.file_batches.cancel(
    vector_store_id="xxx",
    file_id="xxx"
)
print(canceled_vector_store_file_batch)