API de Arquivos

Você pode usar a API de Arquivos para fazer upload e gerenciar com segurança documentos e outros dados que os agentes podem usar enquanto são executados.

Ao anexar arquivos a fluxos de trabalho, como recuperação e resumo de tarefas, os agentes podem trabalhar com materiais de origem grandes ou complexos sem que você precise colar conteúdo em prompts. Isso 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.

Importante

A API de Arquivos usa o mesmo formato da API de Arquivos OpenAI. Consulte a documentação da API de Arquivos OpenAI.

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

Exemplo:

# upload files

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

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

Exemplo:

# list files
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

Exemplo:

# retrieve file
file = client.files.retrieve(file_id="file-fra-d5dd80c5-da8c-435e-b336-48ce9b346200")
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

Exemplo:

# retrieve file content
file = client.files.content(file_id="file-fra-d5dd80c5-da8c-435e-b336-48ce9b346200")
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

Exemplo:

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