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.WebApiSkill, System.ClientModel.Primitives.IJsonModel<Azure.Search.Documents.Indexes.Models.ChatCompletionSkill>, System.ClientModel.Primitives.IPersistableModel<Azure.Search.Documents.Indexes.Models.ChatCompletionSkill>type ChatCompletionSkill = class
inherit WebApiSkill
interface IJsonModel<ChatCompletionSkill>
interface IPersistableModel<ChatCompletionSkill>Public Class ChatCompletionSkill
Inherits WebApiSkill
Implements IJsonModel(Of ChatCompletionSkill), IPersistableModel(Of ChatCompletionSkill)- Inheritance
- Implements
Constructors
| ChatCompletionSkill(IEnumerable<InputFieldMappingEntry>, IEnumerable<OutputFieldMappingEntry>, String) |
Initializes a new instance of ChatCompletionSkill. |
Properties
| 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. Please note SearchIndexerDataIdentity is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include SearchIndexerDataNoneIdentity and SearchIndexerDataUserAssignedIdentity. (Inherited from WebApiSkill) |
| 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. (Inherited from WebApiSkill) |
| BatchSize |
The desired batch size which indicates number of documents. (Inherited from WebApiSkill) |
| 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) |
| DegreeOfParallelism |
If set, the number of parallel calls that can be made to the Web API. (Inherited from WebApiSkill) |
| 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. |
| ExtraParametersBehavior |
How extra parameters are handled by Azure AI Foundry. Default is 'error'. |
| HttpHeaders |
The headers required to make the http request. (Inherited from WebApiSkill) |
| HttpMethod |
The method for the http request. (Inherited from WebApiSkill) |
| 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 prefaced with the character "#" in debug sessions and error messages. (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. |
| Timeout |
The desired timeout for the request. Default is 30 seconds. (Inherited from WebApiSkill) |
| Uri |
The URI of the Web API providing the vectorizer. (Inherited from WebApiSkill) |
Methods
| JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) |
