Skillsets - Get

Referência

Serviço:: Search Service

Versão da API:: 2024-07-01

Recupera um conjunto de habilidades em um serviço de pesquisa.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string	A URL do ponto de extremidade do serviço de pesquisa.
skillsetName	path	True	string	O nome do conjunto de habilidades a ser recuperado.
api-version	query	True	string	Versão da API do cliente.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
x-ms-client-request-id		string (uuid)	A ID de acompanhamento enviada com a solicitação para ajudar na depuração.

Respostas

Nome	Tipo	Description
200 OK	SearchIndexerSkillset	O conjunto de habilidades é retornado com êxito.
Other Status Codes	ErrorResponse	Resposta de erro.

Exemplos

SearchServiceGetSkillset

Solicitação de exemplo

HTTP

GET https://myservice.search.windows.net/skillsets('demoskillset')?api-version=2024-07-01

Resposta de exemplo

Código de status:: 200

{
  "name": "demoskillset",
  "description": "Extract entities, detect language and extract key-phrases",
  "skills": [
    {
      "@odata.type": "#Microsoft.Skills.Text.EntityRecognitionSkill",
      "name": "#1",
      "description": null,
      "context": null,
      "inputs": [
        {
          "name": "text",
          "source": "/document/content"
        }
      ],
      "outputs": [
        {
          "name": "organizations",
          "targetName": "organizations"
        }
      ],
      "categories": [
        "organization"
      ],
      "defaultLanguageCode": "en",
      "minimumPrecision": 0.7
    },
    {
      "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill",
      "name": "#2",
      "description": null,
      "context": null,
      "inputs": [
        {
          "name": "text",
          "source": "/document/content"
        }
      ],
      "outputs": [
        {
          "name": "languageCode",
          "targetName": "languageCode"
        }
      ]
    },
    {
      "@odata.type": "#Microsoft.Skills.Text.SplitSkill",
      "name": "#3",
      "description": null,
      "context": null,
      "inputs": [
        {
          "name": "text",
          "source": "/document/content"
        },
        {
          "name": "languageCode",
          "source": "/document/languageCode"
        }
      ],
      "outputs": [
        {
          "name": "textItems",
          "targetName": "pages"
        }
      ],
      "defaultLanguageCode": null,
      "textSplitMode": "pages",
      "maximumPageLength": 4000
    },
    {
      "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill",
      "name": "#4",
      "description": null,
      "context": "/document/pages/*",
      "inputs": [
        {
          "name": "text",
          "source": "/document/pages/*"
        },
        {
          "name": "languageCode",
          "source": "/document/languageCode"
        }
      ],
      "outputs": [
        {
          "name": "keyPhrases",
          "targetName": "keyPhrases"
        }
      ],
      "defaultLanguageCode": null,
      "maxKeyPhraseCount": null
    },
    {
      "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill",
      "name": "MyCustomWebApiSkill",
      "description": null,
      "context": "/document",
      "uri": "https://contoso.example.org",
      "httpMethod": "POST",
      "timeout": "PT30S",
      "batchSize": 1,
      "degreeOfParallelism": null,
      "inputs": [
        {
          "name": "text",
          "source": "/document/pages/*"
        },
        {
          "name": "languageCode",
          "source": "/document/languageCode"
        }
      ],
      "outputs": [
        {
          "name": "customresult",
          "targetName": "result"
        }
      ],
      "httpHeaders": {}
    }
  ],
  "encryptionKey": {
    "keyVaultKeyName": "myKeyName",
    "keyVaultKeyVersion": "myKeyVersion",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": null
    }
  }
}

Definições

Nome	Description
AzureActiveDirectoryApplicationCredentials	Credenciais de um aplicativo registrado criado para seu serviço de pesquisa, usado para acesso autenticado às chaves de criptografia armazenadas no Azure Key Vault.
AzureOpenAIEmbeddingSkill	Permite que você gere uma inserção de vetor para uma determinada entrada de texto usando o recurso Azure OpenAI.
AzureOpenAIModelName	O nome do modelo de IA Aberta do Azure que será chamado.
CognitiveServicesAccountKey	A chave da conta de várias regiões de um recurso de serviço de IA do Azure anexado a um conjunto de habilidades.
ConditionalSkill	Uma habilidade que permite cenários que exigem uma operação booliana para determinar os dados a serem atribuídos a uma saída.
CustomEntity	Um objeto que contém informações sobre as correspondências que foram encontradas e metadados relacionados.
CustomEntityAlias	Um objeto complexo que pode ser usado para especificar ortografias ou sinônimos alternativos para o nome da entidade raiz.
CustomEntityLookupSkill	Uma habilidade procura texto de uma lista personalizada definida pelo usuário de palavras e frases.
CustomEntityLookupSkillLanguage	Os códigos de idioma com suporte para texto de entrada por CustomEntityLookupSkill.
DefaultCognitiveServicesAccount	Um objeto vazio que representa o recurso de serviço de IA do Azure padrão para um conjunto de habilidades.
DocumentExtractionSkill	Uma habilidade que extrai conteúdo de um arquivo dentro do pipeline de enriquecimento.
EntityCategory	Uma cadeia de caracteres que indica quais categorias de entidade devem ser retornadas.
EntityLinkingSkill	Usando a API de Análise de Texto, extrai entidades vinculadas do texto.
EntityRecognitionSkill	Essa habilidade foi preterida. Use a V3. Em vez disso, EntityRecognitionSkill.
EntityRecognitionSkillLanguage	Deprecado. Os códigos de idioma compatíveis com o texto de entrada por EntityRecognitionSkill.
EntityRecognitionSkillV3	Usando a API de Análise de Texto, extrai entidades de diferentes tipos do texto.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
ImageAnalysisSkill	Uma habilidade que analisa arquivos de imagem. Ele extrai um conjunto avançado de recursos visuais com base no conteúdo da imagem.
ImageAnalysisSkillLanguage	Os códigos de idioma com suporte para entrada por ImageAnalysisSkill.
ImageDetail	Uma cadeia de caracteres que indica quais detalhes específicos do domínio devem ser retornados.
IndexProjectionMode	Define o comportamento das projeções de índice em relação ao restante do indexador.
InputFieldMappingEntry	Mapeamento de campo de entrada para uma habilidade.
KeyPhraseExtractionSkill	Uma habilidade que usa a análise de texto para extração de frases-chave.
KeyPhraseExtractionSkillLanguage	Os códigos de idioma com suporte para texto de entrada por KeyPhraseExtractionSkill.
LanguageDetectionSkill	Uma habilidade que detecta o idioma do texto de entrada e relata um único código de idioma para cada documento enviado na solicitação. O código de idioma é emparelhado com uma pontuação que indica a confiança da análise.
LineEnding	Define a sequência de caracteres a ser usada entre as linhas de texto reconhecidas pela habilidade do OCR. O valor padrão é "space".
MergeSkill	Uma habilidade para mesclar duas ou mais cadeias de caracteres em uma única cadeia de caracteres unificada, com um delimitador opcional definido pelo usuário separando cada parte do componente.
OcrSkill	Uma habilidade que extrai texto de arquivos de imagem.
OcrSkillLanguage	Os códigos de idioma com suporte para entrada pelo OcrSkill.
OutputFieldMappingEntry	Mapeamento de campo de saída para uma habilidade.
PIIDetectionSkill	Usando a API de Análise de Texto, extrai informações pessoais de um texto de entrada e oferece a opção de mascara-la.
PIIDetectionSkillMaskingMode	Uma cadeia de caracteres que indica qual maskingMode usar para mascarar as informações pessoais detectadas no texto de entrada.
SearchIndexerDataNoneIdentity	Limpa a propriedade de identidade de uma fonte de dados.
SearchIndexerDataUserAssignedIdentity	Especifica a identidade de uma fonte de dados a ser usada.
SearchIndexerIndexProjections	Definição de projeções adicionais para índices de pesquisa secundários.
SearchIndexerIndexProjectionSelector	Descrição de quais dados armazenar no índice de pesquisa designado.
SearchIndexerIndexProjectionsParameters	Um dicionário de propriedades de configuração específicas da projeção de índice. Cada nome é o nome de uma propriedade específica. Cada valor deve ser de um tipo primitivo.
SearchIndexerKnowledgeStore	Definição de projeções adicionais para blob, tabela ou arquivos do Azure de dados enriquecidos.
SearchIndexerKnowledgeStoreFileProjectionSelector	Definição de projeção para quais dados armazenar nos Arquivos do Azure.
SearchIndexerKnowledgeStoreObjectProjectionSelector	Definição de projeção para quais dados armazenar no Blob do Azure.
SearchIndexerKnowledgeStoreProjection	Objeto de contêiner para vários seletores de projeção.
SearchIndexerKnowledgeStoreTableProjectionSelector	Descrição de quais dados armazenar nas Tabelas do Azure.
SearchIndexerSkillset	Uma lista de habilidades.
SearchResourceEncryptionKey	Uma chave de criptografia gerenciada pelo cliente no Azure Key Vault. As chaves que você cria e gerencia podem ser usadas para criptografar ou descriptografar dados em repouso, como índices e mapas de sinônimos.
SentimentSkill	Essa habilidade foi preterida. Use a V3. Em vez disso, SentimentSkill.
SentimentSkillLanguage	Deprecado. Os códigos de idioma com suporte para texto de entrada pelo SentimentSkill.
SentimentSkillV3	Usando a API de Análise de Texto, avalia o texto não estruturado e, para cada registro, fornece rótulos de sentimento (como "negativo", "neutro" e "positivo") com base na pontuação de confiança mais alta encontrada pelo serviço em uma frase e no nível do documento.
ShaperSkill	Uma habilidade para remodelar as saídas. Ele cria um tipo complexo para dar suporte a campos compostos (também conhecidos como campos de várias partes).
SplitSkill	Uma habilidade para dividir uma cadeia de caracteres em partes de texto.
SplitSkillLanguage	Os códigos de idioma compatíveis com o texto de entrada por SplitSkill.
TextSplitMode	Um valor que indica qual modo de divisão executar.
TextTranslationSkill	Uma habilidade para traduzir texto de um idioma para outro.
TextTranslationSkillLanguage	Os códigos de idioma com suporte para texto de entrada por TextTranslationSkill.
VisualFeature	As cadeias de caracteres que indicam quais tipos de recursos visuais devem ser retornados.
WebApiSkill	Uma habilidade que pode chamar um ponto de extremidade de API Web, permitindo que você estenda um conjunto de habilidades fazendo com que ele chame seu código personalizado.

