Skillsets - Get

Reference

Service:: Search Service

API Version:: 2024-11-01-preview

Retrieves a skillset in a search service.

GET {endpoint}/skillsets('{skillsetName}')?api-version=2024-11-01-preview

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string	The endpoint URL of the search service.
skillsetName	path	True	string	The name of the skillset to retrieve.
api-version	query	True	string	Client Api Version.

Request Header

Name	Required	Type	Description
x-ms-client-request-id		string uuid	The tracking ID sent with the request to help with debugging.

Responses

Name	Type	Description
200 OK	SearchIndexerSkillset	The skillset is successfully returned.
Other Status Codes	ErrorResponse	Error response.

Examples

SearchServiceGetSkillset

Sample request

HTTP

GET https://previewexampleservice.search.windows.net/skillsets('myskillset')?api-version=2024-11-01-preview

Sample response

Status code:: 200

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "myskillset",
  "description": "Skillset for extracting entities and more",
  "skills": [
    {
      "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill",
      "name": "skill2",
      "context": "/document",
      "inputs": [
        {
          "name": "text",
          "source": "/document/content",
          "inputs": []
        },
        {
          "name": "countryHint",
          "source": "/document/countryHint",
          "inputs": []
        }
      ],
      "outputs": [
        {
          "name": "languageCode",
          "targetName": "languageCode"
        }
      ]
    },
    {
      "@odata.type": "#Microsoft.Skills.Text.SplitSkill",
      "name": "skill3",
      "context": "/document",
      "defaultLanguageCode": "en",
      "textSplitMode": "pages",
      "maximumPageLength": 4000,
      "pageOverlapLength": 0,
      "maximumPagesToTake": 0,
      "unit": "azureOpenAITokens",
      "inputs": [
        {
          "name": "text",
          "source": "/document/content",
          "inputs": []
        },
        {
          "name": "languageCode",
          "source": "/document/languageCode",
          "inputs": []
        }
      ],
      "outputs": [
        {
          "name": "textItems",
          "targetName": "pages"
        }
      ],
      "azureOpenAITokenizerParameters": {
        "encoderModelName": "cl100k_base",
        "allowedSpecialTokens": [
          "[START]",
          "[END]"
        ]
      }
    },
    {
      "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill",
      "name": "skill4",
      "context": "/document/pages/*",
      "defaultLanguageCode": "en",
      "inputs": [
        {
          "name": "text",
          "source": "/document/content",
          "inputs": []
        },
        {
          "name": "languageCode",
          "source": "/document/languageCode",
          "inputs": []
        }
      ],
      "outputs": [
        {
          "name": "keyPhrases",
          "targetName": "keyPhrases"
        }
      ]
    },
    {
      "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill",
      "name": "skill5",
      "context": "/document",
      "uri": "https://contoso.example.org/",
      "httpMethod": "POST",
      "timeout": "PT5S",
      "batchSize": 1000,
      "inputs": [
        {
          "name": "text",
          "source": "/document/content",
          "inputs": []
        },
        {
          "name": "languageCode",
          "source": "/document/languageCode",
          "inputs": []
        }
      ],
      "outputs": [
        {
          "name": "customresult",
          "targetName": "result"
        }
      ],
      "httpHeaders": {}
    },
    {
      "@odata.type": "#Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill",
      "name": "docIntelligenceLayoutSkill",
      "context": "/document",
      "outputMode": "oneToMany",
      "markdownHeaderDepth": "h3",
      "inputs": [
        {
          "name": "file_data",
          "source": "/document/content",
          "inputs": []
        }
      ],
      "outputs": [
        {
          "name": "markdown_document",
          "targetName": "markdown_document"
        }
      ]
    }
  ],
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  }
}

Definitions

Name	Description
AIServicesAccountIdentity	The multi-region account of an Azure AI service resource that's attached to a skillset.
AIServicesAccountKey	The account key of an Azure AI service resource that's attached to a skillset, to be used with the resource's subdomain.
AmlSkill	The AML skill allows you to extend AI enrichment with a custom Azure Machine Learning (AML) model. Once an AML model is trained and deployed, an AML skill integrates it into AI enrichment.
AzureActiveDirectoryApplicationCredentials	Credentials of a registered application created for your search service, used for authenticated access to the encryption keys stored in Azure Key Vault.
AzureOpenAIEmbeddingSkill	Allows you to generate a vector embedding for a given text input using the Azure OpenAI resource.
AzureOpenAIModelName	The Azure Open AI model name that will be called.
AzureOpenAITokenizerParameters
CognitiveServicesAccountKey	The multi-region account key of an Azure AI service resource that's attached to a skillset.
ConditionalSkill	A skill that enables scenarios that require a Boolean operation to determine the data to assign to an output.
CustomEntity	An object that contains information about the matches that were found, and related metadata.
CustomEntityAlias	A complex object that can be used to specify alternative spellings or synonyms to the root entity name.
CustomEntityLookupSkill	A skill looks for text from a custom, user-defined list of words and phrases.
CustomEntityLookupSkillLanguage	The language codes supported for input text by CustomEntityLookupSkill.
DefaultCognitiveServicesAccount	An empty object that represents the default Azure AI service resource for a skillset.
DocumentExtractionSkill	A skill that extracts content from a file within the enrichment pipeline.
DocumentIntelligenceLayoutSkill	A skill that extracts content and layout information (as markdown), via Azure AI Services, from files within the enrichment pipeline.
DocumentIntelligenceLayoutSkillMarkdownHeaderDepth	The depth of headers in the markdown output. Default is h6.
DocumentIntelligenceLayoutSkillOutputMode	Controls the cardinality of the output produced by the skill. Default is 'oneToMany'
EntityCategory	A string indicating what entity categories to return.
EntityLinkingSkill	Using the Text Analytics API, extracts linked entities from text.
EntityRecognitionSkill	This skill is deprecated. Use the V3.EntityRecognitionSkill instead.
EntityRecognitionSkillLanguage	Deprecated. The language codes supported for input text by EntityRecognitionSkill.
EntityRecognitionSkillV3	Using the Text Analytics API, extracts entities of different types from text.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ImageAnalysisSkill	A skill that analyzes image files. It extracts a rich set of visual features based on the image content.
ImageAnalysisSkillLanguage	The language codes supported for input by ImageAnalysisSkill.
ImageDetail	A string indicating which domain-specific details to return.
IndexProjectionMode	Defines behavior of the index projections in relation to the rest of the indexer.
InputFieldMappingEntry	Input field mapping for a skill.
KeyPhraseExtractionSkill	A skill that uses text analytics for key phrase extraction.
KeyPhraseExtractionSkillLanguage	The language codes supported for input text by KeyPhraseExtractionSkill.
LanguageDetectionSkill	A skill that detects the language of input text and reports a single language code for every document submitted on the request. The language code is paired with a score indicating the confidence of the analysis.
LineEnding	Defines the sequence of characters to use between the lines of text recognized by the OCR skill. The default value is "space".
MergeSkill	A skill for merging two or more strings into a single unified string, with an optional user-defined delimiter separating each component part.
OcrSkill	A skill that extracts text from image files.
OcrSkillLanguage	The language codes supported for input by OcrSkill.
OutputFieldMappingEntry	Output field mapping for a skill.
PIIDetectionSkill	Using the Text Analytics API, extracts personal information from an input text and gives you the option of masking it.
PIIDetectionSkillMaskingMode	A string indicating what maskingMode to use to mask the personal information detected in the input text.
SearchIndexerDataNoneIdentity	Clears the identity property of a datasource.
SearchIndexerDataUserAssignedIdentity	Specifies the identity for a datasource to use.
SearchIndexerIndexProjections	Definition of additional projections to secondary search indexes.
SearchIndexerIndexProjectionSelector	Description for what data to store in the designated search index.
SearchIndexerIndexProjectionsParameters	A dictionary of index projection-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type.
SearchIndexerKnowledgeStore	Definition of additional projections to azure blob, table, or files, of enriched data.
SearchIndexerKnowledgeStoreFileProjectionSelector	Projection definition for what data to store in Azure Files.
SearchIndexerKnowledgeStoreObjectProjectionSelector	Projection definition for what data to store in Azure Blob.
SearchIndexerKnowledgeStoreParameters	A dictionary of knowledge store-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type.
SearchIndexerKnowledgeStoreProjection	Container object for various projection selectors.
SearchIndexerKnowledgeStoreTableProjectionSelector	Description for what data to store in Azure Tables.
SearchIndexerSkillset	A list of skills.
SearchResourceEncryptionKey	A customer-managed encryption key in Azure Key Vault. Keys that you create and manage can be used to encrypt or decrypt data-at-rest, such as indexes and synonym maps.
SentimentSkill	This skill is deprecated. Use the V3.SentimentSkill instead.
SentimentSkillLanguage	Deprecated. The language codes supported for input text by SentimentSkill.
SentimentSkillV3	Using the Text Analytics API, evaluates unstructured text and for each record, provides sentiment labels (such as "negative", "neutral" and "positive") based on the highest confidence score found by the service at a sentence and document-level.
ShaperSkill	A skill for reshaping the outputs. It creates a complex type to support composite fields (also known as multipart fields).
SplitSkill	A skill to split a string into chunks of text.
SplitSkillEncoderModelName	Only applies if the unit is set to azureOpenAITokens. Options include 'R50k_base', 'P50k_base', 'P50k_edit' and 'CL100k_base'. The default value is 'CL100k_base'.
SplitSkillLanguage	The language codes supported for input text by SplitSkill.
SplitSkillUnit	A value indicating which unit to use.
TextSplitMode	A value indicating which split mode to perform.
TextTranslationSkill	A skill to translate text from one language to another.
TextTranslationSkillLanguage	The language codes supported for input text by TextTranslationSkill.
VisionVectorizeSkill	Allows you to generate a vector embedding for a given image or text input using the Azure AI Services Vision Vectorize API.
VisualFeature	The strings indicating what visual feature types to return.
WebApiSkill	A skill that can call a Web API endpoint, allowing you to extend a skillset by having it call your custom code.

