@azure/ai-projects package

クラス

AIProjectClient

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

インターフェイス

@azure/ai-projects.Index
A2APreviewTool

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

A2APreviewToolboxTool

工具箱に収納されたA2Aツール。

A2AProtocolConfiguration

A2Aプロトコルに特化した構成です。

AIProjectClientOptionalParams

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

AISearchIndexResource

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

ActivityProtocolConfiguration

アクティビティプロトコル固有の設定。

Agent

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

AgentBlueprintReference

model interface AgentBlueprintReference

AgentCard

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

AgentCardSkill

model interface AgentCardSkill

AgentClusterInsightRequest

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

AgentClusterInsightResult

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

AgentDataGenerationJobSource

データ生成ジョブのエージェントソース — 命令やメタデータを取得するためのエージェントを参照します。

AgentDefinition

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

AgentEndpointAuthorizationScheme

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

AgentEndpointConfig

model interface AgentEndpointConfig

AgentEvaluatorGenerationJobSource

評価者生成ジョブのエージェントソース — 命令やメタデータを取得するためのエージェントを参照します。

AgentIdentity

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

AgentSessionResource

ホストされたエージェント呼び出しのための長寿命の計算サンドボックスを提供するエージェントセッションです。

AgentTaxonomyInput

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

AgentVersion

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

AgenticIdentityPreviewCredentials

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

AgentsCreateAgentFromManifestOptionalParams

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

AgentsCreateAgentVersionFromManifestOptionalParams

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

AgentsCreateOptionalParams

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

AgentsCreateSessionOptionalParams

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

AgentsCreateVersionFromCodeOptionalParams

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

AgentsCreateVersionOptionalParams

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

AgentsDeleteOptionalParams

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

AgentsDeleteSessionFileOptionalParams

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

AgentsDeleteSessionOptionalParams

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

AgentsDeleteVersionOptionalParams

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

AgentsDisableOptionalParams

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

AgentsDownloadAgentCodeOptionalParams

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

AgentsDownloadSessionFileOptionalParams

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

AgentsEnableOptionalParams

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

AgentsGetOptionalParams

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

AgentsGetSessionLogStreamOptionalParams

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

AgentsGetSessionOptionalParams

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

AgentsGetVersionOptionalParams

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

AgentsListOptionalParams

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

AgentsListSessionFilesOptionalParams

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

AgentsListSessionsOptionalParams

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

AgentsListVersionsOptionalParams

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

AgentsOperations

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

AgentsStopSessionOptionalParams

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

AgentsUpdateAgentFromManifestOptionalParams

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

AgentsUpdateAgentObjectOptionalParams

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

AgentsUpdateOptionalParams

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

AgentsUploadSessionFileOptionalParams

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

ApiErrorResponse

API エラーのエラー応答。

ApiKeyCredentials

API キー資格情報の定義

ApplyPatchToolParam

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

ApproximateLocation

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

ArtifactProfile

モデルのアーティファクトプロファイル

AutoCodeInterpreterToolParam

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

AzureAIAgentTarget

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

AzureAIModelTarget

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

AzureAISearchIndex

Azure AI 検索 インデックス定義

AzureAISearchTool

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

AzureAISearchToolResource

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

AzureAISearchToolboxTool

ツールボックスに保存されたAzure AI 検索ツール。

AzureAgentConfig

getOpenAIClient メソッドのエージェントエンドポイントのConfiguration options. 主にホストエージェント向けに使われています。

AzureFunctionBinding

キュー名と URI storage保持するための構造。

AzureFunctionDefinition

Azure関数の定義。

AzureFunctionStorageQueue

キュー名と URI storage保持するための構造。

AzureFunctionTool

Azure Function Toolの入力定義情報で、エージェントの設定に使われます。

AzureOpenAIModelConfiguration

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

BaseCredentials

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

BetaAgentsCancelOptimizationJobOptionalParams

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

BetaAgentsCreateOptimizationJobOptionalParams

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

BetaAgentsDeleteOptimizationJobOptionalParams

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

BetaAgentsGetOptimizationJobOptionalParams

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

BetaAgentsListOptimizationJobsOptionalParams

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

BetaAgentsOperations

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

BetaDatasetsCancelGenerationJobOptionalParams

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

BetaDatasetsCreateGenerationJobOptionalParams

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

BetaDatasetsDeleteGenerationJobOptionalParams

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

BetaDatasetsGetGenerationJobOptionalParams

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

BetaDatasetsListGenerationJobsOptionalParams

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

BetaDatasetsOperations

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

BetaEvaluationTaxonomiesCreateOptionalParams

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

BetaEvaluationTaxonomiesDeleteOptionalParams

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

BetaEvaluationTaxonomiesGetOptionalParams

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

BetaEvaluationTaxonomiesListOptionalParams

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

BetaEvaluationTaxonomiesOperations

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

BetaEvaluationTaxonomiesUpdateOptionalParams

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

BetaEvaluatorsCancelGenerationJobOptionalParams

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

BetaEvaluatorsCreateGenerationJobOptionalParams

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

BetaEvaluatorsCreateVersionOptionalParams

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

BetaEvaluatorsDeleteGenerationJobOptionalParams

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

BetaEvaluatorsDeleteVersionOptionalParams

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

BetaEvaluatorsGetCredentialsOptionalParams

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

BetaEvaluatorsGetGenerationJobOptionalParams

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

BetaEvaluatorsGetVersionOptionalParams

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

BetaEvaluatorsListGenerationJobsOptionalParams

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

BetaEvaluatorsListOptionalParams

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

BetaEvaluatorsListVersionsOptionalParams

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