AzureActiveDirectoryApplicationCredentials

Objeto

Credenciais de um aplicativo registrado criado para seu serviço de pesquisa, usado para acesso autenticado às chaves de criptografia armazenadas no Azure Key Vault.

Nome	Tipo	Description
applicationId	string	Uma ID de aplicativo do AAD que recebeu as permissões de acesso necessárias para o Azure Key Vault que deve ser usada ao criptografar seus dados em repouso. A ID do aplicativo não deve ser confundida com a ID do objeto para seu aplicativo do AAD.
applicationSecret	string	A chave de autenticação do aplicativo AAD especificado.

AzureOpenAIEmbeddingSkill

Objeto

Permite que você gere uma inserção de vetor para uma determinada entrada de texto usando o recurso Azure OpenAI.

Nome	Tipo	Description
@odata.type	string: #Microsoft.Skills.Text.AzureOpenAIEmbeddingSkill	Um fragmento de URI que especifica o tipo de habilidade.
apiKey	string	Chave de API do recurso Azure OpenAI designado.
authIdentity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	A identidade gerenciada atribuída pelo usuário usada para conexões de saída.
context	string	Representa o nível em que as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document.
deploymentId	string	ID da implantação de modelo do Azure OpenAI no recurso designado.
description	string	A descrição da habilidade que descreve as entradas, as saídas e o uso da habilidade.
dimensions	integer (int32)	O número de dimensões que as inserções de saída resultantes devem ter. Só há suporte em modelos text-embedding-3 e posteriores.
inputs	InputFieldMappingEntry[]	As entradas das habilidades podem ser uma coluna no conjunto de dados de origem ou a saída de uma habilidade upstream.
modelName	AzureOpenAIModelName	O nome do modelo de inserção implantado no caminho deploymentId fornecido.
name	string	O nome da habilidade que a identifica exclusivamente dentro do conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixado com o caractere '#'.
outputs	OutputFieldMappingEntry[]	A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como entrada por outra habilidade.
resourceUri	string (uri)	O URI do recurso do Azure OpenAI.

AzureOpenAIModelName

Enumeração

O nome do modelo de IA Aberta do Azure que será chamado.

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

CognitiveServicesAccountKey

Objeto

A chave da conta de várias regiões de um recurso de serviço de IA do Azure anexado a um conjunto de habilidades.

Nome	Tipo	Description
@odata.type	string: #Microsoft.Azure.Search.CognitiveServicesByKey	Um fragmento de URI que especifica o tipo de recurso de serviço de IA do Azure anexado a um conjunto de habilidades.
description	string	Descrição do recurso de serviço de IA do Azure anexado a um conjunto de habilidades.
key	string	A chave usada para provisionar o recurso de serviço de IA do Azure anexado a um conjunto de habilidades.

ConditionalSkill

Objeto

Uma habilidade que permite cenários que exigem uma operação booliana para determinar os dados a serem atribuídos a uma saída.

Nome	Tipo	Description
@odata.type	string: #Microsoft.Skills.Util.ConditionalSkill	Um fragmento de URI que especifica o tipo de habilidade.
context	string	Representa o nível em que as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document.
description	string	A descrição da habilidade que descreve as entradas, as saídas e o uso da habilidade.
inputs	InputFieldMappingEntry[]	As entradas das habilidades podem ser uma coluna no conjunto de dados de origem ou a saída de uma habilidade upstream.
name	string	O nome da habilidade que a identifica exclusivamente dentro do conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixado com o caractere '#'.
outputs	OutputFieldMappingEntry[]	A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como entrada por outra habilidade.

CustomEntity

Objeto

Um objeto que contém informações sobre as correspondências que foram encontradas e metadados relacionados.

Nome	Tipo	Description
accentSensitive	boolean	O padrão é false. Valor booliano que indica se as comparações com o nome da entidade devem ser sensíveis ao acento.
aliases	CustomEntityAlias[]	Uma matriz de objetos complexos que podem ser usados para especificar ortografias ou sinônimos alternativos para o nome da entidade raiz.
caseSensitive	boolean	O padrão é false. Valor booliano que indica se as comparações com o nome da entidade devem ser sensíveis à caixa de caracteres. Correspondências sem diferenciação de maiúsculas de minúsculas de "Microsoft" podem ser: microsoft, microSoft, MICROSOFT.
defaultAccentSensitive	boolean	Altera o valor de confidencialidade de ênfase padrão para essa entidade. Ele será usado para alterar o valor padrão de todos os valores aliases accentSensitive.
defaultCaseSensitive	boolean	Altera o valor de confidencialidade de maiúsculas e minúsculas padrão para essa entidade. Ele será usado para alterar o valor padrão de todos os valores caseSensitive de aliases.
defaultFuzzyEditDistance	integer (int32)	Altera o valor de distância de edição difusa padrão para essa entidade. Ele pode ser usado para alterar o valor padrão de todos os valores de aliases fuzzyEditDistance.
description	string	Esse campo pode ser usado como uma passagem para metadados personalizados sobre os textos correspondentes. O valor desse campo será exibido com cada correspondência de sua entidade na saída da habilidade.
fuzzyEditDistance	integer (int32)	O padrão é 0. Valor máximo de 5. Indica o número aceitável de caracteres divergentes que ainda constituiria uma correspondência com o nome da entidade. A menor confusão possível para qualquer correspondência é retornada. Por exemplo, se a distância de edição for definida como 3, "Windows10" ainda corresponderá a "Windows", "Windows10" e "Windows 7". Quando a confidencialidade de maiúsculas e minúsculas é definida como false, as diferenças de maiúsculas e minúsculas NÃO contam para a tolerância à difusa, mas o contrário.
id	string	Esse campo pode ser usado como uma passagem para metadados personalizados sobre os textos correspondentes. O valor desse campo será exibido com cada correspondência de sua entidade na saída da habilidade.
name	string	O descritor de entidade de nível superior. As correspondências na saída da habilidade serão agrupadas por esse nome e devem representar a forma "normalizada" do texto que está sendo encontrado.
subtype	string	Esse campo pode ser usado como uma passagem para metadados personalizados sobre os textos correspondentes. O valor desse campo será exibido com cada correspondência de sua entidade na saída da habilidade.
type	string	Esse campo pode ser usado como uma passagem para metadados personalizados sobre os textos correspondentes. O valor desse campo será exibido com cada correspondência de sua entidade na saída da habilidade.

