@azure/ai-projects package

クラス

AIProjectClient

OpenAIクライアントとオプションのOpenAIクライアントオプションを得られます

インターフェイス

@azure/ai-projects.Index
A2APreviewTool

A2A プロトコルを実装するエージェント。

AIProjectClientOptionalParams

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

AISearchIndexResource

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

Agent

モデルインターフェースエージェント

AgentClusterInsightRequest

エージェント評価結果のセットに関する洞察

AgentClusterInsightResult

エージェント クラスター分析からの洞察。

AgentDefinition

エージェントの基本定義インタフェース。 エージェントの種類とオプションの RAI 構成が含まれます。

AgentTaxonomyInput

入力タイプがエージェントの場合の評価分類の入力構成。

AgentVersion

エージェントの特定のバージョンを表します。 メタデータ、バージョン管理、作成時間、エージェント定義が含まれます。

AgenticIdentityPreviewCredentials

エージェント ID 資格情報の定義

AgentsCreateAgentFromManifestOptionalParams

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

AgentsCreateAgentVersionFromManifestOptionalParams

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

AgentsCreateOptionalParams

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

AgentsCreateVersionOptionalParams

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

AgentsDeleteOptionalParams

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

AgentsDeleteVersionOptionalParams

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

AgentsGetOptionalParams

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

AgentsGetVersionOptionalParams

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

AgentsListOptionalParams

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

AgentsListVersionsOptionalParams

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

AgentsOperations

エージェントの操作を表すインターフェイス。

AgentsUpdateAgentFromManifestOptionalParams

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

AgentsUpdateOptionalParams

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

Annotation

出力テキストのスパンに適用される注釈。

ApiErrorResponse

API エラーのエラー応答。

ApiKeyCredentials

API キー資格情報の定義

ApplyPatchCreateFileOperationParam

apply_patchツールを使って新しいファイルを作成する手順。

ApplyPatchDeleteFileOperationParam

apply_patchツールを使って既存ファイルを削除する手順。

ApplyPatchOperationParam

apply_patchツールに提供されるcreate_file、delete_file、またはupdate_file操作のいずれかです。

ApplyPatchToolParam

アシスタントが統一差を使ってファイルを作成、削除、更新できるようにします。

ApplyPatchUpdateFileOperationParam

apply_patchツールを使って既存ファイルを更新する方法の手順。

ApproximateLocation

モデルインターフェース ApproximateLocation

AzureAIAgentTarget

Azure AI エージェントを指定するターゲットを表します。

AzureAIModelTarget

モデルの選択を必要とする操作の Azure AI モデルを指定するターゲットを表します。

AzureAISearchIndex

Azure AI Search インデックスの定義

AzureAISearchTool

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

AzureAISearchToolResource

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

AzureFunctionBinding

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

AzureFunctionDefinition

Azure 関数の定義。

AzureFunctionStorageQueue

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

AzureFunctionTool

エージェントの構成に使用される Azure Function Tool の入力定義情報。

AzureOpenAIModelConfiguration

Azure OpenAI モデルの構成。 API バージョンは、モデルをクエリするためにサービスによって選択されます。

BaseCredentials

接続資格情報の基本クラス

BetaEvaluationTaxonomiesCreateOptionalParams

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

BetaEvaluationTaxonomiesDeleteOptionalParams

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

BetaEvaluationTaxonomiesGetOptionalParams

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

BetaEvaluationTaxonomiesListOptionalParams

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

BetaEvaluationTaxonomiesOperations

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

BetaEvaluationTaxonomiesUpdateOptionalParams

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

BetaEvaluatorsCreateVersionOptionalParams

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

BetaEvaluatorsDeleteVersionOptionalParams

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

BetaEvaluatorsGetVersionOptionalParams

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

BetaEvaluatorsListLatestVersionsOptionalParams

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

BetaEvaluatorsListVersionsOptionalParams

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

BetaEvaluatorsOperations

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

BetaEvaluatorsUpdateVersionOptionalParams

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

BetaInsightsGenerateOptionalParams

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

BetaInsightsGetOptionalParams

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

BetaInsightsListOptionalParams

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

BetaInsightsOperations

BetaInsightsの運用を表すインターフェース。

BetaMemoryStoresCreateOptionalParams

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

BetaMemoryStoresDeleteOptionalParams

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

BetaMemoryStoresDeleteScopeOptionalParams

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

BetaMemoryStoresGetOptionalParams

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

BetaMemoryStoresGetUpdateResultOptionalParams

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

BetaMemoryStoresListOptionalParams

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

BetaMemoryStoresOperations

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