BetaEvaluatorsOperations

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

BetaEvaluatorsPendingUploadOptionalParams

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

BetaEvaluatorsUpdateVersionOptionalParams

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

BetaInsightsGenerateOptionalParams

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

BetaInsightsGetOptionalParams

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

BetaInsightsListOptionalParams

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

BetaInsightsOperations

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

BetaMemoryStoresCreateMemoryOptionalParams

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

BetaMemoryStoresCreateOptionalParams

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

BetaMemoryStoresDeleteMemoryOptionalParams

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

BetaMemoryStoresDeleteOptionalParams

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

BetaMemoryStoresDeleteScopeOptionalParams

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

BetaMemoryStoresGetMemoryOptionalParams

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

BetaMemoryStoresGetOptionalParams

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

BetaMemoryStoresGetUpdateResultOptionalParams

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

BetaMemoryStoresListMemoriesOptionalParams

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

BetaMemoryStoresListOptionalParams

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

BetaMemoryStoresOperations

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

BetaMemoryStoresSearchMemoriesOptionalParams

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

BetaMemoryStoresUpdateMemoriesOptionalParams

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

BetaMemoryStoresUpdateMemoryOptionalParams

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

BetaMemoryStoresUpdateOptionalParams

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

BetaModelsCreateOptions

ローカルファイルをアップロードし、モデルバージョンを登録するcreateメソッドのオプション。

BetaModelsDeleteOptionalParams

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

BetaModelsGetCredentialsOptionalParams

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

BetaModelsGetOptionalParams

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

BetaModelsListOptionalParams

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

BetaModelsListVersionsOptionalParams

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

BetaModelsOperations

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

BetaModelsPendingCreateVersionOptionalParams

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

BetaModelsPendingUploadOptionalParams

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

BetaModelsUpdateOptionalParams

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

BetaOperations

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

BetaRedTeamsCreateOptionalParams

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

BetaRedTeamsGetOptionalParams

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

BetaRedTeamsListOptionalParams

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

BetaRedTeamsOperations

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

BetaRoutinesCreateOrUpdateOptionalParams

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

BetaRoutinesDeleteOptionalParams

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

BetaRoutinesDisableOptionalParams

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

BetaRoutinesDispatchOptionalParams

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

BetaRoutinesEnableOptionalParams

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

BetaRoutinesGetOptionalParams

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

BetaRoutinesListOptionalParams

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

BetaRoutinesListRunsOptionalParams

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

BetaRoutinesOperations

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

BetaSchedulesCreateOrUpdateOptionalParams

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

BetaSchedulesDeleteOptionalParams

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

BetaSchedulesGetOptionalParams

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

BetaSchedulesGetRunOptionalParams

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

BetaSchedulesListOptionalParams

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

BetaSchedulesListRunsOptionalParams

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

BetaSchedulesOperations

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

BetaSkillsCreateOptionalParams

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

BetaSkillsCreateVersionFromFilesOptionalParams

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

BetaSkillsDeleteOptionalParams

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

BetaSkillsDeleteVersionOptionalParams

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

BetaSkillsDownloadOptionalParams

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

BetaSkillsDownloadVersionOptionalParams

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

BetaSkillsGetOptionalParams

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

BetaSkillsGetVersionOptionalParams

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

BetaSkillsListOptionalParams

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

BetaSkillsListVersionsOptionalParams

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

BetaSkillsOperations

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

BetaSkillsUpdateOptionalParams

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

BingCustomSearchConfiguration

bingカスタム検索構成。

BingCustomSearchPreviewTool

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

BingCustomSearchToolParameters

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

BingGroundingSearchConfiguration

Bing 接地の検索構成

BingGroundingSearchToolParameters

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

BingGroundingTool

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

BlobReference

BLOB 参照の詳細。

BotServiceAuthorizationScheme

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

BotServiceRbacAuthorizationScheme

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

BotServiceTenantAuthorizationScheme

model interface BotServiceTenantAuthorizationScheme

BrowserAutomationPreviewTool

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

BrowserAutomationPreviewToolboxTool

ツールボックスに保存されたブラウザ自動化ツール。

BrowserAutomationToolConnectionParameters

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

BrowserAutomationToolParameters

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

CaptureStructuredOutputsTool

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

ChartCoordinate

分析チャートの座標。

ChatSummaryMemoryItem

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

ClusterInsightResult

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

ClusterTokenUsage

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

CodeBasedEvaluatorDefinition

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

CodeConfiguration

ホストエージェント向けのコードベースのデプロイメント設定。

CodeInterpreterTool

プロンプトに対する応答を生成するためにPythonコードを実行するツールです。

CodeInterpreterToolboxTool

ツールボックスに保存されたコードインタプリタツール。

ComparisonFilter

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

CompoundFilter

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

ComputerTool

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

ComputerUsePreviewTool

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

Connection

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

ConnectionsGetOptionalParams

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

ConnectionsGetWithCredentialsOptionalParams

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

ConnectionsListOptionalParams

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

ConnectionsOperations

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

ContainerAutoParam

model interface ContainerAutoParam

ContainerConfiguration

ホストエージェント向けのコンテナベースのデプロイメント構成。

ContainerNetworkPolicyAllowlistParam

model interface ContainerNetworkPolicyAllowlistParam

ContainerNetworkPolicyDisabledParam

model interface ContainerNetworkPolicyDisabledParam

ContainerNetworkPolicyDomainSecretParam

model interface ContainerNetworkPolicyDomainSecretParam

ContainerNetworkPolicyParam

コンテナのネットワークアクセスポリシーについて。