CustomEntityAlias

Objeto

Um objeto complexo que pode ser usado para especificar ortografias ou sinônimos alternativos para o nome da entidade raiz.

Nome	Tipo	Description
accentSensitive	boolean	Determine se o alias é sensível ao acento.
caseSensitive	boolean	Determine se o alias diferencia maiúsculas de minúsculas.
fuzzyEditDistance	integer (int32)	Determine a distância de edição difusa do alias.
text	string	O texto do alias.

CustomEntityLookupSkill

Objeto

Uma habilidade procura texto de uma lista personalizada definida pelo usuário de palavras e frases.

Nome	Tipo	Description
@odata.type	string: #Microsoft.Skills.Text.CustomEntityLookupSkill	Um fragmento de URI que especifica o tipo de habilidade.
context	string	Representa o nível em que as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document.
defaultLanguageCode	CustomEntityLookupSkillLanguage	Um valor que indica qual código de idioma usar. O padrão é `en`.
description	string	A descrição da habilidade que descreve as entradas, as saídas e o uso da habilidade.
entitiesDefinitionUri	string	Caminho para um arquivo JSON ou CSV que contém todo o texto de destino com o qual corresponder. Essa definição de entidade é lida no início de uma execução do indexador. Todas as atualizações para esse arquivo durante uma execução do indexador não entrarão em vigor até as execuções subsequentes. Essa configuração deve estar acessível por HTTPS.
globalDefaultAccentSensitive	boolean	Um sinalizador global para AccentSensitive. Se AccentSensitive não estiver definido em CustomEntity, esse valor será o valor padrão.
globalDefaultCaseSensitive	boolean	Um sinalizador global para CaseSensitive. Se CaseSensitive não estiver definido em CustomEntity, esse valor será o valor padrão.
globalDefaultFuzzyEditDistance	integer (int32)	Um sinalizador global para FuzzyEditDistance. Se FuzzyEditDistance não estiver definido em CustomEntity, esse valor será o valor padrão.
inlineEntitiesDefinition	CustomEntity[]	A definição de Entidade Personalizada embutida.
inputs	InputFieldMappingEntry[]	As entradas das habilidades podem ser uma coluna no conjunto de dados de origem ou a saída de uma habilidade upstream.
name	string	O nome da habilidade que a identifica exclusivamente dentro do conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixado com o caractere '#'.
outputs	OutputFieldMappingEntry[]	A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como entrada por outra habilidade.

CustomEntityLookupSkillLanguage

Enumeração

Os códigos de idioma com suporte para texto de entrada por CustomEntityLookupSkill.

Valor	Description
da	Dinamarquês
de	Alemão
en	Inglês
es	Espanhol
fi	Finlandês
fr	Francês
it	Italiano
ko	Coreano
pt	Português

DefaultCognitiveServicesAccount

Objeto

Um objeto vazio que representa o recurso de serviço de IA do Azure padrão para um conjunto de habilidades.

Nome	Tipo	Description
@odata.type	string: #Microsoft.Azure.Search.DefaultCognitiveServices	Um fragmento de URI que especifica o tipo de recurso de serviço de IA do Azure anexado a um conjunto de habilidades.
description	string	Descrição do recurso de serviço de IA do Azure anexado a um conjunto de habilidades.

DocumentExtractionSkill

Objeto

Uma habilidade que extrai conteúdo de um arquivo dentro do pipeline de enriquecimento.

Nome	Tipo	Description
@odata.type	string: #Microsoft.Skills.Util.DocumentExtractionSkill	Um fragmento de URI que especifica o tipo de habilidade.
configuration	object	Um dicionário de configurações para a habilidade.
context	string	Representa o nível em que as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document.
dataToExtract	string	O tipo de dados a serem extraídos para a habilidade. Será definido como 'contentAndMetadata' se não for definido.
description	string	A descrição da habilidade que descreve as entradas, as saídas e o uso da habilidade.
inputs	InputFieldMappingEntry[]	As entradas das habilidades podem ser uma coluna no conjunto de dados de origem ou a saída de uma habilidade upstream.
name	string	O nome da habilidade que a identifica exclusivamente dentro do conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixado com o caractere '#'.
outputs	OutputFieldMappingEntry[]	A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como entrada por outra habilidade.
parsingMode	string	O parsingMode para a habilidade. Será definido como "padrão" se não for definido.

EntityCategory

Enumeração

Uma cadeia de caracteres que indica quais categorias de entidade devem ser retornadas.

Valor	Description
datetime	Entidades que descrevem uma data e hora.
email	Entidades que descrevem um endereço de email.
location	Entidades que descrevem um local físico.
organization	Entidades que descrevem uma organização.
person	Entidades que descrevem uma pessoa.
quantity	Entidades que descrevem uma quantidade.
url	Entidades que descrevem uma URL.

EntityLinkingSkill

Objeto

Usando a API de Análise de Texto, extrai entidades vinculadas do texto.

Nome	Tipo	Description
@odata.type	string: #Microsoft.Skills.Text.V3.EntityLinkingSkill	Um fragmento de URI que especifica o tipo de habilidade.
context	string	Representa o nível em que as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document.
defaultLanguageCode	string	Um valor que indica qual código de idioma usar. O padrão é `en`.
description	string	A descrição da habilidade que descreve as entradas, as saídas e o uso da habilidade.
inputs	InputFieldMappingEntry[]	As entradas das habilidades podem ser uma coluna no conjunto de dados de origem ou a saída de uma habilidade upstream.
minimumPrecision	number (double) minimum: 0 maximum: 1	Um valor entre 0 e 1 que será usado apenas para incluir entidades cuja pontuação de confiança é maior que o valor especificado. Se não for definido (padrão) ou se definido explicitamente como nulo, todas as entidades serão incluídas.
modelVersion	string	A versão do modelo a ser usada ao chamar o serviço de Análise de Texto. Ele usará o padrão para o mais recente disponível quando não for especificado. Recomendamos que você não especifique esse valor, a menos que seja absolutamente necessário.
name	string	O nome da habilidade que a identifica exclusivamente dentro do conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixado com o caractere '#'.
outputs	OutputFieldMappingEntry[]	A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como entrada por outra habilidade.

EntityRecognitionSkill

Objeto

Essa habilidade foi preterida. Use a V3. Em vez disso, EntityRecognitionSkill.

Nome	Tipo	Description
@odata.type	string: #Microsoft.Skills.Text.EntityRecognitionSkill	Um fragmento de URI que especifica o tipo de habilidade.
categories	EntityCategory[]	Uma lista de categorias de entidade que devem ser extraídas.
context	string	Representa o nível em que as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document.
defaultLanguageCode	EntityRecognitionSkillLanguage	Um valor que indica qual código de idioma usar. O padrão é `en`.
description	string	A descrição da habilidade que descreve as entradas, as saídas e o uso da habilidade.
includeTypelessEntities	boolean	Determina se as entidades são conhecidas ou não, mas não estão em conformidade com um tipo predefinido. Se essa configuração não estiver definida (padrão), definida como nula ou definida como false, as entidades que não estão em conformidade com um dos tipos predefinidos não serão exibidas.
inputs	InputFieldMappingEntry[]	As entradas das habilidades podem ser uma coluna no conjunto de dados de origem ou a saída de uma habilidade upstream.
minimumPrecision	number (double)	Um valor entre 0 e 1 que será usado apenas para incluir entidades cuja pontuação de confiança é maior que o valor especificado. Se não for definido (padrão) ou se definido explicitamente como nulo, todas as entidades serão incluídas.
name	string	O nome da habilidade que a identifica exclusivamente dentro do conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixado com o caractere '#'.
outputs	OutputFieldMappingEntry[]	A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como entrada por outra habilidade.

