@azure/ai-agents package

定義とリソースを含む一連のツールを表します。

さまざまなツールを作成するためのユーティリティ クラス。

AI 検索インデックス リソース。

モデルを呼び出してツールを使用できるエージェントを表します。

エージェントの削除操作の状態。

エージェント API によって返されるエラー情報について説明します。

サーバー送信イベント ストリーム内の各イベントには、event プロパティと data プロパティ * * があります。

例

• イベント: thread.created
• データ: {"id": "thread_123", "object": "thread", ...}
• 新しいオブジェクトが作成されたとき、新しい状態に遷移したとき、または新しい状態に遷移するたびに、イベントが生成されます。
• パート (デルタ) でストリーミングされます。 たとえば、新しい実行時に thread.run.created を出力します。
• が作成され、実行が完了したときに thread.run.completed されます。 エージェントが選択した場合
• 実行中にメッセージを作成するには、thread.message.created event、
• thread.message.in_progress イベント、多くの thread.message.delta イベント、最後に
• イベント thread.message.completed します。
• 時間の経過と伴ってイベントを追加する場合があるため、不明なイベントを適切に処理することをお勧めします
• をコード内に格納します。

エージェント イベント メッセージのストリームを表します。

エージェントに関連付けられている 1 つのスレッドに関する情報。

新しいエージェント スレッドの作成に使用される詳細。

エージェント API によって返されたエラー ペイロード。

クライアントの省略可能なパラメーター。

モデルで使用する必要があるツールを指定します。 モデルで特定のツールを強制的に呼び出すために使用します。

モデルの予想される出力を記述するオブジェクト。 json_object の場合、種類 function の tools のみを実行に渡すことができます。 text 場合、モデルはテキストまたは必要な任意の値を返すことができます。

エージェントの構成に使用される Azure AI 検索ツールの入力定義情報。

azure_ai_search ツールによって使用されるインデックス リソースのセット。

ストレージ キューの名前と URI を保持するための構造。

Azure 関数の定義。

ストレージ キューの名前と URI を保持するための構造。

エージェントの構成に使用される Azure 関数ツールの入力定義情報。

Bing 接地の検索構成

Bing接地検索ツールのパラメーター。

エージェントの構成に使用される bing grounding 検索ツールの入力定義情報。

エージェントの構成に使用されるコード インタープリター ツールの入力定義情報。

code_interpreter ツールによって使用されるリソースのセット。

ツールとして 1 つのエージェントを別のエージェントに接続するための情報

ドメイン固有のサブエージェントを定義する接続エージェント ツールの入力定義情報

省略可能なパラメーター。

省略可能なパラメーター。

省略可能なパラメーター。

ファイル削除操作からの状態応答。

モデルを呼び出してツールを使用できるエージェントを表します。

ファイル リスト操作からの応答データ。

ファイル検索のランク付けオプション。

ファイル検索結果コンテンツ オブジェクト。

エージェントの構成に使用されるファイル検索ツールの入力定義情報。

ファイル検索ツールのオプションのオーバーライド。

file_search ツールによって使用されるリソースのセット。

省略可能なパラメーター。

省略可能なパラメーター。

省略可能なパラメーター。

省略可能なパラメーター。

ファイル操作を表すインターフェイス。

省略可能なパラメーター。

関数の入力定義情報。

function ツールを使用する場合に使用する関数名

エージェントの構成に使用される関数ツールの入力定義情報。

省略可能なパラメーター。

実行が不完全である理由の詳細。 実行が不完全でない場合、null されます。

省略可能なパラメーター。

ここでは、ファイルがアタッチされているツールについて説明します。

スレッド メッセージ コンテンツの単一項目の抽象表現。

ストリーミング メッセージデルタチャンク内の型指定された 'delta' ペイロードを表します。

メッセージの差分、つまりストリーミング中に変更されたメッセージのフィールドを表します。

部分的にストリーミングされたメッセージ コンテンツ ペイロードの抽象基本表現。

