Skillsets - Create
Cria um novo conjunto de habilidades em um serviço de pesquisa.
POST {endpoint}/skillsets?api-version=2026-04-01
Parâmetros do URI
| Name | Em | Necessário | Tipo | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
A URL do ponto de extremidade do serviço de pesquisa. |
|
api-version
|
query | True |
string minLength: 1 |
A versão da API a utilizar para esta operação. |
Cabeçalho do Pedido
| Name | Necessário | Tipo | Description |
|---|---|---|---|
| Accept |
O cabeçalho Aceitar. |
||
| x-ms-client-request-id |
string (uuid) |
Um identificador de string opaco, globalmente único e gerado pelo cliente para o pedido. |
Corpo do Pedido
| Name | Necessário | Tipo | Description |
|---|---|---|---|
| name | True |
string |
O nome do conjunto de habilidades. |
| skills | True |
SearchIndexerSkill[]:
|
Uma lista de habilidades no conjunto de habilidades. |
| @odata.etag |
string |
O ETag do conjunto de competências. |
|
| cognitiveServices | CognitiveServicesAccount: |
Detalhes sobre o serviço Azure AI a serem usados ao executar habilidades. |
|
| description |
string |
A descrição do conjunto de competências. |
|
| encryptionKey |
Uma descrição de uma chave de criptografia que você cria no Cofre de Chaves do Azure. Esta chave é usada para fornecer um nível adicional de encriptação em repouso para a definição do seu conjunto de competências quando quer total garantia de que ninguém, nem sequer a Microsoft, pode decifrar a definição do seu conjunto de competências. 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 |
Definição de projeções adicionais para o(s) índice(s) de pesquisa secundário(s). |
||
| knowledgeStore |
Definição de projeções adicionais para blob, tabela ou ficheiros do Azure, de dados enriquecidos. |
Respostas
| Name | Tipo | Description |
|---|---|---|
| 201 Created |
O pedido foi bem-sucedido e, como resultado, foi criado um novo recurso. |
|
| Other Status Codes |
Uma resposta de erro inesperada. |
Segurança
api-key
Tipo:
apiKey
Em:
header
OAuth2Auth
Tipo:
oauth2
Fluxo:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbitos
| Name | Description |
|---|---|
| https://search.azure.com/.default |
Exemplos
SearchServiceCreateSkillset
Pedido de amostra
POST https://stableexampleservice.search.windows.net/skillsets?api-version=2026-04-01
{
"name": "tempskillset",
"description": "Skillset for extracting entities and more",
"skills": [
{
"@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill",
"name": "skill2",
"inputs": [
{
"name": "text",
"source": "/document/content"
},
{
"name": "countryHint",
"source": "/document/countryHint"
}
],
"outputs": [
{
"name": "languageCode",
"targetName": "languageCode"
}
]
},
{
"textSplitMode": "pages",
"maximumPageLength": 4000,
"@odata.type": "#Microsoft.Skills.Text.SplitSkill",
"name": "skill3",
"inputs": [
{
"name": "text",
"source": "/document/content"
},
{
"name": "languageCode",
"source": "/document/languageCode"
}
],
"outputs": [
{
"name": "textItems",
"targetName": "pages"
}
]
},
{
"@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill",
"name": "skill4",
"context": "/document/pages/*",
"inputs": [
{
"name": "text",
"source": "/document/content"
},
{
"name": "languageCode",
"source": "/document/languageCode"
}
],
"outputs": [
{
"name": "keyPhrases",
"targetName": "keyPhrases"
}
]
},
{
"uri": "https://contoso.example.org/",
"httpMethod": "POST",
"timeout": "PT5S",
"@odata.type": "#Microsoft.Skills.Custom.WebApiSkill",
"name": "skill5",
"inputs": [
{
"name": "text",
"source": "/document/content"
},
{
"name": "languageCode",
"source": "/document/languageCode"
}
],
"outputs": [
{
"name": "customresult",
"targetName": "result"
}
]
},
{
"outputMode": "oneToMany",
"markdownHeaderDepth": "h3",
"@odata.type": "#Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill",
"name": "docIntelligenceLayoutSkill",
"context": "/document",
"inputs": [
{
"name": "file_data",
"source": "/document/content"
}
],
"outputs": [
{
"name": "markdown_document",
"targetName": "markdown_document"
}
]
},
{
"outputFormat": "text",
"outputMode": "oneToMany",
"extractionOptions": [
"images",
"locationMetadata"
],
"chunkingProperties": {
"unit": "characters",
"maximumLength": 500,
"overlapLength": 50
},
"@odata.type": "#Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill",
"name": "docIntelligenceLayoutSkill#2",
"context": "/document",
"inputs": [
{
"name": "file_data",
"source": "/document/content"
}
],
"outputs": [
{
"name": "text_sections",
"targetName": "text_sections"
},
{
"name": "normalized_images",
"targetName": "normalized_images"
}
]
}
],
"cognitiveServices": {
"key": "myKey",
"subdomainUrl": "https://mySubdomainName.cognitiveservices.azure.com",
"@odata.type": "#Microsoft.Azure.Search.AIServicesByKey",
"description": "Description of the Azure AI service resource attached to a skillset"
},
"@odata.etag": "0x1234568AE7E58A1"
}
Resposta da amostra
{
"@odata.etag": "0x1234568AE7E58A1",
"name": "tempskillset",
"description": "Skillset for extracting entities and more",
"skills": [
{
"@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill",
"name": "skill2",
"inputs": [
{
"name": "text",
"source": "/document/content",
"inputs": []
},
{
"name": "countryHint",
"source": "/document/countryHint",
"inputs": []
}
],
"outputs": [
{
"name": "languageCode",
"targetName": "languageCode"
}
]
},
{
"@odata.type": "#Microsoft.Skills.Text.SplitSkill",
"name": "skill3",
"textSplitMode": "pages",
"maximumPageLength": 4000,
"inputs": [
{
"name": "text",
"source": "/document/content",
"inputs": []
},
{
"name": "languageCode",
"source": "/document/languageCode",
"inputs": []
}
],
"outputs": [
{
"name": "textItems",
"targetName": "pages"
}
]
},
{
"@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill",
"name": "skill4",
"context": "/document/pages/*",
"inputs": [
{
"name": "text",
"source": "/document/content",
"inputs": []
},
{
"name": "languageCode",
"source": "/document/languageCode",
"inputs": []
}
],
"outputs": [
{
"name": "keyPhrases",
"targetName": "keyPhrases"
}
]
},
{
"@odata.type": "#Microsoft.Skills.Custom.WebApiSkill",
"name": "skill5",
"uri": "https://contoso.example.org/",
"httpMethod": "POST",
"timeout": "PT5S",
"inputs": [
{
"name": "text",
"source": "/document/content",
"inputs": []
},
{
"name": "languageCode",
"source": "/document/languageCode",
"inputs": []
}
],
"outputs": [
{
"name": "customresult",
"targetName": "result"
}
]
},
{
"@odata.type": "#Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill",
"name": "docIntelligenceLayoutSkill",
"context": "/document",
"outputMode": "oneToMany",
"markdownHeaderDepth": "h3",
"extractionOptions": [],
"inputs": [
{
"name": "file_data",
"source": "/document/content",
"inputs": []
}
],
"outputs": [
{
"name": "markdown_document",
"targetName": "markdown_document"
}
]
},
{
"@odata.type": "#Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill",
"name": "docIntelligenceLayoutSkill#2",
"context": "/document",
"outputMode": "oneToMany",
"outputFormat": "text",
"extractionOptions": [
"images",
"locationMetadata"
],
"inputs": [
{
"name": "file_data",
"source": "/document/content",
"inputs": []
}
],
"outputs": [
{
"name": "text_sections",
"targetName": "text_sections"
},
{
"name": "normalized_images",
"targetName": "normalized_images"
}
],
"chunkingProperties": {
"unit": "characters",
"maximumLength": 500,
"overlapLength": 50
}
}
],
"cognitiveServices": {
"@odata.type": "#Microsoft.Azure.Search.AIServicesByKey",
"description": "Description of the Azure AI service resource attached to a skillset",
"key": "myKey",
"subdomainUrl": "https://mySubdomainName.cognitiveservices.azure.com"
}
}
Definições
| Name | Description |
|---|---|
| Accept |
O cabeçalho Aceitar. |
|
AIServices |
A conta multi-região de um recurso de serviço de IA do Azure que está associado a um conjunto de competências. |
|
AIServices |
A chave de conta de um recurso de serviço de IA do Azure que está associado a um conjunto de competências, para ser usado com o subdomínio do recurso. |
|
Azure |
Permite gerar uma incorporação vetorial para uma determinada entrada de texto usando o recurso Azure OpenAI. |
|
Azure |
O nome do modelo de IA aberta do Azure que será chamado. |
|
Chat |
Parâmetros de modelo de linguagem comum para Conclusão de Chat. Se omitidos, os valores padrão são usados. |
|
Chat |
Especifica como os 'extraParâmetros' devem ser tratados pelo Azure AI Foundry. O padrão é 'error'. |
|
Chat |
Determina como a resposta do modelo de linguagem deve ser serializada. O padrão é 'texto'. |
|
Chat |
Especifica como o LLM deve formatar a resposta. |
|
Chat |
Objeto que define o esquema personalizado que o modelo usará para estruturar sua saída. |
|
Chat |
Propriedades para o formato de resposta de esquema JSON. |
|
Chat |
Uma competência que chama um modelo de linguagem através do endpoint Chat Completions do Azure AI Foundry. |
|
Cognitive |
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. |
|
Conditional |
Uma habilidade que permite que cenários que exigem uma operação booleana determinem os dados a serem atribuídos a uma saída. |
|
Content |
Uma competência que aproveita o Azure AI Content Understanding para processar e extrair insights estruturados de documentos, permitindo conteúdos enriquecidos e pesquisáveis para uma indexação e recuperação melhorada de documentos. |
|
Content |
Controla a cardinalidade para fragmentar o conteúdo. |
|
Content |
Controla a cardinalidade do conteúdo extraído do documento pela habilidade. |
|
Custom |
Um objeto que contém informações sobre as correspondências encontradas e metadados relacionados. |
|
Custom |
Um objeto complexo que pode ser usado para especificar grafias alternativas ou sinônimos para o nome da entidade raiz. |
|
Custom |
Uma habilidade procura texto a partir de uma lista personalizada e definida pelo usuário de palavras e frases. |
|
Custom |
Os códigos de idioma suportados para texto de entrada por CustomEntityLookupSkill. |
|
Default |
Um objeto vazio que representa o recurso de serviço de IA padrão do Azure para um conjunto de habilidades. |
|
Document |
Uma habilidade que extrai conteúdo de um arquivo dentro do pipeline de enriquecimento. |
|
Document |
Uma competência que extrai informação de conteúdo e layout, via Azure AI Services, a partir de ficheiros dentro do pipeline de enriquecimento. |
|
Document |
Controla a cardinalidade para fragmentar o conteúdo. |
|
Document |
Controla a cardinalidade do conteúdo extraído do documento pela habilidade. |
|
Entity |
Uma cadeia de caracteres que indica quais categorias de entidade devem ser retornadas. |
|
Entity |
Usando a API de Análise de Texto, extrai entidades vinculadas do texto. |
|
Entity |
Os códigos de idioma suportados para texto de entrada por EntityRecognitionSkill. |
|
Entity |
Usando a API de Análise de Texto, extrai entidades de diferentes tipos do texto. |
|
Error |
O erro de gerenciamento de recursos informações adicionais. |
|
Error |
O detalhe do erro. |
|
Error |
Resposta de erro comum para todas as APIs do Azure Resource Manager devolver detalhes de erro para operações falhadas. (Isso também segue o formato de resposta de erro OData.) |
|
Image |
Uma habilidade que analisa arquivos de imagem. Ele extrai um rico conjunto de recursos visuais com base no conteúdo da imagem. |
|
Image |
Os códigos de idioma suportados para entrada por ImageAnalysisSkill. |
|
Image |
Uma cadeia de caracteres que indica quais detalhes específicos do domínio devem ser retornados. |
|
Index |
Define o comportamento das projeções do índice em relação ao resto do indexador. |
|
Input |
Mapeamento de campo de entrada para uma habilidade. |
|
Key |
Uma habilidade que usa análise de texto para extração de frases-chave. |
|
Key |
Os códigos de idioma suportados para texto de entrada por KeyPhraseExtractionSkill. |
|
Language |
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. |
|
Merge |
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. |
|
Ocr |
Define a sequência de caracteres a ser usada entre as linhas de texto reconhecidas pela habilidade OCR. O valor padrão é "space". |
|
Ocr |
Uma habilidade que extrai texto de arquivos de imagem. |
|
Ocr |
Os códigos de idioma suportados para entrada pelo OcrSkill. |
|
Output |
Mapeamento de campo de saída para uma habilidade. |
|
PIIDetection |
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. |
|
PIIDetection |
Uma cadeia de caracteres que indica qual maskingMode usar para mascarar as informações pessoais detetadas no texto de entrada. |
|
Search |
Limpa a propriedade identity de uma fonte de dados. |
|
Search |
Especifica a identidade a ser usada por uma fonte de dados. |
|
Search |
Definição de projeções adicionais para índices de pesquisa secundários. |
|
Search |
Descrição dos dados a armazenar no índice de pesquisa designado. |
|
Search |
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. |
|
Search |
Definição de projeções adicionais para azure blob, tabela ou arquivos, de dados enriquecidos. |
|
Search |
Definição de projeção para quais dados armazenar nos Arquivos do Azure. |
|
Search |
Definição de projeção para quais dados armazenar no Blob do Azure. |
|
Search |
Objeto de contêiner para vários seletores de projeção. |
|
Search |
Descrição dos dados a armazenar nas Tabelas do Azure. |
|
Search |
Uma lista de competências. |
|
Search |
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. |
|
Sentiment |
Os códigos de idioma suportados para texto de entrada por SentimentSkill. |
|
Sentiment |
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. |
|
Shaper |
Uma habilidade para remodelar os resultados. Ele cria um tipo complexo para suportar campos compostos (também conhecidos como campos de várias partes). |
|
Split |
Uma habilidade para dividir uma cadeia de caracteres em pedaços de texto. |
|
Split |
Os códigos de idioma suportados para texto de entrada por SplitSkill. |
|
Text |
Um valor que indica qual modo de divisão executar. |
|
Text |
Uma habilidade para traduzir texto de um idioma para outro. |
|
Text |
Os códigos de idioma suportados para texto de entrada por TextTranslationSkill. |
|
Visual |
As cadeias de caracteres que indicam quais tipos de recursos visuais devem ser retornados. |
|
Web |
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. |
Accept
O cabeçalho Aceitar.
| Valor | Description |
|---|---|
| application/json;odata.metadata=minimal |
AIServicesAccountIdentity
A conta multi-região de um recurso de serviço de IA do Azure que está associado a um conjunto de competências.
| Name | Tipo | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
O discriminador para tipos derivados. |
| description |
string |
Descrição do recurso de serviço de IA do Azure associado a um conjunto de competências. |
| identity | SearchIndexerDataIdentity: |
A identidade gerenciada atribuída pelo usuário usada para conexões com o Serviço de IA. Se não for especificado, a identidade gerenciada atribuída ao sistema será usada. Em atualizações para o conjunto de habilidades, se a identidade não for especificada, o valor permanecerá inalterado. Se definido como "nenhum", o valor dessa propriedade será limpo. |
| subdomainUrl |
string |
O subdomínio/URL do endpoint Azure AI Services para o respetivo AI Service. |
AIServicesAccountKey
A chave de conta de um recurso de serviço de IA do Azure que está associado a um conjunto de competências, para ser usado com o subdomínio do recurso.
| Name | Tipo | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
O discriminador para tipos derivados. |
| description |
string |
Descrição do recurso de serviço de IA do Azure associado a um conjunto de competências. |
| key |
string |
A chave usada para provisionar o recurso de serviço de IA do Azure associado a um conjunto de competências. |
| subdomainUrl |
string |
O subdomínio/URL do endpoint Azure AI Services para o respetivo AI Service. |
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. |
O discriminador para tipos derivados. |
| 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 (int32) |
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 |
As entradas das habilidades podem ser uma coluna no conjunto de dados de origem ou a saída de uma habilidade a montante. |
|
| modelName |
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 |
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 (uri) |
O URI do recurso Azure OpenAI. |
AzureOpenAIModelName
O nome do modelo de IA aberta do Azure que será chamado.
| Valor | Description |
|---|---|
| text-embedding-ada-002 |
Modelo TextEmbeddingAda002. |
| text-embedding-3-large |
TextEmbedding3 Modelo grande. |
| text-embedding-3-small |
TextEmbedding3Small model. |
| gpt-5-mini |
Modelo Gpt5Mini. |
| gpt-5-nano |
Modelo Gpt5Nano. |
| gpt-5.4-mini |
Modelo Gpt54Mini. |
| gpt-5.4-nano |
Modelo Gpt54Nano. |
ChatCompletionCommonModelParameters
Parâmetros de modelo de linguagem comum para Conclusão de Chat. Se omitidos, os valores padrão são usados.
| Name | Tipo | Default value | Description |
|---|---|---|---|
| frequencyPenalty |
number (double) |
0 |
Um float no intervalo [-2,2] que reduz ou aumenta a probabilidade de tokens repetidos. O padrão é 0. |
| maxTokens |
integer (int32) |
Número máximo de tokens a gerar. |
|
| model |
string |
O nome do modelo a utilizar (por exemplo, 'gpt-4o', etc.). O padrão é nulo se não for especificado. |
|
| presencePenalty |
number (double) |
0 |
Um float na faixa [-2,2] que penaliza novos tokens com base em sua presença existente. O padrão é 0. |
| seed |
integer (int32) |
Sementes aleatórias para controlar saídas determinísticas. Se omitida, a aleatorização é usada. |
|
| stop |
string[] |
Lista de sequências de parada que cortarão a geração de texto. O padrão é nenhum. |
|
| temperature |
number (double) |
0.7 |
Temperatura de amostragem. O padrão é 0,7. |
ChatCompletionExtraParametersBehavior
Especifica como os 'extraParâmetros' devem ser tratados pelo Azure AI Foundry. O padrão é 'error'.
| Valor | Description |
|---|---|
| passThrough |
Passa quaisquer parâmetros extra diretamente para o modelo. |
| drop |
Descarta todos os parâmetros extras. |
| error |
Gera um erro se algum parâmetro extra estiver presente. |
ChatCompletionResponseFormat
Determina como a resposta do modelo de linguagem deve ser serializada. O padrão é 'texto'.
| Name | Tipo | Default value | Description |
|---|---|---|---|
| jsonSchemaProperties |
Um dicionário aberto para propriedades estendidas. Obrigatório se 'tipo' == 'json_schema' |
||
| type | text |
Especifica como o LLM deve formatar a resposta. |
ChatCompletionResponseFormatType
Especifica como o LLM deve formatar a resposta.
| Valor | Description |
|---|---|
| text |
Formato de resposta em texto simples. |
| jsonObject |
Formato arbitrário de resposta a objetos JSON. |
| jsonSchema |
Formato de resposta aderente ao esquema JSON. |
ChatCompletionSchema
Objeto que define o esquema personalizado que o modelo usará para estruturar sua saída.
| Name | Tipo | Default value | Description |
|---|---|---|---|
| additionalProperties |
boolean |
False |
Controla se é permitido que um objeto contenha chaves/valores adicionais que não foram definidos no esquema JSON. O valor predefinido é falso. |
| properties |
string |
Uma cadeia de caracteres formatada em JSON que define as propriedades e restrições do esquema de saída para o modelo. |
|
| required |
string[] |
Uma matriz dos nomes de propriedade que são necessários para fazer parte da resposta do modelo. Todas as propriedades devem ser incluídas para saídas estruturadas. |
|
| type |
string |
object |
Tipo de representação de esquema. Geralmente 'objeto'. O padrão é 'objeto'. |
ChatCompletionSchemaProperties
Propriedades para o formato de resposta de esquema JSON.
| Name | Tipo | Default value | Description |
|---|---|---|---|
| description |
string |
Descrição do esquema json ao qual o modelo irá aderir. |
|
| name |
string |
Nome do esquema json ao qual o modelo irá aderir. |
|
| schema |
A definição do esquema. |
||
| strict |
boolean |
True |
Se a resposta do modelo deve ou não usar saídas estruturadas. A predefinição é verdadeira. |
ChatCompletionSkill
Uma competência que chama um modelo de linguagem através do endpoint Chat Completions do Azure AI Foundry.
| Name | Tipo | Default value | Description |
|---|---|---|---|
| @odata.type |
string:
#Microsoft. |
O discriminador para tipos derivados. |
|
| apiKey |
string |
Chave de API para autenticação no modelo. apiKey e authIdentity não podem ser especificados ao mesmo tempo. |
|
| 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. |
|
| commonModelParameters |
Parâmetros comuns do modelo de linguagem que os clientes podem ajustar. Se omitido, serão aplicados padrões razoáveis. |
||
| 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. |
|
| extraParameters |
Dicionário de tipo aberto para parâmetros específicos do modelo que devem ser anexados à chamada de conclusão de chat. Segue o padrão de extensibilidade do Azure AI Foundry. |
||
| extraParametersBehavior | error |
Como os parâmetros extra são tratados pelo Azure AI Foundry. O padrão é 'erro'. |
|
| inputs |
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 |
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. |
||
| responseFormat |
Determina como o LLM deve formatar sua resposta. O padrão é o tipo de resposta 'texto'. |
||
| uri |
string |
A url para a API da Web. |
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. |
O discriminador para tipos derivados. |
| description |
string |
Descrição do recurso de serviço de IA do Azure associado a um conjunto de competências. |
| key |
string |
A chave usada para provisionar o recurso de serviço de IA do Azure associado a um conjunto de competências. |
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. |
O discriminador para tipos derivados. |
| 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 |
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 |
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. |
ContentUnderstandingSkill
Uma competência que aproveita o Azure AI Content Understanding para processar e extrair insights estruturados de documentos, permitindo conteúdos enriquecidos e pesquisáveis para uma indexação e recuperação melhorada de documentos.
| Name | Tipo | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
O discriminador para tipos derivados. |
| chunkingProperties |
Controla a cardinalidade para fragmentar o conteúdo. |
|
| 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. |
| extractionOptions |
Controla a cardinalidade do conteúdo extraído do documento pela habilidade. |
|
| inputs |
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 |
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. |
ContentUnderstandingSkillChunkingProperties
Controla a cardinalidade para fragmentar o conteúdo.
| Name | Tipo | Default value | Description |
|---|---|---|---|
| maximumLength |
integer (int32) |
O comprimento máximo do bloco em caracteres. O padrão é 500. |
|
| overlapLength |
integer (int32) |
O comprimento da sobreposição fornecida entre dois blocos de texto. O padrão é 0. |
|
| unit |
enum:
characters |
characters |
A unidade do pedaço. |
ContentUnderstandingSkillExtractionOptions
Controla a cardinalidade do conteúdo extraído do documento pela habilidade.
| Valor | Description |
|---|---|
| images |
Especifique que o conteúdo da imagem deve ser extraído do documento. |
| locationMetadata |
Especifique que os metadados de localização devem ser extraídos do documento. |
CustomEntity
Um objeto que contém informações sobre as correspondências encontradas e metadados relacionados.
| Name | Tipo | Description |
|---|---|---|
| accentSensitive |
boolean |
É definido para false por padrão. Valor booleano que indica se as comparações com o nome da entidade devem ser sensíveis ao acento. |
| aliases |
Uma matriz de objetos complexos que podem ser usados para especificar grafias alternativas ou sinônimos para o nome da entidade raiz. |
|
| caseSensitive |
boolean |
É definido para false por padrão. Valor booleano que indica se as comparações com o nome da entidade devem ser sensíveis à caixa de caracteres. Exemplos de correspondências insensíveis a maiúsculas e 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 (int32) |
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 (int32) |
O valor 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 para 3, "Windows10" continuaria a corresponder 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 (int32) |
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. |
O discriminador para tipos derivados. |
| 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 |
Um valor que indica qual código de idioma usar. A predefinição é |
|
| 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 (int32) |
Uma bandeira global para FuzzyEditDistance. Se FuzzyEditDistance não estiver definido em CustomEntity, esse valor será o valor padrão. |
| inlineEntitiesDefinition |
A definição CustomEntity embutida. |
|
| inputs |
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 |
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.
| 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
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. |
O discriminador para tipos derivados. |
| description |
string |
Descrição do recurso de serviço de IA do Azure associado a um conjunto de competências. |
DocumentExtractionSkill
Uma habilidade que extrai conteúdo de um arquivo dentro do pipeline de enriquecimento.
| Name | Tipo | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
O discriminador para tipos derivados. |
| configuration |
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 |
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 |
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. |
DocumentIntelligenceLayoutSkill
Uma competência que extrai informação de conteúdo e layout, via Azure AI Services, a partir de ficheiros dentro do pipeline de enriquecimento.
| Name | Tipo | Default value | Description |
|---|---|---|---|
| @odata.type |
string:
#Microsoft. |
O discriminador para tipos derivados. |
|
| chunkingProperties |
Controla a cardinalidade para fragmentar o conteúdo. |
||
| 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. |
|
| extractionOptions |
Controla a cardinalidade do conteúdo extraído do documento pela habilidade. |
||
| inputs |
As entradas das habilidades podem ser uma coluna no conjunto de dados de origem ou a saída de uma habilidade a montante. |
||
| markdownHeaderDepth |
enum:
|
h6 |
A profundidade dos cabeçalhos na saída de markdown. O padrão é h6. |
| 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 '#'. |
|
| outputFormat |
enum:
|
markdown |
Controla o formato de saída. O padrão é 'markdown'. |
| outputMode |
enum:
one |
oneToMany |
Controla a cardinalidade da saída produzida pela habilidade. O padrão é 'oneToMany'. |
| outputs |
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. |
DocumentIntelligenceLayoutSkillChunkingProperties
Controla a cardinalidade para fragmentar o conteúdo.
| Name | Tipo | Default value | Description |
|---|---|---|---|
| maximumLength |
integer (int32) |
O comprimento máximo do bloco em caracteres. O padrão é 500. |
|
| overlapLength |
integer (int32) |
O comprimento da sobreposição fornecida entre dois blocos de texto. O padrão é 0. |
|
| unit |
enum:
characters |
characters |
A unidade do pedaço. |
DocumentIntelligenceLayoutSkillExtractionOptions
Controla a cardinalidade do conteúdo extraído do documento pela habilidade.
| Valor | Description |
|---|---|
| images |
Especifique que o conteúdo da imagem deve ser extraído do documento. |
| locationMetadata |
Especifique que os metadados de localização devem ser extraídos do documento. |
EntityCategory
Uma cadeia de caracteres que indica quais categorias de entidade devem ser retornadas.
| Valor | Description |
|---|---|
| location |
Entidades que descrevem uma localização física. |
| organization |
Entidades que descrevem uma organização. |
| person |
Entidades que descrevem uma pessoa. |
| quantity |
Entidades que descrevem uma quantidade. |
| datetime |
Entidades que descrevem uma data e hora. |
| url |
Entidades que descrevem um URL. |
|
Entidades que descrevem um endereço de e-mail. |
EntityLinkingSkill
Usando a API de Análise de Texto, extrai entidades vinculadas do texto.
| Name | Tipo | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
O discriminador para tipos derivados. |
| 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. A predefinição é |
| description |
string |
A descrição da habilidade que descreve as entradas, saídas e uso da habilidade. |
| inputs |
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 (double) minimum: 0maximum: 1 |
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 |
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
Os códigos de idioma suportados para texto de entrada por EntityRecognitionSkill.
| Valor | Description |
|---|---|
| ar |
Árabe |
| cs |
Checo |
| zh-Hans |
Chinês Simplificado |
| zh-Hant |
Chinês Tradicional |
| da |
Dinamarquês |
| nl |
Neerlandês |
| en |
Inglês |
| fi |
Finlandês |
| fr |
Francês |
| de |
Alemão |
| el |
Grego |
| hu |
Húngaro |
| it |
Italiano |
| ja |
Japonês |
| ko |
Coreano |
| no |
Norueguês (Bokmaal) |
| pl |
Polaco |
| pt-PT |
Português (Portugal) |
| pt-BR |
Português (Brasil) |
| ru |
Russo |
| es |
Espanhol |
| sv |
Sueco |
| tr |
Turco (língua) |
EntityRecognitionSkillV3
Usando a API de Análise de Texto, extrai entidades de diferentes tipos do texto.
| Name | Tipo | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
O discriminador para tipos derivados. |
| categories |
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 |
Um valor que indica qual código de idioma usar. A predefinição é |
|
| description |
string |
A descrição da habilidade que descreve as entradas, saídas e uso da habilidade. |
| inputs |
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 (double) minimum: 0maximum: 1 |
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 |
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 |
As informações adicionais. |
|
| type |
string |
O tipo de informação adicional. |
ErrorDetail
O detalhe do erro.
| Name | Tipo | Description |
|---|---|---|
| additionalInfo |
O erro informações adicionais. |
|
| code |
string |
O código de erro. |
| details |
Os detalhes do erro. |
|
| message |
string |
A mensagem de erro. |
| target |
string |
O alvo do erro. |
ErrorResponse
Resposta de erro comum para todas as APIs do Azure Resource Manager devolver detalhes de erro para operações falhadas. (Isso também segue o formato de resposta de erro OData.)
| Name | Tipo | Description |
|---|---|---|
| error |
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. |
O discriminador para tipos derivados. |
| 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 |
Um valor que indica qual código de idioma usar. A predefinição é |
|
| description |
string |
A descrição da habilidade que descreve as entradas, saídas e uso da habilidade. |
| details |
Uma cadeia de caracteres que indica quais detalhes específicos do domínio devem ser retornados. |
|
| inputs |
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 |
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 |
Uma lista de recursos visuais. |
ImageAnalysisSkillLanguage
Os códigos de idioma suportados para entrada por ImageAnalysisSkill.
| Valor | Description |
|---|---|
| ar |
Árabe |
| az |
Azerbaijão |
| bg |
Búlgaro |
| bs |
Bósnio Latino |
| ca |
Catalão |
| cs |
Checo |
| cy |
Galês |
| da |
Dinamarquês |
| de |
Alemão |
| el |
Grego |
| en |
Inglês |
| es |
Espanhol |
| et |
Estónio |
| eu |
Bascos |
| fi |
Finlandês |
| fr |
Francês |
| ga |
Irlandês |
| gl |
Galego |
| he |
Hebraico |
| hi |
Híndi |
| 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 |
Malaio Malásia |
| nb |
Norueguês (Bokmal) |
| nl |
Neerlandês |
| pl |
Polaco |
| prs |
Dári |
| pt-BR |
Português (Brasil) |
| pt |
Português (Portugal) |
| pt-PT |
Português (Portugal) |
| ro |
Romeno |
| ru |
Russo |
| sk |
Eslovaco |
| sl |
Esloveno |
| sr-Cyrl |
Sérvio - Cirílico RS |
| sr-Latn |
Sérvio - Latino RS |
| sv |
Sueco |
| th |
Tailandês |
| tr |
Turco (língua) |
| uk |
Ucraniano |
| vi |
Vietnamita |
| zh |
Chinês (Simplificado) |
| zh-Hans |
Chinês (Simplificado) |
| zh-Hant |
Chinês (Tradicional) |
ImageDetail
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
Define o comportamento das projeções do índice em relação ao resto do indexador.
| Valor | Description |
|---|---|
| skipIndexingParentDocuments |
O documento de origem será ignorado da gravação no índice de destino do indexador. |
| includeIndexingParentDocuments |
O documento de origem será gravado no índice de destino do indexador. Este é o padrão padrão. |
InputFieldMappingEntry
Mapeamento de campo de entrada para uma habilidade.
| Name | Tipo | Description |
|---|---|---|
| inputs |
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. |
O discriminador para tipos derivados. |
| 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 |
Um valor que indica qual código de idioma usar. A predefinição é |
|
| description |
string |
A descrição da habilidade que descreve as entradas, saídas e uso da habilidade. |
| inputs |
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 (int32) |
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 |
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.
| Valor | Description |
|---|---|
| da |
Dinamarquês |
| nl |
Neerlandês |
| en |
Inglês |
| fi |
Finlandês |
| fr |
Francês |
| de |
Alemão |
| it |
Italiano |
| ja |
Japonês |
| ko |
Coreano |
| no |
Norueguês (Bokmaal) |
| pl |
Polaco |
| pt-PT |
Português (Portugal) |
| pt-BR |
Português (Brasil) |
| ru |
Russo |
| es |
Espanhol |
| sv |
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. |
O discriminador para tipos derivados. |
| 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 |
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 |
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. |
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. |
O discriminador para tipos derivados. |
|
| 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 |
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 |
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. |
OcrLineEnding
Define a sequência de caracteres a ser usada entre as linhas de texto reconhecidas pela habilidade OCR. O valor padrão é "space".
| Valor | Description |
|---|---|
| space |
As linhas são separadas por um único caractere de espaço. |
| carriageReturn |
As linhas são separadas por um caractere de retorno de carro ('\r'). |
| lineFeed |
As linhas são separadas por um único caractere de alimentação de linha ('\n'). |
| carriageReturnLineFeed |
As linhas são separadas por um retorno de carro e um caractere de alimentação de linha ('\r\n'). |
OcrSkill
Uma habilidade que extrai texto de arquivos de imagem.
| Name | Tipo | Default value | Description |
|---|---|---|---|
| @odata.type |
string:
#Microsoft. |
O discriminador para tipos derivados. |
|
| 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 |
Um valor que indica qual código de idioma usar. A predefinição é |
||
| 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 valor predefinido é falso. |
| inputs |
As entradas das habilidades podem ser uma coluna no conjunto de dados de origem ou a saída de uma habilidade a montante. |
||
| 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 |
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.
| Valor | Description |
|---|---|
| af |
Afrikaans |
| sq |
Albanês |
| anp |
Angika (Devanagiri) |
| ar |
Árabe |
| ast |
Asturiano |
| awa |
Awadhi-Hindi (o Devanagari) |
| az |
Azerbaijão (Latim) |
| bfy |
Bagheli |
| eu |
Bascos |
| be |
Bielorrusso (cirílico e latino) |
| be-cyrl |
Bielorrusso (cirílico) |
| be-latn |
Bielorrusso (latim) |
| bho |
Bhojpuri-Hindi (Devanágari) |
| bi |
Bislama |
| brx |
Bodo (Devanágari) |
| bs |
Bósnio Latino |
| bra |
Brajbha |
| br |
Bretão |
| bg |
Búlgaro |
| bns |
Bundeli |
| bua |
Buryat (cirílico) |
| ca |
Catalão |
| ceb |
Cebuano |
| rab |
Chamling |
| ch |
Chamorro |
| hne |
Chhattisgarhi (Devanagiri) |
| zh-Hans |
Chinês (Simplificado) |
| zh-Hant |
Chinês (Tradicional) |
| kw |
Cornualha |
| co |
Corso |
| crh |
Tártaro da Crimeia (latim) |
| hr |
Croata |
| cs |
Checo |
| da |
Dinamarquês |
| prs |
Dári |
| dhi |
Dhimal (Devanagiri) |
| doi |
Dogri (Devanagiri) |
| nl |
Neerlandês |
| en |
Inglês |
| myv |
Erzya (cirílico) |
| et |
Estónio |
| fo |
Faroês |
| fj |
Fijiano |
| fil |
Filipino |
| fi |
Finlandês |
| fr |
Francês |
| fur |
Fruliano |
| gag |
Gagauz (latim) |
| gl |
Galego |
| de |
Alemão |
| gil |
Gilbertês |
| gon |
Gondi (Devanagiri) |
| el |
Grego |
| kl |
Gronelandês |
| gvr |
Gurung (Devanágari) |
| ht |
Crioulo haitiano |
| hlb |
Halbi (Devanágari) |
| hni |
Hani |
| bgc |
Haryanvi |
| haw |
Havaiano |
| hi |
Híndi |
| mww |
Hmong Daw (latim) |
| hoc |
Ho (Devanagiri) |
| hu |
Húngaro |
| is |
Islandês |
| smn |
Inari Sami |
| id |
Indonésio |
| ia |
Interlíngua |
| iu |
Inuktitut (latim) |
| ga |
Irlandês |
| it |
Italiano |
| ja |
Japonês |
| Jns |
Jaunsari (Devanagiri) |
| jv |
Javanês |
| kea |
Kabuverdianu |
| kac |
Kachin (latim) |
| xnr |
Kangri (Devanagiri) |
| krc |
Karachay-Balkar |
| kaa-cyrl |
Kara-Kalpak (Cirílico) |
| kaa |
Kara-Kalpak (Latim) |
| csb |
Kashubian |
| kk-cyrl |
Cazaque (cirílico) |
| kk-latn |
Cazaque (latim) |
| klr |
Khaling |
| kha |
Khasi |
| quc |
K'iche' |
| ko |
Coreano |
| kfq |
Korku |
| kpy |
Koryak |
| kos |
Kosraean |
| kum |
Kumyk (cirílico) |
| ku-arab |
Curdo (árabe) |
| ku-latn |
Curdo (latim) |
| kru |
Kurukh (Devanágari) |
| ky |
Quirguistão (cirílico) |
| lkt |
Lakota |
| la |
Latim |
| lt |
Lituano |
| dsb |
Baixo Sorábio |
| smj |
Lule Sami |
| lb |
Luxemburguês |
| bfz |
Mahasu Pahari (Devanagiri) |
| ms |
Malaio (latim) |
| mt |
Maltês |
| kmj |
Malto (Devanágari) |
| gv |
Manx |
| mi |
Maori |
| mr |
Maráti |
| mn |
Mongol (cirílico) |
| cnr-cyrl |
Montenegrino (cirílico) |
| cnr-latn |
Montenegrino (Latim) |
| nap |
Napolitano |
| ne |
Nepalês |
| niu |
Niueano |
| nog |
Nogay |
| sme |
Sami do Norte (Latim) |
| nb |
Norueguês |
| no |
Norueguês |
| oc |
Occitano |
| os |
Ossética |
| ps |
Pashto |
| fa |
Persa |
| pl |
Polaco |
| pt |
Português |
| pa |
Punjabi (árabe) |
| ksh |
Ripuariano |
| ro |
Romeno |
| rm |
Romanche |
| ru |
Russo |
| sck |
Sadri (Devanágari) |
| sm |
Samoa (latim) |
| sa |
Sânscrito (Devanagiri) |
| sat |
Santali (Devanagiri) |
| sco |
Escoceses |
| gd |
Gaélico escocês |
| sr |
Sérvio (latim) |
| sr-Cyrl |
Sérvio (cirílico) |
| sr-Latn |
Sérvio (latim) |
| xsr |
Sherpa (Devanágari) |
| srx |
Sirmauri (Devanagiri) |
| sms |
Skolt Sami |
| sk |
Eslovaco |
| sl |
Esloveno |
| so |
Somali (árabe) |
| sma |
Sami do Sul |
| es |
Espanhol |
| sw |
Suaíli (latim) |
| sv |
Sueco |
| tg |
Tajique (cirílico) |
| tt |
Tatar (Latim) |
| tet |
Tetum |
| thf |
Thangmi |
| to |
Tonga |
| tr |
Turco (língua) |
| tk |
Turcomeno (Latim) |
| tyv |
Tuvan |
| hsb |
Alto Sorbian |
| ur |
Língua Urdu |
| ug |
Uigur (árabe) |
| uz-arab |
Uzbeque (árabe) |
| uz-cyrl |
Uzbeque (cirílico) |
| uz |
Uzbeque (latim) |
| vo |
Volapük |
| wae |
Walser |
| cy |
Galês |
| fy |
Frísia Ocidental |
| yua |
Maia Yucateco |
| za |
Zhuang |
| zu |
Zulu |
| unk |
Desconhecido (Todos) |
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. |
O discriminador para tipos derivados. |
| 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. A predefinição é |
| 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 |
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 maxLength: 1 |
O caractere usado para mascarar o texto se o parâmetro maskingMode estiver definido para substituir. O padrão é '*'. |
| maskingMode |
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 (double) minimum: 0maximum: 1 |
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 |
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.
| Valor | Description |
|---|---|
| none |
Nenhum mascaramento ocorre e a saída maskedText não será retornada. |
| replace |
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. |
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. |
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. |
SearchIndexerIndexProjection
Definição de projeções adicionais para índices de pesquisa secundários.
| Name | Tipo | Description |
|---|---|---|
| parameters |
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 |
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 |
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 |
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 |
|---|---|---|
| identity | SearchIndexerDataIdentity: |
A identidade gerida atribuída pelo utilizador usada para ligações ao Armazenamento do Azure ao escrever projeções de armazenamento de conhecimento. Se a cadeia de ligação indicar uma identidade (ResourceId) e esta não for especificada, é usada a identidade gerida atribuída pelo sistema. 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. |
| projections |
Uma lista de projeções adicionais a serem executadas durante a indexação. |
|
| storageConnectionString |
string |
A cadeia de ligação para as projeções da conta de armazenamento será armazenada. |
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 |
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 |
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 |
Projeções para armazenamento de ficheiros no Azure. |
|
| objects |
Projeções para armazenamento Azure Blob. |
|
| tables |
Projeções para armazenamento no Azure Table. |
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 |
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 Azure AI a serem usados ao executar habilidades. |
| description |
string |
A descrição do conjunto de competências. |
| encryptionKey |
Uma descrição de uma chave de criptografia que você cria no Cofre de Chaves do Azure. Esta chave é usada para fornecer um nível adicional de encriptação em repouso para a definição do seu conjunto de competências quando quer total garantia de que ninguém, nem sequer a Microsoft, pode decifrar a definição do seu conjunto de competências. 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 |
Definição de projeções adicionais para o(s) índice(s) de pesquisa secundário(s). |
|
| knowledgeStore |
Definição de projeções adicionais para blob, tabela ou ficheiros 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.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. |
| accessCredentials.applicationSecret |
string |
A chave de autenticação do aplicativo AAD especificado. |
| identity | SearchIndexerDataIdentity: |
Uma identidade gerenciada explícita a ser usada para essa chave de criptografia. Se não for especificado e a propriedade de credenciais de acesso for nula, a identidade gerenciada atribuída ao sistema será usada. Na atualização do recurso, se a identidade explícita não for especificada, ela permanecerá inalterada. Se "nenhum" for especificado, o valor dessa propriedade será limpo. |
| 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 |
SentimentSkillLanguage
Os códigos de idioma suportados para texto de entrada por SentimentSkill.
| Valor | Description |
|---|---|
| da |
Dinamarquês |
| nl |
Neerlandês |
| en |
Inglês |
| fi |
Finlandês |
| fr |
Francês |
| de |
Alemão |
| el |
Grego |
| it |
Italiano |
| no |
Norueguês (Bokmaal) |
| pl |
Polaco |
| pt-PT |
Português (Portugal) |
| ru |
Russo |
| es |
Espanhol |
| sv |
Sueco |
| tr |
Turco (língua) |
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. |
O discriminador para tipos derivados. |
|
| 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 |
Um valor que indica qual código de idioma usar. A predefinição é |
||
| 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 Análise de Texto para mineração de opinião, ou seja, alvos (substantivos ou verbos) e sua avaliação associada (adjetivo) no texto. O valor predefinido é falso. |
| inputs |
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 |
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. |
O discriminador para tipos derivados. |
| 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 |
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 |
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. |
O discriminador para tipos derivados. |
| 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 |
Um valor que indica qual código de idioma usar. A predefinição é |
|
| description |
string |
A descrição da habilidade que descreve as entradas, saídas e uso da habilidade. |
| inputs |
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 (int32) |
O comprimento máximo de página desejado. O padrão é 10000. |
| maximumPagesToTake |
integer (int32) |
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 |
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 (int32) |
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 |
Um valor que indica qual modo de divisão executar. |
SplitSkillLanguage
Os códigos de idioma suportados para texto de entrada por SplitSkill.
| Valor | Description |
|---|---|
| am |
Amárico |
| bs |
Bósnio |
| cs |
Checo |
| da |
Dinamarquês |
| de |
Alemão |
| en |
Inglês |
| es |
Espanhol |
| et |
Estónio |
| fi |
Finlandês |
| fr |
Francês |
| he |
Hebraico |
| hi |
Híndi |
| 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 |
Neerlandês |
| pl |
Polaco |
| pt |
Português (Portugal) |
| pt-br |
Português (Brasil) |
| ru |
Russo |
| sk |
Eslovaco |
| sl |
Esloveno |
| sr |
Sérvio |
| sv |
Sueco |
| tr |
Turco (língua) |
| ur |
Língua Urdu |
| zh |
Chinês (simplificado) |
TextSplitMode
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
Uma habilidade para traduzir texto de um idioma para outro.
| Name | Tipo | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
O discriminador para tipos derivados. |
| 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 |
O código de idioma do qual traduzir documentos para documentos que não especificam explicitamente o idioma de. |
|
| defaultToLanguageCode |
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 |
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 |
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 |
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. A predefinição é |
TextTranslationSkillLanguage
Os códigos de idioma suportados para texto de entrada por TextTranslationSkill.
| Valor | Description |
|---|---|
| af |
Afrikaans |
| ar |
Árabe |
| bn |
Bengali |
| bs |
Bósnio (latim) |
| bg |
Búlgaro |
| yue |
Cantonês (Tradicional) |
| ca |
Catalão |
| zh-Hans |
Chinês (Simplificado) |
| zh-Hant |
Chinês (Tradicional) |
| hr |
Croata |
| cs |
Checo |
| da |
Dinamarquês |
| nl |
Neerlandês |
| en |
Inglês |
| et |
Estónio |
| fj |
Fijiano |
| fil |
Filipino |
| fi |
Finlandês |
| fr |
Francês |
| de |
Alemão |
| el |
Grego |
| ht |
Crioulo haitiano |
| he |
Hebraico |
| hi |
Híndi |
| mww |
Hmong Daw |
| hu |
Húngaro |
| is |
Islandês |
| id |
Indonésio |
| it |
Italiano |
| ja |
Japonês |
| sw |
Kiswahili |
| tlh |
Klingon |
| tlh-Latn |
Klingon (alfabeto latino) |
| tlh-Piqd |
Klingon (script klingon) |
| ko |
Coreano |
| lv |
Letão |
| lt |
Lituano |
| mg |
Malgaxe |
| ms |
Malaio |
| mt |
Maltês |
| nb |
Norueguês |
| fa |
Persa |
| pl |
Polaco |
| pt |
Português |
| pt-br |
Português (Brasil) |
| pt-PT |
Português (Portugal) |
| otq |
Querétaro Otomi |
| ro |
Romeno |
| ru |
Russo |
| sm |
Samoano |
| sr-Cyrl |
Sérvio (cirílico) |
| sr-Latn |
Sérvio (latim) |
| sk |
Eslovaco |
| sl |
Esloveno |
| es |
Espanhol |
| sv |
Sueco |
| ty |
Taitiano |
| ta |
Tamil |
| te |
Telugu |
| th |
Tailandês |
| to |
Tonga |
| tr |
Turco (língua) |
| uk |
Ucraniano |
| ur |
Língua Urdu |
| vi |
Vietnamita |
| cy |
Galês |
| yua |
Maia Yucateco |
| ga |
Irlandês |
| kn |
Kannada |
| mi |
Maori |
| ml |
Malaiala |
| pa |
Punjabi |
VisualFeature
As cadeias de caracteres que indicam quais tipos de recursos visuais devem ser retornados.
| Valor | Description |
|---|---|
| adult |
Características visuais reconhecidas como pessoas adultas. |
| brands |
Características visuais reconhecidas como marcas comerciais. |
| categories |
Categorias. |
| description |
Description. |
| faces |
Recursos visuais reconhecidos como rostos de pessoas. |
| objects |
Recursos visuais reconhecidos como objetos. |
| tags |
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. |
O discriminador para tipos derivados. |
| 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 (int32) |
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 (int32) |
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 |
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 |
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 (duration) |
O tempo limite desejado para a solicitação. O padrão é 30 segundos. |
| uri |
string |
A url para a API da Web. |