EntityRecognitionSkillLanguage

Enumeração

Deprecado. Os códigos de idioma compatíveis com o texto de entrada por EntityRecognitionSkill.

Valor	Description
ar	Árabe
cs	Tcheco
da	Dinamarquês
de	Alemão
el	Grego
en	Inglês
es	Espanhol
fi	Finlandês
fr	Francês
hu	Húngaro
it	Italiano
ja	Japonês
ko	Coreano
nl	Holandês
no	Norueguês (Bokmaal)
pl	Polonês
pt-BR	Português (Brasil)
pt-PT	Português (Portugal)
ru	Russo
sv	Sueco
tr	Turco
zh-Hans	Chinese-Simplified
zh-Hant	Chinese-Traditional

EntityRecognitionSkillV3

Objeto

Usando a API de Análise de Texto, extrai entidades de diferentes tipos do texto.

Nome	Tipo	Description
@odata.type	string: #Microsoft.Skills.Text.V3.EntityRecognitionSkill	Um fragmento de URI que especifica o tipo de habilidade.
categories	string[]	Uma lista de categorias de entidade que devem ser extraídas.
context	string	Representa o nível em que as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document.
defaultLanguageCode	string	Um valor que indica qual código de idioma usar. O padrão é `en`.
description	string	A descrição da habilidade que descreve as entradas, as saídas e o uso da habilidade.
inputs	InputFieldMappingEntry[]	As entradas das habilidades podem ser uma coluna no conjunto de dados de origem ou a saída de uma habilidade upstream.
minimumPrecision	number (double) minimum: 0 maximum: 1	Um valor entre 0 e 1 que será usado apenas para incluir entidades cuja pontuação de confiança é maior que o valor especificado. Se não for definido (padrão) ou se definido explicitamente como nulo, todas as entidades serão incluídas.
modelVersion	string	A versão do modelo a ser usada ao chamar a API de Análise de Texto. Ele usará o padrão para o mais recente disponível quando não for especificado. Recomendamos que você não especifique esse valor, a menos que seja absolutamente necessário.
name	string	O nome da habilidade que a identifica exclusivamente dentro do conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixado com o caractere '#'.
outputs	OutputFieldMappingEntry[]	A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como entrada por outra habilidade.

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

ImageAnalysisSkill

Objeto

Uma habilidade que analisa arquivos de imagem. Ele extrai um conjunto avançado de recursos visuais com base no conteúdo da imagem.

Nome	Tipo	Description
@odata.type	string: #Microsoft.Skills.Vision.ImageAnalysisSkill	Um fragmento de URI que especifica o tipo de habilidade.
context	string	Representa o nível em que as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document.
defaultLanguageCode	ImageAnalysisSkillLanguage	Um valor que indica qual código de idioma usar. O padrão é `en`.
description	string	A descrição da habilidade que descreve as entradas, as saídas e o uso da habilidade.
details	ImageDetail[]	Uma cadeia de caracteres que indica quais detalhes específicos do domínio devem ser retornados.
inputs	InputFieldMappingEntry[]	As entradas das habilidades podem ser uma coluna no conjunto de dados de origem ou a saída de uma habilidade upstream.
name	string	O nome da habilidade que a identifica exclusivamente dentro do conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixado com o caractere '#'.
outputs	OutputFieldMappingEntry[]	A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como entrada por outra habilidade.
visualFeatures	VisualFeature[]	Uma lista de recursos visuais.

ImageAnalysisSkillLanguage

Enumeração

Os códigos de idioma com suporte para entrada por ImageAnalysisSkill.

Valor	Description
ar	Árabe
az	Azerbaijano
bg	Búlgaro
bs	Latim bósnio
ca	Catalão
cs	Tcheco
cy	Galês
da	Dinamarquês
de	Alemão
el	Grego
en	Inglês
es	Espanhol
et	Estoniano
eu	Basco
fi	Finlandês
fr	Francês
ga	Irlandês
gl	Galego
he	Hebraico
hi	Hindi
hr	Croata
hu	Húngaro
id	Indonésio
it	Italiano
ja	Japonês
kk	Cazaque
ko	Coreano
lt	Lituano
lv	Letão
mk	Macedónio
ms	Malásia malaia
nb	Norueguês (Bokmal)
nl	Holandês
pl	Polonês
prs	Dari
pt	Portuguese-Portugal
pt-BR	Portuguese-Brazil
pt-PT	Portuguese-Portugal
ro	Romeno
ru	Russo
sk	Eslovaco
sl	Esloveno
sr-Cyrl	Sérvio - RS cirílico
sr-Latn	Sérvio - RS latino
sv	Sueco
th	Tailandês
tr	Turco
uk	Ucraniano
vi	Vietnamita
zh	Chinês simplificado
zh-Hans	Chinês simplificado
zh-Hant	Chinês tradicional

ImageDetail

Enumeração

Uma cadeia de caracteres que indica quais detalhes específicos do domínio devem ser retornados.

Valor	Description
celebrities	Detalhes reconhecidos como celebridades.
landmarks	Detalhes reconhecidos como pontos de referência.

IndexProjectionMode

Enumeração

Define o comportamento das projeções de índice em relação ao restante do indexador.

Valor	Description
includeIndexingParentDocuments	O documento de origem será gravado no índice de destino do indexador. Esse é o padrão padrão.
skipIndexingParentDocuments	O documento de origem será ignorado da gravação no índice de destino do indexador.

InputFieldMappingEntry

Objeto

Mapeamento de campo de entrada para uma habilidade.

Nome	Tipo	Description
inputs	InputFieldMappingEntry[]	As entradas recursivas usadas ao criar um tipo complexo.
name	string	O nome da entrada.
source	string	A origem da entrada.
sourceContext	string	O contexto de origem usado para selecionar entradas recursivas.

KeyPhraseExtractionSkill

Objeto

Uma habilidade que usa a análise de texto para extração de frases-chave.

Nome	Tipo	Description
@odata.type	string: #Microsoft.Skills.Text.KeyPhraseExtractionSkill	Um fragmento de URI que especifica o tipo de habilidade.
context	string	Representa o nível em que as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document.
defaultLanguageCode	KeyPhraseExtractionSkillLanguage	Um valor que indica qual código de idioma usar. O padrão é `en`.
description	string	A descrição da habilidade que descreve as entradas, as saídas e o uso da habilidade.
inputs	InputFieldMappingEntry[]	As entradas das habilidades podem ser uma coluna no conjunto de dados de origem ou a saída de uma habilidade upstream.
maxKeyPhraseCount	integer (int32)	Um número que indica quantas frases-chave devem ser retornadas. Se ausente, todas as frases-chave identificadas serão retornadas.
modelVersion	string	A versão do modelo a ser usada ao chamar o serviço de Análise de Texto. Ele usará o padrão para o mais recente disponível quando não for especificado. Recomendamos que você não especifique esse valor, a menos que seja absolutamente necessário.
name	string	O nome da habilidade que a identifica exclusivamente dentro do conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixado com o caractere '#'.
outputs	OutputFieldMappingEntry[]	A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como entrada por outra habilidade.

KeyPhraseExtractionSkillLanguage

Enumeração

Os códigos de idioma com suporte para texto de entrada por KeyPhraseExtractionSkill.

Valor	Description
da	Dinamarquês
de	Alemão
en	Inglês
es	Espanhol
fi	Finlandês
fr	Francês
it	Italiano
ja	Japonês
ko	Coreano
nl	Holandês
no	Norueguês (Bokmaal)
pl	Polonês
pt-BR	Português (Brasil)
pt-PT	Português (Portugal)
ru	Russo
sv	Sueco

LanguageDetectionSkill

Objeto

Uma habilidade que detecta o idioma do texto de entrada e relata um único código de idioma para cada documento enviado na solicitação. O código de idioma é emparelhado com uma pontuação que indica a confiança da análise.

