ChatCompletionSkill interface
Azure AI FoundryのChat Completionsエンドポイントを通じて言語モデルを呼び出しるスキルです。
- 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}
WebApiSkill.httpHeadersから継承
httpMethod
inputs
スキルの入力には、ソース データ セット内の列、またはアップストリーム スキルの出力を指定できます。
inputs: InputFieldMappingEntry[]プロパティ値
name
スキルセット内で一意に識別されるスキルの名前。 名前が定義されていないスキルには、スキル配列内の 1 から始まるインデックスの既定の名前が付けられます。先頭には文字 '#' が付きます。
name?: stringプロパティ値
string
outputs
スキルの出力は、検索インデックス内のフィールドか、別のスキルによる入力として使用できる値のいずれかです。
outputs: OutputFieldMappingEntry[]プロパティ値
WebApiSkill.outputsから継承