ストリーミング メッセージデルタチャンク内のストリーミング画像ファイルコンテンツ部分を表します。

ストリーミング イメージ ファイルコンテンツ内の 'image_file' ペイロードを表します。

ストリーミング テキスト コンテンツ パーツのテキスト注釈の抽象基本表現。

ストリーミング メッセージデルタチャンク内のストリーミングテキストコンテンツ部分を表します。

ストリーミング メッセージデルタチャンク内のストリーミングテキストコンテンツ部分のデータを表します。

ストリーミング テキスト コンテンツ パーツに適用されるストリーミング ファイルの引用文献を表します。

ストリーミング テキスト コンテンツ パーツに適用されるストリーミング ファイル引用のデータを表します。

ストリーミング テキスト コンテンツ パーツに適用されるストリーミング ファイル パス注釈を表します。

ストリーミング テキスト コンテンツ パーツに適用されるストリーミング ファイル パス注釈のデータを表します。

メッセージに関連付けられた特定の URL を指すメッセージ内の引用。 エージェントが「bing_grounding」などのツールを使用してインターネットを検索するときに生成されます。

テキストスレッドのメッセージコンテンツで使用されるURL引用の表現。

スレッド メッセージ内のイメージ ファイルコンテンツの表現。

スレッド メッセージの内容で表されるイメージ参照。

イメージ ファイル ブロックを作成するときに、内部的にアップロードされたイメージ ファイルを参照する方法を定義します。

画像 URL ブロックを作成する際に外部画像 URL を参照する方法を定義します。

不完全なステータスを入力するメッセージに関する追加情報を提供する情報。

メッセージの作成時に 1 つのコンテンツ ブロックを定義します。 'type' フィールドは、テキスト、イメージ ファイル、外部イメージ URL などのいずれであるかを決定します。

新しいメッセージ内の image-file ブロックで、内部的にアップロードされた画像をファイル ID で参照します。

新しいメッセージ内の image-URL ブロックで、URL で外部画像を参照します。

プレーン テキスト コンテンツを含む、新しいメッセージ内のテキスト ブロック。

テキスト スレッド メッセージの内容に対する注釈の抽象表現。

スレッド メッセージコンテンツのテキストアイテムの表現。

エージェント スレッド メッセージ コンテンツの 1 つの項目のテキストと関連付けられた注釈。

エージェントまたはメッセージに関連付けられている特定のファイルからの特定の引用符を指すメッセージ内の引用。 エージェントが 'file_search' ツールを使用してファイルを検索するときに生成されます。

テキスト スレッド メッセージコンテンツのファイルベースの注釈で使用される、ファイルベースのテキスト引用の表現。

特定のパスにあるファイルを指すメッセージ内の引用。

メッセージ イメージ コンテンツで使用されるイメージ ファイル ID のカプセル化。

メッセージに関連付けられた特定の URL を指すメッセージ内の引用。 エージェントが「bing_grounding」などのツールを使用してインターネットを検索するときに生成されます。

テキストスレッドのメッセージコンテンツで使用されるURL引用の表現。

省略可能なパラメーター。

省略可能なパラメーター。

省略可能なパラメーター。

メッセージ操作を表すインターフェイス。

省略可能なパラメーター。

OpenApi 匿名認証のセキュリティの詳細

OpenApiFunctionDefinition の認証の詳細

OpenApi 接続認証のセキュリティの詳細

OpenApi managed_identity認証のセキュリティ スキーム

openapi 関数の入力定義情報。

OpenApi managed_identity認証のセキュリティの詳細

OpenApi managed_identity認証のセキュリティ スキーム

エージェントの構成に使用される OpenAPI ツールの入力定義情報。

byPage メソッドのオプション

完了とページごとの非同期反復を可能にするインターフェイス。

ポーリング動作を構成するためのオプション。

ポーリング動作を構成する省略可能なパラメーター。

エージェント スレッドの実行を続行するために必要なアクションの抽象表現。