Nome	Tipo	Description
@odata.type	string: #Microsoft.Skills.Text.LanguageDetectionSkill	Um fragmento de URI que especifica o tipo de habilidade.
context	string	Representa o nível em que as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document.
defaultCountryHint	string	Um código de país a ser usado como uma dica para o modelo de detecção de idioma se ele não puder desambiguar o idioma.
description	string	A descrição da habilidade que descreve as entradas, as saídas e o uso da habilidade.
inputs	InputFieldMappingEntry[]	As entradas das habilidades podem ser uma coluna no conjunto de dados de origem ou a saída de uma habilidade upstream.
modelVersion	string	A versão do modelo a ser usada ao chamar o serviço de Análise de Texto. Ele usará o padrão para o mais recente disponível quando não for especificado. Recomendamos que você não especifique esse valor, a menos que seja absolutamente necessário.
name	string	O nome da habilidade que a identifica exclusivamente dentro do conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixado com o caractere '#'.
outputs	OutputFieldMappingEntry[]	A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como entrada por outra habilidade.

LineEnding

Enumeração

Define a sequência de caracteres a ser usada entre as linhas de texto reconhecidas pela habilidade do OCR. O valor padrão é "space".

Valor	Description
carriageReturn	As linhas são separadas por um caractere de retorno de carro ("\r").
carriageReturnLineFeed	As linhas são separadas por um retorno de carro e um caractere de alimentação de linha ("\r\n").
lineFeed	As linhas são separadas por um único caractere de feed de linha ("\n").
space	As linhas são separadas por um único caractere de espaço.

MergeSkill

Objeto

Uma habilidade para mesclar duas ou mais cadeias de caracteres em uma única cadeia de caracteres unificada, com um delimitador opcional definido pelo usuário separando cada parte do componente.

Nome	Tipo	Description
@odata.type	string: #Microsoft.Skills.Text.MergeSkill	Um fragmento de URI que especifica o tipo de habilidade.
context	string	Representa o nível em que as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document.
description	string	A descrição da habilidade que descreve as entradas, as saídas e o uso da habilidade.
inputs	InputFieldMappingEntry[]	As entradas das habilidades podem ser uma coluna no conjunto de dados de origem ou a saída de uma habilidade upstream.
insertPostTag	string	A marca indica o final do texto mesclado. Por padrão, a marca é um espaço vazio.
insertPreTag	string	A marca indica o início do texto mesclado. Por padrão, a marca é um espaço vazio.
name	string	O nome da habilidade que a identifica exclusivamente dentro do conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixado com o caractere '#'.
outputs	OutputFieldMappingEntry[]	A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como entrada por outra habilidade.

OcrSkill

Objeto

Uma habilidade que extrai texto de arquivos de imagem.

Nome	Tipo	Valor padrão	Description
@odata.type	string: #Microsoft.Skills.Vision.OcrSkill		Um fragmento de URI que especifica o tipo de habilidade.
context	string		Representa o nível em que as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document.
defaultLanguageCode	OcrSkillLanguage		Um valor que indica qual código de idioma usar. O padrão é `en`.
description	string		A descrição da habilidade que descreve as entradas, as saídas e o uso da habilidade.
detectOrientation	boolean	False	Um valor que indica ativar ou não a detecção de orientação. O padrão é false.
inputs	InputFieldMappingEntry[]		As entradas das habilidades podem ser uma coluna no conjunto de dados de origem ou a saída de uma habilidade upstream.
lineEnding	LineEnding		Define a sequência de caracteres a ser usada entre as linhas de texto reconhecidas pela habilidade do OCR. O valor padrão é "space".
name	string		O nome da habilidade que a identifica exclusivamente dentro do conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixado com o caractere '#'.
outputs	OutputFieldMappingEntry[]		A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como entrada por outra habilidade.

OcrSkillLanguage

Enumeração

Os códigos de idioma com suporte para entrada pelo OcrSkill.

Valor	Description
Jns	Jaunsari (Devanagiri)
af	Africâner
anp	Angika (Devanagiri)
ar	Árabe
ast	Asturiano
awa	Awadhi-Hindi (Devanagiri)
az	Azerbaijão (latino)
be	Bielorrusso (cirílico e latino)
be-cyrl	Bielorrusso (cirílico)
be-latn	Bielorrusso (latino)
bfy	Bagheli
bfz	Mahasu Pahari (Devanagiri)
bg	Búlgaro
bgc	Haryanvi
bho	Bhojpuri-Hindi (Devanagiri)
bi	Bislama
bns	Bundeli
br	Bretão
bra	Brajbha
brx	Bodo (Devanagiri)
bs	Latim bósnio
bua	Buryat (cirílico)
ca	Catalão
ceb	Cebuano
ch	Chamorro
cnr-cyrl	Montenegrino (cirílico)
cnr-latn	Montenegrino (latino)
co	Corso
crh	Tártaro da Criméia (latino)
cs	Tcheco
csb	Cassúbio
cy	Galês
da	Dinamarquês
de	Alemão
dhi	Dhimal (Devanagiri)
doi	Dogri (Devanagiri)
dsb	Sorbian inferior
el	Grego
en	Inglês
es	Espanhol
et	Estoniano
eu	Basco
fa	Persa
fi	Finlandês
fil	Filipinas
fj	Fijiano
fo	Faroês
fr	Francês
fur	Frulian
fy	Frísia Ocidental
ga	Irlandês
gag	Gagauz (latino)
gd	Gaélico escocês
gil	Gilbertese
gl	Galego
gon	Gondi (Devanagiri)
gv	Manx
gvr	Gurung (Devanagiri)
haw	Havaiano
hi	Hindi
hlb	Halbi (Devanagiri)
hne	Chhattisgarhi (Devanagiri)
hni	Hani
hoc	Ho (Devanagiri)
hr	Croata
hsb	Alto sorábio
ht	Haitiano
hu	Húngaro
ia	Interlíngua
id	Indonésio
is	Islandês
it	Italiano
iu	Inuktitut (latino)
ja	Japonês
jv	Javanês
kaa	Kara-Kalpak (latino)
kaa-cyrl	Kara-Kalpak (cirílico)
kac	Kachin (latino)
kea	Kabuverdianu
kfq	Korku
kha	Khasi
kk-cyrl	Cazaque (Cirílico)
kk-latn	Cazaque (latino)
kl	Gronelandês
klr	Khaling
kmj	Malto (Devanagiri)
ko	Coreano
kos	Kosraano
kpy	Koryak
krc	Karachay-Balkar
kru	Kurukh (Devanagiri)
ksh	Ripuário
ku-arab	Curdo (árabe)
ku-latn	Curdo (latino)
kum	Kumyk (cirílico)
kw	Córnico
ky	Quirguistão (cirílico)
la	Latim
lb	Luxemburguês
lkt	Lakota
lt	Lituano
mi	Maori
mn	Mongol (cirílico)
mr	Marata
ms	Malaio (latino)
mt	Maltês
mww	Hmong Daw (latino)
myv	Erzya (cirílico)
nap	Napolitano
nb	Norueguês
ne	Nepalês
niu	Niuean
nl	Holandês
no	Norueguês
nog	Nogay
oc	Occitano
os	Ossético
pa	Punjabi (árabe)
pl	Polonês
prs	Dari
ps	Pastó
pt	Português
quc	K'iche'
rab	Chamling
rm	Romanche
ro	Romeno
ru	Russo
sa	Sânscrito (Devanagiri)
sat	Santali (Devanagiri)
sck	Sadri (Devanagiri)
sco	Scots
sk	Eslovaco
sl	Esloveno
sm	Samoano (latino)
sma	Sami do Sul
sme	Sami do Norte (Latino)
smj	Lule Sami
smn	Inari Sami
sms	Skolt Sami
so	Somali (árabe)
sq	Albanês
sr	Sérvio (latino)
sr-Cyrl	Sérvio (Cirílico)
sr-Latn	Sérvio (latino)
srx	Sirmauri (Devanagiri)
sv	Sueco
sw	Swahili (latino)
tet	Tétum
tg	Tajique (cirílico)
thf	Thangmi
tk	Turcomenos (latino)
to	Tonga
tr	Turco
tt	Tártaro (latino)
tyv	Tuvan
ug	Uigure (árabe)
unk	Desconhecido (Todos)
ur	Urdu
uz	Uzbeque (latino)
uz-arab	Uzbeque (árabe)
uz-cyrl	Uzbeque (Cirílico)
vo	Volapuque
wae	Walser
xnr	Kangri (Devanagiri)
xsr	Sherpa (Devanagiri)
yua	Yucatec Maya
za	Zhuang
zh-Hans	Chinês simplificado
zh-Hant	Chinês tradicional
zu	Zulu

