Partilhar via


Skillsets - Get

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

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

Parâmetros do URI

Name Em Necessá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 do Pedido

Name Necessário Tipo Description
x-ms-client-request-id

string

uuid

O ID de rastreamento enviado com a solicitação para ajudar com a depuração.

Respostas

Name Tipo Description
200 OK

SearchIndexerSkillset

O conjunto de habilidades é devolvido com sucesso.

Other Status Codes

ErrorResponse

Resposta de erro.

Exemplos

SearchServiceGetSkillset

Pedido de amostra

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

Resposta da amostra

{
  "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

Name Description
AzureActiveDirectoryApplicationCredentials

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

AzureOpenAIEmbeddingSkill

Permite gerar uma incorporação vetorial 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 de 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 que cenários que exigem uma operação booleana determinem os dados a serem atribuídos a uma saída.

CustomEntity

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

CustomEntityAlias

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

CustomEntityLookupSkill

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

CustomEntityLookupSkillLanguage

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

DefaultCognitiveServicesAccount

Um objeto vazio que representa o recurso de serviço de IA padrão do Azure 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

Esta habilidade foi preterida. Use a V3. EntityRecognitionSkill em vez disso.

EntityRecognitionSkillLanguage

Preterido. Os códigos de idioma suportados para texto de entrada por EntityRecognitionSkill.

EntityRecognitionSkillV3

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

ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta de erro

ImageAnalysisSkill

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

ImageAnalysisSkillLanguage

Os códigos de idioma suportados 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 do índice em relação ao resto do indexador.

InputFieldMappingEntry

Mapeamento de campo de entrada para uma habilidade.

KeyPhraseExtractionSkill

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

KeyPhraseExtractionSkillLanguage

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

LanguageDetectionSkill

Uma habilidade que deteta o idioma do texto de entrada e relata um único código de idioma para cada documento enviado na solicitação. O código da linguagem é 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 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 suportados 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 mascará-lo.

PIIDetectionSkillMaskingMode

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

SearchIndexerDataNoneIdentity

Limpa a propriedade identity de uma fonte de dados.

SearchIndexerDataUserAssignedIdentity

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

SearchIndexerIndexProjections

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

SearchIndexerIndexProjectionSelector

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

SearchIndexerIndexProjectionsParameters

Um dicionário de propriedades de configuração específicas de 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 azure blob, tabela ou arquivos, 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 dos dados a armazenar nas Tabelas do Azure.

SearchIndexerSkillset

Uma lista de competências.

SearchResourceEncryptionKey

Uma chave de criptografia gerenciada pelo cliente no Cofre de Chaves do Azure. 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

Esta habilidade foi preterida. Use a V3. SentimentSkill em vez disso.

SentimentSkillLanguage

Preterido. Os códigos de idioma suportados para texto de entrada por SentimentSkill.

SentimentSkillV3

Usando a API de Análise de Texto, avalia 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 nível de frase e documento.

ShaperSkill

Uma habilidade para remodelar os resultados. Ele cria um tipo complexo para suportar campos compostos (também conhecidos como campos de várias partes).

SplitSkill

Uma habilidade para dividir uma cadeia de caracteres em pedaços de texto.

SplitSkillLanguage

Os códigos de idioma suportados para 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 suportados 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 da Web, permitindo que você estenda um conjunto de habilidades fazendo com que ele chame seu código personalizado.

AzureActiveDirectoryApplicationCredentials

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

Name Tipo Description
applicationId

string

Uma ID de Aplicativo AAD que recebeu as permissões de acesso necessárias ao Cofre da Chave do Azure que deve ser usada ao criptografar seus dados em repouso. A ID do aplicativo não deve ser confundida com a ID do objeto do seu aplicativo AAD.

applicationSecret

string

A chave de autenticação do aplicativo AAD especificado.

AzureOpenAIEmbeddingSkill

Permite gerar uma incorporação vetorial para uma determinada entrada de texto usando o recurso Azure OpenAI.

Name Tipo Description
@odata.type string:

#Microsoft.Skills.Text.AzureOpenAIEmbeddingSkill

Um fragmento de URI especificando o tipo de habilidade.

apiKey

string

Chave de API do recurso OpenAI do Azure designado.

authIdentity SearchIndexerDataIdentity:

A identidade gerenciada atribuída pelo usuário usada para conexões de saída.

context

string

Representa o nível no qual 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 do modelo OpenAI do Azure no recurso designado.

description

string

A descrição da habilidade que descreve as entradas, saídas e uso da habilidade.

dimensions

integer

O número de dimensões que as incorporações de saída resultantes devem ter. Suportado apenas em text-embedding-3 e modelos posteriores.

inputs

InputFieldMappingEntry[]

As entradas das habilidades podem ser uma coluna no conjunto de dados de origem ou a saída de uma habilidade a montante.

modelName

AzureOpenAIModelName

O nome do modelo de incorporaçã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, prefixada 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 uma entrada por outra habilidade.

resourceUri

string

O URI do recurso Azure OpenAI.

AzureOpenAIModelName

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

Name Tipo Description
text-embedding-3-large

string

text-embedding-3-small

string

text-embedding-ada-002

string

CognitiveServicesAccountKey

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

Name Tipo Description
@odata.type string:

#Microsoft.Azure.Search.CognitiveServicesByKey

Um fragmento de URI especificando 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

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

Name Tipo Description
@odata.type string:

#Microsoft.Skills.Util.ConditionalSkill

Um fragmento de URI especificando o tipo de habilidade.

context

string

Representa o nível no qual 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, saídas e 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 a montante.

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, prefixada 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 uma entrada por outra habilidade.

CustomEntity

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

Name Tipo Description
accentSensitive

boolean

O padrão é false. Valor booleano 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 grafias alternativas ou sinônimos para o nome da entidade raiz.

caseSensitive

boolean

O padrão é false. Valor booleano que indica se as comparações com o nome da entidade devem ser sensíveis à caixa de caracteres. Exemplos de correspondências que não diferenciam maiúsculas de minúsculas de "Microsoft" podem ser: microsoft, microSoft, MICROSOFT.

defaultAccentSensitive

boolean

Altera o valor de sensibilidade de acento padrão para esta entidade. Ele será usado para alterar o valor padrão de todos os aliases accentSensitive valores.

defaultCaseSensitive

boolean

Altera o valor padrão de diferenciação de maiúsculas e minúsculas para esta entidade. Ele será usado para alterar o valor padrão de todos os aliases valores caseSensitive.

defaultFuzzyEditDistance

integer

Altera o valor de distância de edição difusa padrão para esta entidade. Ele pode ser usado para alterar o valor padrão de todos os valores de aliases fuzzyEditDistance.

description

string

Este campo pode ser usado como uma passagem para metadados personalizados sobre o(s) texto(s) correspondente(s). O valor deste campo aparecerá com cada correspondência de sua entidade na saída de habilidade.

fuzzyEditDistance

integer

O padrão é 0. Valor máximo de 5. Indica o número aceitável de caracteres divergentes que ainda constituiriam uma correspondência com o nome da entidade. A menor imprecisão possível para qualquer partida é devolvida. Por exemplo, se a distância de edição estiver definida como 3, "Windows10" ainda corresponderia a "Windows", "Windows10" e "Windows 7". Quando a diferenciação de maiúsculas e minúsculas é definida como falsa, as diferenças entre maiúsculas e minúsculas NÃO contam para a tolerância difusa, mas de outra forma contam.

id

string

Este campo pode ser usado como uma passagem para metadados personalizados sobre o(s) texto(s) correspondente(s). O valor deste campo aparecerá com cada correspondência de sua entidade na saída de habilidade.

name

string

O descritor de entidade de nível superior. As correspondências na saída de habilidade serão agrupadas por este nome, e ele deve representar a forma "normalizada" do texto que está sendo encontrado.

subtype

string

Este campo pode ser usado como uma passagem para metadados personalizados sobre o(s) texto(s) correspondente(s). O valor deste campo aparecerá com cada correspondência de sua entidade na saída de habilidade.

type

string

Este campo pode ser usado como uma passagem para metadados personalizados sobre o(s) texto(s) correspondente(s). O valor deste campo aparecerá com cada correspondência de sua entidade na saída de habilidade.

CustomEntityAlias

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

Name 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

Determine a distância de edição difusa do alias.

text

string

O texto do pseudónimo.

CustomEntityLookupSkill

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

Name Tipo Description
@odata.type string:

#Microsoft.Skills.Text.CustomEntityLookupSkill

Um fragmento de URI especificando o tipo de habilidade.

context

string

Representa o nível no qual 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, saídas e uso da habilidade.

entitiesDefinitionUri

string

Caminho para um arquivo JSON ou CSV contendo todo o texto de destino a ser correspondido. Esta definição de entidade é lida no início de uma execução de indexador. Quaisquer atualizações para este arquivo durante uma execução do indexador não terão efeito até execuções subsequentes. Essa configuração deve ser acessível por HTTPS.

globalDefaultAccentSensitive

boolean

Uma bandeira 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

Uma bandeira global para FuzzyEditDistance. Se FuzzyEditDistance não estiver definido em CustomEntity, esse valor será o valor padrão.

inlineEntitiesDefinition

CustomEntity[]

A definição CustomEntity embutida.

inputs

InputFieldMappingEntry[]

As entradas das habilidades podem ser uma coluna no conjunto de dados de origem ou a saída de uma habilidade a montante.

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, prefixada 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 uma entrada por outra habilidade.

CustomEntityLookupSkillLanguage

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

Name Tipo Description
da

string

Dinamarquês

de

string

Alemão

en

string

Inglês

es

string

Espanhol

fi

string

Finlandês

fr

string

Francês

it

string

Italiano

ko

string

Coreano

pt

string

Português

DefaultCognitiveServicesAccount

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

Name Tipo Description
@odata.type string:

#Microsoft.Azure.Search.DefaultCognitiveServices

Um fragmento de URI especificando 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

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

Name Tipo Description
@odata.type string:

#Microsoft.Skills.Util.DocumentExtractionSkill

Um fragmento de URI especificando o tipo de habilidade.

configuration

object

Um dicionário de configurações para a habilidade.

context

string

Representa o nível no qual 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 estiver definido.

description

string

A descrição da habilidade que descreve as entradas, saídas e 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 a montante.

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, prefixada 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 uma entrada por outra habilidade.

parsingMode

string

O parsingMode para a habilidade. Será definido como 'padrão' se não estiver definido.

EntityCategory

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

Name Tipo Description
datetime

string

Entidades que descrevem uma data e hora.

email

string

Entidades que descrevem um endereço de e-mail.

location

string

Entidades que descrevem uma localização física.

organization

string

Entidades que descrevem uma organização.

person

string

Entidades que descrevem uma pessoa.

quantity

string

Entidades que descrevem uma quantidade.

url

string

Entidades que descrevem um URL.

EntityLinkingSkill

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

Name Tipo Description
@odata.type string:

#Microsoft.Skills.Text.V3.EntityLinkingSkill

Um fragmento de URI especificando o tipo de habilidade.

context

string

Representa o nível no qual 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, saídas e 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 a montante.

minimumPrecision

number

Um valor entre 0 e 1 que deve ser usado para incluir apenas entidades cuja pontuação de confiança é maior do que o valor especificado. Se não estiver definido (padrão), ou se explicitamente definido 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. O padrão será o mais recente disponível quando não 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, prefixada 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 uma entrada por outra habilidade.

EntityRecognitionSkill

Esta habilidade foi preterida. Use a V3. EntityRecognitionSkill em vez disso.

Name Tipo Description
@odata.type string:

#Microsoft.Skills.Text.EntityRecognitionSkill

Um fragmento de URI especificando o tipo de habilidade.

categories

EntityCategory[]

Uma lista de categorias de entidades que devem ser extraídas.

context

string

Representa o nível no qual 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, saídas e uso da habilidade.

includeTypelessEntities

boolean

Determina se devem ou não incluir entidades que são bem conhecidas, 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 falsa, as entidades que não estiverem 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 a montante.

minimumPrecision

number

Um valor entre 0 e 1 que deve ser usado para incluir apenas entidades cuja pontuação de confiança é maior do que o valor especificado. Se não estiver definido (padrão), ou se explicitamente definido 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, prefixada 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 uma entrada por outra habilidade.

EntityRecognitionSkillLanguage

Preterido. Os códigos de idioma suportados para texto de entrada por EntityRecognitionSkill.

Name Tipo Description
ar

string

Árabe

cs

string

Checo

da

string

Dinamarquês

de

string

Alemão

el

string

Grego

en

string

Inglês

es

string

Espanhol

fi

string

Finlandês

fr

string

Francês

hu

string

Húngaro

it

string

Italiano

ja

string

Japonês

ko

string

Coreano

nl

string

Holandês

no

string

Norueguês (Bokmaal)

pl

string

Polaco

pt-BR

string

Português (Brasil)

pt-PT

string

Português (Portugal)

ru

string

Russo

sv

string

Sueco

tr

string

Turco

zh-Hans

string

Chinese-Simplified

zh-Hant

string

Chinese-Traditional

EntityRecognitionSkillV3

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

Name Tipo Description
@odata.type string:

#Microsoft.Skills.Text.V3.EntityRecognitionSkill

Um fragmento de URI especificando o tipo de habilidade.

categories

string[]

Uma lista de categorias de entidades que devem ser extraídas.

context

string

Representa o nível no qual 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, saídas e 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 a montante.

minimumPrecision

number

Um valor entre 0 e 1 que deve ser usado para incluir apenas entidades cuja pontuação de confiança é maior do que o valor especificado. Se não estiver definido (padrão), ou se explicitamente definido 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. O padrão será o mais recente disponível quando não 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, prefixada 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 uma entrada por outra habilidade.

ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

Name Tipo Description
info

object

As informações adicionais.

type

string

O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Name Tipo Description
additionalInfo

ErrorAdditionalInfo[]

O erro informações adicionais.

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

Resposta de erro

Name Tipo Description
error

ErrorDetail

O objeto de erro.

ImageAnalysisSkill

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

Name Tipo Description
@odata.type string:

#Microsoft.Skills.Vision.ImageAnalysisSkill

Um fragmento de URI especificando o tipo de habilidade.

context

string

Representa o nível no qual 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, saídas e 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 a montante.

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, prefixada 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 uma entrada por outra habilidade.

visualFeatures

VisualFeature[]

Uma lista de recursos visuais.

ImageAnalysisSkillLanguage

Os códigos de idioma suportados para entrada por ImageAnalysisSkill.

Name Tipo Description
ar

string

Árabe

az

string

Azerbaijão

bg

string

Búlgaro

bs

string

Bósnio Latino

ca

string

Catalão

cs

string

Checo

cy

string

Galês

da

string

Dinamarquês

de

string

Alemão

el

string

Grego

en

string

Inglês

es

string

Espanhol

et

string

Estoniano

eu

string

Basco

fi

string

Finlandês

fr

string

Francês

ga

string

Irlandês

gl

string

Galego

he

string

Hebraico

hi

string

Hindi

hr

string

Croata

hu

string

Húngaro

id

string

Indonésio

it

string

Italiano

ja

string

Japonês

kk

string

Cazaque

ko

string

Coreano

lt

string

Lituano

lv

string

Letão

mk

string

Macedónio

ms

string

Malaio Malásia

nb

string

Norueguês (Bokmal)

nl

string

Holandês

pl

string

Polaco

prs

string

Dari

pt

string

Portuguese-Portugal

pt-BR

string

Portuguese-Brazil

pt-PT

string

Portuguese-Portugal

ro

string

Romeno

ru

string

Russo

sk

string

Eslovaco

sl

string

Esloveno

sr-Cyrl

string

Sérvio - Cirílico RS

sr-Latn

string

Sérvio - Latino RS

sv

string

Sueco

th

string

Tailandês

tr

string

Turco

uk

string

Ucraniano

vi

string

Vietnamita

zh

string

Chinês simplificado

zh-Hans

string

Chinês simplificado

zh-Hant

string

Chinês tradicional

ImageDetail

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

Name Tipo Description
celebrities

string

Detalhes reconhecidos como celebridades.

landmarks

string

Detalhes reconhecidos como pontos de referência.

IndexProjectionMode

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

Name Tipo Description
includeIndexingParentDocuments

string

O documento de origem será gravado no índice de destino do indexador. Este é o padrão padrão.

skipIndexingParentDocuments

string

O documento de origem será ignorado da gravação no índice de destino do indexador.

InputFieldMappingEntry

Mapeamento de campo de entrada para uma habilidade.

Name Tipo Description
inputs

InputFieldMappingEntry[]

As entradas recursivas usadas ao criar um tipo complexo.

name

string

O nome da entrada.

source

string

A fonte da entrada.

sourceContext

string

O contexto de origem usado para selecionar entradas recursivas.

KeyPhraseExtractionSkill

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

Name Tipo Description
@odata.type string:

#Microsoft.Skills.Text.KeyPhraseExtractionSkill

Um fragmento de URI especificando o tipo de habilidade.

context

string

Representa o nível no qual 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, saídas e 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 a montante.

maxKeyPhraseCount

integer

Um número que indica quantas frases-chave devem ser retornadas. Se ausentes, todas as frases-chave identificadas serão devolvidas.

modelVersion

string

A versão do modelo a ser usada ao chamar o serviço de Análise de Texto. O padrão será o mais recente disponível quando não 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, prefixada 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 uma entrada por outra habilidade.

KeyPhraseExtractionSkillLanguage

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

Name Tipo Description
da

string

Dinamarquês

de

string

Alemão

en

string

Inglês

es

string

Espanhol

fi

string

Finlandês

fr

string

Francês

it

string

Italiano

ja

string

Japonês

ko

string

Coreano

nl

string

Holandês

no

string

Norueguês (Bokmaal)

pl

string

Polaco

pt-BR

string

Português (Brasil)

pt-PT

string

Português (Portugal)

ru

string

Russo

sv

string

Sueco

LanguageDetectionSkill

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

Name Tipo Description
@odata.type string:

#Microsoft.Skills.Text.LanguageDetectionSkill

Um fragmento de URI especificando o tipo de habilidade.

context

string

Representa o nível no qual 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 para usar como uma dica para o modelo de deteção de idioma se ele não puder desambiguar o idioma.

description

string

A descrição da habilidade que descreve as entradas, saídas e 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 a montante.

modelVersion

string

A versão do modelo a ser usada ao chamar o serviço de Análise de Texto. O padrão será o mais recente disponível quando não 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, prefixada 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 uma entrada por outra habilidade.

LineEnding

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

Name Tipo Description
carriageReturn

string

As linhas são separadas por um caractere de retorno de carro ('\r').

carriageReturnLineFeed

string

As linhas são separadas por um retorno de carro e um caractere de alimentação de linha ('\r\n').

lineFeed

string

As linhas são separadas por um único caractere de alimentação de linha ('\n').

space

string

As linhas são separadas por um único caractere de espaço.

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.

Name Tipo Default value Description
@odata.type string:

#Microsoft.Skills.Text.MergeSkill

Um fragmento de URI especificando o tipo de habilidade.

context

string

Representa o nível no qual 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, saídas e 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 a montante.

insertPostTag

string

A tag indica o final do texto mesclado. Por padrão, a tag é um espaço vazio.

insertPreTag

string

A tag indica o início do texto mesclado. Por padrão, a tag é 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, prefixada 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 uma entrada por outra habilidade.

OcrSkill

Uma habilidade que extrai texto de arquivos de imagem.

Name Tipo Default value Description
@odata.type string:

#Microsoft.Skills.Vision.OcrSkill

Um fragmento de URI especificando o tipo de habilidade.

context

string

Representa o nível no qual 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, saídas e uso da habilidade.

detectOrientation

boolean

False

Um valor que indica para ativar ou não a deteçã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 a montante.

lineEnding

LineEnding

Define a sequência de caracteres a ser usada entre as linhas de texto reconhecidas pela habilidade 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, prefixada 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 uma entrada por outra habilidade.

OcrSkillLanguage

Os códigos de idioma suportados para entrada pelo OcrSkill.

Name Tipo Description
Jns

string

Jaunsari (Devanagiri)

af

string

Afrikaans

anp

string

Angika (Devanagiri)

ar

string

Árabe

ast

string

Asturiano

awa

string

Awadhi-Hindi (Devanagiri)

az

string

Azerbaijão (Latim)

be

string

Bielorrusso (cirílico e latino)

be-cyrl

string

Bielorrusso (cirílico)

be-latn

string

Bielorrusso (Latim)

bfy

string

Bagheli

bfz

string

Mahasu Pahari (Devanagiri)

bg

string

Búlgaro

bgc

string

Haryanvi

bho

string

Bhojpuri-Hindi (Devanagiri)

bi

string

Bislama

bns

string

Bundeli

br

string

Bretão

bra

string

Brajbha

brx

string

Bodo (Devanagiri)

bs

string

Bósnio Latino

bua

string

Buryat (cirílico)

ca

string

Catalão

ceb

string

Cebuano

ch

string

Chamorro

cnr-cyrl

string

Montenegrino (cirílico)

cnr-latn

string

Montenegrino (Latim)

co

string

Córsega

crh

string

Tártaro da Crimeia (latim)

cs

string

Checo

csb

string

Kashubian

cy

string

Galês

da

string

Dinamarquês

de

string

Alemão

dhi

string

Dhimal (Devanagiri)

doi

string

Dogri (Devanagiri)

dsb

string

Baixo Sorbian

el

string

Grego

en

string

Inglês

es

string

Espanhol

et

string

Estoniano

eu

string

Basco

fa

string

Persa

fi

string

Finlandês

fil

string

Filipino

fj

string

Fiji

fo

string

Faroense

fr

string

Francês

fur

string

Fruliano

fy

string

Frísio Ocidental

ga

string

Irlandês

gag

string

Gagauz (latim)

gd

string

Gaélico escocês

gil

string

Gilbertese

gl

string

Galego

gon

string

Gondi (Devanagiri)

gv

string

Manx

gvr

string

Gurung (Devanagiri)

haw

string

Havaiano

hi

string

Hindi

hlb

string

Halbi (Devanagiri)

hne

string

Chhattisgarhi (Devanagiri)

hni

string

Hani

hoc

string

Ho (Devanagiri)

hr

string

Croata

hsb

string

Alto Sorbian

ht

string

Crioulo haitiano

hu

string

Húngaro

ia

string

Interlíngua

id

string

Indonésio

is

string

Islandês

it

string

Italiano

iu

string

Inuktitut (latim)

ja

string

Japonês

jv

string

Javanês

kaa

string

Kara-Kalpak (latim)

kaa-cyrl

string

Kara-Kalpak (cirílico)

kac

string

Kachin (Latim)

kea

string

Kabuverdianu

kfq

string

Korku

kha

string

Khasi

kk-cyrl

string

Cazaque (cirílico)

kk-latn

string

Cazaque (Latim)

kl

string

Gronelândia

klr

string

Khaling

kmj

string

Malto (Devanagiri)

ko

string

Coreano

kos

string

Kosraean

kpy

string

Koryak

krc

string

Karachay-Balkar

kru

string

Kurukh (Devanagiri)

ksh

string

Ripuariano

ku-arab

string

Curdo (árabe)

ku-latn

string

Curdo (latim)

kum

string

Kumyk (cirílico)

kw

string

Cornualha

ky

string

Quirguistão (cirílico)

la

string

Latim

lb

string

Luxemburguês

lkt

string

Lakota

lt

string

Lituano

mi

string

Maori

mn

string

Mongol (cirílico)

mr

string

Marata

ms

string

Malaio (Latim)

mt

string

Maltês

mww

string

Hmong Daw (Latim)

myv

string

Erzya (cirílico)

nap

string

Napolitano

nb

string

Norueguês

ne

string

Nepalês

niu

string

Niuean

nl

string

Holandês

no

string

Norueguês

nog

string

Nogay

oc

string

Occitano

os

string

Ossético

pa

string

Punjabi (árabe)

pl

string

Polaco

prs

string

Dari

ps

string

Pashto

pt

string

Português

quc

string

K'iche»

rab

string

Chamling

rm

string

Romanche

ro

string

Romeno

ru

string

Russo

sa

string

Sânscrito (Devanagiri)

sat

string

Santali (Devanagiri)

sck

string

Sadri (Devanagiri)

sco

string

Escoceses

sk

string

Eslovaco

sl

string

Esloveno

sm

string

Samoa (Latim)

sma

string

Sami Meridional

sme

string

Sami do Norte (Latim)

smj

string

Lule Sami

smn

string

Inari Sami

sms

string

Skolt Sami

so

string

Somali (árabe)

sq

string

Albanês

sr

string

Sérvio (Latim)

sr-Cyrl

string

Sérvio (Cirílico)

sr-Latn

string

Sérvio (Latim)

srx

string

Sirmauri (Devanagiri)

sv

string

Sueco

sw

string

Swahili (latim)

tet

string

Tétum

tg

string

Tajique (cirílico)

thf

string

Thangmi

tk

string

Turquemeno (latim)

to

string

Tonganês

tr

string

Turco

tt

string

Tártaro (Latim)

tyv

string

Tuvan

ug

string

Uigur (árabe)

unk

string

Desconhecido (Todos)

ur

string

Urdu

uz

string

Uzbeque (Latim)

uz-arab

string

Uzbeque (árabe)

uz-cyrl

string

Usbeque (Cirílico)

vo

string

Volapük

wae

string

Walser

xnr

string

Kangri (Devanagiri)

xsr

string

Sherpa (Devanagiri)

yua

string

Maia Yucatec

za

string

Zhuang

zh-Hans

string

Chinês simplificado

zh-Hant

string

Chinês tradicional

zu

string

Zulu

OutputFieldMappingEntry

Mapeamento de campo de saída para uma habilidade.

Name Tipo Description
name

string

O nome da saída definida pela habilidade.

targetName

string

O nome de destino da saída. É opcional e padrão para nomear.

PIIDetectionSkill

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

Name Tipo Description
@odata.type string:

#Microsoft.Skills.Text.PIIDetectionSkill

Um fragmento de URI especificando o tipo de habilidade.

context

string

Representa o nível no qual 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, saídas e 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 é 'nenhum'.

inputs

InputFieldMappingEntry[]

As entradas das habilidades podem ser uma coluna no conjunto de dados de origem ou a saída de uma habilidade a montante.

maskingCharacter

string

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 detetadas no texto de entrada. O padrão é 'nenhum'.

minimumPrecision

number

Um valor entre 0 e 1 que deve ser usado para incluir apenas entidades cuja pontuação de confiança é maior do que o valor especificado. Se não estiver definido (padrão), ou se explicitamente definido 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. O padrão será o mais recente disponível quando não 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, prefixada 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 uma entrada por outra habilidade.

piiCategories

string[]

Uma lista de categorias de entidades PII que devem ser extraídas e mascaradas.

PIIDetectionSkillMaskingMode

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

Name Tipo Description
none

string

Nenhum mascaramento ocorre e a saída maskedText não será retornada.

replace

string

Substitui as entidades detetadas pelo caractere fornecido no parâmetro maskingCharacter. O caractere será repetido até o comprimento da entidade detetada para que os deslocamentos correspondam corretamente tanto ao texto de entrada quanto ao maskedText de saída.

SearchIndexerDataNoneIdentity

Limpa a propriedade identity de uma fonte de dados.

Name Tipo Description
@odata.type string:

#Microsoft.Azure.Search.DataNoneIdentity

Um fragmento de URI especificando o tipo de identidade.

SearchIndexerDataUserAssignedIdentity

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

Name Tipo Description
@odata.type string:

#Microsoft.Azure.Search.DataUserAssignedIdentity

Um fragmento de URI especificando o tipo de identidade.

userAssignedIdentity

string

A ID de recurso do Azure totalmente qualificada de uma identidade gerenciada atribuída ao usuário normalmente no formato "/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId" que deveria ter sido atribuída ao serviço de pesquisa.

SearchIndexerIndexProjections

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

Name Tipo Description
parameters

SearchIndexerIndexProjectionsParameters

Um dicionário de propriedades de configuração específicas de 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 realizadas para índices de pesquisa secundários.

SearchIndexerIndexProjectionSelector

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

Name 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 filtrável e não o campo chave.

sourceContext

string

Contexto de origem das projeções. Representa a cardinalidade na qual o documento será dividido em vários subdocumentos.

targetIndexName

string

Nome do índice de pesquisa para projetar. Deve ter um campo chave com o conjunto de analisadores de 'palavras-chave'.

SearchIndexerIndexProjectionsParameters

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

Name Tipo Description
projectionMode

IndexProjectionMode

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

SearchIndexerKnowledgeStore

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

Name 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 em.

SearchIndexerKnowledgeStoreFileProjectionSelector

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

Name Tipo Description
generatedKeyName

string

Nome da chave gerada para armazenar a projeção em.

inputs

InputFieldMappingEntry[]

Entradas aninhadas para projeções complexas.

referenceKeyName

string

Nome da chave de referência para projeção diferente.

source

string

Fonte dos dados para o projeto.

sourceContext

string

Contexto de origem para projeções complexas.

storageContainer

string

Recipiente de blob para armazenar projeções.

SearchIndexerKnowledgeStoreObjectProjectionSelector

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

Name Tipo Description
generatedKeyName

string

Nome da chave gerada para armazenar a projeção em.

inputs

InputFieldMappingEntry[]

Entradas aninhadas para projeções complexas.

referenceKeyName

string

Nome da chave de referência para projeção diferente.

source

string

Fonte dos dados para o projeto.

sourceContext

string

Contexto de origem para projeções complexas.

storageContainer

string

Recipiente de blob para armazenar projeções.

SearchIndexerKnowledgeStoreProjection

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

Name Tipo Description
files

SearchIndexerKnowledgeStoreFileProjectionSelector[]

Projeções para o armazenamento de arquivos do Azure.

objects

SearchIndexerKnowledgeStoreObjectProjectionSelector[]

Projeções para o armazenamento de Blob do Azure.

tables

SearchIndexerKnowledgeStoreTableProjectionSelector[]

Projeções para o armazenamento de tabelas do Azure.

SearchIndexerKnowledgeStoreTableProjectionSelector

Descrição dos dados a armazenar nas Tabelas do Azure.

Name Tipo Description
generatedKeyName

string

Nome da chave gerada para armazenar a projeção em.

inputs

InputFieldMappingEntry[]

Entradas aninhadas para projeções complexas.

referenceKeyName

string

Nome da chave de referência para projeção diferente.

source

string

Fonte dos dados para o projeto.

sourceContext

string

Contexto de origem para projeções complexas.

tableName

string

Nome da tabela do Azure na qual armazenar os dados projetados.

SearchIndexerSkillset

Uma lista de competências.

Name Tipo Description
@odata.etag

string

O ETag do conjunto de competências.

cognitiveServices CognitiveServicesAccount:

Detalhes sobre o serviço de IA do Azure a ser usado ao executar habilidades.

description

string

A descrição do conjunto de competências.

encryptionKey

SearchResourceEncryptionKey

Uma descrição de uma chave de criptografia que você cria no Cofre de Chaves do Azure. Essa chave é usada para fornecer um nível adicional de criptografia em repouso para sua definição de conjunto de habilidades quando você quiser garantia total de que ninguém, nem mesmo a Microsoft, pode descriptografar sua definição de conjunto de habilidades. Depois de ter criptografado sua definição de conjunto de habilidades, ela sempre permanecerá criptografada. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como null. 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 ou após 1º de janeiro de 2019.

indexProjections

SearchIndexerIndexProjections

Definição de projeções adicionais para o(s) índice(s) de pesquisa secundário(s).

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[]:

Uma lista de habilidades no conjunto de habilidades.

SearchResourceEncryptionKey

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

Name Tipo Description
accessCredentials

AzureActiveDirectoryApplicationCredentials

Credenciais opcionais do Azure Ative Directory usadas para acessar seu Cofre da Chave do Azure. Não é necessário se estiver usando a identidade gerenciada.

keyVaultKeyName

string

O nome da sua chave do Cofre da Chave do Azure a ser usada para criptografar seus dados em repouso.

keyVaultKeyVersion

string

A versão da chave do Cofre da Chave do Azure a ser usada para criptografar seus dados em repouso.

keyVaultUri

string

O URI do seu Cofre da Chave do Azure, também conhecido como nome DNS, que contém a chave a ser usada para criptografar seus dados em repouso. Um exemplo de URI pode ser https://my-keyvault-name.vault.azure.net.

SentimentSkill

Esta habilidade foi preterida. Use a V3. SentimentSkill em vez disso.

Name Tipo Description
@odata.type string:

#Microsoft.Skills.Text.SentimentSkill

Um fragmento de URI especificando o tipo de habilidade.

context

string

Representa o nível no qual 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, saídas e 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 a montante.

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, prefixada 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 uma entrada por outra habilidade.

SentimentSkillLanguage

Preterido. Os códigos de idioma suportados para texto de entrada por SentimentSkill.

Name Tipo Description
da

string

Dinamarquês

de

string

Alemão

el

string

Grego

en

string

Inglês

es

string

Espanhol

fi

string

Finlandês

fr

string

Francês

it

string

Italiano

nl

string

Holandês

no

string

Norueguês (Bokmaal)

pl

string

Polaco

pt-PT

string

Português (Portugal)

ru

string

Russo

sv

string

Sueco

tr

string

Turco

SentimentSkillV3

Usando a API de Análise de Texto, avalia 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 nível de frase e documento.

Name Tipo Default value Description
@odata.type string:

#Microsoft.Skills.Text.V3.SentimentSkill

Um fragmento de URI especificando o tipo de habilidade.

context

string

Representa o nível no qual 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, saídas e uso da habilidade.

includeOpinionMining

boolean

False

Se definido como true, o resultado da habilidade incluirá informações do Text Analytics para mineração de opinião, ou seja, alvos (substantivos ou verbos) e sua avaliação associada (adjetivo) 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 a montante.

modelVersion

string

A versão do modelo a ser usada ao chamar o serviço de Análise de Texto. O padrão será o mais recente disponível quando não 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, prefixada 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 uma entrada por outra habilidade.

ShaperSkill

Uma habilidade para remodelar os resultados. Ele cria um tipo complexo para suportar campos compostos (também conhecidos como campos de várias partes).

Name Tipo Description
@odata.type string:

#Microsoft.Skills.Util.ShaperSkill

Um fragmento de URI especificando o tipo de habilidade.

context

string

Representa o nível no qual 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, saídas e 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 a montante.

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, prefixada 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 uma entrada por outra habilidade.

SplitSkill

Uma habilidade para dividir uma cadeia de caracteres em pedaços de texto.

Name Tipo Description
@odata.type string:

#Microsoft.Skills.Text.SplitSkill

Um fragmento de URI especificando o tipo de habilidade.

context

string

Representa o nível no qual 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, saídas e 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 a montante.

maximumPageLength

integer

O comprimento máximo de página desejado. O padrão é 10000.

maximumPagesToTake

integer

Aplicável apenas quando textSplitMode está definido como 'pages'. Se especificado, o SplitSkill interromperá a divisão após o processamento das 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, prefixada 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 uma entrada por outra habilidade.

pageOverlapLength

integer

Aplicável apenas quando textSplitMode está definido como 'pages'. Se especificado, n+1º bloco começará com esse número de caracteres/tokens a partir do final do nono bloco.

textSplitMode

TextSplitMode

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

SplitSkillLanguage

Os códigos de idioma suportados para texto de entrada por SplitSkill.

Name Tipo Description
am

string

Amárico

bs

string

Bósnio

cs

string

Checo

da

string

Dinamarquês

de

string

Alemão

en

string

Inglês

es

string

Espanhol

et

string

Estoniano

fi

string

Finlandês

fr

string

Francês

he

string

Hebraico

hi

string

Hindi

hr

string

Croata

hu

string

Húngaro

id

string

Indonésio

is

string

Islandês

it

string

Italiano

ja

string

Japonês

ko

string

Coreano

lv

string

Letão

nb

string

Norueguês

nl

string

Holandês

pl

string

Polaco

pt

string

Português (Portugal)

pt-br

string

Português (Brasil)

ru

string

Russo

sk

string

Eslovaco

sl

string

Esloveno

sr

string

Sérvio

sv

string

Sueco

tr

string

Turco

ur

string

Urdu

zh

string

Chinês (simplificado)

TextSplitMode

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

Name Tipo Description
pages

string

Divida o texto em páginas individuais.

sentences

string

Divida o texto em frases individuais.

TextTranslationSkill

Uma habilidade para traduzir texto de um idioma para outro.

Name Tipo Description
@odata.type string:

#Microsoft.Skills.Text.TranslationSkill

Um fragmento de URI especificando o tipo de habilidade.

context

string

Representa o nível no qual 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 explicitamente o idioma de.

defaultToLanguageCode

TextTranslationSkillLanguage

O código de idioma para traduzir documentos para documentos que não especificam o idioma para explicitamente.

description

string

A descrição da habilidade que descreve as entradas, saídas e 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 a montante.

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, prefixada 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 uma 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 deteção automática de idioma não é bem-sucedida. O padrão é en.

TextTranslationSkillLanguage

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

Name Tipo Description
af

string

Afrikaans

ar

string

Árabe

bg

string

Búlgaro

bn

string

Bangla

bs

string

Bósnio (Latim)

ca

string

Catalão

cs

string

Checo

cy

string

Galês

da

string

Dinamarquês

de

string

Alemão

el

string

Grego

en

string

Inglês

es

string

Espanhol

et

string

Estoniano

fa

string

Persa

fi

string

Finlandês

fil

string

Filipino

fj

string

Fiji

fr

string

Francês

ga

string

Irlandês

he

string

Hebraico

hi

string

Hindi

hr

string

Croata

ht

string

Crioulo haitiano

hu

string

Húngaro

id

string

Indonésio

is

string

Islandês

it

string

Italiano

ja

string

Japonês

kn

string

Canarês

ko

string

Coreano

lt

string

Lituano

lv

string

Letão

mg

string

Malgaxe

mi

string

Maori

ml

string

Malaiala

ms

string

Malaio

mt

string

Maltês

mww

string

Hmong Daw

nb

string

Norueguês

nl

string

Holandês

otq

string

Querétaro Otomi

pa

string

Punjabi

pl

string

Polaco

pt

string

Português

pt-PT

string

Português (Portugal)

pt-br

string

Português (Brasil)

ro

string

Romeno

ru

string

Russo

sk

string

Eslovaco

sl

string

Esloveno

sm

string

Samoa

sr-Cyrl

string

Sérvio (Cirílico)

sr-Latn

string

Sérvio (Latim)

sv

string

Sueco

sw

string

Kiswahili

ta

string

Tâmil

te

string

Telugu

th

string

Tailandês

tlh

string

Klingon

tlh-Latn

string

Klingon (alfabeto latino)

tlh-Piqd

string

Klingon (script klingon)

to

string

Tonganês

tr

string

Turco

ty

string

Taiti

uk

string

Ucraniano

ur

string

Urdu

vi

string

Vietnamita

yua

string

Maia Yucatec

yue

string

Cantonês (Tradicional)

zh-Hans

string

Chinês simplificado

zh-Hant

string

Chinês tradicional

VisualFeature

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

Name Tipo Description
adult

string

Características visuais reconhecidas como pessoas adultas.

brands

string

Características visuais reconhecidas como marcas comerciais.

categories

string

Categorias.

description

string

Descrição.

faces

string

Recursos visuais reconhecidos como rostos de pessoas.

objects

string

Recursos visuais reconhecidos como objetos.

tags

string

Etiquetas.

WebApiSkill

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

Name Tipo Description
@odata.type string:

#Microsoft.Skills.Custom.WebApiSkill

Um fragmento de URI especificando o tipo de habilidade.

authIdentity SearchIndexerDataIdentity:

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 ao sistema será usada. Nas atualizações do indexador, se a identidade não for especificada, o valor permanecerá inalterado. Se definido como "nenhum", o valor dessa propriedade será limpo.

authResourceId

string

Aplica-se a habilidades personalizadas que se conectam a 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 Ative Directory. Quando especificada, a habilidade personalizada se conecta à função ou aplicativo usando uma ID gerenciada (atribuída pelo sistema ou 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

O tamanho de lote desejado que indica o número de documentos.

context

string

Representa o nível no qual 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

Se definido, o número de chamadas paralelas que podem ser feitas para a API da Web.

description

string

A descrição da habilidade que descreve as entradas, saídas e 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 a montante.

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, prefixada 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 uma entrada por outra habilidade.

timeout

string

O tempo limite desejado para a solicitação. O padrão é 30 segundos.

uri

string

A url para a API da Web.