OpenAI
OpenAI API
このノードは資格情報(OpenAI API Key)で接続します。資格情報を接続する を参照してください。
アクション
このノードが実行できる処理です。ステップを追加 からノードを追加し、アクションを選びます。
テキストメッセージ
AIとチャット
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| モデル | 選択 | はい | 使用するモデル 選択肢: GPT 5.2, GPT 5.1, GPT 5, GPT 5 Mini, GPT 5 Nano, GPT 4.1, GPT 4.1 Mini, GPT 4.1 Nano, GPT-5.5既定値: gpt-5.5 |
| メッセージ | リスト | はい | モデルに送信するメッセージ一覧 |
| Temperature | 数値 | 使用するtemperatureの値 既定値: 0.5 | |
| Top P | 数値 | 使用するtop_pの値 既定値: 0.5 | |
| Frequency Penalty | 数値 | 使用するfrequency_penaltyの値 既定値: 0 | |
| Presence Penalty | 数値 | 使用するpresence_penaltyの値 既定値: 0 | |
| Max Tokens | 数値 | 生成する最大トークン数 既定値: 256 | |
| 停止シーケンス | テキスト | 使用する停止シーケンス | |
| 推論強度 | 選択 | 使用する推論強度 選択肢: 低, 中, 高既定値: low | |
| Verbosity | 選択 | 出力の詳細度 選択肢: 低, 中, 高既定値: low |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば model_used は $.<ステップID>.output.model_used です。
{
"model_used": "string",
"response": {
"choices": [
{
"finish_reason": "string",
"index": 0,
"message": {}
}
],
"created": 0,
"id": "string",
"model": "string",
"object": "chat.completion",
"usage": {
"completion_tokens": 0,
"prompt_tokens": 0,
"total_tokens": 0
}
},
"success": false,
"tokens_used": 0
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
model_used | テキスト | チャット補完を生成したモデル |
response | オブジェクト | OpenAI によって返された完全なチャット完了応答 |
response.choices[] | リスト | チャット補完候補のリスト |
response.choices[].finish_reason | テキスト | モデルがトークン生成を停止した理由 |
response.choices[].index | 数値 | 候補リスト内のインデックス |
response.choices[].message | オブジェクト | モデルが生成したメッセージ |
response.choices[].message.content | テキスト | メッセージの内容 |
response.choices[].message.role | テキスト | メッセージ作成者の役割 |
response.created | 数値 | チャット補完が作成されたUnixタイムスタンプ(秒) |
response.id | テキスト | チャット補完の一意識別子 |
response.model | テキスト | チャット補完に使用されたモデル |
response.object | テキスト | オブジェクト種別(常に 'chat.completion') |
response.usage | オブジェクト | 補完リクエストの使用統計 |
response.usage.completion_tokens | 数値 | 生成された補完のトークン数 |
response.usage.prompt_tokens | 数値 | プロンプトのトークン数 |
response.usage.total_tokens | 数値 | リクエストで使用した総トークン数 |
success | はい / いいえ | チャット完了リクエストが成功したかどうか |
tokens_used | 数値 | リクエストで使用した総トークン数 |
ディープリサーチ
OpenAIのDeep Research APIを用いて、状態を保持する会話の新しいレスポンスを作成
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| モデル | 選択 | はい | 使用するモデル 選択肢: O3 Deep Research既定値: gpt-5.6-sol |
| 入力 | テキスト | はい | レスポンス生成用の入力テキストまたはメッセージ |
| ツール | リスト | はい | 使用する組み込みツール(web_search) |
| レスポンスを保存 | はい / いいえ | レスポンスをデータベースに保存するかどうか 既定値: false | |
| 最大ツール呼び出し | 数値 | ツール呼び出しの最大回数 既定値: 10 | |
| 前回レスポンスID | テキスト | コンテキストとして使用する前回のレスポンスID | |
| メタデータ | オブジェクト | レスポンスに付与するメタデータ | |
| 推論強度 | 選択 | 使用する推論強度 選択肢: 中, 高既定値: medium | |
| 実行モード | 選択 | アクションが 深い研究 の仕事をどのように処理するか 。「 バックグラウンドリクエスト 」は ジョブ を送信し、 すぐに 応答 ID で返されます — フローは 結果を待たず に 続行します 。「 完了まで待機 」は ジョブ を送信し、 終端 状態 ( 完了 、 失敗 、 または キャンセル) に達するまで ポーリングしてから 次の ノードに 制御を渡します 。 選択肢: 背景リクエスト, 完了まで待機既定値: background_request | |
| ポーリング間隔(秒) | 数値 | 完了確認の間隔(秒)。既定は 60 秒。OpenAI は最低 2 秒の間隔を推奨。 既定値: 60 |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば conversation_id は $.<ステップID>.output.conversation_id です。
{
"conversation_id": "string",
"created_at": 0,
"error": {
"message": "string",
"type": "string"
},
"id": "string",
"metadata": {},
"model": "string",
"object": "response",
"output": [
{
"content": "string",
"role": "string"
}
],
"status": "in_progress",
"usage": {
"completion_tokens": 0,
"prompt_tokens": 0,
"total_tokens": 0
}
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
conversation_id | テキスト | このレスポンスが属する会話ID |
created_at | 数値 | レスポンスが作成されたUnixタイムスタンプ(秒) |
error | オブジェクト | 失敗時のエラー情報 |
error.message | テキスト | エラーメッセージ |
error.type | テキスト | エラー種別 |
id | テキスト | レスポンスの一意識別子 |
metadata | オブジェクト | レスポンスの追加メタデータ |
model | テキスト | レスポンスに使用されたモデル |
object | テキスト | オブジェクト種別(常に 'response') |
output[] | リスト | 出力メッセージまたはコンテンツの配列 |
output[].content | テキスト | メッセージの内容 |
output[].role | テキスト | メッセージ作成者のロール |
status | テキスト | レスポンスの現在の状態 |
usage | オブジェクト | レスポンスの使用状況 |
usage.completion_tokens | 数値 | 生成結果のトークン数 |
usage.prompt_tokens | 数値 | プロンプトのトークン数 |
usage.total_tokens | 数値 | 使用したトークン合計 |
レスポンス作成
OpenAIのResponses APIを用いて、状態を保持する会話の新しいレスポンスを作成
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| モデル | 選択 | はい | レスポンスに使用するモデル 選択肢: GPT-4o, GPT-4o Mini, GPT-5, GPT-5 Mini, GPT-5 Nano, GPT-5.1, GPT-4.1 Mini, GPT-4.1 Nano, GPT-5.5, GPT-5.5 Pro既定値: gpt-5.5 |
| 入力 | テキスト | はい | レスポンス生成用の入力テキストまたはメッセージ |
| ツール | リスト | 使用する組み込みツール(web_search) | |
| ストリーム出力 | はい / いいえ | ストリーミング出力を有効化 既定値: false | |
| Temperature | 数値 | ランダム性を制御(0.0〜2.0) 既定値: 1 | |
| 最大出力トークン | 数値 | 生成する最大トークン数 既定値: 1000 | |
| 指示 | テキスト | レスポンス生成のための指示 | |
| レスポンスを保存 | はい / いいえ | レスポンスをデータベースに保存するかどうか 既定値: false | |
| 最大ツール呼び出し | 数値 | ツール呼び出しの最大回数 既定値: 10 | |
| 前回レスポンスID | テキスト | コンテキストとして使用する前回のレスポンスID | |
| メタデータ | オブジェクト | レスポンスに付与するメタデータ | |
| 推論強度 | 選択 | 使用する推論強度 選択肢: 低, 中, 高既定値: low | |
| バックグラウンド処理 | はい / いいえ | レスポンスをバックグラウンドで処理するか。trueの場合、即時にレスポンスIDを返し、後で結果を取得できる。 既定値: false | |
| レスポンス形式 | オブジェクト | モデル出力の形式を指定。JSON Schema による構造化出力に使用 |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば conversation_id は $.<ステップID>.output.conversation_id です。
{
"conversation_id": "string",
"created_at": 0,
"error": {
"message": "string",
"type": "string"
},
"id": "string",
"metadata": {},
"model": "string",
"object": "response",
"output": [
{
"content": "string",
"role": "string"
}
],
"status": "in_progress",
"usage": {
"completion_tokens": 0,
"prompt_tokens": 0,
"total_tokens": 0
}
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
conversation_id | テキスト | このレスポンスが属する会話ID |
created_at | 数値 | レスポンスが作成されたUnixタイムスタンプ(秒) |
error | オブジェクト | 失敗時のエラー情報 |
error.message | テキスト | エラーメッセージ |
error.type | テキスト | エラー種別 |
id | テキスト | レスポンスの一意識別子 |
metadata | オブジェクト | レスポンスの追加メタデータ |
model | テキスト | レスポンスに使用されたモデル |
object | テキスト | オブジェクト種別(常に 'response') |
output[] | リスト | 出力メッセージまたはコンテンツの配列 |
output[].content | テキスト | メッセージの内容 |
output[].role | テキスト | メッセージ作成者のロール |
status | テキスト | レスポンスの現在の状態 |
usage | オブジェクト | レスポンスの使用状況 |
usage.completion_tokens | 数値 | 生成結果のトークン数 |
usage.prompt_tokens | 数値 | プロンプトのトークン数 |
usage.total_tokens | 数値 | 使用したトークン合計 |
レスポンス取得
OpenAIのResponses APIからレスポンスの状態と結果を取得
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| レスポンスID | テキスト | はい | 取得対象のレスポンスID |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば conversation_id は $.<ステップID>.output.conversation_id です。
{
"conversation_id": "string",
"created_at": 0,
"error": {
"message": "string",
"type": "string"
},
"id": "string",
"metadata": {},
"model": "string",
"object": "response",
"output": [
{
"content": "string",
"role": "string"
}
],
"status": "in_progress",
"usage": {
"completion_tokens": 0,
"prompt_tokens": 0,
"total_tokens": 0
}
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
conversation_id | テキスト | このレスポンスが属する会話ID |
created_at | 数値 | レスポンスが作成されたUnixタイムスタンプ(秒) |
error | オブジェクト | 失敗時のエラー情報 |
error.message | テキスト | エラーメッセージ |
error.type | テキスト | エラー種別 |
id | テキスト | レスポンスの一意識別子 |
metadata | オブジェクト | レスポンスの追加メタデータ |
model | テキスト | レスポンスに使用されたモデル |
object | テキスト | オブジェクト種別(常に 'response') |
output[] | リスト | 出力メッセージまたはコンテンツの配列 |
output[].content | テキスト | メッセージの内容 |
output[].role | テキスト | メッセージ作成者のロール |
status | テキスト | レスポンスの現在の状態 |
usage | オブジェクト | レスポンスの使用状況 |
usage.completion_tokens | 数値 | 生成結果のトークン数 |
usage.prompt_tokens | 数値 | プロンプトのトークン数 |
usage.total_tokens | 数値 | 使用したトークン合計 |
画像生成
OpenAIの画像モデルでテキストプロンプトから画像を生成
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| プロンプト | テキスト | はい | 生成したい画像のテキスト説明 |
| モデル | 選択 | はい | 画像生成に使用するモデル 選択肢: GPT Image 1.5, GPT Image 1, GPT Image 1 Mini既定値: gpt-image-1.5 |
| 品質 | 選択 | 画像品質 選択肢: 高, 中, 低既定値: medium | |
| 解像度 | 選択 | 生成画像の解像度 選択肢: 1024x1024, 1792x1024, 1024x1792既定値: 1024x1024 | |
| Background | 選択 | Background transparency. Only supported for GPT-image models. Requires png or webp output format for transparency. 選択肢: Auto, Opaque, Transparent既定値: auto | |
| 画像枚数 | 数値 | 生成する画像の枚数 既定値: 1 | |
| Moderation | 選択 | Content moderation sensitivity level. Only supported for GPT-image models. 選択肢: Auto (Standard filtering), Low (Less restrictive)既定値: auto | |
| Output File | ファイル | はい | The configuration for the output file. The file extension will be determined by the output_type field |
| Output Type | 選択 | The image file format for the output 選択肢: PNG, WebP, JPEG既定値: png |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば created は $.<ステップID>.output.created です。
{
"created": 0,
"data": [
{
"fileId": "string",
"fileName": "string",
"fileSize": 0
}
],
"model": "string",
"prompt": "string"
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
created | 数値 | OpenAIが画像を生成した日時(Unix秒) |
data[] | リスト | 生成され、ファイルストレージに保存された画像 |
data[].fileId | テキスト | 保存された画像ファイルのID |
data[].fileName | テキスト | 保存された画像ファイルの名前 |
data[].fileSize | 数値 | 画像サイズ(バイト) |
model | テキスト | 使用した画像モデル |
prompt | テキスト | 画像生成に使用したプロンプト |
違反判定(テキスト)
OpenAIのモデレーションAPIを使って有害の可能性があるコンテンツを特定・フラグ付け
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| テキスト入力 | テキスト | はい | モデレーションポリシーに違反しているか判定するテキストを入力 |
| オプション | オブジェクト | テキストモデレーションの追加オプション |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば flagged は $.<ステップID>.output.flagged です。
{
"flagged": false,
"model_used": "string",
"response": {
"id": "string",
"model": "string",
"results": [
{
"categories": "hate",
"category_scores": {},
"flagged": false
}
]
},
"success": false
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
flagged | はい / いいえ | 最初の入力がフラグ付けされたかどうか。OpenAIが結果を返さなかった場合は含まれません |
model_used | テキスト | OpenAIが使用したモデレーションモデル |
response | オブジェクト | OpenAIのモデレーションレスポンス全体 |
response.id | テキスト | モデレーションリクエストID |
response.model | テキスト | モデレーションモデル |
response.results[] | リスト | 入力ごとに1件の結果 |
response.results[].categories | オブジェクト | カテゴリごとの判定(例: hate、harassment、violence) |
response.results[].category_scores | オブジェクト | カテゴリごとのスコア(0〜1) |
response.results[].flagged | はい / いいえ | 入力が利用ポリシーに違反しているかどうか |
success | はい / いいえ | モデレーションリクエストが成功した場合は true |
ファイルアップロード
アシスタント、バッチ処理、ファインチューニング、ビジョンモデルで使用するためにOpenAIにファイルをアップロード
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| 目的 | 選択 | はい | ファイルアップロードの目的 選択肢: アシスタント (最大512 MB), ビジョン (最大20 MB), バッチ (最大100 MB), ファインチューン (最大1 GB)既定値: batch |
| ファイル内容タイプ | 選択 | はい | ファイル内容のタイプ - FSSストレージキーの場合は'reference'、base64データの場合は'raw' 選択肢: 生コンテンツ。大きなデータの場合は参照を検討してください, ストレージ内のファイルへの参照既定値: raw |
| ファイル内容 | テキスト | はい | Base64エンコードされたファイル内容(file_content_typeが'raw'の場合)またはストレージキー(file_content_typeが'reference'の場合) |
| ファイル名 | テキスト | はい | 拡張子付きの元のファイル名(例:document.pdf、image.png) |
| コンテンツタイプ | テキスト | ファイルのMIMEタイプ(オプション、提供されない場合は自動検出) |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば bytes は $.<ステップID>.output.bytes です。
{
"bytes": 0,
"file_id": "string",
"filename": "string",
"purpose": "assistants"
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
bytes | 数値 | アップロードされたファイルのサイズ(バイト) |
file_id | テキスト | アップロードされたファイルの一意の識別子 |
filename | テキスト | アップロードされたファイルの名前 |
purpose | テキスト | アップロードされたファイルの目的 |
音声 文字起こし
直接 OpenAI API を使用して添付または同時実行のリファレンスオーディオファイルを文字起こし
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| モデル | 選択 | はい | OpenAI 音声書き起こしモデル 選択肢: GPT トランスクライブ, GPT-4o トランスクライブ, GPT-4o Mini トランスクライブ, ウィスパー 1, GPT-4o トランスクライブ・ダイアライズ既定値: whisper-1 |
| 音声ファイル | ファイル | はい | 文字起こしするための音声ファイル (FLAC , MP3 , MP4 , MPEG , MPGA , M4A , OGG , WAV , WEBM ; 最大 25 MiB) 選択肢: 参照, 新規添付 |
| レスポンス形式 | 選択 | 文字起こしレスポンスの形式。OpenAI モデルは OpenAI の対応表に従い、OpenRouter モデルは json と verbose_json をサポートします。Gemini では使用されません。 選択肢: JSON, 話者分離 JSON既定値: json | |
| プロンプト | テキスト | モデルのスタイルや語彙(例:固有名詞)を指定するための任意のテキスト。注:話者分離モデルではサポートされていません。 | |
| チャンク分割戦略 | 選択 | 音声のチャンク分割方法。gpt-4o-transcribe-diarize で 30 秒を超える入力の場合は 'auto' に設定します。 選択肢: Auto |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば model_used は $.<ステップID>.output.model_used です。
{
"model_used": "string",
"segments": [
{
"end": 0,
"id": "string",
"speaker": "Speaker 1",
"start": 0,
"text": "string"
}
],
"text": "string"
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
model_used | テキスト | 使用 されている OpenAI トランスクリプション モデル |
segments[] | リスト | diarized_json または verbose_json 使用時のタイムスタンプと話者ラベル付きセグメント |
segments[].end | 数値 | 秒単位の終了タイムスタンプ |
segments[].id | 任意 | セグメント ID |
segments[].speaker | テキスト | 話者ラベル(例:話者 1、話者 2) |
segments[].start | 数値 | 秒単位の開始タイムスタンプ |
segments[].text | テキスト | 文字起こしされたセグメントテキスト |
text | テキスト | 文字起こしされた音声テキスト |
バッチジョブ作成
大量のリクエストを50%削減コストで非同期処理するバッチジョブを作成します。purpose'batch'でアップロードされたファイルが必要です。完了時間は自動的に24時間に設定されます。'in_progress'または'failed'状態になるまで1分ごとにバッチステータスを自動ポーリングします。
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| 入力ファイルID | テキスト | はい | 新しいバッチのリクエストを含むアップロード済みファイルのID。ファイルはJSONL形式で、purpose'batch'でアップロードされ、最大50,000件のリクエストを含み、最大200MBである必要があります。 |
| エンドポイント | 選択 | はい | バッチリクエスト用のOpenAI APIエンドポイント 選択肢: チャット補完, 埋め込み, 補完既定値: /v1/chat/completions |
| メタデータ | オブジェクト | バッチジョブを追跡するためのカスタムメタデータ(最大16個のキーと値のペア) |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば batch_id は $.<ステップID>.output.batch_id です。
{
"batch_id": "string",
"input_file_id": "string",
"status": "validating"
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
batch_id | テキスト | バッチジョブの一意の識別子 |
input_file_id | テキスト | バッチに使用された入力ファイルのID |
status | テキスト | バッチジョブの現在のステータス |
バッチジョブ取得
バッチIDでバッチジョブのステータスと詳細を取得
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| バッチID | テキスト | はい | 取得するバッチジョブのID |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば completion_window は $.<ステップID>.output.completion_window です。
{
"completion_window": "24h",
"created_at": 0,
"endpoint": "string",
"error_file_id": "string",
"errors": {
"data": [
{
"code": "string",
"line": 0,
"message": "string",
"param": "string"
}
],
"object": "string"
},
"expires_at": 0,
"id": "string",
"input_file_id": "string",
"metadata": {},
"object": "batch",
"output_file_id": "string",
"request_counts": {
"completed": 0,
"failed": 0,
"total": 0
},
"status": "validating"
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
completion_window | テキスト | バッチ完了の時間枠(例:'24h') |
created_at | 数値 | バッチが作成されたときのUnixタイムスタンプ(秒) |
endpoint | テキスト | バッチがターゲットとするAPIエンドポイント |
error_file_id | テキスト | 処理エラーを含むエラーファイルのID(エラーがない場合はnull) |
errors | オブジェクト | バッチが失敗した場合のエラー情報 |
errors.data[] | リスト | エラー詳細の配列 |
errors.data[].code | テキスト | エラーコード |
errors.data[].line | 数値 | エラーが発生した行番号 |
errors.data[].message | テキスト | エラーメッセージ |
errors.data[].param | テキスト | エラーに関連するパラメータ |
errors.object | テキスト | オブジェクトタイプ |
expires_at | 数値 | バッチが期限切れになるときのUnixタイムスタンプ(秒) |
id | テキスト | バッチの一意の識別子 |
input_file_id | テキスト | バッチに使用された入力ファイルのID |
metadata | オブジェクト | バッチジョブを追跡するためのカスタムメタデータ |
object | テキスト | 常に'batch'であるオブジェクトタイプ |
output_file_id | テキスト | バッチ結果を含む出力ファイルのID(完了していない場合はnull) |
request_counts | オブジェクト | ステータス別のリクエスト数 |
request_counts.completed | 数値 | 完了したリクエスト数 |
request_counts.failed | 数値 | 失敗したリクエスト数 |
request_counts.total | 数値 | バッチ内のリクエストの総数 |
status | テキスト | バッチの現在のステータス |
バッチジョブキャンセル
進行中のバッチジョブをキャンセルします。バッチは最大10分間'cancelling'ステータスとなり、その後'cancelled'ステータスに変更されます。
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| バッチID | テキスト | はい | キャンセルするバッチジョブのID |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば completion_window は $.<ステップID>.output.completion_window です。
{
"completion_window": "24h",
"created_at": 0,
"endpoint": "string",
"error_file_id": "string",
"errors": {
"data": [
{
"code": "string",
"line": 0,
"message": "string",
"param": "string"
}
],
"object": "string"
},
"expires_at": 0,
"id": "string",
"input_file_id": "string",
"metadata": {},
"object": "batch",
"output_file_id": "string",
"request_counts": {
"completed": 0,
"failed": 0,
"total": 0
},
"status": "validating"
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
completion_window | テキスト | バッチ完了の時間枠(例:'24h') |
created_at | 数値 | バッチが作成されたときのUnixタイムスタンプ(秒) |
endpoint | テキスト | バッチがターゲットとするAPIエンドポイント |
error_file_id | テキスト | 処理エラーを含むエラーファイルのID(エラーがない場合はnull) |
errors | オブジェクト | バッチが失敗した場合のエラー情報 |
errors.data[] | リスト | エラー詳細の配列 |
errors.data[].code | テキスト | エラーコード |
errors.data[].line | 数値 | エラーが発生した行番号 |
errors.data[].message | テキスト | エラーメッセージ |
errors.data[].param | テキスト | エラーに関連するパラメータ |
errors.object | テキスト | オブジェクトタイプ |
expires_at | 数値 | バッチが期限切れになるときのUnixタイムスタンプ(秒) |
id | テキスト | バッチの一意の識別子 |
input_file_id | テキスト | バッチに使用された入力ファイルのID |
metadata | オブジェクト | バッチジョブを追跡するためのカスタムメタデータ |
object | テキスト | 常に'batch'であるオブジェクトタイプ |
output_file_id | テキスト | バッチ結果を含む出力ファイルのID(完了していない場合はnull) |
request_counts | オブジェクト | ステータス別のリクエスト数 |
request_counts.completed | 数値 | 完了したリクエスト数 |
request_counts.failed | 数値 | 失敗したリクエスト数 |
request_counts.total | 数値 | バッチ内のリクエストの総数 |
status | テキスト | バッチの現在のステータス |
ファイル取得
IDで以前にアップロードされたファイルのメタデータと情報を取得
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| ファイルID | テキスト | はい | 取得するファイルのID |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば bytes は $.<ステップID>.output.bytes です。
{
"bytes": 0,
"created_at": 0,
"expires_at": 0,
"filename": "string",
"id": "string",
"object": "file",
"purpose": "assistants",
"status": "uploaded",
"status_details": "string"
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
bytes | 数値 | ファイルのサイズ(バイト) |
created_at | 数値 | ファイルが作成されたときのUnixタイムスタンプ(秒) |
expires_at | 数値 | ファイルが期限切れになるときのUnixタイムスタンプ(秒) |
filename | テキスト | アップロードされたファイルの名前 |
id | テキスト | ファイルの一意の識別子 |
object | テキスト | 常に'file'であるオブジェクトタイプ |
purpose | テキスト | ファイルの意図された目的 |
status | テキスト | ファイルの現在の処理ステータス |
status_details | テキスト | ファイルステータスに関する追加詳細(非推奨) |
ファイル削除
OpenAIストレージからファイルを削除します。削除ステータスオブジェクトを返します。
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| ファイルID | テキスト | はい | 削除するファイルのID |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば deleted は $.<ステップID>.output.deleted です。
{
"deleted": false,
"file_id": "string",
"object": "string"
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
deleted | はい / いいえ | OpenAIがファイルを削除したかどうか |
file_id | テキスト | 削除されたファイルのID |
object | テキスト | OpenAIが返したオブジェクト種別(通常は file) |
ファイル内容取得
ファイルの実際の内容を取得します。ファイル内容を文字列として返します。
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| ファイルID | テキスト | はい | 内容を取得するファイルのID |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば content は $.<ステップID>.output.content です。
{
"content": "string",
"file_id": "string",
"size": 0
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
content | テキスト | テキストとしてのファイル内容 |
file_id | テキスト | ファイルのID |
size | 数値 | 内容のサイズ(バイト) |