ChatCompletionSkill interface
Azure AI Foundry のチャット完了エンドポイントを介して言語モデルを呼び出すスキル。
- Extends
プロパティ
| api |
モデルに対して認証するための API キー。 apiKey と authIdentity の両方を同時に指定することはできません。 |
| common |
顧客が微調整できる共通の言語モデル パラメーター。 省略すると、合理的なデフォルトが適用されます。 |
| extra |
チャット完了呼び出しに追加する必要があるモデル固有のパラメーターのオープン型ディクショナリ。 Azure AI Foundry の機能拡張パターンに従います。 |
| extra |
Azure AI Foundry による追加のパラメーターの処理方法。 デフォルトは「error」です。 |
| odatatype | ポリモーフィック識別子。このオブジェクトは、さまざまな型を指定します。 |
| response |
LLM が応答をどのようにフォーマットするかを決定します。 デフォルトは「テキスト」応答タイプです。 |
継承されたプロパティ
| auth |
送信接続に使用されるユーザー割り当てマネージド ID。 authResourceId が指定されていて指定されていない場合は、システム割り当てマネージド ID が使用されます。 インデクサーの更新時に、ID が指定されていない場合、値は変更されません。 「none」に設定すると、このプロパティの値はクリアされます。 |
| auth |
Azure 関数の外部コードまたは変換を提供するその他のアプリケーションに接続するカスタム スキルに適用されます。 この値は、Azure Active Directory に登録されたときに関数またはアプリ用に作成されたアプリケーション ID である必要があります。 指定すると、カスタム スキルは、検索サービスのマネージド ID (システムまたはユーザー割り当て) と関数またはアプリのアクセス トークンを使用して関数またはアプリに接続し、この値をアクセス トークンのスコープを作成するためのリソース ID として使用します。 |
| batch |
ドキュメントの数を示す目的のバッチ サイズ。 |
| context | ドキュメントルートやドキュメントコンテンツ (/document や /document/content など) など、操作が実行されるレベルを表します。 デフォルトは /document です。 |
| degree |
設定されている場合は、Web API に対して実行できる並列呼び出しの数。 |
| description | スキルの入力、出力および使用法を説明するスキルの説明。 |
| http |
http リクエストを行うために必要なヘッダー。 |
| http |
http リクエストのメソッド。 |
| inputs | スキルの入力は、ソース・データ・セットの列、またはアップストリーム・スキルの出力である可能性があります。 |
| name | スキルセット内で一意に識別するスキルの名前。 名前が定義されていないスキルには、スキル配列内の 1 から始まるインデックスのデフォルト名が与えられ、接頭辞に文字「#」が付けられます。 |
| outputs | スキルの出力は、検索インデックスのフィールド、または別のスキルによる入力として使用できる値のいずれかです。 |
| timeout | 要求に必要なタイムアウト。 既定値は 30 秒です。 |
| uri | Web API の URL。 |
プロパティの詳細
apiKey
モデルに対して認証するための API キー。 apiKey と authIdentity の両方を同時に指定することはできません。
apiKey?: stringプロパティ値
string
commonModelParameters
顧客が微調整できる共通の言語モデル パラメーター。 省略すると、合理的なデフォルトが適用されます。
commonModelParameters?: CommonModelParametersプロパティ値
extraParameters
チャット完了呼び出しに追加する必要があるモデル固有のパラメーターのオープン型ディクショナリ。 Azure AI Foundry の機能拡張パターンに従います。
extraParameters?: {[propertyName: string]: unknown}プロパティ値
{[propertyName: string]: unknown}
extraParametersBehavior
Azure AI Foundry による追加のパラメーターの処理方法。 デフォルトは「error」です。
extraParametersBehavior?: stringプロパティ値
string
odatatype
ポリモーフィック識別子。このオブジェクトは、さまざまな型を指定します。
odatatype: "#Microsoft.Skills.Custom.ChatCompletionSkill"プロパティ値
"#Microsoft.Skills.Custom.ChatCompletionSkill"
responseFormat
LLM が応答をどのようにフォーマットするかを決定します。 デフォルトは「テキスト」応答タイプです。
responseFormat?: ChatCompletionResponseFormatプロパティ値
継承されたプロパティの詳細
authIdentity
送信接続に使用されるユーザー割り当てマネージド ID。 authResourceId が指定されていて指定されていない場合は、システム割り当てマネージド ID が使用されます。 インデクサーの更新時に、ID が指定されていない場合、値は変更されません。 「none」に設定すると、このプロパティの値はクリアされます。
authIdentity?: SearchIndexerDataIdentityプロパティ値
authResourceId
Azure 関数の外部コードまたは変換を提供するその他のアプリケーションに接続するカスタム スキルに適用されます。 この値は、Azure Active Directory に登録されたときに関数またはアプリ用に作成されたアプリケーション ID である必要があります。 指定すると、カスタム スキルは、検索サービスのマネージド ID (システムまたはユーザー割り当て) と関数またはアプリのアクセス トークンを使用して関数またはアプリに接続し、この値をアクセス トークンのスコープを作成するためのリソース ID として使用します。
authResourceId?: stringプロパティ値
string
batchSize
context
ドキュメントルートやドキュメントコンテンツ (/document や /document/content など) など、操作が実行されるレベルを表します。 デフォルトは /document です。
context?: stringプロパティ値
string
degreeOfParallelism
設定されている場合は、Web API に対して実行できる並列呼び出しの数。
degreeOfParallelism?: numberプロパティ値
number
description
httpHeaders
http リクエストを行うために必要なヘッダー。
httpHeaders?: {[propertyName: string]: string}プロパティ値
{[propertyName: string]: string}
httpMethod
inputs
スキルの入力は、ソース・データ・セットの列、またはアップストリーム・スキルの出力である可能性があります。
inputs: InputFieldMappingEntry[]プロパティ値
name
スキルセット内で一意に識別するスキルの名前。 名前が定義されていないスキルには、スキル配列内の 1 から始まるインデックスのデフォルト名が与えられ、接頭辞に文字「#」が付けられます。
name?: stringプロパティ値
string
outputs
スキルの出力は、検索インデックスのフィールド、または別のスキルによる入力として使用できる値のいずれかです。
outputs: OutputFieldMappingEntry[]