BetaMemoryStoresSearchMemoriesOptionalParams

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

BetaMemoryStoresUpdateMemoriesOptionalParams

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

BetaMemoryStoresUpdateOptionalParams

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

BetaOperations

ベータオペレーションを表すインターフェース。

BetaRedTeamsCreateOptionalParams

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

BetaRedTeamsGetOptionalParams

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

BetaRedTeamsListOptionalParams

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

BetaRedTeamsOperations

BetaRedTeamsの運用を表すインターフェース。

BetaSchedulesCreateOrUpdateOptionalParams

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

BetaSchedulesDeleteOptionalParams

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

BetaSchedulesGetOptionalParams

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

BetaSchedulesGetRunOptionalParams

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

BetaSchedulesListOptionalParams

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

BetaSchedulesListRunsOptionalParams

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

BetaSchedulesOperations

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

BingCustomSearchConfiguration

Bing カスタム検索構成。

BingCustomSearchPreviewTool

エージェントの構成に使用される Bing カスタム検索ツールの入力定義情報。

BingCustomSearchToolParameters

Bingカスタム検索ツールのパラメーター。

BingGroundingSearchConfiguration

Bing 接地の検索構成

BingGroundingSearchToolParameters

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

BingGroundingTool

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

BlobReference

BLOB 参照の詳細。

BrowserAutomationPreviewTool

エージェントの構成に使用されるブラウザ自動化ツールの入力定義情報。

BrowserAutomationToolConnectionParameters

ブラウザ自動化ツールで使用される接続の入力パラメータの定義。

BrowserAutomationToolParameters

ブラウザオートメーションツールの入力パラメータの定義。

CaptureStructuredOutputsTool

構造化された出力をキャプチャするためのツール

ChartCoordinate

分析チャートの座標。

ChatSummaryMemoryItem

会話から抽出された要約を含むメモリアイテム。

ClickParam

クリック操作。

ClusterInsightResult

クラスター分析からの洞察。

ClusterTokenUsage

クラスター分析のトークン使用量

CodeBasedEvaluatorDefinition

Python コードを使用したコードベースのエバリュエーター定義

CodeInterpreterContainerAuto

コード インタープリター コンテナーの構成。 必要に応じて、コードを実行するファイルの ID を指定します。

CodeInterpreterOutputImage

コード インタープリターからの画像出力。

CodeInterpreterOutputLogs

コード インタープリターからのログ出力。

CodeInterpreterTool

プロンプトへの応答を生成するのに役立つ Python コードを実行するツール。

ComparisonFilter

定義された比較操作を使用して、指定した属性キーを特定の値と比較するために使用されるフィルター。

CompoundFilter

andまたはorを使用して複数のフィルターを結合します。

ComputerAction

モデル・インタフェース ComputerAction

ComputerCallSafetyCheckParam

コンピューターを使った通話の保留中の安全性チェック。

ComputerScreenshotImage

コンピューター使用ツールで使用されるコンピューターのスクリーンショット画像。

ComputerUsePreviewTool

仮想コンピューターを制御するツール。 コンピューター ツールの詳細をご覧ください。

Connection

リストからの応答と接続の取得操作

ConnectionsGetOptionalParams

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

ConnectionsGetWithCredentialsOptionalParams

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

ConnectionsListOptionalParams

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

ConnectionsOperations

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

ContainerAppAgentDefinition

コンテナー アプリ エージェントの定義。

ContainerFileCitationBody

モデル応答を生成するために使われるコンテナファイルの引用。

ContinuousEvaluationRuleAction

継続的評価のための評価ルールアクション。

CosmosDBIndex

CosmosDB ベクター ストア インデックスの定義

CronTrigger

Cron ベースのトリガー。

CustomCredential

カスタム資格情報の定義

CustomGrammarFormatParam

ユーザーによって定義された文法です。

CustomTextFormatParam

制約のない自由形式テキスト。

CustomToolParam

指定されたフォーマットで入力を処理するカスタムツールです。 カスタムツールについてもっと詳しくは

CustomToolParamFormat

カスタムツールの入力フォーマット。 デフォルトは制約のないテキストです。

DailyRecurrenceSchedule

毎日の繰り返しスケジュール。

DatasetCredential

使用する BLOB への参照を表します

DatasetUploadOptions

データセットのアップロードのオプション

DatasetVersion

DatasetVersion の定義

DatasetsCreateOrUpdateOptionalParams

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

DatasetsDeleteOptionalParams

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

DatasetsGetCredentialsOptionalParams

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

DatasetsGetOptionalParams

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

DatasetsListOptionalParams

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

