Oracle Cloud Infrastructureドキュメント

ファイルAPI

Files APIを使用して、エージェントが実行中に使用できるドキュメントおよびその他のデータを安全にアップロードおよび管理できます。

検索や要約タスクなどのワークフローにファイルを添付することで、エージェントは、プロンプトにコンテンツを貼り付けることなく、大規模または複雑なソース資料を操作できます。これにより、データ処理を一元化して一貫性を保ちながら、ナレッジ・ベース、レポート、ログおよびデータセットをスケーラブルで再利用可能な方法で使用できる、より効率的なエージェントを構築できます。

警告

このサービスは、Oracleに特定のデータ・セキュリティ、データ保護または規制上の義務を課す個人情報またはデータ(特定の規制対象となる健康情報や支払カード情報など)を、Oracleとの契約に規定されているものと異なるものに加え、処理することを意図したものではありません。

重要

ファイルAPIは、OpenAIファイルAPIと同じ形式を使用します。OpenAI Files APIドキュメントを参照してください。

ファイルをアップロードしています

POST/files

本文のパラメータ
  • file (必須): アップロードするファイル・オブジェクト
  • purpose (必須): ファイルの目的。サポートされる値:
    • assistants
    • batch
    • fine-tune
    • vision
    • user_data
    • evals
  • expires_after (オプション): ファイルの有効期限ポリシー
ファイル・タイプの制限(目的別)
  • batch: .jsonl
  • fine-tune: .jsonl
  • evals: .jsonl
  • vision: .gif, .jpeg, .jpg, .png, .webp

例:

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

ファイルの一覧表示

GET/files

入力パラメータ
  • after (オプション): ページ区切りで使用するカーソル
  • limit (オプション): 返されるオブジェクトの数
  • order (オプション): created_at(「asc」または「desc」)によるソート順序
  • purpose (オプション): 目的別にファイルをフィルタします。

例:

# list files
files_list = client.files.list(order="asc")
print(files_list)

ファイル情報の取得

GET/files/{file_id}

入力パラメータ
  • file_id (必須): 取得するファイルのID

例:

# retrieve file
file = client.files.retrieve(file_id="file-fra-d5dd80c5-da8c-435e-b336-48ce9b346200")
print(file)

ファイル・コンテンツの取得中

GET/files/{file_id}/content

入力パラメータ
  • file_id (必須): コンテンツを取得するファイルのID

例:

# retrieve file content
file = client.files.content(file_id="file-fra-d5dd80c5-da8c-435e-b336-48ce9b346200")
print(file.content)

ファイルの削除

DELETE/files/{file_id}

入力パラメータ
  • file_id (必須): 削除するファイルのID

例:

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