AIServicesAccountIdentity

Object

The multi-region account of an Azure AI service resource that's attached to a skillset.

Name	Type	Description
@odata.type	string: #Microsoft.Azure.Search.AIServicesByIdentity	A URI fragment specifying the type of Azure AI service resource attached to a skillset.
description	string	Description of the Azure AI service resource attached to a skillset.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	The user-assigned managed identity used for connections to AI Service. If not specified, the system-assigned managed identity is used. On updates to the skillset, if the identity is unspecified, the value remains unchanged. If set to "none", the value of this property is cleared.
subdomainUrl	string	The subdomain url for the corresponding AI Service.

AIServicesAccountKey

Object

The account key of an Azure AI service resource that's attached to a skillset, to be used with the resource's subdomain.

Name	Type	Description
@odata.type	string: #Microsoft.Azure.Search.AIServicesByKey	A URI fragment specifying the type of Azure AI service resource attached to a skillset.
description	string	Description of the Azure AI service resource attached to a skillset.
key	string	The key used to provision the Azure AI service resource attached to a skillset.
subdomainUrl	string	The subdomain url for the corresponding AI Service.

AmlSkill

Object

The AML skill allows you to extend AI enrichment with a custom Azure Machine Learning (AML) model. Once an AML model is trained and deployed, an AML skill integrates it into AI enrichment.

Name	Type	Description
@odata.type	string: #Microsoft.Skills.Custom.AmlSkill	A URI fragment specifying the type of 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.
degreeOfParallelism	integer	(Optional) When specified, indicates the number of calls the indexer will make in parallel to the endpoint you have provided. You can decrease this value if your endpoint is failing under too high of a request load, or raise it if your endpoint is able to accept more requests and you would like an increase in the performance of the indexer. If not set, a default value of 5 is used. The degreeOfParallelism can be set to a maximum of 10 and a minimum of 1.
description	string	The description of the skill which describes the inputs, outputs, and usage of the skill.
inputs	InputFieldMappingEntry[]	Inputs of the skills could be a column in the source data set, or the output of an upstream skill.
key	string	(Required for key authentication) The key for the AML service.
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 '#'.
outputs	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.
region	string	(Optional for token authentication). The region the AML service is deployed in.
resourceId	string	(Required for token authentication). The Azure Resource Manager resource ID of the AML service. It should be in the format subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.MachineLearningServices/workspaces/{workspace-name}/services/{service_name}.
timeout	string	(Optional) When specified, indicates the timeout for the http client making the API call.
uri	string	(Required for no authentication or key authentication) The scoring URI of the AML service to which the JSON payload will be sent. Only the https URI scheme is allowed.

AzureActiveDirectoryApplicationCredentials

Object

Credentials of a registered application created for your search service, used for authenticated access to the encryption keys stored in Azure Key Vault.

Name	Type	Description
applicationId	string	An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application.
applicationSecret	string	The authentication key of the specified AAD application.

AzureOpenAIEmbeddingSkill

Object

Allows you to generate a vector embedding for a given text input using the Azure OpenAI resource.

Name	Type	Description
@odata.type	string: #Microsoft.Skills.Text.AzureOpenAIEmbeddingSkill	A URI fragment specifying the type of skill.
apiKey	string	API key of the designated Azure OpenAI resource.
authIdentity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	The user-assigned managed identity used for outbound connections.
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.
deploymentId	string	ID of the Azure OpenAI model deployment on the designated resource.
description	string	The description of the skill which describes the inputs, outputs, and usage of the skill.
dimensions	integer	The number of dimensions the resulting output embeddings should have. Only supported in text-embedding-3 and later models.
inputs	InputFieldMappingEntry[]	Inputs of the skills could be a column in the source data set, or the output of an upstream skill.
modelName	AzureOpenAIModelName	The name of the embedding model that is deployed at the provided deploymentId path.
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 '#'.
outputs	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.
resourceUri	string	The resource URI of the Azure OpenAI resource.

AzureOpenAIModelName

Enumeration

The Azure Open AI model name that will be called.

Value	Description
text-embedding-3-large
text-embedding-3-small
text-embedding-ada-002

AzureOpenAITokenizerParameters

Object