DatasetsListVersionsOptionalParams

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

DatasetsOperations

データセット操作を表すインターフェイス。

DatasetsPendingUploadOptionalParams

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

DeleteAgentResponse

削除されたエージェントオブジェクト

DeleteAgentVersionResponse

削除されたエージェントバージョンオブジェクト

DeleteMemoryStoreResponse

モデルインタフェース DeleteMemoryStoreResponse

Deployment

モデル・デプロイメント定義

DeploymentsGetOptionalParams

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

DeploymentsListOptionalParams

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

DeploymentsOperations

デプロイメント操作を表すインタフェース。

DoubleClickAction

ダブルクリック アクション。

Drag

ドラッグ操作。

DragPoint

x/y 座標ペア (例: { x: 100, y: 200 })。

EasyInputMessage

命令フォロー階層を示すロールを含むモデルへのメッセージ入力。 developerロールまたはsystemロールで指定された命令は、userロールで指定された命令よりも優先されます。 assistant ロールを持つメッセージは、以前の操作でモデルによって生成されたものと見なされます。

EmbeddingConfiguration

埋め込み構成クラス

EntraIDCredentials

Entra ID 資格情報の定義

ErrorModel

モデルインターフェースエラーモデル

EvalResult

評価の結果。

EvalRunResultCompareItem

ベースラインに対する治療のメトリック比較。

EvalRunResultComparison

ベースラインに対する治療ランの比較結果。

EvalRunResultSummary

評価実行におけるメトリックの要約統計。

EvaluationComparisonInsightRequest

評価比較依頼

EvaluationComparisonInsightResult

評価比較からの洞察。

EvaluationResultSample

評価結果からのサンプル。

EvaluationRule

評価ルールモデル。

EvaluationRuleAction

評価アクションモデル。

EvaluationRuleFilter

評価フィルターモデル。

EvaluationRulesCreateOrUpdateOptionalParams

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

EvaluationRulesDeleteOptionalParams

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

EvaluationRulesGetOptionalParams

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

EvaluationRulesListOptionalParams

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

EvaluationRulesOperations

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

EvaluationRunClusterInsightRequest

一連の評価結果に関する洞察

EvaluationRunClusterInsightResult

評価から得られた分析情報は、クラスター分析を実行します。

EvaluationScheduleTask

スケジュールの評価タスク。

EvaluationTaxonomy

評価タクソノミーの定義

EvaluationTaxonomyInput

評価分類の入力構成。

EvaluatorDefinition

ディスクリミネーターを使用した基本エバリュエーター構成

EvaluatorMetric

評価者メトリック

EvaluatorVersion

エバリュエーターの定義

FabricDataAgentToolParameters

ファブリック・データ・エージェント・ツールのパラメーター。

FieldMapping

フィールド マッピング構成クラス

FileCitationBody

ファイルへの引用。

FileDatasetVersion

FileDatasetVersion の定義

FilePath

ファイルへのパス。

FileSearchTool

アップロードされたファイルから関連するコンテンツを検索するツール。 ファイル検索ツールの詳細をご覧ください。

FileSearchToolCallResults

モデルインターフェースファイル検索ツールコールリザルズ

FolderDatasetVersion

FileDatasetVersion の定義

FunctionAndCustomToolCallOutput

model interface FunctionAndCustomToolCallOutput

FunctionAndCustomToolCallOutputInputFileContent

モデルへのファイル入力。

FunctionAndCustomToolCallOutputInputImageContent

モデルへの画像入力。 画像入力について学習します。

FunctionAndCustomToolCallOutputInputTextContent

モデルへのテキスト入力。

FunctionShellActionParam

シェルツールコールを実行する方法を説明するコマンドと制限。

FunctionShellCallOutputContentParam

シェルツール呼び出し出力の一部に対してstdoutとstderrをキャプチャしました。

FunctionShellCallOutputExitOutcomeParam

シェルコマンドが終了し、終了コードを返したことを示します。

FunctionShellCallOutputOutcomeParam

このシェルコールに関連する終了またはタイムアウトの結果。

FunctionShellCallOutputTimeoutOutcomeParam

シェルコールが設定された時間制限を超えたことを示します。

FunctionShellToolParam

モデルがシェルコマンドを実行できるツールです。

FunctionTool

モデルが呼び出しを選択できる関数を独自のコードで定義します。 関数呼び出しの詳細について説明します。

HostedAgentDefinition

ホストされたエージェントの定義。

HourlyRecurrenceSchedule

時間ごとの繰り返しスケジュール。

HumanEvaluationPreviewRuleAction

人間による評価のための評価ルールアクション。

