Share via


SearchIndexerSkill Class

Definition

Base type for skills. Please note SearchIndexerSkill 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 AzureMachineLearningSkill, ChatCompletionSkill, WebApiSkill, AzureOpenAIEmbeddingSkill, CustomEntityLookupSkill, EntityRecognitionSkill, KeyPhraseExtractionSkill, LanguageDetectionSkill, MergeSkill, PiiDetectionSkill, SentimentSkill, SplitSkill, TextTranslationSkill, EntityLinkingSkill, ConditionalSkill, DocumentExtractionSkill, DocumentIntelligenceLayoutSkill, ShaperSkill, ImageAnalysisSkill, OcrSkill and VisionVectorizeSkill.

public class SearchIndexerSkill
public class SearchIndexerSkill : System.ClientModel.Primitives.IJsonModel<Azure.Search.Documents.Indexes.Models.SearchIndexerSkill>, System.ClientModel.Primitives.IPersistableModel<Azure.Search.Documents.Indexes.Models.SearchIndexerSkill>
type SearchIndexerSkill = class
type SearchIndexerSkill = class
    interface IJsonModel<SearchIndexerSkill>
    interface IPersistableModel<SearchIndexerSkill>
Public Class SearchIndexerSkill
Public Class SearchIndexerSkill
Implements IJsonModel(Of SearchIndexerSkill), IPersistableModel(Of SearchIndexerSkill)
Inheritance
SearchIndexerSkill
Derived
Implements

Properties

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.

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.

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.

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.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<SearchIndexerSkill>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<SearchIndexerSkill>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<SearchIndexerSkill>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<SearchIndexerSkill>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<SearchIndexerSkill>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to