ChatCompletionSkill interface

Package:

@azure/search-documents

A skill that calls a language model via Azure AI Foundry's Chat Completions endpoint.

Extends

WebApiSkill

Properties

apiKey	API key for authenticating to the model. Both apiKey and authIdentity cannot be specified at the same time.
commonModelParameters	Common language model parameters that customers can tweak. If omitted, reasonable defaults will be applied.
extraParameters	Open-type dictionary for model-specific parameters that should be appended to the chat completions call. Follows Azure AI Foundry’s extensibility pattern.
extraParametersBehavior	How extra parameters are handled by Azure AI Foundry. Default is 'error'.
odatatype	Polymorphic discriminator, which specifies the different types this object can be
responseFormat	Determines how the LLM should format its response. Defaults to 'text' response type.

Inherited Properties

authIdentity	The user-assigned managed identity used for outbound connections. If an authResourceId is provided and it's not specified, the system-assigned managed identity is used. On updates to the indexer, if the identity is unspecified, the value remains unchanged. If set to "none", the value of this property is cleared.
authResourceId	Applies to custom skills that connect to external code in an Azure function or some other application that provides the transformations. This value should be the application ID created for the function or app when it was registered with Azure Active Directory. When specified, the custom skill connects to the function or app using a managed ID (either system or user-assigned) of the search service and the access token of the function or app, using this value as the resource id for creating the scope of the access token.
batchSize	The desired batch size which indicates number of documents.
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.
degreeOfParallelism	If set, the number of parallel calls that can be made to the Web API.
description	The description of the skill which describes the inputs, outputs, and usage of the skill.
httpHeaders	The headers required to make the http request.
httpMethod	The method for the http request.
inputs	Inputs of the skills could be a column in the source data set, or the output of an upstream skill.
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.
timeout	The desired timeout for the request. Default is 30 seconds.
uri	The url for the Web API.

Property Details

apiKey

API key for authenticating to the model. Both apiKey and authIdentity cannot be specified at the same time.

apiKey?: string

Property Value

string

commonModelParameters

Common language model parameters that customers can tweak. If omitted, reasonable defaults will be applied.

commonModelParameters?: CommonModelParameters

Property Value

CommonModelParameters

extraParameters

Open-type dictionary for model-specific parameters that should be appended to the chat completions call. Follows Azure AI Foundry’s extensibility pattern.

extraParameters?: {[propertyName: string]: unknown}

Property Value

{[propertyName: string]: unknown}

extraParametersBehavior

How extra parameters are handled by Azure AI Foundry. Default is 'error'.

extraParametersBehavior?: string

Property Value

string

odatatype

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

odatatype: "#Microsoft.Skills.Custom.ChatCompletionSkill"

Property Value

"#Microsoft.Skills.Custom.ChatCompletionSkill"

responseFormat

Determines how the LLM should format its response. Defaults to 'text' response type.

responseFormat?: ChatCompletionResponseFormat

Property Value

ChatCompletionResponseFormat

Inherited Property Details

authIdentity

The user-assigned managed identity used for outbound connections. If an authResourceId is provided and it's not specified, the system-assigned managed identity is used. On updates to the indexer, if the identity is unspecified, the value remains unchanged. If set to "none", the value of this property is cleared.

authIdentity?: SearchIndexerDataIdentity

Property Value

SearchIndexerDataIdentity

Inherited From WebApiSkill.authIdentity

authResourceId

Applies to custom skills that connect to external code in an Azure function or some other application that provides the transformations. This value should be the application ID created for the function or app when it was registered with Azure Active Directory. When specified, the custom skill connects to the function or app using a managed ID (either system or user-assigned) of the search service and the access token of the function or app, using this value as the resource id for creating the scope of the access token.

authResourceId?: string

Property Value

string

Inherited From WebApiSkill.authResourceId

batchSize

The desired batch size which indicates number of documents.

batchSize?: number

Property Value

number

Inherited From WebApiSkill.batchSize

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 WebApiSkill.context

degreeOfParallelism

If set, the number of parallel calls that can be made to the Web API.

degreeOfParallelism?: number

Property Value

number

Inherited From WebApiSkill.degreeOfParallelism

description

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

description?: string

Property Value

string

Inherited From WebApiSkill.description

httpHeaders

The headers required to make the http request.

httpHeaders?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From WebApiSkill.httpHeaders

httpMethod

The method for the http request.

httpMethod?: string

Property Value

string

Inherited From WebApiSkill.httpMethod

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 WebApiSkill.inputs

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 WebApiSkill.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 WebApiSkill.outputs

timeout

The desired timeout for the request. Default is 30 seconds.

timeout?: string

Property Value

string

Inherited From WebApiSkill.timeout

uri

The url for the Web API.

uri: string

Property Value

string

Inherited From WebApiSkill.uri