Name	Type	Description
allowedSpecialTokens	string[]	(Optional) Only applies if the unit is set to azureOpenAITokens. This parameter defines a collection of special tokens that are permitted within the tokenization process.
encoderModelName	SplitSkillEncoderModelName	Only applies if the unit is set to azureOpenAITokens. Options include 'R50k_base', 'P50k_base', 'P50k_edit' and 'CL100k_base'. The default value is 'CL100k_base'.

CognitiveServicesAccountKey

Object

The multi-region account key of an Azure AI service resource that's attached to a skillset.

Name	Type	Description
@odata.type	string: #Microsoft.Azure.Search.CognitiveServicesByKey	A URI fragment specifying the type of Azure AI service resource attached to a skillset.
description	string	Description of the Azure AI service resource attached to a skillset.
key	string	The key used to provision the Azure AI service resource attached to a skillset.

ConditionalSkill

Object

A skill that enables scenarios that require a Boolean operation to determine the data to assign to an output.

Name	Type	Description
@odata.type	string: #Microsoft.Skills.Util.ConditionalSkill	A URI fragment specifying the type of 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.
description	string	The description of the skill which describes the inputs, outputs, and usage of the skill.
inputs	InputFieldMappingEntry[]	Inputs of the skills could be a column in the source data set, or the output of an upstream skill.
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 '#'.
outputs	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.

CustomEntity

Object

An object that contains information about the matches that were found, and related metadata.

Name	Type	Description
accentSensitive	boolean	Defaults to false. Boolean value denoting whether comparisons with the entity name should be sensitive to accent.
aliases	CustomEntityAlias[]	An array of complex objects that can be used to specify alternative spellings or synonyms to the root entity name.
caseSensitive	boolean	Defaults to false. Boolean value denoting whether comparisons with the entity name should be sensitive to character casing. Sample case insensitive matches of "Microsoft" could be: microsoft, microSoft, MICROSOFT.
defaultAccentSensitive	boolean	Changes the default accent sensitivity value for this entity. It be used to change the default value of all aliases accentSensitive values.
defaultCaseSensitive	boolean	Changes the default case sensitivity value for this entity. It be used to change the default value of all aliases caseSensitive values.
defaultFuzzyEditDistance	integer	Changes the default fuzzy edit distance value for this entity. It can be used to change the default value of all aliases fuzzyEditDistance values.
description	string	This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output.
fuzzyEditDistance	integer	Defaults to 0. Maximum value of 5. Denotes the acceptable number of divergent characters that would still constitute a match with the entity name. The smallest possible fuzziness for any given match is returned. For instance, if the edit distance is set to 3, "Windows10" would still match "Windows", "Windows10" and "Windows 7". When case sensitivity is set to false, case differences do NOT count towards fuzziness tolerance, but otherwise do.
id	string	This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output.
name	string	The top-level entity descriptor. Matches in the skill output will be grouped by this name, and it should represent the "normalized" form of the text being found.
subtype	string	This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output.
type	string	This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output.

CustomEntityAlias

Object

A complex object that can be used to specify alternative spellings or synonyms to the root entity name.

Name	Type	Description
accentSensitive	boolean	Determine if the alias is accent sensitive.
caseSensitive	boolean	Determine if the alias is case sensitive.
fuzzyEditDistance	integer	Determine the fuzzy edit distance of the alias.
text	string	The text of the alias.

CustomEntityLookupSkill

Object

A skill looks for text from a custom, user-defined list of words and phrases.

Name	Type	Description
@odata.type	string: #Microsoft.Skills.Text.CustomEntityLookupSkill	A URI fragment specifying the type of 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.
defaultLanguageCode	CustomEntityLookupSkillLanguage	A value indicating which language code to use. Default is `en`.
description	string	The description of the skill which describes the inputs, outputs, and usage of the skill.
entitiesDefinitionUri	string	Path to a JSON or CSV file containing all the target text to match against. This entity definition is read at the beginning of an indexer run. Any updates to this file during an indexer run will not take effect until subsequent runs. This config must be accessible over HTTPS.
globalDefaultAccentSensitive	boolean	A global flag for AccentSensitive. If AccentSensitive is not set in CustomEntity, this value will be the default value.
globalDefaultCaseSensitive	boolean	A global flag for CaseSensitive. If CaseSensitive is not set in CustomEntity, this value will be the default value.
globalDefaultFuzzyEditDistance	integer	A global flag for FuzzyEditDistance. If FuzzyEditDistance is not set in CustomEntity, this value will be the default value.
inlineEntitiesDefinition	CustomEntity[]	The inline CustomEntity definition.
inputs	InputFieldMappingEntry[]	Inputs of the skills could be a column in the source data set, or the output of an upstream skill.
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 '#'.
outputs	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.

CustomEntityLookupSkillLanguage

Enumeration

The language codes supported for input text by CustomEntityLookupSkill.

Value	Description
da	Danish
de	German
en	English
es	Spanish
fi	Finnish
fr	French
it	Italian
ko	Korean
pt	Portuguese

DefaultCognitiveServicesAccount

Object

An empty object that represents the default Azure AI service resource for a skillset.

Name	Type	Description
@odata.type	string: #Microsoft.Azure.Search.DefaultCognitiveServices	A URI fragment specifying the type of Azure AI service resource attached to a skillset.
description	string	Description of the Azure AI service resource attached to a skillset.

DocumentExtractionSkill

Object

A skill that extracts content from a file within the enrichment pipeline.

Name	Type	Description
@odata.type	string: #Microsoft.Skills.Util.DocumentExtractionSkill	A URI fragment specifying the type of skill.
configuration	object	A dictionary of configurations for 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.
dataToExtract	string	The type of data to be extracted for the skill. Will be set to 'contentAndMetadata' if not defined.
description	string	The description of the skill which describes the inputs, outputs, and usage of the skill.
inputs	InputFieldMappingEntry[]	Inputs of the skills could be a column in the source data set, or the output of an upstream skill.
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 '#'.
outputs	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.
parsingMode	string	The parsingMode for the skill. Will be set to 'default' if not defined.

DocumentIntelligenceLayoutSkill

Object

A skill that extracts content and layout information (as markdown), via Azure AI Services, from files within the enrichment pipeline.

Name	Type	Default value	Description
@odata.type	string: #Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill		A URI fragment specifying the type of 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.
description	string		The description of the skill which describes the inputs, outputs, and usage of the skill.
inputs	InputFieldMappingEntry[]		Inputs of the skills could be a column in the source data set, or the output of an upstream skill.
markdownHeaderDepth	DocumentIntelligenceLayoutSkillMarkdownHeaderDepth	h6	The depth of headers in the markdown output. Default is h6.
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 '#'.
outputMode	DocumentIntelligenceLayoutSkillOutputMode	oneToMany	Controls the cardinality of the output produced by the skill. Default is 'oneToMany'.
outputs	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.

DocumentIntelligenceLayoutSkillMarkdownHeaderDepth

Enumeration

The depth of headers in the markdown output. Default is h6.

Value	Description
h1	Header level 1.
h2	Header level 2.
h3	Header level 3.
h4	Header level 4.
h5	Header level 5.
h6	Header level 6.

DocumentIntelligenceLayoutSkillOutputMode

Enumeration

Controls the cardinality of the output produced by the skill. Default is 'oneToMany'

Value	Description
oneToMany	Specify the deepest markdown header section to parse.

EntityCategory

Enumeration

A string indicating what entity categories to return.

