@azure/ai-agents package

クラス

AgentsClient
ToolSet	定義とリソースを含む一連のツールを表します。
ToolUtility	さまざまなツールを作成するためのユーティリティ クラス。

インターフェイス

AISearchIndexResource	AI 検索インデックス リソース。
Agent	モデルを呼び出してツールを使用できるエージェントを表します。
AgentDeletionStatus	エージェントの削除操作の状態。
AgentErrorDetail	エージェント API によって返されるエラー情報について説明します。
AgentEventMessage	サーバー送信イベント ストリーム内の各イベントには、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 します。 時間の経過と伴ってイベントを追加する場合があるため、不明なイベントを適切に処理することをお勧めします をコード内に格納します。
AgentEventMessageStream	エージェント イベント メッセージのストリームを表します。
AgentThread	エージェントに関連付けられている 1 つのスレッドに関する情報。
AgentThreadCreationOptions	新しいエージェント スレッドの作成に使用される詳細。
AgentV1Error	エージェント API によって返されたエラー ペイロード。
AgentsClientOptionalParams	クライアントの省略可能なパラメーター。
AgentsNamedToolChoice	モデルで使用する必要があるツールを指定します。 モデルで特定のツールを強制的に呼び出すために使用します。
AgentsResponseFormat	モデルの予想される出力を記述するオブジェクト。 json_object の場合、種類 function の tools のみを実行に渡すことができます。 text 場合、モデルはテキストまたは必要な任意の値を返すことができます。
AzureAISearchToolDefinition	エージェントの構成に使用される Azure AI 検索ツールの入力定義情報。
AzureAISearchToolResource	azure_ai_search ツールによって使用されるインデックス リソースのセット。
AzureFunctionBinding	ストレージ キューの名前と URI を保持するための構造。
AzureFunctionDefinition	Azure 関数の定義。
AzureFunctionStorageQueue	ストレージ キューの名前と URI を保持するための構造。
AzureFunctionToolDefinition	エージェントの構成に使用される Azure 関数ツールの入力定義情報。
BingGroundingSearchConfiguration	Bing 接地の検索構成
BingGroundingSearchToolParameters	Bing接地検索ツールのパラメーター。
BingGroundingToolDefinition	エージェントの構成に使用される bing grounding 検索ツールの入力定義情報。
CodeInterpreterToolDefinition	エージェントの構成に使用されるコード インタープリター ツールの入力定義情報。
CodeInterpreterToolResource	code_interpreter ツールによって使用されるリソースのセット。
ConnectedAgentDetails	ツールとして 1 つのエージェントを別のエージェントに接続するための情報
ConnectedAgentToolDefinition	ドメイン固有のサブエージェントを定義する接続エージェント ツールの入力定義情報
CreateAgentOptionalParams	省略可能なパラメーター。
CreateThreadAndRunOptionalParams	省略可能なパラメーター。
DeleteAgentOptionalParams	省略可能なパラメーター。
FileDeletionStatus	ファイル削除操作からの状態応答。
FileInfo	モデルを呼び出してツールを使用できるエージェントを表します。
FileListResponse	ファイル リスト操作からの応答データ。
FileSearchRankingOptions	ファイル検索のランク付けオプション。
FileSearchToolCallContent	ファイル検索結果コンテンツ オブジェクト。
FileSearchToolDefinition	エージェントの構成に使用されるファイル検索ツールの入力定義情報。
FileSearchToolDefinitionDetails	ファイル検索ツールのオプションのオーバーライド。
FileSearchToolResource	file_search ツールによって使用されるリソースのセット。
FilesDeleteFileOptionalParams	省略可能なパラメーター。
FilesGetFileContentOptionalParams	省略可能なパラメーター。
FilesGetFileOptionalParams	省略可能なパラメーター。
FilesListFilesOptionalParams	省略可能なパラメーター。
FilesOperations	ファイル操作を表すインターフェイス。
FilesUploadFileOptionalParams	省略可能なパラメーター。
FunctionDefinition	関数の入力定義情報。
FunctionName	function ツールを使用する場合に使用する関数名
FunctionToolDefinition	エージェントの構成に使用される関数ツールの入力定義情報。
GetAgentOptionalParams	省略可能なパラメーター。
IncompleteRunDetails	実行が不完全である理由の詳細。 実行が不完全でない場合、null されます。
ListAgentsOptionalParams	省略可能なパラメーター。
MessageAttachment	ここでは、ファイルがアタッチされているツールについて説明します。
MessageContent	スレッド メッセージ コンテンツの単一項目の抽象表現。
MessageDelta	ストリーミング メッセージデルタチャンク内の型指定された 'delta' ペイロードを表します。
MessageDeltaChunk	メッセージの差分、つまりストリーミング中に変更されたメッセージのフィールドを表します。
MessageDeltaContent	部分的にストリーミングされたメッセージ コンテンツ ペイロードの抽象基本表現。
MessageDeltaImageFileContent	ストリーミング メッセージデルタチャンク内のストリーミング画像ファイルコンテンツ部分を表します。
MessageDeltaImageFileContentObject	ストリーミング イメージ ファイルコンテンツ内の 'image_file' ペイロードを表します。
MessageDeltaTextAnnotation	ストリーミング テキスト コンテンツ パーツのテキスト注釈の抽象基本表現。
MessageDeltaTextContent	ストリーミング メッセージデルタチャンク内のストリーミングテキストコンテンツ部分を表します。
MessageDeltaTextContentObject	ストリーミング メッセージデルタチャンク内のストリーミングテキストコンテンツ部分のデータを表します。
MessageDeltaTextFileCitationAnnotation	ストリーミング テキスト コンテンツ パーツに適用されるストリーミング ファイルの引用文献を表します。
MessageDeltaTextFileCitationAnnotationObject	ストリーミング テキスト コンテンツ パーツに適用されるストリーミング ファイル引用のデータを表します。
MessageDeltaTextFilePathAnnotation	ストリーミング テキスト コンテンツ パーツに適用されるストリーミング ファイル パス注釈を表します。
MessageDeltaTextFilePathAnnotationObject	ストリーミング テキスト コンテンツ パーツに適用されるストリーミング ファイル パス注釈のデータを表します。
MessageDeltaTextUrlCitationAnnotation	メッセージに関連付けられた特定の URL を指すメッセージ内の引用。 エージェントが「bing_grounding」などのツールを使用してインターネットを検索するときに生成されます。
MessageDeltaTextUrlCitationDetails	テキストスレッドのメッセージコンテンツで使用されるURL引用の表現。
MessageImageFileContent	スレッド メッセージ内のイメージ ファイルコンテンツの表現。
MessageImageFileDetails	スレッド メッセージの内容で表されるイメージ参照。
MessageImageFileParam	イメージ ファイル ブロックを作成するときに、内部的にアップロードされたイメージ ファイルを参照する方法を定義します。
MessageImageUrlParam	画像 URL ブロックを作成する際に外部画像 URL を参照する方法を定義します。
MessageIncompleteDetails	不完全なステータスを入力するメッセージに関する追加情報を提供する情報。
MessageInputContentBlock	メッセージの作成時に 1 つのコンテンツ ブロックを定義します。 'type' フィールドは、テキスト、イメージ ファイル、外部イメージ URL などのいずれであるかを決定します。
MessageInputImageFileBlock	新しいメッセージ内の image-file ブロックで、内部的にアップロードされた画像をファイル ID で参照します。
MessageInputImageUrlBlock	新しいメッセージ内の image-URL ブロックで、URL で外部画像を参照します。
MessageInputTextBlock	プレーン テキスト コンテンツを含む、新しいメッセージ内のテキスト ブロック。
MessageTextAnnotation	テキスト スレッド メッセージの内容に対する注釈の抽象表現。
MessageTextContent	スレッド メッセージコンテンツのテキストアイテムの表現。
MessageTextDetails	エージェント スレッド メッセージ コンテンツの 1 つの項目のテキストと関連付けられた注釈。
MessageTextFileCitationAnnotation	エージェントまたはメッセージに関連付けられている特定のファイルからの特定の引用符を指すメッセージ内の引用。 エージェントが 'file_search' ツールを使用してファイルを検索するときに生成されます。
MessageTextFileCitationDetails	テキスト スレッド メッセージコンテンツのファイルベースの注釈で使用される、ファイルベースのテキスト引用の表現。
MessageTextFilePathAnnotation	特定のパスにあるファイルを指すメッセージ内の引用。
MessageTextFilePathDetails	メッセージ イメージ コンテンツで使用されるイメージ ファイル ID のカプセル化。
MessageTextUrlCitationAnnotation	メッセージに関連付けられた特定の URL を指すメッセージ内の引用。 エージェントが「bing_grounding」などのツールを使用してインターネットを検索するときに生成されます。
MessageTextUrlCitationDetails	テキストスレッドのメッセージコンテンツで使用されるURL引用の表現。
MessagesCreateMessageOptionalParams	省略可能なパラメーター。
MessagesGetMessageOptionalParams	省略可能なパラメーター。
MessagesListMessagesOptionalParams	省略可能なパラメーター。
MessagesOperations	メッセージ操作を表すインターフェイス。
MessagesUpdateMessageOptionalParams	省略可能なパラメーター。
OpenApiAnonymousAuthDetails	OpenApi 匿名認証のセキュリティの詳細
OpenApiAuthDetails	OpenApiFunctionDefinition の認証の詳細
OpenApiConnectionAuthDetails	OpenApi 接続認証のセキュリティの詳細
OpenApiConnectionSecurityScheme	OpenApi managed_identity認証のセキュリティ スキーム
OpenApiFunctionDefinition	openapi 関数の入力定義情報。
OpenApiManagedAuthDetails	OpenApi managed_identity認証のセキュリティの詳細
OpenApiManagedSecurityScheme	OpenApi managed_identity認証のセキュリティ スキーム
OpenApiToolDefinition	エージェントの構成に使用される OpenAPI ツールの入力定義情報。
PageSettings	byPage メソッドのオプション
PagedAsyncIterableIterator	完了とページごとの非同期反復を可能にするインターフェイス。
PollingOptions	ポーリング動作を構成するためのオプション。
PollingOptionsParams	ポーリング動作を構成する省略可能なパラメーター。
RequiredAction	エージェント スレッドの実行を続行するために必要なアクションの抽象表現。
RequiredFunctionToolCall	実行の評価を継続するためにモデルが必要とする、関数ツールに対する要求された呼び出しの表現。
RequiredFunctionToolCallDetails	関数の名前と引数を含む、関数ツールを呼び出す必要なアクションによって提供される関数呼び出しの詳細情報。
RequiredToolCall	実行を続行するためにモデルで必要なツール呼び出しの抽象表現。
ResponseFormatJsonSchema	応答形式の説明で、モデルがその形式でどのように応答するかを決定するために使用されます。
ResponseFormatJsonSchemaType	定義されている応答形式の種類: json_schema
RunCompletionUsage	実行に関連する使用状況の統計。 実行が終了状態 (null、in_progressなど) でない場合、この値は queued されます。
RunError	エージェント スレッドの実行で発生したエラーの詳細。
RunStep	エージェント スレッド実行の単一ステップに関する詳細情報。
RunStepAzureAISearchToolCall	定義されたツールの評価でモデルによって発行された、実行された Azure AI 検索を表す Azure AI Search ツールの呼び出しのレコード。
RunStepBingGroundingToolCall	bing grounding を使用して実行された検索を表す、定義されたツールの評価でモデルによって発行された bing グラウンディング ツールの呼び出しのレコード。
RunStepCodeInterpreterImageOutput	モデルによるツール呼び出しに応答してコード インタープリター ツールによって出力される画像出力の表現。
RunStepCodeInterpreterImageReference	モデルによるツール呼び出しに応答してコード インタープリター ツールによって出力される画像参照。
RunStepCodeInterpreterLogOutput	モデルによるツール呼び出しに応答してコード インタープリター ツールによって出力されるログ出力の表現。
RunStepCodeInterpreterToolCall	定義されたツールの評価でモデルによって発行されるコード インタープリター ツールの呼び出しのレコード。コード インタープリターによって使用および出力される入力と出力を表します。
RunStepCodeInterpreterToolCallDetails	モデルによるコード インタープリター呼び出しに関する詳細情報。
RunStepCodeInterpreterToolCallOutput	コード インタープリター ツールから出力された出力の抽象表現。
RunStepCompletionUsage	実行ステップに関連する使用状況の統計。
RunStepDelta	ストリーミング実行ステップのデルタ チャンク内のデルタ ペイロードを表します。
RunStepDeltaChunk	実行ステップの差分、つまりストリーミング中に変更された実行ステップのフィールドを表します。
RunStepDeltaCodeInterpreterDetailItemObject	ストリーミング実行ステップのツール呼び出しのコード インタープリター ツール呼び出しデータを表します。
RunStepDeltaCodeInterpreterImageOutput	生成されたコード インタープリター ツールとして、およびストリーミング実行ステップのデルタ ツール呼び出しコレクションで表されるイメージ出力を表します。
RunStepDeltaCodeInterpreterImageOutputObject	ストリーミング実行ステップのコード インタープリター ツール呼び出しイメージ出力のデータを表します。
RunStepDeltaCodeInterpreterLogOutput	コード インタープリター ツールによって生成され、ストリーミング実行ステップのデルタ ツール呼び出しコレクションで表されるログ出力を表します。
RunStepDeltaCodeInterpreterOutput	ストリーミング実行ステップ ツール呼び出しのコード インタープリター ツール出力の抽象基本表現。
RunStepDeltaCodeInterpreterToolCall	ストリーミング実行ステップのツール呼び出しの詳細内でのコード インタープリター ツールの呼び出しを表します。
RunStepDeltaDetail	ストリーミング実行ステップのデルタ ペイロード内の 1 つの実行ステップの詳細項目を表します。
RunStepDeltaFileSearchToolCall	ストリーミング実行ステップのツール呼び出しの詳細内のファイル検索ツール呼び出しを表します。
RunStepDeltaFunction	ストリーミング実行ステップ デルタの関数ツール呼び出しの関数データを表します。
RunStepDeltaFunctionToolCall	ストリーミング実行ステップのツール呼び出しの詳細内での関数ツール呼び出しを表します。
RunStepDeltaMessageCreation	ストリーミング実行ステップデルタ内でのメッセージの作成を表します。
RunStepDeltaMessageCreationObject	ストリーミング実行ステップ メッセージ作成応答オブジェクト内のデータを表します。
RunStepDeltaToolCall	ストリーミング実行ステップのデルタ ツール呼び出しの詳細内での 1 つのツール呼び出しの抽象基本表現。
RunStepDeltaToolCallObject	ストリーミング実行ステップの一部としてのツール呼び出しの呼び出しを表します。
RunStepDetails	実行ステップの詳細の抽象的な表現。
RunStepError	失敗した実行ステップに関連付けられているエラー情報。
RunStepFileSearchToolCall	定義されたツールの評価でモデルによって発行された、実行されたファイル検索を表すファイル検索ツールの呼び出しのレコード。
RunStepFileSearchToolCallResult	ファイル検索ツールの呼び出し結果。
RunStepFileSearchToolCallResults	ファイル検索の結果。
RunStepFunctionToolCall	定義されたツールの評価でモデルによって発行される関数ツールの呼び出しのレコード。指定された関数によって消費および出力された入力と出力を表します。
RunStepFunctionToolCallDetails	モデルによって呼び出される関数に関する詳細情報。
RunStepMessageCreationDetails	メッセージ作成の実行ステップに関連付けられている詳細情報。
RunStepMessageCreationReference	実行ステップの一部として作成されたメッセージの詳細。
RunStepOpenAPIToolCall	定義されたツールの評価でモデルによって発行される OpenAPI ツールへの呼び出しの記録で、実行された OpenAPI 操作を表します。
RunStepToolCall	既存の実行の実行ステップ内に記録された詳細なツール呼び出しの抽象的な表現。
RunStepToolCallDetails	実行ステップ呼び出しツールに関連付けられている詳細情報。
RunStepsGetRunStepOptionalParams	省略可能なパラメーター。
RunStepsListRunStepsOptionalParams	省略可能なパラメーター。
RunStepsOperations	RunSteps 操作を表すインターフェイス。
RunsCancelRunOptionalParams	省略可能なパラメーター。
RunsCreateRunOptionalParams	省略可能なパラメーター。
RunsGetRunOptionalParams	省略可能なパラメーター。
RunsListRunsOptionalParams	省略可能なパラメーター。
RunsOperations	Runs 操作を表すインターフェイス。
RunsSubmitToolOutputsToRunOptionalParams	省略可能なパラメーター。
RunsUpdateRunOptionalParams	省略可能なパラメーター。
SubmitToolOutputsAction	エージェント スレッドを実行して続行するために送信する必要がある、必要なツール呼び出しの詳細。
SubmitToolOutputsDetails	ツールの出力を送信するために呼び出す必要があるツールの詳細。
ThreadDeletionStatus	スレッド削除操作の状態。
ThreadMessage	エージェント スレッド内の 1 つの既存のメッセージ。
ThreadMessageOptions	エージェント スレッド内の 1 つのメッセージ 。そのスレッドの初期状態の作成時に指定されます。
ThreadRun	エージェント スレッドの単一の評価実行を表すデータ。
ThreadsCreateThreadOptionalParams	省略可能なパラメーター。
ThreadsDeleteThreadOptionalParams	省略可能なパラメーター。
ThreadsGetThreadOptionalParams	省略可能なパラメーター。
ThreadsListThreadsOptionalParams	省略可能なパラメーター。
ThreadsOperations	スレッド操作を表すインターフェイス。
ThreadsUpdateThreadOptionalParams	省略可能なパラメーター。
ToolDefinition	エージェントが使用できる入力ツール定義の抽象表現。
ToolOutput	ツールの実行中に提供されたデータは、保留中のツール呼び出しを解決し、モデルを続行できるように送信を出力します。
ToolResources	エージェントのツールによって使用されるリソースのセット。 リソースは、ツールの種類に固有です。 たとえば、code_interpreter ツールにはファイル ID の一覧が必要ですが、file_search ツールにはベクター ストア ID の一覧が必要です。
TruncationObject	実行前にスレッドを切り捨てる方法を制御します。 これを使用して、実行の初期コンテキスト ウィンドウを制御します。
UpdateAgentOptionalParams	省略可能なパラメーター。
VectorStore	ベクター ストアは、file_search ツールで使用できる処理済みファイルのコレクションです。
VectorStoreAutoChunkingStrategyRequest	既定の戦略。 この戦略では現在、max_chunk_size_tokens 800、chunk_overlap_tokens 400 を使用しています。
VectorStoreAutoChunkingStrategyResponse	これは、チャンキング戦略が不明な場合に返されます。 通常、これは、chunking_strategyの概念が API で導入される前にファイルのインデックスが作成されたためです。
VectorStoreChunkingStrategyRequest	ベクター ストアチャンク戦略の構成の抽象的な表現。
VectorStoreChunkingStrategyResponse	ベクター ストアチャンク戦略の構成の抽象的な表現。
VectorStoreConfiguration	ベクター ストレージ構成は、エンタープライズ ファイル検索に複数のファイルを使用できる場合に使用されるデータ ソースの一覧です。
VectorStoreConfigurations	ベクター ストレージ構成の一覧 (Azure 資産 ID の一覧) を含む構造体。
VectorStoreDataSource	Azure 資産 URI パスと、エンタープライズ ファイル検索のデータ ソースとして使用されるファイルの資産の種類を含む構造。
VectorStoreDeletionStatus	ベクター ストアを削除するための応答オブジェクト。
VectorStoreExpirationPolicy	ベクター ストアの有効期限ポリシー。
VectorStoreFile	ベクター ストアにアタッチされているファイルの説明。
VectorStoreFileBatch	ベクター ストアにアタッチされているファイルのバッチ。
VectorStoreFileBatchesCancelVectorStoreFileBatchOptionalParams	省略可能なパラメーター。
VectorStoreFileBatchesCreateVectorStoreFileBatchOptionalParams	省略可能なパラメーター。
VectorStoreFileBatchesGetVectorStoreFileBatchOptionalParams	省略可能なパラメーター。
VectorStoreFileBatchesListVectorStoreFileBatchFilesOptionalParams	省略可能なパラメーター。
VectorStoreFileBatchesOperations	VectorStoreFileBatches 操作を表すインターフェイス。
VectorStoreFileCount	状態別にグループ化された、このベクター ストアによって処理または処理されているファイルの数。
VectorStoreFileDeletionStatus	ベクター ストア ファイルリレーションシップを削除するための応答オブジェクト。
VectorStoreFileError	このベクター ストアのファイルの処理中に発生した可能性があるエラーの詳細
VectorStoreFilesCreateVectorStoreFileOptionalParams	省略可能なパラメーター。
VectorStoreFilesDeleteVectorStoreFileOptionalParams	省略可能なパラメーター。
VectorStoreFilesGetVectorStoreFileOptionalParams	省略可能なパラメーター。
VectorStoreFilesListVectorStoreFilesOptionalParams	省略可能なパラメーター。
VectorStoreFilesOperations	VectorStoreFiles操作を表すインターフェイス。
VectorStoreStaticChunkingStrategyOptions	ベクター ストアの静的チャンク戦略を構成するためのオプション。
VectorStoreStaticChunkingStrategyRequest	静的に構成されたチャンク戦略。
VectorStoreStaticChunkingStrategyResponse	静的に構成されたチャンク戦略。
VectorStoresCreateVectorStoreOptionalParams	省略可能なパラメーター。
VectorStoresDeleteVectorStoreOptionalParams	省略可能なパラメーター。
VectorStoresGetVectorStoreOptionalParams	省略可能なパラメーター。
VectorStoresListVectorStoresOptionalParams	省略可能なパラメーター。
VectorStoresModifyVectorStoreOptionalParams	省略可能なパラメーター。
VectorStoresOperations	VectorStores操作を表すインターフェース。

