AzureOpenAIEmbeddingSkill interface

  • リファレンス
パッケージ:
@azure/search-documents

Azure OpenAI リソースを使用して、特定のテキスト入力のベクター埋め込みを生成できます。

Extends

BaseSearchIndexerSkill,AzureOpenAIParameters

プロパティ

dimensions

結果の出力埋め込みで必要なディメンションの数。 text-embedding-3 以降のモデルでのみサポートされます。
odatatype

ポリモーフィック識別子。このオブジェクトは、さまざまな型を指定します。

継承されたプロパティ

apiKey

指定された Azure Open AI リソースの API キー。
authIdentity

送信接続に使用されるユーザー割り当てマネージド ID。
context

ドキュメントのルートやドキュメントのコンテンツ (/document や /document/content など) など、操作が行われるレベルを表します。 既定値は /document です。
deploymentId

指定されたリソースに対する Azure Open AI モデルのデプロイの ID。
description

スキルの入力、出力、および使用方法を記述するスキルの説明。
inputs

スキルの入力には、ソース データ セット内の列、またはアップストリーム スキルの出力を指定できます。
modelName

指定された deploymentId パスにデプロイされる埋め込みモデルの名前。
name

スキルセット内で一意に識別されるスキルの名前。 名前が定義されていないスキルには、スキル配列内の 1 から始まるインデックスの既定の名前が付けられます。先頭には文字 '#' が付きます。
outputs

スキルの出力は、検索インデックス内のフィールドか、別のスキルによる入力として使用できる値のいずれかです。
resourceUrl

Azure Open AI リソースのリソース URI。

プロパティの詳細

dimensions

結果の出力埋め込みで必要なディメンションの数。 text-embedding-3 以降のモデルでのみサポートされます。

dimensions?: number

プロパティ値

number

odatatype

ポリモーフィック識別子。このオブジェクトは、さまざまな型を指定します。

odatatype: "#Microsoft.Skills.Text.AzureOpenAIEmbeddingSkill"

プロパティ値

"#Microsoft.Skills.Text.AzureOpenAIEmbeddingSkill"

継承されたプロパティの詳細

apiKey

指定された Azure Open AI リソースの API キー。

apiKey?: string

プロパティ値

string

継承された AzureOpenAIParameters.apiKey

authIdentity

送信接続に使用されるユーザー割り当てマネージド ID。

authIdentity?: SearchIndexerDataIdentity

プロパティ値

SearchIndexerDataIdentity

azureOpenAIParameters.authIdentityから継承された

context

ドキュメントのルートやドキュメントのコンテンツ (/document や /document/content など) など、操作が行われるレベルを表します。 既定値は /document です。

context?: string

プロパティ値

string

baseSearchIndexerSkill.context から継承

deploymentId

指定されたリソースに対する Azure Open AI モデルのデプロイの ID。

deploymentId?: string

プロパティ値

string

azureOpenAIParameters.deploymentIdから継承された

description

スキルの入力、出力、および使用方法を記述するスキルの説明。

description?: string

プロパティ値

string

baseSearchIndexerSkill.descriptionから継承された

inputs

スキルの入力には、ソース データ セット内の列、またはアップストリーム スキルの出力を指定できます。

inputs: InputFieldMappingEntry[]

プロパティ値

InputFieldMappingEntry[]

baseSearchIndexerSkill.inputs から継承

modelName

指定された deploymentId パスにデプロイされる埋め込みモデルの名前。

modelName?: string

プロパティ値

string

azureOpenAIParameters.modelName から継承

name

スキルセット内で一意に識別されるスキルの名前。 名前が定義されていないスキルには、スキル配列内の 1 から始まるインデックスの既定の名前が付けられます。先頭には文字 '#' が付きます。

name?: string

プロパティ値

string

BaseSearchIndexerSkill.name から継承された

outputs

スキルの出力は、検索インデックス内のフィールドか、別のスキルによる入力として使用できる値のいずれかです。

outputs: OutputFieldMappingEntry[]

プロパティ値

OutputFieldMappingEntry[]

baseSearchIndexerSkill.outputs から継承

resourceUrl

Azure Open AI リソースのリソース URI。

resourceUrl?: string

プロパティ値

string

azureOpenAIParameters.resourceUrl から継承