ChatCompletionSkill Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
A skill that calls a language model via Azure AI Foundry's Chat Completions endpoint.
public class ChatCompletionSkill : Azure.Search.Documents.Indexes.Models.SearchIndexerSkill, System.ClientModel.Primitives.IJsonModel<Azure.Search.Documents.Indexes.Models.ChatCompletionSkill>, System.ClientModel.Primitives.IPersistableModel<Azure.Search.Documents.Indexes.Models.ChatCompletionSkill>type ChatCompletionSkill = class
inherit SearchIndexerSkill
interface IJsonModel<ChatCompletionSkill>
interface IPersistableModel<ChatCompletionSkill>Public Class ChatCompletionSkill
Inherits SearchIndexerSkill
Implements IJsonModel(Of ChatCompletionSkill), IPersistableModel(Of ChatCompletionSkill)- Inheritance
- Implements
Constructors
| Name | Description |
|---|---|
| ChatCompletionSkill(IEnumerable<InputFieldMappingEntry>, IEnumerable<OutputFieldMappingEntry>, Uri) |
Initializes a new instance of ChatCompletionSkill. |
Properties
| Name | Description |
|---|---|
| ApiKey |
API key for authenticating to the model. Both apiKey and authIdentity cannot be specified at the same time. |
| 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. |
| CommonModelParameters |
Common language model parameters that customers can tweak. If omitted, reasonable defaults will be applied. |
| 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. (Inherited from SearchIndexerSkill) |
| Description |
The description of the skill which describes the inputs, outputs, and usage of the skill. (Inherited from SearchIndexerSkill) |
| ExtraParameters |
Open-type dictionary for model-specific parameters that should be appended to the chat completions call. Follows Azure AI Foundry's extensibility pattern. To assign an object to the value of this property use FromObjectAsJson<T>(T, JsonSerializerOptions). To assign an already formatted json string to this property use FromString(String). Examples:
|
| ExtraParametersBehavior |
How extra parameters are handled by Azure AI Foundry. Default is 'error'. |
| Inputs |
Inputs of the skills could be a column in the source data set, or the output of an upstream skill. (Inherited from SearchIndexerSkill) |
| 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 '#'. (Inherited from SearchIndexerSkill) |
| 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. (Inherited from SearchIndexerSkill) |
| ResponseFormat |
Determines how the LLM should format its response. Defaults to 'text' response type. |
| Uri |
The url for the Web API. |