ContainerSkill

model interface ContainerSkill

ContinuousEvaluationRuleAction

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

CosmosDBIndex

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

CreateAgentVersionFromCodeContent

コードベースのエージェント(POST /agents/{name} および POST /agents/{name}/versions)の更新やバージョン管理のための多部要求体です。

CreateAgentVersionFromCodeMetadata

コードベースのエージェント操作(作成、更新、バージョン作成)のためのJSONメタデータ。 エージェント名はURLパスパラメータまたは x-ms-agent-name ヘッダーから来るため、このモデルには含まれていません。 コンテンツハッシュ(zipのSHA-256)は x-ms-code-zip-sha256 ヘッダーに載せられます。

CreateSkillVersionFromFilesBody

ファイルからスキルバージョンを作成するための多部リクエストボディ。 単一のzipファイルまたは複数の個別スキルファイル(ディレクトリアップロード)を受け付けます。 zipアップロードの場合、サーバーはコンテンツを抽出して検証します。 ディレクトリアップロードの場合、ファイルは as-is検証されます。

CronTrigger

Cron ベースのトリガー。

CustomCredential

カスタム資格情報の定義

CustomGrammarFormatParam

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

CustomRoutineTrigger

カスタムイベントルーチンのトリガーです。

CustomTextFormatParam

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

CustomToolParam

指定されたフォーマットで入力を処理するカスタムツールです。 custom ツール

CustomToolParamFormat

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

DailyRecurrenceSchedule

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

DataGenerationJob

データ生成の求人リソース。

DataGenerationJobInputs

データ生成ジョブのための発信者からの入力。

DataGenerationJobOptions

データ生成の仕事を管理するための選択肢。

DataGenerationJobOutput

データ生成ジョブのための出力情報。

DataGenerationJobOutputOptions

データ生成ジョブの出力オプション。

DataGenerationJobResult

成功したデータ生成の仕事によって生まれる結果。

DataGenerationJobSource

データ生成ジョブのベースソースモデルです。

DataGenerationModelOptions

データ生成ジョブのためのLLMモデルの選択肢。

DataGenerationTokenUsage

データ生成ジョブのトークン使用情報。

DatasetCredential

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

DatasetDataGenerationJobOutput

データ生成ジョブのためのデータセット出力。

DatasetEvaluatorGenerationJobSource

評価者生成ジョブのデータセットソース — データセットへの参照。

DatasetReference

バージョン管理されたFoundryデータセットへの言及。

DatasetVersion

DatasetVersion の定義

DatasetsCreateOrUpdateOptionalParams

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

DatasetsDeleteOptionalParams

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

DatasetsGetCredentialsOptionalParams

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

DatasetsGetOptionalParams

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

DatasetsListOptionalParams

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

DatasetsListVersionsOptionalParams

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

DatasetsOperations

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

DatasetsPendingUploadOptionalParams

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

DeleteAgentResponse

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

DeleteAgentVersionResponse

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

DeleteMemoryResponse

メモリストアからメモリ項目を削除することへの応答。

DeleteMemoryStoreResponse

モデルインタフェース DeleteMemoryStoreResponse

DeleteSkillResponse

削除されたスキルです。

DeleteSkillVersionResponse

削除されたスキルバージョン。

Deployment

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

DeploymentsGetOptionalParams

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

DeploymentsListOptionalParams

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

DeploymentsOperations

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

Dimension

単一の次元――評価評価者のスコア設計図の中で独立し測定可能な品質次元が一つ。

DispatchRoutineResponse

ルーチンディスパッチ後に返される識別子はキューイングされます。

EmbeddingConfiguration

埋め込み構成クラス

EmptyModelParam

model interface EmptyModelParam

EndpointBasedEvaluatorDefinition

エンドポイントベース評価者の定義。 顧客は評価契約を実装するHTTPエンドポイントを所有しホストしています。 評価者は名前でProject Connectionを参照し、接続はエンドポイントのURLと認証情報(APIキーまたはEntra ID)を保存します。 実行時にサービスは接続を解決し、エンドポイントのURLと認証情報を取得し、各評価行ごとにエンドポイントを呼び出します。

EntraAuthorizationScheme

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

EntraIDCredentials

Entra ID 認証定義

ErrorModel

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

EvalResult

評価の結果。

EvalRunResultCompareItem

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

EvalRunResultComparison

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

EvalRunResultSummary

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

EvaluationComparisonInsightRequest

評価比較依頼

EvaluationComparisonInsightResult

評価比較からの洞察。

EvaluationResultSample

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

EvaluationRule

評価ルールモデル。

EvaluationRuleAction

評価アクションモデル。

EvaluationRuleFilter

評価フィルターモデル。

EvaluationRulesCreateOrUpdateOptionalParams

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

EvaluationRulesDeleteOptionalParams

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

EvaluationRulesGetOptionalParams

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

EvaluationRulesListOptionalParams

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

EvaluationRulesOperations

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

EvaluationRunClusterInsightRequest

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

EvaluationRunClusterInsightResult

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

EvaluationScheduleTask

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

EvaluationTarget

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

EvaluationTaxonomy

評価タクソノミーの定義

EvaluationTaxonomyInput

評価分類の入力構成。

EvaluatorCredentialRequest

評価者資格取得のための申請機関

EvaluatorDefinition

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

EvaluatorGenerationArtifacts

評価者生成ジョブによって生成されるサービス管理プロウェナンスアーティファクト。 生成パイプラインを通じて作成されたEvaluatorVersionリソースにのみ存在します。 combined-JSONL Foundry Datasetは読み取り専用で、サービス予約された名前空間内のバージョン管理データセットに解決されます。

