SearchModelFactory.ContentUnderstandingSkill Method

Definition

A skill that leverages Azure AI Content Understanding to process and extract structured insights from documents, enabling enriched, searchable content for enhanced document indexing and retrieval.

public static Azure.Search.Documents.Indexes.Models.ContentUnderstandingSkill ContentUnderstandingSkill(string name = default, string description = default, string context = default, System.Collections.Generic.IEnumerable<Azure.Search.Documents.Indexes.Models.InputFieldMappingEntry> inputs = default, System.Collections.Generic.IEnumerable<Azure.Search.Documents.Indexes.Models.OutputFieldMappingEntry> outputs = default, System.Collections.Generic.IEnumerable<Azure.Search.Documents.Indexes.Models.ContentUnderstandingSkillExtractionOptions> extractionOptions = default, Azure.Search.Documents.Indexes.Models.ContentUnderstandingSkillChunkingProperties chunkingProperties = default);
static member ContentUnderstandingSkill : string * string * string * seq<Azure.Search.Documents.Indexes.Models.InputFieldMappingEntry> * seq<Azure.Search.Documents.Indexes.Models.OutputFieldMappingEntry> * seq<Azure.Search.Documents.Indexes.Models.ContentUnderstandingSkillExtractionOptions> * Azure.Search.Documents.Indexes.Models.ContentUnderstandingSkillChunkingProperties -> Azure.Search.Documents.Indexes.Models.ContentUnderstandingSkill
Public Shared Function ContentUnderstandingSkill (Optional name As String = Nothing, Optional description As String = Nothing, Optional context As String = Nothing, Optional inputs As IEnumerable(Of InputFieldMappingEntry) = Nothing, Optional outputs As IEnumerable(Of OutputFieldMappingEntry) = Nothing, Optional extractionOptions As IEnumerable(Of ContentUnderstandingSkillExtractionOptions) = Nothing, Optional chunkingProperties As ContentUnderstandingSkillChunkingProperties = Nothing) As ContentUnderstandingSkill

Parameters

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

description
String

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

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.

inputs
IEnumerable<InputFieldMappingEntry>

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

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

extractionOptions
IEnumerable<ContentUnderstandingSkillExtractionOptions>

Controls the cardinality of the content extracted from the document by the skill.

chunkingProperties
ContentUnderstandingSkillChunkingProperties

Controls the cardinality for chunking the content.

Returns

A new ContentUnderstandingSkill instance for mocking.

Applies to