Package version:

Interface AzureOpenAIEmbeddingSkill

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

interface AzureOpenAIEmbeddingSkill {
    apiKey?: string;
    authIdentity?: SearchIndexerDataIdentity;
    context?: string;
    deploymentId?: string;
    description?: string;
    dimensions?: number;
    inputs: InputFieldMappingEntry[];
    modelName?: string;
    name?: string;
    odatatype: "#Microsoft.Skills.Text.AzureOpenAIEmbeddingSkill";
    outputs: OutputFieldMappingEntry[];
    resourceUrl?: string;
}

Hierarchy (view full)

Properties

apiKey? authIdentity? context? deploymentId? description? dimensions? inputs modelName? name? odatatype outputs resourceUrl?

Properties

OptionalapiKey

apiKey?: string

API key of the designated Azure OpenAI resource.

OptionalauthIdentity

authIdentity?: SearchIndexerDataIdentity

The user-assigned managed identity used for outbound connections.

Optionalcontext

context?: string

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.

OptionaldeploymentId

deploymentId?: string

ID of the Azure OpenAI model deployment on the designated resource.

Optionaldescription

description?: string

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

Optionaldimensions

dimensions?: number

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

inputs

inputs: InputFieldMappingEntry[]

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

OptionalmodelName

modelName?: string

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

Optionalname

name?: string

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 '#'.

odatatype

odatatype

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

outputs

outputs: OutputFieldMappingEntry[]

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.

OptionalresourceUrl

resourceUrl?: string

The resource URI of the Azure OpenAI resource.

Settings

Member Visibility