EvaluatorGenerationInputs

評価者生成ジョブのための発信者からの入力。

EvaluatorGenerationJob

評価者生成ジョブリソース — ソースからルーブリックベースの評価者定義を生成する長期間続くジョブです。 成功すると、永続化されたEvaluatorVersionが得られます。

EvaluatorGenerationJobSource

評価者生成ジョブのベースソースモデル。 多型性は、多形性 type

EvaluatorGenerationTokenUsage

評価者生成ジョブのトークン消費概要。 仕事が終着状態に達したときに埋められます。

EvaluatorMetric

評価者メトリック

EvaluatorVersion

エバリュエーターの定義

ExternalAgentDefinition

外部エージェントの定義。 Foundryの外部でホストされているサードパーティエージェント(例えばGCPやAWS)を表します。 登録はメタデータのみで行われます。Foundryはエージェントの定義を記録し、顧客が発信したOpenTelemetryデータ上で観察可能性体験(トレースや評価)を活性化します。

FabricDataAgentToolParameters

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

FabricIQPreviewTool

FabricIQのサーバーサイドツールです。

FabricIQPreviewToolboxTool

ツールボックスに保存されたFabricIQツール。

FieldMapping

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

FileDataGenerationJobOutput

Azure OpenAIファイル出力はデータ生成ジョブ用です。

FileDataGenerationJobSource

File source for data generation jobs — Azure OpenAI file input.

FileDatasetVersion

FileDatasetVersion の定義

FileSearchTool

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

FileSearchToolboxTool

ツールボックスに保存されたファイル検索ツール。

FixedRatioVersionSelectionRule

model interface FixedRatioVersionSelectionRule

FolderDatasetVersion

FileDatasetVersion の定義

FoundryModelWarning

モデルに関連した警告です。

FunctionShellToolParam

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

FunctionShellToolParamEnvironment

model interface FunctionShellToolParamEnvironment

FunctionShellToolParamEnvironmentContainerReferenceParam

model interface FunctionShellToolParamEnvironmentContainerReferenceParam

FunctionShellToolParamEnvironmentLocalEnvironmentParam

model interface FunctionShellToolParamEnvironmentLocalEnvironmentParam

FunctionTool

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

FunctionToolParam

model interface FunctionToolParam

GenAITracingOptions

特定のAIProjectClientインスタンスでGenAIトレーシングを設定するオプション。

これらをAIProjectClientOptionalParamsの tracingOptions キーで渡すことで、クライアントがインスタンス化される際にGenAIトレーシングが可能になります。 各クライアントインスタンスは独自のトレーシング構成を維持しています。

GitHubIssueRoutineTrigger

GitHubのイシュールーチントリガーです。

HeaderTelemetryEndpointAuth

テレメトリエンドポイント向けのヘッダーベースの秘密認証。 解決された秘密値はHTTPヘッダーとして注入されます。

HostedAgentDefinition

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

HourlyRecurrenceSchedule

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

HumanEvaluationPreviewRuleAction

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

HybridSearchOptions

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

ImageGenTool

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

ImageGenToolInputImageMask

model interface ImageGenToolInputImageMask

IndexesCreateOrUpdateOptionalParams

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

IndexesDeleteOptionalParams

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

IndexesGetOptionalParams

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

IndexesListOptionalParams

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

IndexesListVersionsOptionalParams

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

IndexesOperations

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

InlineSkillParam

model interface InlineSkillParam

InlineSkillSourceParam

インラインスキルペイロード

Insight

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

InsightCluster

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

InsightGenerationRequest

洞察を生み出すための要求機関。

InsightModelConfiguration

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

InsightRequest

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

InsightResult

洞察の結果。

InsightSample

分析からのサンプル。

InsightScheduleTask

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

InsightSummary

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

InsightsMetadata

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

InvocationsProtocolConfiguration

呼び出しプロトコル固有の構成。

InvocationsWsProtocolConfiguration

WebSocketベースの呼び出しプロトコルに特化した構成。

InvokeAgentInvocationsApiDispatchPayload

呼び出しAPIルーチンディスパッチをテストするための手動ペイロードです。

InvokeAgentInvocationsApiRoutineAction

生の呼び出しAPIを通じてルーチンをディスパッチします。 agent_nameまたはagent_endpoint_idのうち、正確に1つしか提供されなければなりません。

InvokeAgentResponsesApiDispatchPayload

応答APIルーチンディスパッチをテストするための手動ペイロードです。

InvokeAgentResponsesApiRoutineAction

responses APIを通じてルーチンをディスパッチします。 agent_nameまたはagent_endpoint_idのうち、正確に1つしか提供されなければなりません。

LocalShellToolParam

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

LocalSkillParam

model interface LocalSkillParam

LoraConfig

LoRAモデル向けのアダプター固有のメタデータ。 展開時のエンジン構成を駆動します。

MCPTool

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

MCPToolFilter

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

MCPToolRequireApproval

model interface MCPToolRequireApproval

MCPToolboxTool

ツールボックスに収納されたMCPツールです。

ManagedAgentIdentityBlueprintReference

model interface ManagedAgentIdentityBlueprintReference

ManagedAzureAISearchIndex

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

McpProtocolConfiguration

MCPプロトコル固有の構成。

MemoryItem

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

MemoryOperation

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

MemorySearchItem

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

MemorySearchOptions

メモリ検索オプション。

MemorySearchPreviewTool

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

MemoryStore

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

MemoryStoreDefaultDefinition

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

MemoryStoreDefaultOptions

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