HybridSearchOptions

モデルインターフェース HybridSearchOptions

ImageGenTool

GPTの画像モデルを使って画像を生成するツールです。

ImageGenToolInputImageMask

model interface ImageGenToolInputImageMask

IndexesCreateOrUpdateOptionalParams

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

IndexesDeleteOptionalParams

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

IndexesGetOptionalParams

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

IndexesListOptionalParams

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

IndexesListVersionsOptionalParams

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

IndexesOperations

インデックス操作を表すインターフェイス。

InputContent

モデルインターフェース入力コンテンツ

InputContentInputFileContent

モデルへのファイル入力。

InputContentInputImageContent

モデルへの画像入力。 画像入力について学習します。

InputContentInputTextContent

モデルへのテキスト入力。

InputFileContentParam

モデルへのファイル入力。

InputImageContentParamAutoParam

モデルへの画像入力。 画像入力について学ぶ

InputItem

モデルによって生成される応答のコンテキストの一部を表す項目。 テキスト、画像、オーディオ入力、および以前のアシスタント応答とツール呼び出し出力を含めることができます。

InputItemApplyPatchToolCallItemParam

diffパッチを使ってファイルを作成、削除、更新するリクエストを表すツールコールです。

InputItemApplyPatchToolCallOutputItemParam

パッチ適用ツール呼び出しによって出力されるストリーム出力。

InputItemCodeInterpreterToolCall

コードを実行するためのツール呼び出し。

InputItemCompactionSummaryItemParam

v1/responses/compact APIによって生成されるコンパクトアイテムです。

InputItemComputerCallOutputItemParam

コンピューター ツール呼び出しの出力。

InputItemComputerToolCall

コンピューター使用ツールへのツール呼び出し。 詳細については、 コンピューター使用ガイド を参照してください。

InputItemCustomToolCall

モデルが作成したカスタムツールへの呼び出し。

InputItemCustomToolCallOutput

コードからのカスタムツール呼び出しの出力がモデルに戻されます。

InputItemFileSearchToolCall

ファイル検索ツールの呼び出しの結果。 詳細については、 ファイル検索ガイド を参照してください。

InputItemFunctionCallOutputItemParam

関数ツール呼び出しの出力。

InputItemFunctionShellCallItemParam

1つ以上のシェルコマンドを実行するための要求を表すツール。

InputItemFunctionShellCallOutputItemParam

シェルツール呼び出しによって出力されるストリーム出力項目。

InputItemFunctionToolCall

関数を実行するためのツール呼び出し。 詳細については、 関数呼び出しガイド を参照してください。

InputItemImageGenToolCall

モデルによって行われたイメージ生成要求。

InputItemLocalShellToolCall

ローカル シェルでコマンドを実行するためのツール呼び出し。

InputItemLocalShellToolCallOutput

ローカル シェル ツール呼び出しの出力。

InputItemMcpApprovalRequest

ツール呼び出しの人間による承認の要求。

InputItemMcpApprovalResponse

MCP 承認要求への応答。

InputItemMcpListTools

MCP サーバーで使用できるツールの一覧。

InputItemMcpToolCall

MCP サーバーでのツールの呼び出し。

InputItemOutputMessage

モデルからの出力メッセージ。

InputItemReasoningItem

応答の生成中に推論モデルによって使用される思考のチェーンの説明。 コンテキストinputする場合は、会話の次のターンでこれらの項目をResponses APIのに必ず含めてください。

InputItemWebSearchToolCall

Web 検索ツール呼び出しの結果。 詳細については、 Web 検索ガイド を参照してください。

InputTextContentParam

モデルへのテキスト入力。

Insight

クラスター分析情報の応答本文。

InsightCluster

分析サンプルのクラスター。

InsightModelConfiguration

インサイトの生成で使用されるモデルの構成。

InsightRequest

インサイトレポートの要求。

InsightResult

洞察の結果。

InsightSample

分析からのサンプル。

InsightScheduleTask

スケジュールのインサイトタスク。

InsightSummary

エラークラスター分析の概要。

InsightsMetadata

分析情報に関するメタデータ。

ItemReferenceParam

参照する項目の内部識別子。

KeyPressAction

モデルが実行するキー押下のコレクション。

LocalShellExecAction

サーバーでシェル コマンドを実行します。

LocalShellToolParam

モデルがローカル環境でシェル コマンドを実行できるようにするツール。

LogProb

トークンのログ確率。

MCPListToolsTool

MCP サーバーで使用できるツール。

MCPListToolsToolAnnotations

model interface MCPListToolsToolAnnotations

