Documentação do Oracle Cloud Infrastructure

API de Arquivos

Você pode usar a API Arquivos para fazer upload e gerenciar documentos e outros dados que os agentes podem usar durante a execução.

Ao anexar arquivos a workflows, como recuperação e resumo de tarefas, os agentes podem trabalhar com materiais de origem grandes ou complexos sem exigir que você cole conteúdo em prompts. Essa abordagem ajuda a criar agentes mais capazes que possam usar bases de conhecimento, relatórios, logs e conjuntos de dados de maneira escalável e reutilizável, mantendo o tratamento de dados centralizado e consistente.

Advertência

Este serviço não tem a intenção de processar informações pessoais ou quaisquer dados (por exemplo, determinadas informações regulamentadas de saúde ou cartão de pagamento) que imponham obrigações específicas de segurança de dados, proteção de dados ou regulatórias à Oracle, além daquelas especificadas em seu contrato com a Oracle, ou diferentes delas.

Observação

A API OCI Files usa o mesmo formato que a API OpenAI Files com o ponto final compatível com OCI OpenAI. Para obter detalhes de sintaxe e solicitação, consulte a documentação da API OpenAI Files.

Ponto Final de API Suportado

URL Base Caminho do Ponto Final Autenticação
https://inference.generativeai.${region}.oci.oraclecloud.com/openai/v1 /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 de configuração antes de usar essa API, consulte Início Rápido.

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.

Fazendo Upload de um Arquivo

POST /files

Parâmetros do Corpo
  • file (obrigatório): objeto de arquivo a ser submetido a upload
  • purpose (obrigatório): A finalidade pretendida do arquivo. Valores suportados:
    • assistants
    • batch
    • fine-tune
    • vision
    • user_data
    • evals
  • expires_after (opcional): Política de expiração para o arquivo
Restrições de tipo de arquivo (por finalidade)
  • batch: .jsonl
  • fine-tune: .jsonl
  • evals: .jsonl
  • vision: .gif, .jpeg, .jpg, .png, .webp
Referência

Fazer upload do arquivo

Exemplo de Python:

# upload a file

file_path = "./example-file.pdf"
with open(file_path, "rb") as f:
    file = client.files.create(
        file=f,
        purpose="user_data"
    )
print(file.id)

Listando Arquivos

GET /files

Parâmetros de Entrada
  • after (opcional): Cursor para uso na paginação
  • limit (opcional): Número de objetos a serem retornados
  • order (opcional): Ordem de classificação por created_at ("asc" ou "desc")
  • purpose (opcional): Filtrar arquivos por finalidade
Referência

Listar arquivos

Exemplo de Python:

# list files

client = OpenAI(
    base_url="https://inference.generativeai.us-chicago-1.oci.oraclecloud.com/openai/v1",
    api_key="sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    project="ocid1.generativeaiproject.oc1.us-chicago-1.xxxxxxxx",
)
files_list = client.files.list(order="asc")
print(files_list)

Recuperando informações do arquivo

GET /files/{file_id}

Parâmetro de Entrada
  • file_id (obrigatório): Id do arquivo a ser recuperado
Referência

Recuperar arquivo

Exemplo de Python:

# retrieve file
file = client.files.retrieve(file_id="xxx")
print(file)

Recuperando Conteúdo do Arquivo

GET /files/{file_id}/content

Parâmetro de Entrada
  • file_id (obrigatório): Id do arquivo cujo conteúdo você deseja recuperar
Referência

Recuperar conteúdo do arquivo

Exemplo de Python:

# retrieve file content
file = client.files.content(file_id="xxx")
print(file.content)

Excluindo um Arquivo

DELETE /files/{file_id}

Parâmetro de Entrada
  • file_id (obrigatório): Id do arquivo a ser excluído
Referência

Excluir arquivo

Exemplo de Python:

# delete file
delete_result = client.files.delete(file_id="xxx")
print(delete_result)