実行の評価を継続するためにモデルが必要とする、関数ツールに対する要求された呼び出しの表現。

関数の名前と引数を含む、関数ツールを呼び出す必要なアクションによって提供される関数呼び出しの詳細情報。

実行を続行するためにモデルで必要なツール呼び出しの抽象表現。

応答形式の説明で、モデルがその形式でどのように応答するかを決定するために使用されます。

定義されている応答形式の種類: json_schema

実行に関連する使用状況の統計。 実行が終了状態 (null、in_progressなど) でない場合、この値は queued されます。

エージェント スレッドの実行で発生したエラーの詳細。

エージェント スレッド実行の単一ステップに関する詳細情報。

定義されたツールの評価でモデルによって発行された、実行された Azure AI 検索を表す Azure AI Search ツールの呼び出しのレコード。

bing grounding を使用して実行された検索を表す、定義されたツールの評価でモデルによって発行された bing グラウンディング ツールの呼び出しのレコード。

モデルによるツール呼び出しに応答してコード インタープリター ツールによって出力される画像出力の表現。

モデルによるツール呼び出しに応答してコード インタープリター ツールによって出力される画像参照。

モデルによるツール呼び出しに応答してコード インタープリター ツールによって出力されるログ出力の表現。

定義されたツールの評価でモデルによって発行されるコード インタープリター ツールの呼び出しのレコード。コード インタープリターによって使用および出力される入力と出力を表します。

モデルによるコード インタープリター呼び出しに関する詳細情報。

コード インタープリター ツールから出力された出力の抽象表現。

実行ステップに関連する使用状況の統計。

ストリーミング実行ステップのデルタ チャンク内のデルタ ペイロードを表します。

実行ステップの差分、つまりストリーミング中に変更された実行ステップのフィールドを表します。

ストリーミング実行ステップのツール呼び出しのコード インタープリター ツール呼び出しデータを表します。

生成されたコード インタープリター ツールとして、およびストリーミング実行ステップのデルタ ツール呼び出しコレクションで表されるイメージ出力を表します。

ストリーミング実行ステップのコード インタープリター ツール呼び出しイメージ出力のデータを表します。

コード インタープリター ツールによって生成され、ストリーミング実行ステップのデルタ ツール呼び出しコレクションで表されるログ出力を表します。

ストリーミング実行ステップ ツール呼び出しのコード インタープリター ツール出力の抽象基本表現。

ストリーミング実行ステップのツール呼び出しの詳細内でのコード インタープリター ツールの呼び出しを表します。

ストリーミング実行ステップのデルタ ペイロード内の 1 つの実行ステップの詳細項目を表します。

ストリーミング実行ステップのツール呼び出しの詳細内のファイル検索ツール呼び出しを表します。

ストリーミング実行ステップ デルタの関数ツール呼び出しの関数データを表します。

ストリーミング実行ステップのツール呼び出しの詳細内での関数ツール呼び出しを表します。

ストリーミング実行ステップデルタ内でのメッセージの作成を表します。

ストリーミング実行ステップ メッセージ作成応答オブジェクト内のデータを表します。

ストリーミング実行ステップのデルタ ツール呼び出しの詳細内での 1 つのツール呼び出しの抽象基本表現。

ストリーミング実行ステップの一部としてのツール呼び出しの呼び出しを表します。

実行ステップの詳細の抽象的な表現。

失敗した実行ステップに関連付けられているエラー情報。

定義されたツールの評価でモデルによって発行された、実行されたファイル検索を表すファイル検索ツールの呼び出しのレコード。

ファイル検索ツールの呼び出し結果。

ファイル検索の結果。

定義されたツールの評価でモデルによって発行される関数ツールの呼び出しのレコード。指定された関数によって消費および出力された入力と出力を表します。

モデルによって呼び出される関数に関する詳細情報。

メッセージ作成の実行ステップに関連付けられている詳細情報。

実行ステップの一部として作成されたメッセージの詳細。