MemoryStoreDefinition

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

MemoryStoreDeleteScopeResponse

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

MemoryStoreOperationUsage

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

MemoryStoreSearchResponse

メモリ検索応答。

MemoryStoreUpdateCompletedResult

メモリ更新結果。

MemoryStoreUpdateResponse

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

MicrosoftFabricPreviewTool

Microsoft Fabricツールの入力定義情報は、エージェントの設定に使用されます。

ModelCredentialRequest

モデル資産の認証情報取得をリクエストします。

ModelDeployment

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

ModelDeploymentSku

SKU 情報

ModelPendingUploadRequest

モデルバージョンのアップロード保留中のリクエストを表します。

ModelPendingUploadResponse

アップロードリクエスト中のモデルに対する応答を表します。

ModelSamplingParams

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

ModelSourceData

モデルの情報源

ModelVersion

モデルバージョン定義

MonthlyRecurrenceSchedule

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

NamespaceToolParam

共有名前空間のもとでグループ機能やカスタムツールを組みます。

NoAuthenticationCredentials

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

OneTimeTrigger

1 回限りのトリガー。

OpenAIClientOptionsWithAzureAgent

Azure Agentエンドポイント構成を含む拡張されたOpenAIクライアントオプション。

OpenApiAnonymousAuthDetails

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

OpenApiAuthDetails

OpenApiFunctionDefinition の認証の詳細

OpenApiFunctionDefinition

openapi 関数の入力定義情報。

OpenApiManagedAuthDetails

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

OpenApiManagedSecurityScheme

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

OpenApiProjectConnectionAuthDetails

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

OpenApiProjectConnectionSecurityScheme

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

OpenApiTool

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

OpenApiToolboxTool

ツールボックスに保存されたOpenAPIツールです。

OptimizationAgentIdentifier

最適化のために登録されたFoundryエージェントを特定します(リクエストのみで)。 スキル、道具、system_promptは、options.optimization_configで明示されています。

OptimizationCandidate

すべてのタスクにおける単一の候補エージェント構成の集約評価結果。

OptimizationDatasetCriterion

評価基準:項目ごとの採点に用いられる名前+命令の組み合わせ。

OptimizationDatasetInput

データセット入力のための基準識別モデル。 インライン項目か登録された推薦状のいずれかです。

OptimizationDatasetItem

インラインデータセット内の単一のアイテム。

OptimizationEvaluatorRef

名前付きの評価者への参照、オプションでバージョンにピン留め。

OptimizationInlineDatasetInput

インラインデータセット — リクエスト本体に直接提供される項目。

OptimizationJob

エージェント最適化ジョブリソース — エージェントの設定(指示、モデル、スキル、ツール)を最適化し、評価スコアを最大化する長期的なジョブです。 成功すると、結果には得点された候補者が含まれます。

OptimizationJobInputs

最適化ジョブのための発信者からの入力。

OptimizationJobListItem

LISTエンドポイントから返されるスリムジョブ表現。

OptimizationJobProgress

機内進捗;ステータスがキュー中またはin_progress中のみ入力されます。

OptimizationJobResult

終端状態の結果機関。 ステータスが成功または失敗した場合に居住します。

OptimizationOptions

最適化作業のためのノブとランモードの調整。

OptimizationReferenceDatasetInput

登録されたFoundryデータセットへの言及。

OtlpTelemetryEndpoint

OTLP(OpenTelemetry Protocol)テレメトリエクスポートエンドポイントです。

PageSettings

ページングされたイテレーションの設定を追跡するインターフェイス

PagedAsyncIterableIterator

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

PendingUploadRequest

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

PendingUploadResponse

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

ProceduralMemoryItem

会話から抽出された手続きを含むメモリ項目。

PromotionInfo

候補者がFoundryエージェントに展開された際に記録される昇進メタデータ。

PromptAgentDefinition

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

PromptAgentDefinitionTextOptions

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

PromptBasedEvaluatorDefinition

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

PromptDataGenerationJobSource

データ生成ジョブのプロンプトソース — ユーザーが提供するインラインテキスト。

PromptEvaluatorGenerationJobSource

評価者生成ジョブのプロンプトソース — ユーザーが提供するインラインテキスト。

ProtocolConfiguration

エージェントエンドポイントのプロトコルごとの設定。

ProtocolVersionRecord

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

RaiConfig

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

RankingOptions

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

Reasoning

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

RecurrenceSchedule

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

RecurrenceTrigger

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

RedTeam

レッドチームの詳細。

RedTeamTargetConfig

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

ReminderPreviewToolboxTool

工具箱に保管されたリマインダーツール。

ResponseUsageInputTokensDetails

model interface ResponseUsageInputTokens詳細

ResponseUsageOutputTokensDetails

model interface ResponseUsageOutputTokens詳細

ResponsesProtocolConfiguration

レスポンスプロトコルに特化した設定。

Routine

サービスが返すルーチン定義です。

RoutineAction

ルーチンアクションのベースモデル。

RoutineDispatchPayload

手動派遣ペイロードのベースモデルです。

RoutineRun

ラン履歴APIからは単一のルーチン実行が返されます。

RoutineTrigger

ルーチントリガーの基本モデル。

RubricBasedEvaluatorDefinition

ルーブリックベースの評価者定義 — 生成APIによって生成された次元を保存します。 品質評価者と安全性評価者の両方に使用されます。

SASTokenCredentials

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

SasCredential

SAS資格情報の定義

Schedule

スケジュールモデル。

ScheduleRoutineTrigger

繰り返し発生するクロンベースのルーチントリガー。

ScheduleRun

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