MCPListToolsToolInputSchema

モデルインターフェース MCPListToolsToolInputSchema

MCPTool

リモート モデル コンテキスト プロトコル (MCP) サーバーを使用して、モデルに追加のツールへのアクセス権を付与します。 MCP の詳細をご覧ください

MCPToolFilter

どのツールが許可されているかを指定するフィルターオブジェクト。

MCPToolRequireApproval

model interface MCPToolRequireApproval

ManagedAzureAISearchIndex

マネージド Azure AI 検索インデックスの定義

MemoryItem

メモリ ストアに格納され、コンテンツとメタデータを含む 1 つのメモリ項目。

MemoryOperation

メモリ項目に対して実行される 1 つのメモリ操作 (作成、更新、または削除) を表します。

MemorySearchItem

メモリ検索から取得したメモリ項目。

MemorySearchOptions

メモリ検索オプション。

MemorySearchPreviewTool

エージェントに記憶を統合するためのツール。

MemoryStore

ユーザーのメモリを格納および取得できるメモリストア。

MemoryStoreDefaultDefinition

デフォルトのメモリストア実装。

MemoryStoreDefaultOptions

デフォルトのメモリストア構成。

MemoryStoreDefinition

メモリストア構成の基本定義。

MemoryStoreDeleteScopeResponse

スコープからメモリを削除するための応答。

MemoryStoreOperationUsage

メモリストア操作の使用状況統計。

MemoryStoreSearchResponse

メモリ検索応答。

MemoryStoreUpdateCompletedResult

メモリ更新結果。

MemoryStoreUpdateResponse

メモリ ストアの更新操作の状態を提供します。

MicrosoftFabricPreviewTool

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

ModelDeployment

モデル・デプロイメント定義

ModelDeploymentSku

SKU 情報

ModelSamplingParams

テキストの生成中に言語モデルのサンプリング動作を制御するために使用されるパラメーターのセットを表します。

MonthlyRecurrenceSchedule

毎月の繰り返しスケジュール。

Move

マウスの移動アクション。

NoAuthenticationCredentials

認証を必要としない資格情報

OneTimeTrigger

1 回限りのトリガー。

OpenApiAnonymousAuthDetails

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

OpenApiAuthDetails

OpenApiFunctionDefinition の認証の詳細

OpenApiFunctionDefinition

openapi 関数の入力定義情報。

OpenApiManagedAuthDetails

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

OpenApiManagedSecurityScheme

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

OpenApiProjectConnectionAuthDetails

OpenApi プロジェクト接続認証のセキュリティの詳細

OpenApiProjectConnectionSecurityScheme

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

OpenApiTool

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

OutputMessageContent

モデルインターフェース OutputMessageContent

OutputMessageContentOutputTextContent

モデルからのテキスト出力。

OutputMessageContentRefusalContent

モデルからの拒否。

PageSettings

byPage メソッドのオプション

PagedAsyncIterableIterator

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

PendingUploadRequest

保留中のアップロードの要求を表します。

PendingUploadResponse

保留中のアップロード要求の応答を表します

PromptAgentDefinition

プロンプト エージェントの定義

PromptAgentDefinitionTextOptions

モデルからのテキスト応答の構成オプション。 プレーン テキストまたは構造化された JSON データを指定できます。

PromptBasedEvaluatorDefinition

プロンプトベースのエバリュエーター

ProtocolVersionRecord

単一のプロトコルとそのバージョンのレコードマッピング。

RaiConfig

責任ある AI (RAI) コンテンツのフィルタリングと安全機能の構成。

RankingOptions

モデルインターフェースRankingOptions

Reasoning

GPT-5およびOシリーズモデルのみ推論モデルの設定オプション。

ReasoningTextContent

モデルからの推論テキスト。

RecurrenceSchedule

繰り返しスケジュール モデル。

RecurrenceTrigger

繰り返しベースのトリガー。

RedTeam

レッドチームの詳細。

ResponseUsageInputTokensDetails

model interface ResponseUsageInputTokens詳細

ResponseUsageOutputTokensDetails

model interface ResponseUsageOutputTokens詳細

RestorePollerOptions
SASTokenCredentials

Shared Access Signature (SAS) 資格情報の定義

SasCredential

SAS資格情報の定義

Schedule

スケジュールモデル。

ScheduleRun

実行モデルのスケジュール。

ScheduleTask

スケジュール タスク モデル。

Screenshot

スクリーンショット操作。

Scroll

スクロール アクション。

SharepointGroundingToolParameters

SharePoint グラウンディング ツールのパラメーター。

SharepointPreviewTool

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