OutputFieldMappingEntry

Objeto

Mapeamento de campo de saída para uma habilidade.

Nome	Tipo	Description
name	string	O nome da saída definida pela habilidade.
targetName	string	O nome de destino da saída. Ele é opcional e o padrão para nomear.

PIIDetectionSkill

Objeto

Usando a API de Análise de Texto, extrai informações pessoais de um texto de entrada e oferece a opção de mascara-la.

Nome	Tipo	Description
@odata.type	string: #Microsoft.Skills.Text.PIIDetectionSkill	Um fragmento de URI que especifica o tipo de habilidade.
context	string	Representa o nível em que as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document.
defaultLanguageCode	string	Um valor que indica qual código de idioma usar. O padrão é `en`.
description	string	A descrição da habilidade que descreve as entradas, as saídas e o uso da habilidade.
domain	string	Se especificado, definirá o domínio PII para incluir apenas um subconjunto das categorias de entidade. Os valores possíveis incluem: 'phi', 'none'. O padrão é 'none'.
inputs	InputFieldMappingEntry[]	As entradas das habilidades podem ser uma coluna no conjunto de dados de origem ou a saída de uma habilidade upstream.
maskingCharacter	string maxLength: 1	O caractere usado para mascarar o texto se o parâmetro maskingMode estiver definido para substituir. O padrão é '*'.
maskingMode	PIIDetectionSkillMaskingMode	Um parâmetro que fornece várias maneiras de mascarar as informações pessoais detectadas no texto de entrada. O padrão é 'none'.
minimumPrecision	number (double) minimum: 0 maximum: 1	Um valor entre 0 e 1 que será usado apenas para incluir entidades cuja pontuação de confiança é maior que o valor especificado. Se não for definido (padrão) ou se definido explicitamente como nulo, todas as entidades serão incluídas.
modelVersion	string	A versão do modelo a ser usada ao chamar o serviço de Análise de Texto. Ele usará o padrão para o mais recente disponível quando não for especificado. Recomendamos que você não especifique esse valor, a menos que seja absolutamente necessário.
name	string	O nome da habilidade que a identifica exclusivamente dentro do conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixado com o caractere '#'.
outputs	OutputFieldMappingEntry[]	A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como entrada por outra habilidade.
piiCategories	string[]	Uma lista de categorias de entidade pii que devem ser extraídas e mascaradas.

PIIDetectionSkillMaskingMode

Enumeração

Uma cadeia de caracteres que indica qual maskingMode usar para mascarar as informações pessoais detectadas no texto de entrada.

Valor	Description
none	Nenhuma máscara ocorre e a saída maskedText não será retornada.
replace	Substitui as entidades detectadas pelo caractere dado no parâmetro maskingCharacter. O caractere será repetido até o comprimento da entidade detectada para que os deslocamentos correspondam corretamente ao texto de entrada, bem como ao maskedText de saída.

SearchIndexerDataNoneIdentity

Objeto

Limpa a propriedade de identidade de uma fonte de dados.

Nome	Tipo	Description
@odata.type	string: #Microsoft.Azure.Search.DataNoneIdentity	Um fragmento de URI que especifica o tipo de identidade.

SearchIndexerDataUserAssignedIdentity

Objeto

Especifica a identidade de uma fonte de dados a ser usada.

Nome	Tipo	Description
@odata.type	string: #Microsoft.Azure.Search.DataUserAssignedIdentity	Um fragmento de URI que especifica o tipo de identidade.
userAssignedIdentity	string	A ID de recurso do Azure totalmente qualificada de uma identidade gerenciada atribuída pelo usuário normalmente no formato "/subscriptions/12345678-1234-1234-12334-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId" que deveria ter sido atribuída ao serviço de pesquisa.

SearchIndexerIndexProjections

Objeto

Definição de projeções adicionais para índices de pesquisa secundários.

Nome	Tipo	Description
parameters	SearchIndexerIndexProjectionsParameters	Um dicionário de propriedades de configuração específicas da projeção de índice. Cada nome é o nome de uma propriedade específica. Cada valor deve ser de um tipo primitivo.
selectors	SearchIndexerIndexProjectionSelector[]	Uma lista de projeções a serem executadas em índices de pesquisa secundários.

SearchIndexerIndexProjectionSelector

Objeto

Descrição de quais dados armazenar no índice de pesquisa designado.

Nome	Tipo	Description
mappings	InputFieldMappingEntry[]	Mapeamentos para a projeção ou qual fonte deve ser mapeada para qual campo no índice de destino.
parentKeyFieldName	string	Nome do campo no índice de pesquisa para o qual mapear o valor da chave do documento pai. Deve ser um campo de cadeia de caracteres que seja filtrado e não o campo de chave.
sourceContext	string	Contexto de origem para as projeções. Representa a cardinalidade na qual o documento será dividido em vários subprocursos.
targetIndexName	string	Nome do índice de pesquisa para o qual projetar. Deve ter um campo de chave com o conjunto de analisadores "palavra-chave".

SearchIndexerIndexProjectionsParameters

Objeto

Um dicionário de propriedades de configuração específicas da projeção de índice. Cada nome é o nome de uma propriedade específica. Cada valor deve ser de um tipo primitivo.

Nome	Tipo	Description
projectionMode	IndexProjectionMode	Define o comportamento das projeções de índice em relação ao restante do indexador.

SearchIndexerKnowledgeStore

Objeto

Definição de projeções adicionais para blob, tabela ou arquivos do Azure de dados enriquecidos.

Nome	Tipo	Description
projections	SearchIndexerKnowledgeStoreProjection[]	Uma lista de projeções adicionais a serem executadas durante a indexação.
storageConnectionString	string	A cadeia de conexão para as projeções da conta de armazenamento será armazenada.

SearchIndexerKnowledgeStoreFileProjectionSelector

Objeto

Definição de projeção para quais dados armazenar nos Arquivos do Azure.

Nome	Tipo	Description
generatedKeyName	string	Nome da chave gerada na qual armazenar a projeção.
inputs	InputFieldMappingEntry[]	Entradas aninhadas para projeções complexas.
referenceKeyName	string	Nome da chave de referência para projeção diferente.
source	string	Dados de origem para projeto.
sourceContext	string	Contexto de origem para projeções complexas.
storageContainer	string	Contêiner de blob no qual armazenar projeções.

SearchIndexerKnowledgeStoreObjectProjectionSelector

Objeto

Definição de projeção para quais dados armazenar no Blob do Azure.

Nome	Tipo	Description
generatedKeyName	string	Nome da chave gerada na qual armazenar a projeção.
inputs	InputFieldMappingEntry[]	Entradas aninhadas para projeções complexas.
referenceKeyName	string	Nome da chave de referência para projeção diferente.
source	string	Dados de origem para projeto.
sourceContext	string	Contexto de origem para projeções complexas.
storageContainer	string	Contêiner de blob no qual armazenar projeções.

SearchIndexerKnowledgeStoreProjection

Objeto

Objeto de contêiner para vários seletores de projeção.

Nome	Tipo	Description
files	SearchIndexerKnowledgeStoreFileProjectionSelector[]	Projeções para o Armazenamento de Arquivos do Azure.
objects	SearchIndexerKnowledgeStoreObjectProjectionSelector[]	Projeções para o Armazenamento de Blobs do Azure.
tables	SearchIndexerKnowledgeStoreTableProjectionSelector[]	Projeções para o Armazenamento de Tabelas do Azure.

SearchIndexerKnowledgeStoreTableProjectionSelector

Objeto

Descrição de quais dados armazenar nas Tabelas do Azure.

Nome	Tipo	Description
generatedKeyName	string	Nome da chave gerada na qual armazenar a projeção.
inputs	InputFieldMappingEntry[]	Entradas aninhadas para projeções complexas.
referenceKeyName	string	Nome da chave de referência para projeção diferente.
source	string	Dados de origem para projeto.
sourceContext	string	Contexto de origem para projeções complexas.
tableName	string	Nome da tabela do Azure na qual os dados projetados serão armazenados.