ScheduleTask

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

SessionDirectoryEntry

ディレクトリリストの単一のエントリー。

SessionDirectoryListResponse

セッションサンドボックスでディレクトリをリストすることからの応答。

SessionFileWriteResponse

セッションサンドボックスにファイルをアップロードする際の応答。

SessionLogEvent

ホストされたエージェントのセッションログストリームから送信される単一のイベントフレーム Server-Sent。

各フレームにはイベントタイプを示す event フィールドと、ペイロードを平文として記す data フィールドが含まれています。 現在の data のペイロードはJSON形式ですが、そのスキーマは契約的ではなく、追加のキーが現れたり、時間とともにフォーマットが変わったりします。 クライアントは data を不透明な文字列として扱い、オプションでJSON解析を試みるべきです。

将来的には新しいイベントタイプが追加される可能性があります。 クライアントは認識されていないイベントタイプを優雅に無視すべきです。

ワイヤーフォーマット:

event: log
data: {"timestamp":"2026-03-10T09:33:17.121Z","stream":"stdout","message":"Starting server on port 18080"}

event: log
data: {"timestamp":"2026-03-10T09:34:52.714Z","stream":"status","message":"Successfully connected to container"}
SharepointGroundingToolParameters

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

SharepointPreviewTool

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

SimpleQnADataGenerationJobOptions

SimpleQnA型のデータ生成ジョブの選択肢。

Skill

スキルリソースです。

SkillInlineContent

ファイルをアップロードせずに簡単なスキルを定義するためのインラインコンテンツ。 agentskills.io SKILL.md 仕様に従っています。

SkillReferenceParam

model interface SkillReferenceParam

SkillVersion

特定のスキルのバージョンです。

SpecificApplyPatchParam

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

SpecificFunctionShellParam

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

StructuredInputDefinition

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

StructuredOutputDefinition

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

TaxonomyCategory

分類カテゴリの定義。

TaxonomySubCategory

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

TelemetryConfig

コンテナログ、トレース、メトリクスのエクスポートのための顧客提供のテレメトリ構成。

TelemetryEndpoint

テレメトリーのエクスポートエンドポイント設定です。

TelemetryEndpointAuth

テレメトリエンドポイントの認証設定。

TelemetryOperations

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

TextResponseFormat

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

TextResponseFormatConfiguration
TextResponseFormatConfigurationResponseFormatJsonObject
TextResponseFormatConfigurationResponseFormatText
TextResponseFormatJsonObject

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

TextResponseFormatJsonSchema

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

TextResponseFormatText

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

TimerRoutineTrigger

ワンショットタイマーのルーチントリガー。

Tool

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

ToolChoiceAllowed

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

ToolChoiceCodeInterpreter

モデルが組み込みのツールを使用して応答を生成する必要があることを示します。 組み込みツールの詳細についてはを参照してください。

ToolChoiceComputer

モデルが組み込みのツールを使用して応答を生成する必要があることを示します。 組み込みツールの詳細についてはを参照してください。

ToolChoiceComputerUse

モデルが組み込みのツールを使用して応答を生成する必要があることを示します。 組み込みツールの詳細についてはを参照してください。

ToolChoiceComputerUsePreview

モデルが組み込みのツールを使用して応答を生成する必要があることを示します。 組み込みツールの詳細についてはを参照してください。

ToolChoiceCustom

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

ToolChoiceFileSearch

モデルが組み込みのツールを使用して応答を生成する必要があることを示します。 組み込みツールの詳細についてはを参照してください。

ToolChoiceFunction

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

ToolChoiceImageGeneration

モデルが組み込みのツールを使用して応答を生成する必要があることを示します。 組み込みツールの詳細についてはを参照してください。

ToolChoiceMCP

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

ToolChoiceParam

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

ToolChoiceWebSearchPreview

モデルが組み込みのツールを使用して応答を生成する必要があることを示します。 組み込みツールの詳細についてはを参照してください。

ToolChoiceWebSearchPreview20250311

モデルが組み込みのツールを使用して応答を生成する必要があることを示します。 組み込みツールの詳細についてはを参照してください。

ToolConfig

ツールごとの設定で、ツールの可視性と検索動作を制御します。

ToolDescription

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

ToolProjectConnection

project接続リソース。

ToolSearchToolParam

遅延ツールのホスティングまたはBYOTツール検索設定。

ToolUseFineTuningDataGenerationJobOptions

ToolUseタイプのデータ生成ジョブの選択肢。 微調整のシナリオにのみ使用。

ToolboxObject

エージェント用の再利用可能なツール定義を保存するツールボックスです。

ToolboxPolicies

コンテンツセキュリティやその他のガバナンス設定を含むツールボックスのポリシー設定。

ToolboxSearchPreviewToolboxTool

ツールボックス内に保存されたツールボックス検索ツール。

ToolboxSkill

ツールボックスに含まれているスキルソース。

ToolboxSkillReference

ツールボックスに含める既存のスキルの言及です。

ToolboxTool

工具箱に収納された工具の抽象的な表現。

ToolboxVersionObject

工具箱の特定のバージョンです。

ToolboxesCreateVersionOptionalParams

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

ToolboxesDeleteOptionalParams

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

ToolboxesDeleteVersionOptionalParams

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

ToolboxesGetOptionalParams

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

ToolboxesGetVersionOptionalParams

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

ToolboxesListOptionalParams

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

ToolboxesListVersionsOptionalParams

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

ToolboxesOperations

ツールボックス操作を表すインターフェース。

ToolboxesUpdateOptionalParams

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

TracesDataGenerationJobOptions

