API de Arquivos do Vector Store

Arquivos de armazenamento de vetores são arquivos que você pode anexar a um armazenamento de vetores.

Observação

A API do OCI Vector Store Files usa o mesmo formato que a API do OpenAI Vector Store Files 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 Files.

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}/files 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 Arquivo de Armazenamento de Vetores

POST /vector_stores/{vector_store_id}/files

Referência

Criar arquivo de armazenamento de vetores

Exemplo:

# create vector store file

vector_store_file = client.vector_stores.files.create(
  vector_store_id="xxx",
  file_id="xxx"
)
print(vector_store_file)

Listando Arquivos do Vector Store

GET /vector_stores/{vector_store_id}/files

Referência

Listar arquivos de armazenamento de vetores

Exemplo:

# list vector store files

vector_store_files = client.vector_stores.files.list(
  vector_store_id="xxx"
)
print(vector_store_files)

Recuperando Informações do Arquivo de Armazenamento de Vetores

GET /vector_stores/{vector_store_id}/files/{file_id}

Referência

Recuperar arquivo de armazenamento de vetores

Exemplo:

# retrieve vector store file

vector_store_file = client.vector_stores.files.retrieve(
  vector_store_id="xxx",
  file_id="xxx"
)
print(vector_store_file)

Excluindo um Arquivo de Armazenamento de Vetores

DELETE /vector_stores/{vector_store_id}/files/{file_id}

Referência

Excluir arquivo de armazenamento de vetores

Exemplo:

# delete a vector store file

deleted_vector_store_file = client.vector_stores.files.delete(
    vector_store_id="xxx",
    file_id="xxx"
)
print(deleted_vector_store_file)