Value	Description
datetime	Entities describing a date and time.
email	Entities describing an email address.
location	Entities describing a physical location.
organization	Entities describing an organization.
person	Entities describing a person.
quantity	Entities describing a quantity.
url	Entities describing a URL.

EntityLinkingSkill

Object

Using the Text Analytics API, extracts linked entities from text.

Name	Type	Description
@odata.type	string: #Microsoft.Skills.Text.V3.EntityLinkingSkill	A URI fragment specifying the type of 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.
defaultLanguageCode	string	A value indicating which language code to use. Default is `en`.
description	string	The description of the skill which describes the inputs, outputs, and usage of the skill.
inputs	InputFieldMappingEntry[]	Inputs of the skills could be a column in the source data set, or the output of an upstream skill.
minimumPrecision	number	A value between 0 and 1 that be used to only include entities whose confidence score is greater than the value specified. If not set (default), or if explicitly set to null, all entities will be included.
modelVersion	string	The version of the model to use when calling the Text Analytics service. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary.
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 '#'.
outputs	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.

EntityRecognitionSkill

Object

This skill is deprecated. Use the V3.EntityRecognitionSkill instead.

Name	Type	Description
@odata.type	string: #Microsoft.Skills.Text.EntityRecognitionSkill	A URI fragment specifying the type of skill.
categories	EntityCategory[]	A list of entity categories that should be extracted.
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.
defaultLanguageCode	EntityRecognitionSkillLanguage	A value indicating which language code to use. Default is `en`.
description	string	The description of the skill which describes the inputs, outputs, and usage of the skill.
includeTypelessEntities	boolean	Determines whether or not to include entities which are well known but don't conform to a pre-defined type. If this configuration is not set (default), set to null or set to false, entities which don't conform to one of the pre-defined types will not be surfaced.
inputs	InputFieldMappingEntry[]	Inputs of the skills could be a column in the source data set, or the output of an upstream skill.
minimumPrecision	number	A value between 0 and 1 that be used to only include entities whose confidence score is greater than the value specified. If not set (default), or if explicitly set to null, all entities will be included.
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 '#'.
outputs	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.

EntityRecognitionSkillLanguage

Enumeration

Deprecated. The language codes supported for input text by EntityRecognitionSkill.

Value	Description
ar	Arabic
cs	Czech
da	Danish
de	German
el	Greek
en	English
es	Spanish
fi	Finnish
fr	French
hu	Hungarian
it	Italian
ja	Japanese
ko	Korean
nl	Dutch
no	Norwegian (Bokmaal)
pl	Polish
pt-BR	Portuguese (Brazil)
pt-PT	Portuguese (Portugal)
ru	Russian
sv	Swedish
tr	Turkish
zh-Hans	Chinese-Simplified
zh-Hant	Chinese-Traditional

EntityRecognitionSkillV3

Object

Using the Text Analytics API, extracts entities of different types from text.

Name	Type	Description
@odata.type	string: #Microsoft.Skills.Text.V3.EntityRecognitionSkill	A URI fragment specifying the type of skill.
categories	string[]	A list of entity categories that should be extracted.
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.
defaultLanguageCode	string	A value indicating which language code to use. Default is `en`.
description	string	The description of the skill which describes the inputs, outputs, and usage of the skill.
inputs	InputFieldMappingEntry[]	Inputs of the skills could be a column in the source data set, or the output of an upstream skill.
minimumPrecision	number	A value between 0 and 1 that be used to only include entities whose confidence score is greater than the value specified. If not set (default), or if explicitly set to null, all entities will be included.
modelVersion	string	The version of the model to use when calling the Text Analytics API. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary.
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 '#'.
outputs	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.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

ImageAnalysisSkill

Object

A skill that analyzes image files. It extracts a rich set of visual features based on the image content.

Name	Type	Description
@odata.type	string: #Microsoft.Skills.Vision.ImageAnalysisSkill	A URI fragment specifying the type of 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.
defaultLanguageCode	ImageAnalysisSkillLanguage	A value indicating which language code to use. Default is `en`.
description	string	The description of the skill which describes the inputs, outputs, and usage of the skill.
details	ImageDetail[]	A string indicating which domain-specific details to return.
inputs	InputFieldMappingEntry[]	Inputs of the skills could be a column in the source data set, or the output of an upstream skill.
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 '#'.
outputs	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.
visualFeatures	VisualFeature[]	A list of visual features.

ImageAnalysisSkillLanguage

Enumeration

The language codes supported for input by ImageAnalysisSkill.

Value	Description
ar	Arabic
az	Azerbaijani
bg	Bulgarian
bs	Bosnian Latin
ca	Catalan
cs	Czech
cy	Welsh
da	Danish
de	German
el	Greek
en	English
es	Spanish
et	Estonian
eu	Basque
fi	Finnish
fr	French
ga	Irish
gl	Galician
he	Hebrew
hi	Hindi
hr	Croatian
hu	Hungarian
id	Indonesian
it	Italian
ja	Japanese
kk	Kazakh
ko	Korean
lt	Lithuanian
lv	Latvian
mk	Macedonian
ms	Malay Malaysia
nb	Norwegian (Bokmal)
nl	Dutch
pl	Polish
prs	Dari
pt	Portuguese-Portugal
pt-BR	Portuguese-Brazil
pt-PT	Portuguese-Portugal
ro	Romanian
ru	Russian
sk	Slovak
sl	Slovenian
sr-Cyrl	Serbian - Cyrillic RS
sr-Latn	Serbian - Latin RS
sv	Swedish
th	Thai
tr	Turkish
uk	Ukrainian
vi	Vietnamese
zh	Chinese Simplified
zh-Hans	Chinese Simplified
zh-Hant	Chinese Traditional

ImageDetail

Enumeration

A string indicating which domain-specific details to return.

Value	Description
celebrities	Details recognized as celebrities.
landmarks	Details recognized as landmarks.

IndexProjectionMode

Enumeration

Defines behavior of the index projections in relation to the rest of the indexer.

Value	Description
includeIndexingParentDocuments	The source document will be written into the indexer's target index. This is the default pattern.
skipIndexingParentDocuments	The source document will be skipped from writing into the indexer's target index.

InputFieldMappingEntry

Object

Input field mapping for a skill.

Name	Type	Description
inputs	InputFieldMappingEntry[]	The recursive inputs used when creating a complex type.
name	string	The name of the input.
source	string	The source of the input.
sourceContext	string	The source context used for selecting recursive inputs.

KeyPhraseExtractionSkill

Object

A skill that uses text analytics for key phrase extraction.

Name	Type	Description
@odata.type	string: #Microsoft.Skills.Text.KeyPhraseExtractionSkill	A URI fragment specifying the type of 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.
defaultLanguageCode	KeyPhraseExtractionSkillLanguage	A value indicating which language code to use. Default is `en`.
description	string	The description of the skill which describes the inputs, outputs, and usage of the skill.
inputs	InputFieldMappingEntry[]	Inputs of the skills could be a column in the source data set, or the output of an upstream skill.
maxKeyPhraseCount	integer	A number indicating how many key phrases to return. If absent, all identified key phrases will be returned.
modelVersion	string	The version of the model to use when calling the Text Analytics service. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary.
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 '#'.
outputs	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.