SpecificApplyPatchParam

ツール呼び出しの実行時に、apply_patch ツールを強制的に呼び出します。

SpecificFunctionShellParam

ツール呼び出しが必要な場合に、モデルにシェル ツールの呼び出しを強制します。

StructuredInputDefinition

プロンプト テンプレートの置換とツール引数のバインディングに参加できる構造化入力。

StructuredOutputDefinition

エージェントによって生成できる構造化された出力。

Summary

モデルからの要約テキスト。

Target

ディスクリミネーターをサポートするターゲットの基本クラス。

TargetConfig

ターゲット構成の抽象クラス。

TaxonomyCategory

分類カテゴリの定義。

TaxonomySubCategory

分類サブカテゴリの定義。

TelemetryOperations

テレメトリー操作を表すインターフェース

TextResponseFormatConfiguration

モデルが出力する必要がある形式を指定するオブジェクト。 { "type": "json_schema" }を構成すると、構造化出力が有効になり、モデルが指定した JSON スキーマと一致することが保証されます。 詳細については、 構造化出力ガイドを参照してください。 既定の形式は { "type": "text" } であり、追加のオプションはありません。 GPT-4o以降のモデルにはおすすめしません:* { "type": "json_object" } に設定すると古いJSONモードが有効になり、モデルが生成するメッセージが有効なJSONであることを保証します。 json_schemaをサポートするモデルには、を使用することをお勧めします。

TextResponseFormatConfigurationResponseFormatJsonObject

JSON オブジェクトの応答形式。 JSON 応答を生成する古い方法。 json_schemaをサポートするモデルには、の使用をお勧めします。 このモデルでは、システムまたはユーザーに指示するメッセージがない場合、JSON は生成されないことに注意してください。

TextResponseFormatConfigurationResponseFormatText

既定の応答形式。 テキスト応答を生成するために使用されます。

TextResponseFormatJsonSchema

JSON スキーマの応答形式。 構造化された JSON 応答を生成するために使用されます。 構造化出力の詳細を確認します。

Tool

応答の生成に使用できるツール。

ToolChoiceAllowed

モデルで使用できるツールを定義済みのセットに制限します。

ToolChoiceCodeInterpreter

モデルが組み込みのツールを使用して応答を生成する必要があることを示します。 組み込みツールの詳細を確認します。

ToolChoiceComputerUsePreview

モデルが組み込みのツールを使用して応答を生成する必要があることを示します。 組み込みツールの詳細を確認します。

ToolChoiceCustom

モデルで特定のカスタム ツールを強制的に呼び出すには、このオプションを使用します。

ToolChoiceFileSearch

モデルが組み込みのツールを使用して応答を生成する必要があることを示します。 組み込みツールの詳細を確認します。

ToolChoiceFunction

モデルで特定の関数を強制的に呼び出すには、このオプションを使用します。

ToolChoiceImageGeneration

モデルが組み込みのツールを使用して応答を生成する必要があることを示します。 組み込みツールの詳細を確認します。

ToolChoiceMCP

モデルでリモート MCP サーバー上の特定のツールを強制的に呼び出すには、このオプションを使用します。

ToolChoiceParam

応答を生成するときに使用するツール (またはツール) をモデルで選択する方法。 モデルが呼び出すことができるツールを指定する方法については、 tools パラメーターを参照してください。

ToolChoiceWebSearchPreview

モデルが組み込みのツールを使用して応答を生成する必要があることを示します。 組み込みツールの詳細を確認します。

ToolChoiceWebSearchPreview20250311

モデルが組み込みのツールを使用して応答を生成する必要があることを示します。 組み込みツールの詳細を確認します。

ToolDescription

エージェントが使用できるツールの説明。

ToolProjectConnection

プロジェクト接続リソース。

TopLogProb

トークンの最上位のログ確率。

Trigger

スケジュールのトリガーのベースモデル。

Type

テキストを入力するアクション。

UrlCitationBody

モデル応答の生成に使用される Web リソースの引用。

UserProfileMemoryItem

会話から抽出されたユーザープロファイル情報(好み、興味、個人情報など)を具体的に含むメモリアイテム。

VectorStoreFileAttributes

オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。 キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字、ブール値、または数値の文字列です。

Wait

待機操作。

WebSearchActionFind

アクションの種類 "find": 読み込まれたページ内のパターンを検索します。

WebSearchActionOpenPage

アクションの種類 "open_page" - 検索結果から特定の URL を開きます。

WebSearchActionSearch

アクションの種類 "search" - Web 検索クエリを実行します。

WebSearchActionSearchSources

