Documentação do Oracle Cloud Infrastructure

API de Lotes de Arquivos de Armazenamento de Vetores

Os lotes de arquivos de armazenamento de vetores são para gerenciar muitos arquivos ao mesmo tempo.

Observação

A API de Lotes de Arquivos do OCI Vector Store usa o mesmo formato da API de Lotes de Arquivos do OpenAI Vector Store com o ponto final compatível com o OCI OpenAI. Para obter detalhes de sintaxe e solicitação, consulte a documentação da API OpenAI Vector Store File Batches.

Ponto Final de API Suportado

URL Base Caminho do Ponto Final Autenticação
https://inference.generativeai.${region}.oci.oraclecloud.com/openai/v1 /vector_stores/{id}/file_batches Chave de API ou sessão do IAM

Substitua ${region} por uma região suportada, como us-chicago-1.

Embora o formato de solicitação seja compatível com OpenAI, a autenticação usa credenciais da OCI, as solicitações são roteadas por meio de pontos finais de inferência da OCI Generative AI e os recursos e a execução permanecem na OCI.

Dica

Para saber as etapas a serem executadas antes de usar essa API, consulte o QuickStart.

Autenticação

Você pode acessar os pontos finais compatíveis com o OCI OpenAI de duas maneiras:

Use chaves de API para teste e desenvolvimento antecipado. Usar autenticação baseada em IAM para cargas de trabalho de produção e ambientes gerenciados pela OCI.

Criando um Lote de Arquivos de Armazenamento de Vetores

POST /vector_stores/{vector_store_id}/file_batches

Referência

Criar batch de arquivos de armazenamento de vetores

Exemplo:

# 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)

Listando Lotes de Arquivos de Armazenamento de Vetores

GET /vector_stores/{vector_store_id}/file_batches

Referência

Listar lotes de arquivos de armazenamento de vetores

Exemplo:

# 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)

Recuperando Informações do Lote de Arquivos do Vector Store

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

Referência

Recuperar batch de arquivos de armazenamento de vetores

Exemplo:

# 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)

Cancelando um Lote de Arquivos de Armazenamento de Vetores

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

Referência

Cancelar batch de arquivos de armazenamento de vetores

Exemplo:

# 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)