KeyPhraseExtractionSkillLanguage

Enumeration

The language codes supported for input text by KeyPhraseExtractionSkill.

Value	Description
da	Danish
de	German
en	English
es	Spanish
fi	Finnish
fr	French
it	Italian
ja	Japanese
ko	Korean
nl	Dutch
no	Norwegian (Bokmaal)
pl	Polish
pt-BR	Portuguese (Brazil)
pt-PT	Portuguese (Portugal)
ru	Russian
sv	Swedish

LanguageDetectionSkill

Object

A skill that detects the language of input text and reports a single language code for every document submitted on the request. The language code is paired with a score indicating the confidence of the analysis.

Name	Type	Description
@odata.type	string: #Microsoft.Skills.Text.LanguageDetectionSkill	A URI fragment specifying the type of 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.
defaultCountryHint	string	A country code to use as a hint to the language detection model if it cannot disambiguate the language.
description	string	The description of the skill which describes the inputs, outputs, and usage of the skill.
inputs	InputFieldMappingEntry[]	Inputs of the skills could be a column in the source data set, or the output of an upstream skill.
modelVersion	string	The version of the model to use when calling the Text Analytics service. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary.
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 '#'.
outputs	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.

LineEnding

Enumeration

Defines the sequence of characters to use between the lines of text recognized by the OCR skill. The default value is "space".

Value	Description
carriageReturn	Lines are separated by a carriage return ('\r') character.
carriageReturnLineFeed	Lines are separated by a carriage return and a line feed ('\r\n') character.
lineFeed	Lines are separated by a single line feed ('\n') character.
space	Lines are separated by a single space character.

MergeSkill

Object

A skill for merging two or more strings into a single unified string, with an optional user-defined delimiter separating each component part.

Name	Type	Description
@odata.type	string: #Microsoft.Skills.Text.MergeSkill	A URI fragment specifying the type of 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.
description	string	The description of the skill which describes the inputs, outputs, and usage of the skill.
inputs	InputFieldMappingEntry[]	Inputs of the skills could be a column in the source data set, or the output of an upstream skill.
insertPostTag	string	The tag indicates the end of the merged text. By default, the tag is an empty space.
insertPreTag	string	The tag indicates the start of the merged text. By default, the tag is an empty space.
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 '#'.
outputs	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.

OcrSkill

Object

A skill that extracts text from image files.

Name	Type	Default value	Description
@odata.type	string: #Microsoft.Skills.Vision.OcrSkill		A URI fragment specifying the type of 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.
defaultLanguageCode	OcrSkillLanguage		A value indicating which language code to use. Default is `en`.
description	string		The description of the skill which describes the inputs, outputs, and usage of the skill.
detectOrientation	boolean	False	A value indicating to turn orientation detection on or not. Default is false.
inputs	InputFieldMappingEntry[]		Inputs of the skills could be a column in the source data set, or the output of an upstream skill.
lineEnding	LineEnding		Defines the sequence of characters to use between the lines of text recognized by the OCR skill. The default value is "space".
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 '#'.
outputs	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.

OcrSkillLanguage

Enumeration

The language codes supported for input by OcrSkill.

Value	Description
Jns	Jaunsari (Devanagiri)
af	Afrikaans
anp	Angika (Devanagiri)
ar	Arabic
ast	Asturian
awa	Awadhi-Hindi (Devanagiri)
az	Azerbaijani (Latin)
be	Belarusian (Cyrillic and Latin)
be-cyrl	Belarusian (Cyrillic)
be-latn	Belarusian (Latin)
bfy	Bagheli
bfz	Mahasu Pahari (Devanagiri)
bg	Bulgarian
bgc	Haryanvi
bho	Bhojpuri-Hindi (Devanagiri)
bi	Bislama
bns	Bundeli
br	Breton
bra	Brajbha
brx	Bodo (Devanagiri)
bs	Bosnian Latin
bua	Buryat (Cyrillic)
ca	Catalan
ceb	Cebuano
ch	Chamorro
cnr-cyrl	Montenegrin (Cyrillic)
cnr-latn	Montenegrin (Latin)
co	Corsican
crh	Crimean Tatar (Latin)
cs	Czech
csb	Kashubian
cy	Welsh
da	Danish
de	German
dhi	Dhimal (Devanagiri)
doi	Dogri (Devanagiri)
dsb	Lower Sorbian
el	Greek
en	English
es	Spanish
et	Estonian
eu	Basque
fa	Persian
fi	Finnish
fil	Filipino
fj	Fijian
fo	Faroese
fr	French
fur	Frulian
fy	Western Frisian
ga	Irish
gag	Gagauz (Latin)
gd	Scottish Gaelic
gil	Gilbertese
gl	Galician
gon	Gondi (Devanagiri)
gv	Manx
gvr	Gurung (Devanagiri)
haw	Hawaiian
hi	Hindi
hlb	Halbi (Devanagiri)
hne	Chhattisgarhi (Devanagiri)
hni	Hani
hoc	Ho (Devanagiri)
hr	Croatian
hsb	Upper Sorbian
ht	Haitian Creole
hu	Hungarian
ia	Interlingua
id	Indonesian
is	Icelandic
it	Italian
iu	Inuktitut (Latin)
ja	Japanese
jv	Javanese
kaa	Kara-Kalpak (Latin)
kaa-cyrl	Kara-Kalpak (Cyrillic)
kac	Kachin (Latin)
kea	Kabuverdianu
kfq	Korku
kha	Khasi
kk-cyrl	Kazakh (Cyrillic)
kk-latn	Kazakh (Latin)
kl	Greenlandic
klr	Khaling
kmj	Malto (Devanagiri)
ko	Korean
kos	Kosraean
kpy	Koryak
krc	Karachay-Balkar
kru	Kurukh (Devanagiri)
ksh	Ripuarian
ku-arab	Kurdish (Arabic)
ku-latn	Kurdish (Latin)
kum	Kumyk (Cyrillic)
kw	Cornish
ky	Kyrgyz (Cyrillic)
la	Latin
lb	Luxembourgish
lkt	Lakota
lt	Lithuanian
mi	Maori
mn	Mongolian (Cyrillic)
mr	Marathi
ms	Malay (Latin)
mt	Maltese
mww	Hmong Daw (Latin)
myv	Erzya (Cyrillic)
nap	Neapolitan
nb	Norwegian
ne	Nepali
niu	Niuean
nl	Dutch
no	Norwegian
nog	Nogay
oc	Occitan
os	Ossetic
pa	Punjabi (Arabic)
pl	Polish
prs	Dari
ps	Pashto
pt	Portuguese
quc	K'iche'
rab	Chamling
rm	Romansh
ro	Romanian
ru	Russian
sa	Sanskrit (Devanagiri)
sat	Santali (Devanagiri)
sck	Sadri (Devanagiri)
sco	Scots
sk	Slovak
sl	Slovenian
sm	Samoan (Latin)
sma	Southern Sami
sme	Northern Sami (Latin)
smj	Lule Sami
smn	Inari Sami
sms	Skolt Sami
so	Somali (Arabic)
sq	Albanian
sr	Serbian (Latin)
sr-Cyrl	Serbian (Cyrillic)
sr-Latn	Serbian (Latin)
srx	Sirmauri (Devanagiri)
sv	Swedish
sw	Swahili (Latin)
tet	Tetum
tg	Tajik (Cyrillic)
thf	Thangmi
tk	Turkmen (Latin)
to	Tongan
tr	Turkish
tt	Tatar (Latin)
tyv	Tuvan
ug	Uyghur (Arabic)
unk	Unknown (All)
ur	Urdu
uz	Uzbek (Latin)
uz-arab	Uzbek (Arabic)
uz-cyrl	Uzbek (Cyrillic)
vo	Volapük
wae	Walser
xnr	Kangri (Devanagiri)
xsr	Sherpa (Devanagiri)
yua	Yucatec Maya
za	Zhuang
zh-Hans	Chinese Simplified
zh-Hant	Chinese Traditional
zu	Zulu