モデル・インターフェースWebSearchActionSearchSources

WebSearchApproximateLocation

ユーザーのおおよその位置。

WebSearchConfiguration

Bingのカスタム検索のためのウェブ検索設定

WebSearchPreviewTool

このツールは、回答に使える関連結果をウェブ上で検索します。 ウェブ検索ツールについて詳しく学びましょう。

WebSearchTool

このプロンプトに関連する情報源をインターネットで検索してください。 ウェブ検索ツールについて詳しく学びましょう。

WebSearchToolFilters

モデルインターフェース WebSearchToolFilters

WeeklyRecurrenceSchedule

毎週の繰り返しスケジュール。

WorkflowAgentDefinition

ワークフローエージェントの定義。

型エイリアス

AgentDefinitionUnion

すべてのエージェント定義タイプの共用体タイプ。 ワークフロー、ホスト型、コンテナー アプリ、プロンプト エージェントをサポートします。

AgentKind

エージェントの種類/種類を定義します。 使用するエージェント定義構造を決定します。

AgentProtocol

AgentProtocol のタイプ

AgentType

エージェントタイプの種類

AnnotationType

アノテーションの種類タイプ

AnnotationUnion

AnnotationUnion のエイリアス

ApplyPatchCallOutputStatusParam

ツールコール出力apply_patch結果値を報告します。

ApplyPatchCallStatusParam

ツール呼び出しのステータス値は報告apply_patch。

ApplyPatchOperationParamType

ApplyPatchOperationParamType のタイプ

ApplyPatchOperationParamUnion

ApplyPatchOperationParamUnion の別名

AttackStrategy

攻撃の戦略。

AzureAISearchQueryType

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

BaseCredentialsUnion

BaseCredentialsUnion のエイリアス

ClickButtonType

ClickButtonType の種類

ComparisonFilterValueItems

ComparisonFilterValueItemsのエイリアス

ComputerActionType

ComputerActionType の種類

ComputerActionUnion

ComputerActionUnion のエイリアス

ComputerEnvironment

コンピュータ環境の種類

ConnectionType

接続の種類 (またはカテゴリ)

ContainerMemoryLimit

コンテナメモリ制限の種類

ContinuablePage

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

CredentialType

接続で使用される資格情報の種類

CustomToolParamFormatType

TypeCustomToolParamFormatType のタイプ

CustomToolParamFormatUnion

Alias for CustomToolParamFormatUnion

DatasetType

データの型を決定する列挙型。

DatasetVersionUnion

DatasetVersionUnion のエイリアス

DayOfWeek

繰り返しスケジュールの曜日。

DeploymentType

DeploymentType のタイプ

DeploymentUnion

DeploymentUnion のエイリアス

DetailEnum

詳細の種類詳細枚数

EvaluationRuleActionType

評価アクションのタイプ。

EvaluationRuleActionUnion

EvaluationRuleActionUnion のエイリアス

EvaluationRuleEventType

評価ルール・イベントのタイプ。

EvaluationTaxonomyInputType

評価タクソノミー入力のタイプ。

EvaluationTaxonomyInputUnion

評価のエイリアスTaxonomyInputUnion

EvaluatorCategory

評価者のカテゴリ

EvaluatorDefinitionType

エバリュエーター定義のタイプ

EvaluatorDefinitionUnion

EvaluatorDefinitionUnion のエイリアス

EvaluatorMetricDirection

値が高いほど良いか、低い値ほど良いか、中立的かを示すメトリックの方向

EvaluatorMetricType

評価者のタイプ

EvaluatorType

評価者のタイプ

Filters

フィルター用のエイリアス

FoundryFeaturesOptInKeys

鋳造会社の種類特徴OptInKeys(オープティンキー)

FunctionAndCustomToolCallOutputType

Type of FunctionAndCustomToolCallOutputType

FunctionAndCustomToolCallOutputUnion

Alias for FunctionAndCustomToolCallOutputUnion

FunctionCallItemStatus

関数の種CallItemStatus

FunctionShellCallItemStatus

シェルツール呼び出しのステータス値が報告されます。

FunctionShellCallOutputOutcomeParamType

関数の種類シェルコールアウトアウトcomeパラムタイプ

FunctionShellCallOutputOutcomeParamUnion

FunctionShellCallOutputOutcomeParamUnion の別名

GrammarSyntax1

文法統語の種類1

ImageDetail

ImageDetailの種類

IndexType

IndexType のタイプ

IndexUnion

IndexUnion のエイリアス

InputContentType

入力内容タイプのタイプ

InputContentUnion

InputContentUnion の別名

InputFidelity