SearchIndexerSkillset

Objeto

Uma lista de habilidades.

Nome	Tipo	Description
@odata.etag	string	A ETag do conjunto de habilidades.
cognitiveServices	CognitiveServicesAccount: CognitiveServicesAccountKey DefaultCognitiveServicesAccount	Detalhes sobre o serviço de IA do Azure a ser usado ao executar habilidades.
description	string	A descrição do conjunto de habilidades.
encryptionKey	SearchResourceEncryptionKey	Uma descrição de uma chave de criptografia que você cria no Azure Key Vault. Essa chave é usada para fornecer um nível adicional de criptografia em repouso para sua definição de conjunto de habilidades quando você quiser ter total garantia de que ninguém, nem mesmo a Microsoft, pode descriptografar sua definição de conjunto de habilidades. Depois de criptografar sua definição de conjunto de habilidades, ela sempre permanecerá criptografada. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como nula. Você pode alterar essa propriedade conforme necessário se quiser girar sua chave de criptografia; Sua definição de conjunto de habilidades não será afetada. A criptografia com chaves gerenciadas pelo cliente não está disponível para serviços de pesquisa gratuitos e só está disponível para serviços pagos criados em 1º de janeiro de 2019 ou depois de 1º de janeiro de 2019.
indexProjections	SearchIndexerIndexProjections	Definição de projeções adicionais para índices de pesquisa secundários.
knowledgeStore	SearchIndexerKnowledgeStore	Definição de projeções adicionais para blob, tabela ou arquivos do Azure de dados enriquecidos.
name	string	O nome do conjunto de habilidades.
skills	SearchIndexerSkill[]: AzureOpenAIEmbeddingSkill[] ConditionalSkill[] CustomEntityLookupSkill[] DocumentExtractionSkill[] EntityLinkingSkill[] EntityRecognitionSkill[] EntityRecognitionSkillV3[] ImageAnalysisSkill[] KeyPhraseExtractionSkill[] LanguageDetectionSkill[] MergeSkill[] OcrSkill[] PIIDetectionSkill[] SentimentSkill[] SentimentSkillV3[] ShaperSkill[] SplitSkill[] TextTranslationSkill[] WebApiSkill[]	Uma lista de habilidades no conjunto de habilidades.

SearchResourceEncryptionKey

Objeto

Uma chave de criptografia gerenciada pelo cliente no Azure Key Vault. As chaves que você cria e gerencia podem ser usadas para criptografar ou descriptografar dados em repouso, como índices e mapas de sinônimos.

Nome	Tipo	Description
accessCredentials	AzureActiveDirectoryApplicationCredentials	Credenciais opcionais do Azure Active Directory usadas para acessar o Azure Key Vault. Não é necessário se estiver usando a identidade gerenciada.
keyVaultKeyName	string	O nome da chave do Azure Key Vault a ser usada para criptografar seus dados em repouso.
keyVaultKeyVersion	string	A versão da chave do Azure Key Vault a ser usada para criptografar seus dados em repouso.
keyVaultUri	string	O URI do Azure Key Vault, também conhecido como nome DNS, que contém a chave a ser usada para criptografar seus dados em repouso. Um URI de exemplo pode ser `https://my-keyvault-name.vault.azure.net`.

SentimentSkill

Objeto

Essa habilidade foi preterida. Use a V3. Em vez disso, SentimentSkill.

Nome	Tipo	Description
@odata.type	string: #Microsoft.Skills.Text.SentimentSkill	Um fragmento de URI que especifica o tipo de habilidade.
context	string	Representa o nível em que as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document.
defaultLanguageCode	SentimentSkillLanguage	Um valor que indica qual código de idioma usar. O padrão é `en`.
description	string	A descrição da habilidade que descreve as entradas, as saídas e o uso da habilidade.
inputs	InputFieldMappingEntry[]	As entradas das habilidades podem ser uma coluna no conjunto de dados de origem ou a saída de uma habilidade upstream.
name	string	O nome da habilidade que a identifica exclusivamente dentro do conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixado com o caractere '#'.
outputs	OutputFieldMappingEntry[]	A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como entrada por outra habilidade.

SentimentSkillLanguage

Enumeração

Deprecado. Os códigos de idioma com suporte para texto de entrada pelo SentimentSkill.

Valor	Description
da	Dinamarquês
de	Alemão
el	Grego
en	Inglês
es	Espanhol
fi	Finlandês
fr	Francês
it	Italiano
nl	Holandês
no	Norueguês (Bokmaal)
pl	Polonês
pt-PT	Português (Portugal)
ru	Russo
sv	Sueco
tr	Turco

SentimentSkillV3

Objeto

Usando a API de Análise de Texto, avalia o texto não estruturado e, para cada registro, fornece rótulos de sentimento (como "negativo", "neutro" e "positivo") com base na pontuação de confiança mais alta encontrada pelo serviço em uma frase e no nível do documento.

Nome	Tipo	Valor padrão	Description
@odata.type	string: #Microsoft.Skills.Text.V3.SentimentSkill		Um fragmento de URI que especifica o tipo de habilidade.
context	string		Representa o nível em que as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document.
defaultLanguageCode	string		Um valor que indica qual código de idioma usar. O padrão é `en`.
description	string		A descrição da habilidade que descreve as entradas, as saídas e o uso da habilidade.
includeOpinionMining	boolean	False	Se definido como true, a saída da habilidade incluirá informações da Análise de Texto para mineração de opinião, ou seja, destinos (substantivos ou verbos) e sua avaliação associada (adjetiva) no texto. O padrão é false.
inputs	InputFieldMappingEntry[]		As entradas das habilidades podem ser uma coluna no conjunto de dados de origem ou a saída de uma habilidade upstream.
modelVersion	string		A versão do modelo a ser usada ao chamar o serviço de Análise de Texto. Ele usará o padrão para o mais recente disponível quando não for especificado. Recomendamos que você não especifique esse valor, a menos que seja absolutamente necessário.
name	string		O nome da habilidade que a identifica exclusivamente dentro do conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixado com o caractere '#'.
outputs	OutputFieldMappingEntry[]		A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como entrada por outra habilidade.

ShaperSkill

Objeto

Uma habilidade para remodelar as saídas. Ele cria um tipo complexo para dar suporte a campos compostos (também conhecidos como campos de várias partes).

Nome	Tipo	Description
@odata.type	string: #Microsoft.Skills.Util.ShaperSkill	Um fragmento de URI que especifica o tipo de habilidade.
context	string	Representa o nível em que as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document.
description	string	A descrição da habilidade que descreve as entradas, as saídas e o uso da habilidade.
inputs	InputFieldMappingEntry[]	As entradas das habilidades podem ser uma coluna no conjunto de dados de origem ou a saída de uma habilidade upstream.
name	string	O nome da habilidade que a identifica exclusivamente dentro do conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixado com o caractere '#'.
outputs	OutputFieldMappingEntry[]	A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como entrada por outra habilidade.

SplitSkill

Objeto

Uma habilidade para dividir uma cadeia de caracteres em partes de texto.

Nome	Tipo	Description
@odata.type	string: #Microsoft.Skills.Text.SplitSkill	Um fragmento de URI que especifica o tipo de habilidade.
context	string	Representa o nível em que as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document.
defaultLanguageCode	SplitSkillLanguage	Um valor que indica qual código de idioma usar. O padrão é `en`.
description	string	A descrição da habilidade que descreve as entradas, as saídas e o uso da habilidade.
inputs	InputFieldMappingEntry[]	As entradas das habilidades podem ser uma coluna no conjunto de dados de origem ou a saída de uma habilidade upstream.
maximumPageLength	integer (int32)	O comprimento máximo de página desejado. O padrão é 10000.
maximumPagesToTake	integer (int32)	Aplicável somente quando textSplitMode é definido como 'pages'. Se especificado, o SplitSkill interromperá a divisão depois de processar as primeiras páginas 'maximumPagesToTake', a fim de melhorar o desempenho quando apenas algumas páginas iniciais forem necessárias de cada documento.
name	string	O nome da habilidade que a identifica exclusivamente dentro do conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixado com o caractere '#'.
outputs	OutputFieldMappingEntry[]	A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como entrada por outra habilidade.
pageOverlapLength	integer (int32)	Aplicável somente quando textSplitMode é definido como 'pages'. Se especificado, n+1º bloco começará com esse número de caracteres/tokens a partir do final da nth chunk.
textSplitMode	TextSplitMode	Um valor que indica qual modo de divisão executar.