OutputFieldMappingEntry

Object

Output field mapping for a skill.

Name	Type	Description
name	string	The name of the output defined by the skill.
targetName	string	The target name of the output. It is optional and default to name.

PIIDetectionSkill

Object

Using the Text Analytics API, extracts personal information from an input text and gives you the option of masking it.

Name	Type	Description
@odata.type	string: #Microsoft.Skills.Text.PIIDetectionSkill	A URI fragment specifying the type of 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.
defaultLanguageCode	string	A value indicating which language code to use. Default is `en`.
description	string	The description of the skill which describes the inputs, outputs, and usage of the skill.
domain	string	If specified, will set the PII domain to include only a subset of the entity categories. Possible values include: 'phi', 'none'. Default is 'none'.
inputs	InputFieldMappingEntry[]	Inputs of the skills could be a column in the source data set, or the output of an upstream skill.
maskingCharacter	string	The character used to mask the text if the maskingMode parameter is set to replace. Default is '*'.
maskingMode	PIIDetectionSkillMaskingMode	A parameter that provides various ways to mask the personal information detected in the input text. Default is 'none'.
minimumPrecision	number	A value between 0 and 1 that be used to only include entities whose confidence score is greater than the value specified. If not set (default), or if explicitly set to null, all entities will be included.
modelVersion	string	The version of the model to use when calling the Text Analytics service. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary.
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 '#'.
outputs	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.
piiCategories	string[]	A list of PII entity categories that should be extracted and masked.

PIIDetectionSkillMaskingMode

Enumeration

A string indicating what maskingMode to use to mask the personal information detected in the input text.

Value	Description
none	No masking occurs and the maskedText output will not be returned.
replace	Replaces the detected entities with the character given in the maskingCharacter parameter. The character will be repeated to the length of the detected entity so that the offsets will correctly correspond to both the input text as well as the output maskedText.

SearchIndexerDataNoneIdentity

Object

Clears the identity property of a datasource.

Name	Type	Description
@odata.type	string: #Microsoft.Azure.Search.DataNoneIdentity	A URI fragment specifying the type of identity.

SearchIndexerDataUserAssignedIdentity

Object

Specifies the identity for a datasource to use.

Name	Type	Description
@odata.type	string: #Microsoft.Azure.Search.DataUserAssignedIdentity	A URI fragment specifying the type of identity.
userAssignedIdentity	string	The fully qualified Azure resource Id of a user assigned managed identity typically in the form "/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId" that should have been assigned to the search service.

SearchIndexerIndexProjections

Object

Definition of additional projections to secondary search indexes.

Name	Type	Description
parameters	SearchIndexerIndexProjectionsParameters	A dictionary of index projection-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type.
selectors	SearchIndexerIndexProjectionSelector[]	A list of projections to be performed to secondary search indexes.

SearchIndexerIndexProjectionSelector

Object

Description for what data to store in the designated search index.

Name	Type	Description
mappings	InputFieldMappingEntry[]	Mappings for the projection, or which source should be mapped to which field in the target index.
parentKeyFieldName	string	Name of the field in the search index to map the parent document's key value to. Must be a string field that is filterable and not the key field.
sourceContext	string	Source context for the projections. Represents the cardinality at which the document will be split into multiple sub documents.
targetIndexName	string	Name of the search index to project to. Must have a key field with the 'keyword' analyzer set.

SearchIndexerIndexProjectionsParameters

Object

A dictionary of index projection-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type.

Name	Type	Description
projectionMode	IndexProjectionMode	Defines behavior of the index projections in relation to the rest of the indexer.

SearchIndexerKnowledgeStore

Object

Definition of additional projections to azure blob, table, or files, of enriched data.

Name	Type	Description
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	The user-assigned managed identity used for connections to Azure Storage when writing knowledge store projections. If the connection string indicates an identity (ResourceId) 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.
parameters	SearchIndexerKnowledgeStoreParameters	A dictionary of knowledge store-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type.
projections	SearchIndexerKnowledgeStoreProjection[]	A list of additional projections to perform during indexing.
storageConnectionString	string	The connection string to the storage account projections will be stored in.

SearchIndexerKnowledgeStoreFileProjectionSelector

Object

Projection definition for what data to store in Azure Files.

Name	Type	Description
generatedKeyName	string	Name of generated key to store projection under.
inputs	InputFieldMappingEntry[]	Nested inputs for complex projections.
referenceKeyName	string	Name of reference key to different projection.
source	string	Source data to project.
sourceContext	string	Source context for complex projections.
storageContainer	string	Blob container to store projections in.

SearchIndexerKnowledgeStoreObjectProjectionSelector

Object

Projection definition for what data to store in Azure Blob.

Name	Type	Description
generatedKeyName	string	Name of generated key to store projection under.
inputs	InputFieldMappingEntry[]	Nested inputs for complex projections.
referenceKeyName	string	Name of reference key to different projection.
source	string	Source data to project.
sourceContext	string	Source context for complex projections.
storageContainer	string	Blob container to store projections in.

SearchIndexerKnowledgeStoreParameters

Object

A dictionary of knowledge store-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type.

Name	Type	Default value	Description
synthesizeGeneratedKeyName	boolean	False	Whether or not projections should synthesize a generated key name if one isn't already present.

SearchIndexerKnowledgeStoreProjection

Object

Container object for various projection selectors.

Name	Type	Description
files	SearchIndexerKnowledgeStoreFileProjectionSelector[]	Projections to Azure File storage.
objects	SearchIndexerKnowledgeStoreObjectProjectionSelector[]	Projections to Azure Blob storage.
tables	SearchIndexerKnowledgeStoreTableProjectionSelector[]	Projections to Azure Table storage.

SearchIndexerKnowledgeStoreTableProjectionSelector

Object

Description for what data to store in Azure Tables.

Name	Type	Description
generatedKeyName	string	Name of generated key to store projection under.
inputs	InputFieldMappingEntry[]	Nested inputs for complex projections.
referenceKeyName	string	Name of reference key to different projection.
source	string	Source data to project.
sourceContext	string	Source context for complex projections.
tableName	string	Name of the Azure table to store projected data in.

SearchIndexerSkillset

Object

A list of skills.