定義されたツールの評価でモデルによって発行される OpenAPI ツールへの呼び出しの記録で、実行された OpenAPI 操作を表します。

既存の実行の実行ステップ内に記録された詳細なツール呼び出しの抽象的な表現。

実行ステップ呼び出しツールに関連付けられている詳細情報。

省略可能なパラメーター。

省略可能なパラメーター。

RunSteps 操作を表すインターフェイス。

省略可能なパラメーター。

省略可能なパラメーター。

省略可能なパラメーター。

省略可能なパラメーター。

Runs 操作を表すインターフェイス。

省略可能なパラメーター。

省略可能なパラメーター。

エージェント スレッドを実行して続行するために送信する必要がある、必要なツール呼び出しの詳細。

ツールの出力を送信するために呼び出す必要があるツールの詳細。

スレッド削除操作の状態。

エージェント スレッド内の 1 つの既存のメッセージ。

エージェント スレッド内の 1 つのメッセージ 。そのスレッドの初期状態の作成時に指定されます。

エージェント スレッドの単一の評価実行を表すデータ。

省略可能なパラメーター。

省略可能なパラメーター。

省略可能なパラメーター。

省略可能なパラメーター。

スレッド操作を表すインターフェイス。

省略可能なパラメーター。

エージェントが使用できる入力ツール定義の抽象表現。

ツールの実行中に提供されたデータは、保留中のツール呼び出しを解決し、モデルを続行できるように送信を出力します。

エージェントのツールによって使用されるリソースのセット。 リソースは、ツールの種類に固有です。 たとえば、code_interpreter ツールにはファイル ID の一覧が必要ですが、file_search ツールにはベクター ストア ID の一覧が必要です。

実行前にスレッドを切り捨てる方法を制御します。 これを使用して、実行の初期コンテキスト ウィンドウを制御します。

省略可能なパラメーター。

ベクター ストアは、file_search ツールで使用できる処理済みファイルのコレクションです。

既定の戦略。 この戦略では現在、max_chunk_size_tokens 800、chunk_overlap_tokens 400 を使用しています。

これは、チャンキング戦略が不明な場合に返されます。 通常、これは、chunking_strategyの概念が API で導入される前にファイルのインデックスが作成されたためです。

ベクター ストアチャンク戦略の構成の抽象的な表現。

ベクター ストアチャンク戦略の構成の抽象的な表現。

ベクター ストレージ構成は、エンタープライズ ファイル検索に複数のファイルを使用できる場合に使用されるデータ ソースの一覧です。

ベクター ストレージ構成の一覧 (Azure 資産 ID の一覧) を含む構造体。

Azure 資産 URI パスと、エンタープライズ ファイル検索のデータ ソースとして使用されるファイルの資産の種類を含む構造。

ベクター ストアを削除するための応答オブジェクト。

ベクター ストアの有効期限ポリシー。

ベクター ストアにアタッチされているファイルの説明。

ベクター ストアにアタッチされているファイルのバッチ。

省略可能なパラメーター。

省略可能なパラメーター。

省略可能なパラメーター。

省略可能なパラメーター。

VectorStoreFileBatches 操作を表すインターフェイス。

状態別にグループ化された、このベクター ストアによって処理または処理されているファイルの数。

ベクター ストア ファイルリレーションシップを削除するための応答オブジェクト。

このベクター ストアのファイルの処理中に発生した可能性があるエラーの詳細

省略可能なパラメーター。

省略可能なパラメーター。

省略可能なパラメーター。

省略可能なパラメーター。

VectorStoreFiles操作を表すインターフェイス。

ベクター ストアの静的チャンク戦略を構成するためのオプション。

静的に構成されたチャンク戦略。

静的に構成されたチャンク戦略。

省略可能なパラメーター。

省略可能なパラメーター。

省略可能なパラメーター。

省略可能なパラメーター。

省略可能なパラメーター。

VectorStores操作を表すインターフェース。