Tracesタイプのデータ生成ジョブの選択肢。

TracesDataGenerationJobSource

データ生成ジョブのトレースソース — Application Insightsの会話トレース。

TracesEvaluatorGenerationJobSource

評価者生成ジョブのトレースソース — Application Insightsからの会話トレース。

Trigger

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

UpdateModelVersionRequest

モデルバージョンの更新を依頼する本体。 変更できるのは説明とタグのみです。

UpdateToolboxRequest

model interface UpdateToolboxRequest

UserProfileMemoryItem

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

VersionIndicator

バージョンインジケーターは、セッションを支持するエージェントバージョンを示します。

VersionRefIndicator

特定のエージェントバージョンを名前で参照するバージョンインジケーター。

VersionSelectionRule

model interface VersionSelectionRule

VersionSelector

モデルインターフェースバージョンセレクター

WebSearchApproximateLocation

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

WebSearchConfiguration

カスタム検索用の Web 検索構成bing

WebSearchPreviewTool

このツールは、回答に使える関連結果をウェブ上で検索します。 詳細については、web 検索ツールを参照してください。

WebSearchTool

このプロンプトに関連する情報源をインターネットで検索してください。 詳細については、web 検索ツールを参照してください。

WebSearchToolFilters

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

WebSearchToolboxTool

ツールボックスに保存されたウェブ検索ツール。

WeeklyRecurrenceSchedule

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

WorkIQPreviewTool

WorkIQのサーバーサイドツールです。

WorkIQPreviewToolboxTool

WorkIQツールをツールボックスに格納しています。

WorkflowAgentDefinition

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

型エイリアス

AgentBlueprintReferenceType

エージェントの種類BlueprintReferenceType(参照タイプ)

AgentBlueprintReferenceUnion

AgentBlueprintReferenceUnion の別名

AgentDefinitionOptInKeys

ホスト型またはワークフローエージェントをサポートするエージェント定義操作のための機能オプトインキー。

AgentDefinitionUnion

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

AgentEndpoint
AgentEndpointAuthorizationSchemeType

エージェントの種類エンドポイント認証スキームタイプ

AgentEndpointAuthorizationSchemeUnion

AgentEndpointAuthorizationSchemeUnion のエイリアス

AgentKind

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

AgentProtocol

AgentProtocol のタイプ

AgentSessionStatus

エージェントセッションの状況。

AgentState

エージェントの運用状態。

AgentType

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

AgentVersionStatus

エージェントバージョンのプロビジョニング状況。

AgentsDownloadAgentCodeResponse
AgentsDownloadSessionFileResponse
AttackStrategy

攻撃の戦略。

AzureAISearchQueryType

Azure AI 検索ツールで利用可能なクエリタイプ。

BaseCredentialsUnion

BaseCredentialsUnion のエイリアス

BetaSkillsDownloadResponse
CodeDependencyResolution

コードベースのホストエージェントの展開時にパッケージ依存関係がどのように解決されるか。

ComparisonFilterValueItems

ComparisonFilterValueItemsのエイリアス

ComputerEnvironment

コンピュータ環境の種類

ConnectionType

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

ContainerMemoryLimit

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

ContainerNetworkPolicyParamType

コンテナネットワークポリシーパラムタイプのタイプ

ContainerNetworkPolicyParamUnion

Alias for ContainerNetworkPolicyParamUnion

ContainerSkillType

コンテナの種類スキルタイプ

ContainerSkillUnion

コンテナスキルユニオンの別名

ContinuablePage

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

CredentialType

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

CustomToolParamFormatType

TypeCustomToolParamFormatType のタイプ

CustomToolParamFormatUnion

Alias for CustomToolParamFormatUnion

DataGenerationJobOptionsUnion

Alias for DataGenerationJobOptionsUnion

DataGenerationJobOutputType

データ生成ジョブに対応した出力ファイル形式。

DataGenerationJobOutputUnion

DataGenerationJobOutputUnion の別名

DataGenerationJobScenario

データ生成ジョブのサポートシナリオ。

DataGenerationJobSourceType

データ生成ジョブに対応しているソースタイプ。

DataGenerationJobSourceUnion

DataGenerationJobSourceUnion の別名

DataGenerationJobType

サポートされるデータ生成ジョブタイプ。

DatasetType

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

DatasetVersionUnion

DatasetVersionUnion のエイリアス

DayOfWeek

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

DeploymentType

DeploymentType のタイプ

DeploymentUnion

DeploymentUnion のエイリアス

DownloadVersionResponse
EvaluationLevel

評価が行われるレベル。

EvaluationRuleActionType

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

EvaluationRuleActionUnion

EvaluationRuleActionUnion のエイリアス

EvaluationRuleEventType

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

EvaluationTargetUnion

評価用エイリアスTargetUnion

EvaluationTaxonomyInputType

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

EvaluationTaxonomyInputUnion

評価のエイリアスTaxonomyInputUnion

EvaluatorCategory

評価者のカテゴリ

EvaluatorDefinitionType

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

EvaluatorDefinitionUnion

EvaluatorDefinitionUnion のエイリアス

EvaluatorGenerationJobSourceType

評価者生成ジョブのサポートソースタイプ。

EvaluatorGenerationJobSourceUnion

EvaluatorGenerationJobSourceUnion の別名

EvaluatorMetricDirection

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

EvaluatorMetricType

評価者のタイプ

EvaluatorType

評価者のタイプ

FileContents

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

Filters

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

FoundryFeaturesOptInKeys

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

FoundryModelArtifactProfileCategory

アーティファクトプロファイルのカテゴリ。