Name	Type	Description
@odata.etag	string	The ETag of the skillset.
cognitiveServices	CognitiveServicesAccount: AIServicesAccountIdentity AIServicesAccountKey CognitiveServicesAccountKey DefaultCognitiveServicesAccount	Details about the Azure AI service to be used when running skills.
description	string	The description of the skillset.
encryptionKey	SearchResourceEncryptionKey	A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your skillset definition when you want full assurance that no one, not even Microsoft, can decrypt your skillset definition. Once you have encrypted your skillset definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your skillset definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019.
indexProjections	SearchIndexerIndexProjections	Definition of additional projections to secondary search index(es).
knowledgeStore	SearchIndexerKnowledgeStore	Definition of additional projections to Azure blob, table, or files, of enriched data.
name	string	The name of the skillset.
skills	SearchIndexerSkill[]: AmlSkill[] AzureOpenAIEmbeddingSkill[] ConditionalSkill[] CustomEntityLookupSkill[] DocumentExtractionSkill[] DocumentIntelligenceLayoutSkill[] EntityLinkingSkill[] EntityRecognitionSkill[] EntityRecognitionSkillV3[] ImageAnalysisSkill[] KeyPhraseExtractionSkill[] LanguageDetectionSkill[] MergeSkill[] OcrSkill[] PIIDetectionSkill[] SentimentSkill[] SentimentSkillV3[] ShaperSkill[] SplitSkill[] TextTranslationSkill[] VisionVectorizeSkill[] WebApiSkill[]	A list of skills in the skillset.

SearchResourceEncryptionKey

Object

A customer-managed encryption key in Azure Key Vault. Keys that you create and manage can be used to encrypt or decrypt data-at-rest, such as indexes and synonym maps.