エージェント内のストリーム イベント データを表します。

エージェントは、ストリームをサポートして応答を実行します。

AgentStreamEvent のエイリアス

エージェントの名前付きツールで使用可能なツールタイプ。

モデルがツール呼び出しの戻り値の形式を処理するモードを表します。

AgentsResponseFormatOption のエイリアス

AgentsToolChoiceOption のエイリアス

ツールの選択方法を指定します

Azure AI Search ツールで使用できるクエリの種類。

結果のページを記述するインターフェイス。

バイナリ・ファイルの内容の有効な値。

ファイルの使用目的を示す指定可能な値。

ファイルの状態。

画像の詳細レベルを指定します。 'auto'、'low'、'high'、または不明な将来の値を指定できます。

実行が不完全である理由。 これは、実行の過程で達した特定のトークン制限を指します。

応答オブジェクトのリストを要求するときに使用可能な並べ替えオプション。

MessageAttachmentToolDefinition のエイリアス

メッセージ内のコンテンツ・ブロックの種類を指定します。 テキスト、画像ファイル、外部画像の URL、または不明な将来のタイプである可能性があります。

MessageContentUnion のエイリアス

MessageDeltaContentUnion のエイリアス

MessageDeltaTextAnnotationUnion のエイリアス

メッセージが不完全としてマークされる理由を説明する一連の理由。

MessageInputContent のエイリアス

MessageInputContentBlockUnion のエイリアス

スレッド内のメッセージに帰属するロールの可能な値。

スレッド・メッセージの可能な実行ステータス値。

MessageTextAnnotationUnion のエイリアス

OpenApiAuthDetailsUnion のエイリアス

OpenApi エンドポイントの認証タイプ。 使用できるタイプは次のとおりです。

• 匿名 (認証不要)
• 接続(AI Foundryでの設定時にエンドポイントへのconnection_idが必要)
• Managed_Identity (ID ベースの認証には対象ユーザーが必要)

RequiredActionUnion のエイリアス

RequiredToolCallUnion のエイリアス

可能な API 応答形式。

応答に含める追加フィールドの一覧。

エージェント・スレッド実行のステータスに指定できる値。

RunStepCodeInterpreterToolCallOutputUnion のエイリアス

RunStepDeltaCodeInterpreterOutputUnion のエイリアス

RunStepDeltaDetailUnion のエイリアス

RunStepDeltaToolCallUnion のエイリアス

RunStepDetailsUnion のエイリアス

失敗した実行ステップに起因する可能性のあるエラー・コード値。

実行ステップのステータスに指定できる値。

RunStepToolCallUnion のエイリアス

実行ステップの可能なタイプ。

ToolDefinitionUnion のエイリアス

スレッドの可能な切り捨て戦略。

チャンク戦略のタイプ

VectorStoreChunkingStrategyRequestUnion のエイリアス

チャンク戦略のタイプ

VectorStoreChunkingStrategyResponseUnion のエイリアス

このベクトル ストアの日数と有効期限の関係について説明します

ベクトル ストア ファイル バッチの状態。

ベクトル・ストア・ファイル処理のエラー・コード・バリアント

ベクトル ストア ファイルの状態

ベクトル ストア ファイル取得エンドポイントのクエリ パラメーター フィルター

ベクトル ストアの可能なステータス

ストリームの正常終了を示すターミナル イベント。

ストリーミング中のサーバー側エラーを示すターミナル イベント。

Azure AI Agents API のバージョン

メッセージ操作関連のストリーミング イベント

ステップ操作関連のストリーミング イベントを実行する

実行操作に関連するストリーミング イベント

スレッド操作関連のストリーミング イベント

ベクトル ストレージ アセットのタイプ。 アセットタイプはuri_assetの場合があり、この場合はアセットURI IDを含む必要があり、id_assetの場合はデータIDを含める必要があります。

エージェントの構成に使用される接続ツールの種類

指定された出力が指定した型であるかどうかを判断します。