FoundryModelArtifactProfileSignal

モデルのアーティファクトで検出された信号。

FoundryModelSourceType

モデルのソースタイプ。

FoundryModelWarningCode

モデルアーティファクトに関する警告コード。

FoundryModelWeightType

モデルの重量の種類。

FunctionShellToolParamEnvironmentType

関数の種類シェルツールパラム環境タイプ

FunctionShellToolParamEnvironmentUnion

FunctionShellToolParamEnvironmentUnion のエイリアス

GitHubIssueEvent

ルーチンを起動できる既知のGitHubイシューイベント。

GrammarSyntax

文法統語論の種類

ImageGenAction

ImageGenActionの種類

IndexType

IndexType のタイプ

IndexUnion

IndexUnion のエイリアス

InputFidelity

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

InsightRequestUnion

InsightRequestUnion のエイリアス

InsightResultUnion

InsightResultUnion のエイリアス

InsightSampleUnion

InsightSampleUnion のエイリアス

InsightType

インサイトの要求。

JobStatus

Foundryジョブが共有する拡張可能なステータス価値。

MemoryItemKind

メモリアイテムの種類。

MemoryItemUnion

MemoryItemUnion のエイリアス

MemoryOperationKind

メモリ操作の種類。

MemoryStoreDefinitionUnion

MemoryStoreDefinitionUnion のエイリアス

MemoryStoreKind

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

MemoryStoreType

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

MemoryStoreUpdateStatus

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

NodeReadableStream

ReadableStream Node.js エイリアスをタイプしてください。 ノードターゲットでは、これは実際のNodeJS.ReadableStream型に解決されます。 ブラウザやreactネイティブ向けのプラットフォームバリアントは neverに解決され、自然にユニオン型から除外されます。

OpenApiAuthDetailsUnion

OpenApiAuthDetailsUnion のエイリアス

OpenApiAuthType

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

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

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

OptimizationDatasetInputType

データセットの入力和集合のための識別子値。

OptimizationDatasetInputUnion

Alias for OptimizationDatasetInputUnion

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

繰り返しタイプ。

RedTeamTargetConfigUnion

RedTeamTargetConfigUnion のエイリアス

RiskCategory

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

RoutineActionType

判別子値はルーチン動作にサポートされます。

RoutineActionUnion

RoutineActionUnionの別名

RoutineAttemptSource

ルーチン実行を生成できる既知のソースパス。

RoutineDispatchPayloadType

手動のルーチン派遣ペイロードに対応した識別器の値。

RoutineDispatchPayloadUnion

RoutineDispatchPayloadUnion の別名

RoutineRunPhase

通常のランで記録された既知のライフサイクルフェーズ。

RoutineRunStatus

ルーチンのランの状態。

RoutineTriggerType

ルーチントリガーに対応した識別子値。

RoutineTriggerUnion

RoutineTriggerUnion の別名

SampleType

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

ScheduleProvisioningStatus

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

ScheduleTaskType

タスクの種類。

ScheduleTaskUnion

ScheduleTaskUnion のエイリアス

SearchContentType

検索コンテンツタイプ

SearchContextSize

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

SessionLogEventType

ホストエージェントのセッションログストリームから送信される既知のSSEイベントタイプ。 今後のバージョンでは追加のイベントタイプが導入される可能性があります。

SimpleQnAFineTuningQuestionType

SimpleQnAのデータ生成ジョブでサポートされた質問タイプは、ファインチューニングシナリオに使用されます。

TelemetryDataKind

エクスポートすべきテレメトリデータの種類。

TelemetryEndpointAuthType

テレメトリエンドポイントの認証の種類。

TelemetryEndpointAuthUnion

Alias for TelemetryEndpointAuthUnion

TelemetryEndpointKind

テレメトリエクスポートエンドポイントのようなものです。

TelemetryEndpointUnion

Alias for TelemetryEndpointUnion

TelemetryTransportProtocol

テレメトリエクスポートのためのトランスポートプロトコル。

TextResponseFormatConfigurationType

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

TextResponseFormatConfigurationUnion
TextResponseFormatUnion

TextResponseFormatUnion の別名

ToolChoiceParamType

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

ToolChoiceParamUnion

ToolChoiceParamUnion の別名

ToolSearchExecutionType

ツールの種類検索実行タイプ

ToolType

ツールタイプの種類

ToolUnion

ToolUnion のエイリアス

ToolboxSkillUnion

ToolboxSkillUnion の別名

ToolboxToolType

ツールボックスに保存されたツールに対応したツールタイプ。

ToolboxToolUnion

ToolboxToolUnion のエイリアス

TreatmentEffectType

治療効果の種類。

TriggerType

トリガーのタイプ。

TriggerUnion

TriggerUnion のエイリアス

VersionIndicatorType

セッションを支えるエージェントバージョンを決定するために使われるバージョンインジケーターの種類。

VersionIndicatorUnion

VersionIndicatorUnion の別名

VersionSelectionRuleType

バージョン選択ルールタイプのタイプ

VersionSelectionRuleUnion

VersionSelectionRuleUnion の別名

列挙型

KnownApiVersions

Microsoft Foundry API バージョン

関数

isRestError(unknown)

RestError の Typeguard

変数

RestError

失敗したパイプライン要求のカスタム エラーの種類。

関数の詳細

isRestError(unknown)

RestError の Typeguard

function isRestError(e: unknown): e

パラメーター

e

unknown

catch 句によってキャッチされる何か。

返品

e

変数の詳細

RestError

失敗したパイプライン要求のカスタム エラーの種類。

RestError: RestErrorConstructor