Name	Type	Description
accessCredentials	AzureActiveDirectoryApplicationCredentials	Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified, the value of this property is cleared.
keyVaultKeyName	string	The name of your Azure Key Vault key to be used to encrypt your data at rest.
keyVaultKeyVersion	string	The version of your Azure Key Vault key to be used to encrypt your data at rest.
keyVaultUri	string	The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`.

SentimentSkill

Object

This skill is deprecated. Use the V3.SentimentSkill instead.

Name	Type	Description
@odata.type	string: #Microsoft.Skills.Text.SentimentSkill	A URI fragment specifying the type of 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.
defaultLanguageCode	SentimentSkillLanguage	A value indicating which language code to use. Default is `en`.
description	string	The description of the skill which describes the inputs, outputs, and usage of the skill.
inputs	InputFieldMappingEntry[]	Inputs of the skills could be a column in the source data set, or the output of an upstream skill.
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 '#'.
outputs	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.

SentimentSkillLanguage

Enumeration

Deprecated. The language codes supported for input text by SentimentSkill.

Value	Description
da	Danish
de	German
el	Greek
en	English
es	Spanish
fi	Finnish
fr	French
it	Italian
nl	Dutch
no	Norwegian (Bokmaal)
pl	Polish
pt-PT	Portuguese (Portugal)
ru	Russian
sv	Swedish
tr	Turkish

SentimentSkillV3

Object

Using the Text Analytics API, evaluates unstructured text and for each record, provides sentiment labels (such as "negative", "neutral" and "positive") based on the highest confidence score found by the service at a sentence and document-level.

Name	Type	Default value	Description
@odata.type	string: #Microsoft.Skills.Text.V3.SentimentSkill		A URI fragment specifying the type of 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.
defaultLanguageCode	string		A value indicating which language code to use. Default is `en`.
description	string		The description of the skill which describes the inputs, outputs, and usage of the skill.
includeOpinionMining	boolean	False	If set to true, the skill output will include information from Text Analytics for opinion mining, namely targets (nouns or verbs) and their associated assessment (adjective) in the text. Default is false.
inputs	InputFieldMappingEntry[]		Inputs of the skills could be a column in the source data set, or the output of an upstream skill.
modelVersion	string		The version of the model to use when calling the Text Analytics service. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary.
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 '#'.
outputs	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.

ShaperSkill

Object

A skill for reshaping the outputs. It creates a complex type to support composite fields (also known as multipart fields).

Name	Type	Description
@odata.type	string: #Microsoft.Skills.Util.ShaperSkill	A URI fragment specifying the type of 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.
description	string	The description of the skill which describes the inputs, outputs, and usage of the skill.
inputs	InputFieldMappingEntry[]	Inputs of the skills could be a column in the source data set, or the output of an upstream skill.
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 '#'.
outputs	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.

SplitSkill

Object

A skill to split a string into chunks of text.

Name	Type	Description
@odata.type	string: #Microsoft.Skills.Text.SplitSkill	A URI fragment specifying the type of skill.
azureOpenAITokenizerParameters	AzureOpenAITokenizerParameters	Only applies if the unit is set to azureOpenAITokens. If specified, the splitSkill will use these parameters when performing the tokenization. The parameters are a valid 'encoderModelName' and an optional 'allowedSpecialTokens' property.
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.
defaultLanguageCode	SplitSkillLanguage	A value indicating which language code to use. Default is `en`.
description	string	The description of the skill which describes the inputs, outputs, and usage of the skill.
inputs	InputFieldMappingEntry[]	Inputs of the skills could be a column in the source data set, or the output of an upstream skill.
maximumPageLength	integer	The desired maximum page length. Default is 10000.
maximumPagesToTake	integer	Only applicable when textSplitMode is set to 'pages'. If specified, the SplitSkill will discontinue splitting after processing the first 'maximumPagesToTake' pages, in order to improve performance when only a few initial pages are needed from each document.
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 '#'.
outputs	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.
pageOverlapLength	integer	Only applicable when textSplitMode is set to 'pages'. If specified, n+1th chunk will start with this number of characters/tokens from the end of the nth chunk.
textSplitMode	TextSplitMode	A value indicating which split mode to perform.
unit	SplitSkillUnit	Only applies if textSplitMode is set to pages. There are two possible values. The choice of the values will decide the length (maximumPageLength and pageOverlapLength) measurement. The default is 'characters', which means the length will be measured by character.

SplitSkillEncoderModelName

Enumeration

Only applies if the unit is set to azureOpenAITokens. Options include 'R50k_base', 'P50k_base', 'P50k_edit' and 'CL100k_base'. The default value is 'CL100k_base'.

Value	Description
cl100k_base	A base model with a 100,000 token vocabulary.
p50k_base	A base model with a 50,000 token vocabulary, optimized for prompt-based tasks.
p50k_edit	Similar to p50k_base but fine-tuned for editing or rephrasing tasks with a 50,000 token vocabulary.
r50k_base	Refers to a base model trained with a 50,000 token vocabulary, often used in general natural language processing tasks.

SplitSkillLanguage

Enumeration

The language codes supported for input text by SplitSkill.

Value	Description
am	Amharic
bs	Bosnian
cs	Czech
da	Danish
de	German
en	English
es	Spanish
et	Estonian
fi	Finnish
fr	French
he	Hebrew
hi	Hindi
hr	Croatian
hu	Hungarian
id	Indonesian
is	Icelandic
it	Italian
ja	Japanese
ko	Korean
lv	Latvian
nb	Norwegian
nl	Dutch
pl	Polish
pt	Portuguese (Portugal)
pt-br	Portuguese (Brazil)
ru	Russian
sk	Slovak
sl	Slovenian
sr	Serbian
sv	Swedish
tr	Turkish
ur	Urdu
zh	Chinese (Simplified)

SplitSkillUnit

Enumeration

A value indicating which unit to use.

Value	Description
azureOpenAITokens	The length will be measured by an AzureOpenAI tokenizer from the tiktoken library.
characters	The length will be measured by character.

TextSplitMode

Enumeration

A value indicating which split mode to perform.

Value	Description
pages	Split the text into individual pages.
sentences	Split the text into individual sentences.

TextTranslationSkill

Object

A skill to translate text from one language to another.

Name	Type	Description
@odata.type	string: #Microsoft.Skills.Text.TranslationSkill	A URI fragment specifying the type of 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.
defaultFromLanguageCode	TextTranslationSkillLanguage	The language code to translate documents from for documents that don't specify the from language explicitly.
defaultToLanguageCode	TextTranslationSkillLanguage	The language code to translate documents into for documents that don't specify the to language explicitly.
description	string	The description of the skill which describes the inputs, outputs, and usage of the skill.
inputs	InputFieldMappingEntry[]	Inputs of the skills could be a column in the source data set, or the output of an upstream skill.
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 '#'.
outputs	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.
suggestedFrom	TextTranslationSkillLanguage	The language code to translate documents from when neither the fromLanguageCode input nor the defaultFromLanguageCode parameter are provided, and the automatic language detection is unsuccessful. Default is `en`.

TextTranslationSkillLanguage

Enumeration

The language codes supported for input text by TextTranslationSkill.

Value	Description
af	Afrikaans
ar	Arabic
bg	Bulgarian
bn	Bangla
bs	Bosnian (Latin)
ca	Catalan
cs	Czech
cy	Welsh
da	Danish
de	German
el	Greek
en	English
es	Spanish
et	Estonian
fa	Persian
fi	Finnish
fil	Filipino
fj	Fijian
fr	French
ga	Irish
he	Hebrew
hi	Hindi
hr	Croatian
ht	Haitian Creole
hu	Hungarian
id	Indonesian
is	Icelandic
it	Italian
ja	Japanese
kn	Kannada
ko	Korean
lt	Lithuanian
lv	Latvian
mg	Malagasy
mi	Maori
ml	Malayalam
ms	Malay
mt	Maltese
mww	Hmong Daw
nb	Norwegian
nl	Dutch
otq	Queretaro Otomi
pa	Punjabi
pl	Polish
pt	Portuguese
pt-PT	Portuguese (Portugal)
pt-br	Portuguese (Brazil)
ro	Romanian
ru	Russian
sk	Slovak
sl	Slovenian
sm	Samoan
sr-Cyrl	Serbian (Cyrillic)
sr-Latn	Serbian (Latin)
sv	Swedish
sw	Kiswahili
ta	Tamil
te	Telugu
th	Thai
tlh	Klingon
tlh-Latn	Klingon (Latin script)
tlh-Piqd	Klingon (Klingon script)
to	Tongan
tr	Turkish
ty	Tahitian
uk	Ukrainian
ur	Urdu
vi	Vietnamese
yua	Yucatec Maya
yue	Cantonese (Traditional)
zh-Hans	Chinese Simplified
zh-Hant	Chinese Traditional

VisionVectorizeSkill

Object

Allows you to generate a vector embedding for a given image or text input using the Azure AI Services Vision Vectorize API.

Name	Type	Description
@odata.type	string: #Microsoft.Skills.Vision.VectorizeSkill	A URI fragment specifying the type of 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.
description	string	The description of the skill which describes the inputs, outputs, and usage of the skill.
inputs	InputFieldMappingEntry[]	Inputs of the skills could be a column in the source data set, or the output of an upstream skill.
modelVersion	string	The version of the model to use when calling the AI Services Vision service. It will default to the latest available when not specified.
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 '#'.
outputs	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.

VisualFeature

Enumeration

The strings indicating what visual feature types to return.

Value	Description
adult	Visual features recognized as adult persons.
brands	Visual features recognized as commercial brands.
categories	Categories.
description	Description.
faces	Visual features recognized as people faces.
objects	Visual features recognized as objects.
tags	Tags.

WebApiSkill

Object

A skill that can call a Web API endpoint, allowing you to extend a skillset by having it call your custom code.

Name	Type	Description
@odata.type	string: #Microsoft.Skills.Custom.WebApiSkill	A URI fragment specifying the type of skill.
authIdentity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	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	string	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	integer	The desired batch size which indicates number of documents.
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.
degreeOfParallelism	integer	If set, the number of parallel calls that can be made to the Web API.
description	string	The description of the skill which describes the inputs, outputs, and usage of the skill.
httpHeaders	object	The headers required to make the http request.
httpMethod	string	The method for the http request.
inputs	InputFieldMappingEntry[]	Inputs of the skills could be a column in the source data set, or the output of an upstream skill.
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 '#'.
outputs	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.
timeout	string	The desired timeout for the request. Default is 30 seconds.
uri	string	The url for the Web API.

Share via

Skillsets - Get

URI Parameters

Request Header

Responses

Examples

SearchServiceGetSkillset

Sample request

Sample response

Definitions

AIServicesAccountIdentity

AIServicesAccountKey

AmlSkill

AzureActiveDirectoryApplicationCredentials

AzureOpenAIEmbeddingSkill

AzureOpenAIModelName

AzureOpenAITokenizerParameters

CognitiveServicesAccountKey

ConditionalSkill

CustomEntity

CustomEntityAlias

CustomEntityLookupSkill

CustomEntityLookupSkillLanguage

DefaultCognitiveServicesAccount

DocumentExtractionSkill

DocumentIntelligenceLayoutSkill

DocumentIntelligenceLayoutSkillMarkdownHeaderDepth

DocumentIntelligenceLayoutSkillOutputMode

EntityCategory

EntityLinkingSkill

EntityRecognitionSkill

EntityRecognitionSkillLanguage

EntityRecognitionSkillV3

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ImageAnalysisSkill

ImageAnalysisSkillLanguage

ImageDetail

IndexProjectionMode

InputFieldMappingEntry

KeyPhraseExtractionSkill

KeyPhraseExtractionSkillLanguage

LanguageDetectionSkill

LineEnding

MergeSkill

OcrSkill

OcrSkillLanguage

OutputFieldMappingEntry

PIIDetectionSkill

PIIDetectionSkillMaskingMode

SearchIndexerDataNoneIdentity

SearchIndexerDataUserAssignedIdentity

SearchIndexerIndexProjections

SearchIndexerIndexProjectionSelector

SearchIndexerIndexProjectionsParameters

SearchIndexerKnowledgeStore

SearchIndexerKnowledgeStoreFileProjectionSelector

SearchIndexerKnowledgeStoreObjectProjectionSelector

SearchIndexerKnowledgeStoreParameters

SearchIndexerKnowledgeStoreProjection

SearchIndexerKnowledgeStoreTableProjectionSelector

SearchIndexerSkillset

SearchResourceEncryptionKey

SentimentSkill

SentimentSkillLanguage

SentimentSkillV3

ShaperSkill

SplitSkill

SplitSkillEncoderModelName

SplitSkillLanguage

SplitSkillUnit

TextSplitMode

TextTranslationSkill

TextTranslationSkillLanguage

VisionVectorizeSkill

VisualFeature

WebApiSkill

Additional resources