SplitSkillLanguage

Enumeração

Os códigos de idioma compatíveis com o texto de entrada por SplitSkill.

Valor	Description
am	Amárico
bs	Bósnio
cs	Tcheco
da	Dinamarquês
de	Alemão
en	Inglês
es	Espanhol
et	Estoniano
fi	Finlandês
fr	Francês
he	Hebraico
hi	Hindi
hr	Croata
hu	Húngaro
id	Indonésio
is	Islandês
it	Italiano
ja	Japonês
ko	Coreano
lv	Letão
nb	Norueguês
nl	Holandês
pl	Polonês
pt	Português (Portugal)
pt-br	Português (Brasil)
ru	Russo
sk	Eslovaco
sl	Esloveno
sr	Sérvio
sv	Sueco
tr	Turco
ur	Urdu
zh	Chinês (simplificado)

TextSplitMode

Enumeração

Um valor que indica qual modo de divisão executar.

Valor	Description
pages	Divida o texto em páginas individuais.
sentences	Divida o texto em frases individuais.

TextTranslationSkill

Objeto

Uma habilidade para traduzir texto de um idioma para outro.

Nome	Tipo	Description
@odata.type	string: #Microsoft.Skills.Text.TranslationSkill	Um fragmento de URI que especifica o tipo de habilidade.
context	string	Representa o nível em que as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document.
defaultFromLanguageCode	TextTranslationSkillLanguage	O código de idioma do qual traduzir documentos para documentos que não especificam o idioma explicitamente.
defaultToLanguageCode	TextTranslationSkillLanguage	O código de idioma para traduzir documentos para documentos que não especificam o idioma explicitamente.
description	string	A descrição da habilidade que descreve as entradas, as saídas e o uso da habilidade.
inputs	InputFieldMappingEntry[]	As entradas das habilidades podem ser uma coluna no conjunto de dados de origem ou a saída de uma habilidade upstream.
name	string	O nome da habilidade que a identifica exclusivamente dentro do conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixado com o caractere '#'.
outputs	OutputFieldMappingEntry[]	A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como entrada por outra habilidade.
suggestedFrom	TextTranslationSkillLanguage	O código de idioma para traduzir documentos de quando nem a entrada fromLanguageCode nem o parâmetro defaultFromLanguageCode são fornecidos e a detecção automática de idioma não é bem-sucedida. O padrão é `en`.

TextTranslationSkillLanguage

Enumeração

Os códigos de idioma com suporte para texto de entrada por TextTranslationSkill.

Valor	Description
af	Africâner
ar	Árabe
bg	Búlgaro
bn	Bangla
bs	Bósnio (latino)
ca	Catalão
cs	Tcheco
cy	Galês
da	Dinamarquês
de	Alemão
el	Grego
en	Inglês
es	Espanhol
et	Estoniano
fa	Persa
fi	Finlandês
fil	Filipinas
fj	Fijiano
fr	Francês
ga	Irlandês
he	Hebraico
hi	Hindi
hr	Croata
ht	Haitiano
hu	Húngaro
id	Indonésio
is	Islandês
it	Italiano
ja	Japonês
kn	Kannada
ko	Coreano
lt	Lituano
lv	Letão
mg	Malgaxe
mi	Maori
ml	Malaiala
ms	Malaio
mt	Maltês
mww	Hmong Daw
nb	Norueguês
nl	Holandês
otq	Queretaro Otomi
pa	Punjabi
pl	Polonês
pt	Português
pt-PT	Português (Portugal)
pt-br	Português (Brasil)
ro	Romeno
ru	Russo
sk	Eslovaco
sl	Esloveno
sm	Samoano
sr-Cyrl	Sérvio (Cirílico)
sr-Latn	Sérvio (latino)
sv	Sueco
sw	Kiswahili
ta	Tâmil
te	Telugu
th	Tailandês
tlh	Klingon
tlh-Latn	Klingon (script latino)
tlh-Piqd	Klingon (script Klingon)
to	Tonga
tr	Turco
ty	Taitiano
uk	Ucraniano
ur	Urdu
vi	Vietnamita
yua	Yucatec Maya
yue	Cantonês (Tradicional)
zh-Hans	Chinês simplificado
zh-Hant	Chinês tradicional

VisualFeature

Enumeração

As cadeias de caracteres que indicam quais tipos de recursos visuais devem ser retornados.

Valor	Description
adult	Recursos visuais reconhecidos como pessoas adultas.
brands	Recursos visuais reconhecidos como marcas comerciais.
categories	Categorias.
description	Descrição.
faces	Recursos visuais reconhecidos como rostos de pessoas.
objects	Recursos visuais reconhecidos como objetos.
tags	Tags.

WebApiSkill

Objeto

Uma habilidade que pode chamar um ponto de extremidade de API Web, permitindo que você estenda um conjunto de habilidades fazendo com que ele chame seu código personalizado.

Nome	Tipo	Description
@odata.type	string: #Microsoft.Skills.Custom.WebApiSkill	Um fragmento de URI que especifica o tipo de habilidade.
authIdentity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	A identidade gerenciada atribuída pelo usuário usada para conexões de saída. Se um authResourceId for fornecido e não for especificado, a identidade gerenciada atribuída pelo sistema será usada. Em atualizações para o indexador, se a identidade não for especificada, o valor permanecerá inalterado. Se definido como "nenhum", o valor dessa propriedade será desmarcado.
authResourceId	string	Aplica-se a habilidades personalizadas que se conectam ao código externo em uma função do Azure ou em algum outro aplicativo que fornece as transformações. Esse valor deve ser a ID do aplicativo criada para a função ou aplicativo quando ela foi registrada no Azure Active Directory. Quando especificado, a habilidade personalizada se conecta à função ou aplicativo usando uma ID gerenciada (sistema ou atribuído pelo usuário) do serviço de pesquisa e o token de acesso da função ou aplicativo, usando esse valor como a ID do recurso para criar o escopo do token de acesso.
batchSize	integer (int32)	O tamanho do lote desejado que indica o número de documentos.
context	string	Representa o nível em que as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document.
degreeOfParallelism	integer (int32)	Se definido, o número de chamadas paralelas que podem ser feitas na API Web.
description	string	A descrição da habilidade que descreve as entradas, as saídas e o uso da habilidade.
httpHeaders	object	Os cabeçalhos necessários para fazer a solicitação http.
httpMethod	string	O método para a solicitação http.
inputs	InputFieldMappingEntry[]	As entradas das habilidades podem ser uma coluna no conjunto de dados de origem ou a saída de uma habilidade upstream.
name	string	O nome da habilidade que a identifica exclusivamente dentro do conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixado com o caractere '#'.
outputs	OutputFieldMappingEntry[]	A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como entrada por outra habilidade.
timeout	string (duration)	O tempo limite desejado para a solicitação. O padrão é 30 segundos.
uri	string	A URL da API Web.

Compartilhar via

Skillsets - Get

Parâmetros de URI

Cabeçalho da solicitação

Respostas

Exemplos

SearchServiceGetSkillset

Solicitação de exemplo

Resposta de exemplo

Definições

AzureActiveDirectoryApplicationCredentials

AzureOpenAIEmbeddingSkill

AzureOpenAIModelName

CognitiveServicesAccountKey

ConditionalSkill

CustomEntity

CustomEntityAlias

CustomEntityLookupSkill

CustomEntityLookupSkillLanguage

DefaultCognitiveServicesAccount

DocumentExtractionSkill

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

SearchIndexerKnowledgeStoreProjection

SearchIndexerKnowledgeStoreTableProjectionSelector

SearchIndexerSkillset

SearchResourceEncryptionKey

SentimentSkill

SentimentSkillLanguage

SentimentSkillV3

ShaperSkill

SplitSkill

SplitSkillLanguage

TextSplitMode

TextTranslationSkill

TextTranslationSkillLanguage

VisualFeature

WebApiSkill

Recursos adicionais