入力画像のスタイルと特徴、特に顔の特徴に合わせてモデルが実行する労力を制御します。 このパラメーターは、gpt-image-1 に対してのみサポートされます。 gpt-image-1-mini ではサポートされていません。 highlow をサポートします。 既定値は low です。

InputItemType

TypeInputItemTypeの種類

InputItemUnion

InputItemUnion の別名

InsightRequestUnion

InsightRequestUnion のエイリアス

InsightResultUnion

InsightResultUnion のエイリアス

InsightSampleUnion

InsightSampleUnion のエイリアス

InsightType

インサイトの要求。

MCPToolCallStatus

MCPToolCallStatusの種類

MemoryItemKind

メモリアイテムの種類。

MemoryItemUnion

MemoryItemUnion のエイリアス

MemoryOperationKind

メモリ操作の種類。

MemoryStoreDefinitionUnion

MemoryStoreDefinitionUnion のエイリアス

MemoryStoreKind

使用するメモリストア実装の種類。

MemoryStoreType

メモリストアタイプの種類

MemoryStoreUpdateStatus

メモリ ストア更新操作の状態。

OpenApiAuthDetailsUnion

OpenApiAuthDetailsUnion のエイリアス

OpenApiAuthType

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

  • 匿名 (認証不要)
  • プロジェクト接続(エンドポイントへのproject_connection_idが必要で、AI Foundryで設定)
  • Managed_Identity (ID ベースの認証には対象ユーザーが必要)
OperationState

許可された操作状態を記述する列挙型。

OutputMessageContentType

出力メッセージ内容タイプの種類

OutputMessageContentUnion

OutputMessageContentUnion のエイリアス

PageOrder

ページ順序の種類

PendingUploadType

保留中のアップロードの種類。

RankerVersionType

ランクの種類バージョンタイプ

ReasoningEffort

推論モデルの推論に関 する作業を制限します。 現在サポートされている値は、 noneminimallowmediumhighxhighです。 推論作業を減らすと、応答が速くなり、応答の推論に使用されるトークンが少なくなる可能性があります。

  • gpt-5.1 デフォルトは noneであり、推論は行われません。 gpt-5.1の支持される推論値はnonelowmediumhighです。 ツール呼び出しは、gpt-5.1 のすべての推論値でサポートされています。
  • gpt-5.1以前のモデルはすべてmedium推論作業にデフォルトで対応しており、noneをサポートしていません。
  • gpt-5-proモデルはデフォルトで(しかも)high推論努力のみをサポートします。
  • xhigh gpt-5.1-codex-max以降のすべてのモデルでサポートされています。
RecurrenceScheduleUnion

RecurrenceScheduleUnion のエイリアス

RecurrenceType

繰り返しタイプ。

RiskCategory

攻撃目標のリスク カテゴリ。

SampleType

分析で使用されるサンプルのタイプ。

ScheduleProvisioningStatus

プロビジョニングステータスをスケジュールします。

ScheduleTaskType

タスクの種類。

ScheduleTaskUnion

ScheduleTaskUnion のエイリアス

SearchContextSize

検索コンテキストサイズの種類

TargetConfigUnion

TargetConfigUnion のエイリアス

TargetUnion

TargetUnion のエイリアス

TextResponseFormatConfigurationType

テキストの種類 応答フォーマット構成タイプ

TextResponseFormatConfigurationUnion

TextResponseFormatConfigurationUnion のエイリアス

ToolChoiceParamType

ツール選択パラムタイプの種類

ToolChoiceParamUnion

ToolChoiceParamUnion の別名

ToolType

ツールタイプの種類

ToolUnion

ToolUnion のエイリアス

TreatmentEffectType

治療効果の種類。

TriggerType

トリガーのタイプ。

TriggerUnion

TriggerUnion のエイリアス

列挙型

KnownApiVersions

Microsoft Foundry API バージョン

関数

restorePoller<TResponse, TResult>(AIProjectClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

別のポーラーのシリアル化された状態からポーリングャーを作成します。 これは、別のホストに投票者を作成する場合や、元のホストがスコープ内にない後にポーリングャーを構築する必要がある場合に便利です。

関数の詳細

restorePoller<TResponse, TResult>(AIProjectClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

別のポーラーのシリアル化された状態からポーリングャーを作成します。 これは、別のホストに投票者を作成する場合や、元のホストがスコープ内にない後にポーリングャーを構築する必要がある場合に便利です。

function restorePoller<TResponse, TResult>(client: AIProjectClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

パラメーター

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

戻り値

PollerLike<OperationState<TResult>, TResult>