型エイリアス

AgentEventStreamData	エージェント内のストリーム イベント データを表します。
AgentRunResponse	エージェントは、ストリームをサポートして応答を実行します。
AgentStreamEvent	AgentStreamEvent のエイリアス
AgentsNamedToolChoiceType	エージェントの名前付きツールで使用可能なツールタイプ。
AgentsResponseFormatMode	モデルがツール呼び出しの戻り値の形式を処理するモードを表します。
AgentsResponseFormatOption	AgentsResponseFormatOption のエイリアス
AgentsToolChoiceOption	AgentsToolChoiceOption のエイリアス
AgentsToolChoiceOptionMode	ツールの選択方法を指定します
AzureAISearchQueryType	Azure AI Search ツールで使用できるクエリの種類。
ContinuablePage	結果のページを記述するインターフェイス。
FileContents	バイナリ・ファイルの内容の有効な値。
FilePurpose	ファイルの使用目的を示す指定可能な値。
FileState	ファイルの状態。
ImageDetailLevel	画像の詳細レベルを指定します。 'auto'、'low'、'high'、または不明な将来の値を指定できます。
IncompleteDetailsReason	実行が不完全である理由。 これは、実行の過程で達した特定のトークン制限を指します。
ListSortOrder	応答オブジェクトのリストを要求するときに使用可能な並べ替えオプション。
MessageAttachmentToolDefinition	MessageAttachmentToolDefinition のエイリアス
MessageBlockType	メッセージ内のコンテンツ・ブロックの種類を指定します。 テキスト、画像ファイル、外部画像の URL、または不明な将来のタイプである可能性があります。
MessageContentUnion	MessageContentUnion のエイリアス
MessageDeltaContentUnion	MessageDeltaContentUnion のエイリアス
MessageDeltaTextAnnotationUnion	MessageDeltaTextAnnotationUnion のエイリアス
MessageIncompleteDetailsReason	メッセージが不完全としてマークされる理由を説明する一連の理由。
MessageInputContent	MessageInputContent のエイリアス
MessageInputContentBlockUnion	MessageInputContentBlockUnion のエイリアス
MessageRole	スレッド内のメッセージに帰属するロールの可能な値。
MessageStatus	スレッド・メッセージの可能な実行ステータス値。
MessageTextAnnotationUnion	MessageTextAnnotationUnion のエイリアス
OpenApiAuthDetailsUnion	OpenApiAuthDetailsUnion のエイリアス
OpenApiAuthType	OpenApi エンドポイントの認証タイプ。 使用できるタイプは次のとおりです。 匿名 (認証不要) 接続(AI Foundryでの設定時にエンドポイントへのconnection_idが必要) Managed_Identity (ID ベースの認証には対象ユーザーが必要)
RequiredActionUnion	RequiredActionUnion のエイリアス
RequiredToolCallUnion	RequiredToolCallUnion のエイリアス
ResponseFormat	可能な API 応答形式。
RunAdditionalFieldList	応答に含める追加フィールドの一覧。
RunStatus	エージェント・スレッド実行のステータスに指定できる値。
RunStepCodeInterpreterToolCallOutputUnion	RunStepCodeInterpreterToolCallOutputUnion のエイリアス
RunStepDeltaCodeInterpreterOutputUnion	RunStepDeltaCodeInterpreterOutputUnion のエイリアス
RunStepDeltaDetailUnion	RunStepDeltaDetailUnion のエイリアス
RunStepDeltaToolCallUnion	RunStepDeltaToolCallUnion のエイリアス
RunStepDetailsUnion	RunStepDetailsUnion のエイリアス
RunStepErrorCode	失敗した実行ステップに起因する可能性のあるエラー・コード値。
RunStepStatus	実行ステップのステータスに指定できる値。
RunStepToolCallUnion	RunStepToolCallUnion のエイリアス
RunStepType	実行ステップの可能なタイプ。
ToolDefinitionUnion	ToolDefinitionUnion のエイリアス
TruncationStrategy	スレッドの可能な切り捨て戦略。
VectorStoreChunkingStrategyRequestType	チャンク戦略のタイプ
VectorStoreChunkingStrategyRequestUnion	VectorStoreChunkingStrategyRequestUnion のエイリアス
VectorStoreChunkingStrategyResponseType	チャンク戦略のタイプ
VectorStoreChunkingStrategyResponseUnion	VectorStoreChunkingStrategyResponseUnion のエイリアス
VectorStoreExpirationPolicyAnchor	このベクトル ストアの日数と有効期限の関係について説明します
VectorStoreFileBatchStatus	ベクトル ストア ファイル バッチの状態。
VectorStoreFileErrorCode	ベクトル・ストア・ファイル処理のエラー・コード・バリアント
VectorStoreFileStatus	ベクトル ストア ファイルの状態
VectorStoreFileStatusFilter	ベクトル ストア ファイル取得エンドポイントのクエリ パラメーター フィルター
VectorStoreStatus	ベクトル ストアの可能なステータス

