AzureOpenAIEmbeddingSkill interface

Package:

@azure/search-documents

Allows you to generate a vector embedding for a given text input using the Azure OpenAI resource.

Extends

BaseSearchIndexerSkill,AzureOpenAIParameters

Properties

dimensions	The number of dimensions the resulting output embeddings should have. Only supported in text-embedding-3 and later models.
odatatype	Polymorphic discriminator, which specifies the different types this object can be

Inherited Properties

apiKey	API key for the designated Azure Open AI resource.
authIdentity	The user-assigned managed identity used for outbound connections.
context	Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content). The default is /document.
deploymentId	ID of your Azure Open AI model deployment on the designated resource.
description	The description of the skill which describes the inputs, outputs, and usage of the skill.
inputs	Inputs of the skills could be a column in the source data set, or the output of an upstream skill.
modelName	The name of the embedding model that is deployed at the provided deploymentId path.
name	The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '#'.
outputs	The output of a skill is either a field in a search index, or a value that can be consumed as an input by another skill.
resourceUrl	The resource uri for your Azure Open AI resource.

Property Details

dimensions

The number of dimensions the resulting output embeddings should have. Only supported in text-embedding-3 and later models.

dimensions?: number

Property Value

number

odatatype

Polymorphic discriminator, which specifies the different types this object can be

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

Property Value

"#Microsoft.Skills.Text.AzureOpenAIEmbeddingSkill"

Inherited Property Details

apiKey

API key for the designated Azure Open AI resource.

apiKey?: string

Property Value

string

Inherited From AzureOpenAIParameters.apiKey

authIdentity

The user-assigned managed identity used for outbound connections.

authIdentity?: SearchIndexerDataIdentity

Property Value

SearchIndexerDataIdentity

Inherited From AzureOpenAIParameters.authIdentity

context

Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content). The default is /document.

context?: string

Property Value

string

Inherited From BaseSearchIndexerSkill.context

deploymentId

ID of your Azure Open AI model deployment on the designated resource.

deploymentId?: string

Property Value

string

Inherited From AzureOpenAIParameters.deploymentId

description

The description of the skill which describes the inputs, outputs, and usage of the skill.

description?: string

Property Value

string

Inherited From BaseSearchIndexerSkill.description

inputs

Inputs of the skills could be a column in the source data set, or the output of an upstream skill.

inputs: InputFieldMappingEntry[]

Property Value

InputFieldMappingEntry[]

Inherited From BaseSearchIndexerSkill.inputs

modelName

The name of the embedding model that is deployed at the provided deploymentId path.

modelName?: string

Property Value

string

Inherited From AzureOpenAIParameters.modelName

name

The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '#'.

name?: string

Property Value

string

Inherited From BaseSearchIndexerSkill.name

outputs

The output of a skill is either a field in a search index, or a value that can be consumed as an input by another skill.

outputs: OutputFieldMappingEntry[]

Property Value

OutputFieldMappingEntry[]

Inherited From BaseSearchIndexerSkill.outputs

resourceUrl

The resource uri for your Azure Open AI resource.

resourceUrl?: string

Property Value

string

Inherited From AzureOpenAIParameters.resourceUrl