列挙型

DoneEvent	ストリームの正常終了を示すターミナル イベント。
ErrorEvent	ストリーミング中のサーバー側エラーを示すターミナル イベント。
KnownVersions	Azure AI Agents API のバージョン
MessageStreamEvent	メッセージ操作関連のストリーミング イベント
RunStepStreamEvent	ステップ操作関連のストリーミング イベントを実行する
RunStreamEvent	実行操作に関連するストリーミング イベント
ThreadStreamEvent	スレッド操作関連のストリーミング イベント
VectorStoreDataSourceAssetType	ベクトル ストレージ アセットのタイプ。 アセットタイプはuri_assetの場合があり、この場合はアセットURI IDを含む必要があり、id_assetの場合はデータIDを含める必要があります。
connectionToolType	エージェントの構成に使用される接続ツールの種類

関数

isOutputOfType<T>(ToolDefinitionUnion | RequiredAction | RequiredToolCall, string)

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

関数の詳細

isOutputOfType<T>(ToolDefinitionUnion | RequiredAction | RequiredToolCall, string)

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

function isOutputOfType<T>(output: ToolDefinitionUnion | RequiredAction | RequiredToolCall, type: string): output

パラメーター

output

ToolDefinitionUnion | RequiredAction | RequiredToolCall

チェックするアクション。RequiredAction、RequiredToolCall、または ToolDefinitionUnionの種類を指定できます。

type

string

アクションを確認する対象の型。

戻り値

output

アクションが指定した型であるかどうかを示すブール値。