Skillsets - Create Or Update
Cria um novo conjunto de habilidades em um serviço de pesquisa ou atualiza o conjunto de habilidades se ele já existir.
PUT {endpoint}/skillsets('{skillsetName}')?api-version=2026-04-01
Parâmetros de URI
| Nome | Em | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
A URL do ponto de extremidade do serviço de pesquisa. |
|
skillset
|
path | True |
string |
O nome do conjunto de habilidades. |
|
api-version
|
query | True |
string minLength: 1 |
A versão da API a ser usada para esta operação. |
Cabeçalho da solicitação
| Nome | Obrigatório | Tipo | Description |
|---|---|---|---|
| Accept |
O cabeçalho Aceitar. |
||
| If-Match |
string |
Define a condição de If-Match. A operação será executada somente se a ETag no servidor corresponder a esse valor. |
|
| If-None-Match |
string |
Define a condição If-None-Match. A operação será executada somente se a ETag no servidor não corresponder a esse valor. |
|
| Prefer | True |
Para solicitações HTTP PUT, instrui o serviço a retornar o recurso criado/atualizado em caso de êxito. |
|
| x-ms-client-request-id |
string (uuid) |
Um identificador de cadeia de caracteres opaco, globalmente exclusivo e gerado pelo cliente para a solicitação. |
Corpo da solicitação
| Nome | Obrigató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 |
A ETag do conjunto de habilidades. |
|
| cognitiveServices | CognitiveServicesAccount: |
Detalhes sobre o serviço de IA do Azure a serem usados ao executar habilidades. |
|
| description |
string |
A descrição do conjunto de habilidades. |
|
| encryptionKey |
Uma descrição de uma chave de criptografia que você cria no Azure Key Vault. Essa chave é usada para fornecer um nível adicional de criptografia em repouso para a definição do seu conjunto de habilidades quando você quer total garantia de que ninguém, nem mesmo a Microsoft, pode descriptografar a definição do seu conjunto de habilidades. Depois de criptografar sua definição de conjunto de habilidades, ela sempre permanecerá criptografada. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como nula. Você pode alterar essa propriedade conforme necessário se quiser girar sua chave de criptografia; Sua definição de conjunto de habilidades não será afetada. A criptografia com chaves gerenciadas pelo cliente não está disponível para serviços de pesquisa gratuitos e só está disponível para serviços pagos criados em 1º de janeiro de 2019 ou depois de 1º de janeiro de 2019. |
||
| indexProjections |
Definição de projeções adicionais para índices de pesquisa secundários. |
||
| knowledgeStore |
Definição de projeções adicionais para blob, tabela ou arquivos do Azure, de dados enriquecidos. |
Respostas
| Nome | Tipo | Description |
|---|---|---|
| 200 OK |
A solicitação foi bem-sucedida. |
|
| 201 Created |
A solicitação foi bem-sucedida e um novo recurso foi criado como resultado. |
|
| Other Status Codes |
Uma resposta de erro inesperada. |
Segurança
api-key
Tipo:
apiKey
Em:
header
OAuth2Auth
Tipo:
oauth2
Flow:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Escopos
| Nome | Description |
|---|---|
| https://search.azure.com/.default |
Exemplos
SearchServiceCreateOrUpdateSkillset
Solicitação de exemplo
PUT https://stableexampleservice.search.windows.net/skillsets('tempskillset')?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 de exemplo
{
"@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"
}
}
{
"@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
| Nome | Description |
|---|---|
| Accept |
O cabeçalho Aceitar. |
|
AIServices |
A conta multi-região de um recurso de serviço de IA do Azure que está vinculado a um conjunto de habilidades. |
|
AIServices |
A chave de conta de um recurso de serviço de IA do Azure que está vinculado a um conjunto de habilidades, para ser usado com o subdomínio do recurso. |
|
Azure |
Permite que você gere uma inserção de vetor para uma determinada entrada de texto usando o recurso Azure OpenAI. |
|
Azure |
O nome do modelo do Azure Open AI que será chamado. |
|
Chat |
Parâmetros de modelo de linguagem comum para conclusões de chat. Se omitido, os valores padrão serão usados. |
|
Chat |
Especifica como os 'extraParameters' devem ser tratados pelo Fábrica de IA do Azure. O padrão é 'error'. |
|
Chat |
Determina como a resposta do modelo de linguagem deve ser serializada. O padrão é 'text'. |
|
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 habilidade que chama um modelo de linguagem via o endpoint Chat Completions do Fábrica de IA do Azure. |
|
Cognitive |
A chave da conta de várias regiões de um recurso de serviço de IA do Azure anexado a um conjunto de habilidades. |
|
Conditional |
Uma habilidade que permite cenários que exigem uma operação booliana para determinar os dados a serem atribuídos a uma saída. |
|
Content |
Uma habilidade que aproveita o Azure AI Content Understanding para processar e extrair insights estruturados de documentos, possibilitando conteúdo enriquecido e pesquisável para uma indexação e recuperação aprimorada de documentos. |
|
Content |
Controla a cardinalidade para dividir 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 que foram encontradas e metadados relacionados. |
|
Custom |
Um objeto complexo que pode ser usado para especificar ortografias ou sinônimos alternativos para o nome da entidade raiz. |
|
Custom |
Uma habilidade procura texto de uma lista personalizada definida pelo usuário de palavras e frases. |
|
Custom |
Os códigos de idioma com suporte para texto de entrada por CustomEntityLookupSkill. |
|
Default |
Um objeto vazio que representa o recurso de serviço de IA do Azure padrão para um conjunto de habilidades. |
|
Document |
Uma habilidade que extrai conteúdo de um arquivo dentro do pipeline de enriquecimento. |
|
Document |
Uma habilidade que extrai informações de conteúdo e layout, via Azure AI Services, a partir de arquivos dentro do pipeline de enriquecimento. |
|
Document |
Controla a cardinalidade para dividir 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 retornar. |
|
Entity |
Usando a API de Análise de Texto, extrai entidades vinculadas do texto. |
|
Entity |
Os códigos de idioma com suporte para texto de entrada por EntityRecognitionSkill. |
|
Entity |
Usando a API de Análise de Texto, extrai entidades de diferentes tipos do texto. |
|
Error |
As informações adicionais do erro de gerenciamento de recursos. |
|
Error |
O detalhe do erro. |
|
Error |
Resposta comum de erro para todas as APIs do Azure Resource Manager devolver detalhes de erro em 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 conjunto avançado de recursos visuais com base no conteúdo da imagem. |
|
Image |
Os códigos de idioma com suporte 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 de índice em relação ao restante do indexador. |
|
Input |
Mapeamento de campo de entrada para uma habilidade. |
|
Key |
Uma habilidade que usa a análise de texto para extração de frases-chave. |
|
Key |
Os códigos de idioma com suporte para texto de entrada por KeyPhraseExtractionSkill. |
|
Language |
Uma habilidade que detecta o idioma do texto de entrada e relata um único código de idioma para cada documento enviado na solicitação. O código de idioma é emparelhado com uma pontuação que indica a confiança da análise. |
|
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 de OCR. O valor padrão é "espaço". |
|
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 mascara-la. |
|
PIIDetection |
Uma cadeia de caracteres que indica qual maskingMode usar para mascarar as informações pessoais detectadas no texto de entrada. |
| Prefer |
Para solicitações HTTP PUT, instrui o serviço a retornar o recurso criado/atualizado em caso de êxito. |
|
Search |
Limpa a propriedade de identidade de uma fonte de dados. |
|
Search |
Especifica a identidade de uma fonte de dados a ser usada. |
|
Search |
Definição de projeções adicionais para índices de pesquisa secundários. |
|
Search |
Descrição de quais dados armazenar no índice de pesquisa designado. |
|
Search |
Um dicionário de propriedades de configuração específicas da projeção de índice. Cada nome é o nome de uma propriedade específica. Cada valor deve ser de um tipo primitivo. |
|
Search |
Definição de projeções adicionais para blob, tabela ou arquivos do Azure 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 de quais dados armazenar nas Tabelas do Azure. |
|
Search |
Uma lista de habilidades. |
|
Search |
Uma chave de criptografia gerenciada pelo cliente no Azure Key Vault. As chaves que você cria e gerencia podem ser usadas para criptografar ou descriptografar dados em repouso, como índices e mapas de sinônimos. |
|
Sentiment |
Os códigos de idioma com suporte para texto de entrada por SentimentSkill. |
|
Sentiment |
Usando a API de Análise de Texto, avalia o texto não estruturado e, para cada registro, fornece rótulos de sentimento (como "negativo", "neutro" e "positivo") com base na pontuação de confiança mais alta encontrada pelo serviço em uma frase e no nível do documento. |
|
Shaper |
Uma habilidade para remodelar as saídas. Ele cria um tipo complexo para dar suporte a campos compostos (também conhecidos como campos de várias partes). |
|
Split |
Uma habilidade para dividir uma cadeia de caracteres em partes de texto. |
|
Split |
Os códigos de idioma com suporte 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 com suporte para texto de entrada por TextTranslationSkill. |
|
Visual |
As cadeias de caracteres que indicam quais tipos de recursos visuais retornar. |
|
Web |
Uma habilidade que pode chamar um ponto de extremidade de API Web, permitindo que você estenda um conjunto de habilidades fazendo com que ele chame seu código personalizado. |
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á vinculado a um conjunto de habilidades.
| Nome | Tipo | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
O discriminador para tipos derivados. |
| description |
string |
Descrição do recurso de serviço de IA do Azure anexado a um conjunto de habilidades. |
| 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 pelo sistema será usada. Nas atualizações do 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 |
A URL do endpoint do subdomínio/Azure AI Services para o respectivo Serviço de IA. |
AIServicesAccountKey
A chave de conta de um recurso de serviço de IA do Azure que está vinculado a um conjunto de habilidades, para ser usado com o subdomínio do recurso.
| Nome | Tipo | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
O discriminador para tipos derivados. |
| 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 fornecer o recurso de serviço de IA do Azure vinculado a um conjunto de habilidades. |
| subdomainUrl |
string |
A URL do endpoint do subdomínio/Azure AI Services para o respectivo Serviço de IA. |
AzureOpenAIEmbeddingSkill
Permite que você gere uma inserção de vetor para uma determinada entrada de texto usando o recurso Azure OpenAI.
| Nome | Tipo | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
O discriminador para tipos derivados. |
| apiKey |
string |
Chave de API do recurso Azure OpenAI designado. |
| authIdentity | SearchIndexerDataIdentity: |
A identidade gerenciada atribuída pelo usuário usada para conexões de saída. |
| context |
string |
Representa o nível em que as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document. |
| deploymentId |
string |
ID da implantação de modelo do Azure OpenAI no recurso designado. |
| description |
string |
A descrição da habilidade que descreve as entradas, as saídas e o uso da habilidade. |
| dimensions |
integer (int32) |
O número de dimensões que os embeddings de saída resultantes devem ter. Só há suporte em modelos text-embedding-3 e posteriores. |
| inputs |
As entradas das habilidades podem ser uma coluna no conjunto de dados de origem ou a saída de uma habilidade upstream. |
|
| modelName |
O nome do modelo de inserção implantado no caminho deploymentId fornecido. |
|
| name |
string |
O nome da habilidade que a identifica exclusivamente dentro do conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixado com o caractere '#'. |
| outputs |
A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como entrada por outra habilidade. |
|
| resourceUri |
string (uri) |
O URI do recurso do Azure OpenAI. |
AzureOpenAIModelName
O nome do modelo do Azure Open AI que será chamado.
| Valor | Description |
|---|---|
| text-embedding-ada-002 |
TextEmbeddingAda002 modelo. |
| text-embedding-3-large |
TextEmbedding3 Modelo grande. |
| text-embedding-3-small |
TextEmbedding3Small modelo. |
| 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ões de chat. Se omitido, os valores padrão serão usados.
| Nome | Tipo | Valor padrão | 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 serem gerados. |
|
| model |
string |
O nome do modelo a ser usado (por exemplo, 'gpt-4o', etc.). O padrão é nulo se não for especificado. |
|
| presencePenalty |
number (double) |
0 |
Um float no intervalo [-2,2] que penaliza novos tokens com base em sua presença existente. O padrão é 0. |
| seed |
integer (int32) |
Semente aleatória para controlar saídas determinísticas. Se omitido, a randomização é usada. |
|
| stop |
string[] |
Lista de sequências de parada que interromperã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 'extraParameters' devem ser tratados pelo Fábrica de IA do Azure. O padrão é 'error'.
| Valor | Description |
|---|---|
| passThrough |
Passa todos os parâmetros extras 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 é 'text'.
| Nome | Tipo | Valor padrão | Description |
|---|---|---|---|
| jsonSchemaProperties |
Um dicionário aberto para propriedades estendidas. Obrigatório se 'type' == '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.
| Nome | Tipo | Valor padrão | Description |
|---|---|---|---|
| additionalProperties |
boolean |
False |
Controla se é permitido que um objeto contenha chaves/valores adicionais que não foram definidos no esquema JSON. O padrão é false. |
| 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 devem 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 é 'object'. |
ChatCompletionSchemaProperties
Propriedades para o formato de resposta de esquema JSON.
| Nome | Tipo | Valor padrão | 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. O padrão é true. |
ChatCompletionSkill
Uma habilidade que chama um modelo de linguagem via o endpoint Chat Completions do Fábrica de IA do Azure.
| Nome | Tipo | Valor padrão | Description |
|---|---|---|---|
| @odata.type |
string:
#Microsoft. |
O discriminador para tipos derivados. |
|
| apiKey |
string |
Chave de API para autenticação no modelo. Tanto apiKey quanto 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 pelo sistema será usada. Em atualizações para o indexador, se a identidade não for especificada, o valor permanecerá inalterado. Se definido como "nenhum", o valor dessa propriedade será limpo. |
|
| commonModelParameters |
Parâmetros de modelo de linguagem comum que os clientes podem ajustar. Se omitido, padrões razoáveis serão aplicados. |
||
| context |
string |
Representa o nível em que as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document. |
|
| description |
string |
A descrição da habilidade que descreve as entradas, as saídas e o uso da habilidade. |
|
| extraParameters |
Dicionário de tipo aberto para parâmetros específicos do modelo que devem ser acrescentados à chamada de conclusão de chat. Segue o padrão de extensibilidade do Fábrica de IA do Azure. |
||
| extraParametersBehavior | error |
Como parâmetros extras são tratados pelo Fábrica de IA do Azure. O padrão é 'error'. |
|
| inputs |
As entradas das habilidades podem ser uma coluna no conjunto de dados de origem ou a saída de uma habilidade upstream. |
||
| name |
string |
O nome da habilidade que a identifica exclusivamente dentro do conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixado com o caractere '#'. |
|
| outputs |
A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como entrada por outra habilidade. |
||
| responseFormat |
Determina como o LLM deve formatar sua resposta. O padrão é o tipo de resposta 'text'. |
||
| uri |
string |
A URL da API Web. |
CognitiveServicesAccountKey
A chave da conta de várias regiões de um recurso de serviço de IA do Azure anexado a um conjunto de habilidades.
| Nome | Tipo | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
O discriminador para tipos derivados. |
| 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 fornecer o recurso de serviço de IA do Azure vinculado a um conjunto de habilidades. |
ConditionalSkill
Uma habilidade que permite cenários que exigem uma operação booliana para determinar os dados a serem atribuídos a uma saída.
| Nome | Tipo | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
O discriminador para tipos derivados. |
| context |
string |
Representa o nível em que as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document. |
| description |
string |
A descrição da habilidade que descreve as entradas, as saídas e o uso da habilidade. |
| inputs |
As entradas das habilidades podem ser uma coluna no conjunto de dados de origem ou a saída de uma habilidade upstream. |
|
| name |
string |
O nome da habilidade que a identifica exclusivamente dentro do conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixado com o caractere '#'. |
| outputs |
A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como entrada por outra habilidade. |
ContentUnderstandingSkill
Uma habilidade que aproveita o Azure AI Content Understanding para processar e extrair insights estruturados de documentos, possibilitando conteúdo enriquecido e pesquisável para uma indexação e recuperação aprimorada de documentos.
| Nome | Tipo | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
O discriminador para tipos derivados. |
| chunkingProperties |
Controla a cardinalidade para dividir o conteúdo. |
|
| context |
string |
Representa o nível em que as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document. |
| description |
string |
A descrição da habilidade que descreve as entradas, as saídas e o uso da habilidade. |
| 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 upstream. |
|
| name |
string |
O nome da habilidade que a identifica exclusivamente dentro do conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixado com o caractere '#'. |
| outputs |
A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como entrada por outra habilidade. |
ContentUnderstandingSkillChunkingProperties
Controla a cardinalidade para dividir o conteúdo.
| Nome | Tipo | Valor padrão | Description |
|---|---|---|---|
| maximumLength |
integer (int32) |
O comprimento máximo da parte 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 que foram encontradas e metadados relacionados.
| Nome | 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 |
Uma matriz de objetos complexos que podem ser usados para especificar grafias ou sinônimos alternativos para o nome da entidade raiz. |
|
| caseSensitive |
boolean |
O padrão é false. Valor booliano que indica se as comparações com o nome da entidade devem conseguir diferenciar os caracteres maiúsculos de minúsculos. Exemplos de correspondências insensíveis ao caso de "Microsoft" podem ser: Microsoft, Microsoft, MICROSOFT. |
| defaultAccentSensitive |
boolean |
Altera o valor de diferenciação de acento padrão para essa entidade. Ele pode ser usado para alterar o valor padrão de todos os valores accentSensitive de aliases. |
| defaultCaseSensitive |
boolean |
Altera o valor padrão de diferenciação de maiúsculas e minúsculas para essa entidade. Ele pode ser usado para alterar o valor padrão de todos os valores caseSensitive de aliases. |
| defaultFuzzyEditDistance |
integer (int32) |
Altera o valor padrão da distância de edição difusa para esta entidade. Ele pode ser usado para alterar o valor padrão de todos os valores de aliases fuzzyEditDistance. |
| description |
string |
Esse campo pode ser usado como uma passagem para metadados personalizados sobre o(s) texto(s) correspondente(s). O valor desse campo será exibido com cada correspondência de sua entidade na saída da habilidade. |
| fuzzyEditDistance |
integer (int32) |
O valor padrão é 0. Valor máximo de 5. Denota o número aceitável de caracteres divergentes que ainda constituem uma correspondência com o nome da entidade. A menor possibilidade de difusão possível para qualquer correspondência fornecida é retornada. Por exemplo, se a distância de edição estiver definida para 3, "Windows10" ainda corresponderia a "Windows", "Windows10" e "Windows 7". Quando a diferenciação de maiúsculas e minúsculas estiver definida como false, as diferenças de maiúsculas e minúsculas NÃO contarão na tolerância de difusão, caso contrário, contarão. |
| id |
string |
Esse campo pode ser usado como uma passagem para metadados personalizados sobre o(s) texto(s) correspondente(s). O valor desse campo será exibido com cada correspondência de sua entidade na saída da habilidade. |
| name |
string |
O descritor de entidade de nível superior. As correspondências na saída da habilidade serão agrupadas por esse nome e deverão representar a forma "normalizada" do texto que está sendo encontrado. |
| subtype |
string |
Esse campo pode ser usado como uma passagem para metadados personalizados sobre o(s) texto(s) correspondente(s). O valor desse campo será exibido com cada correspondência de sua entidade na saída da habilidade. |
| type |
string |
Esse campo pode ser usado como uma passagem para metadados personalizados sobre o(s) texto(s) correspondente(s). O valor desse campo será exibido com cada correspondência de sua entidade na saída da habilidade. |
CustomEntityAlias
Um objeto complexo que pode ser usado para especificar ortografias ou sinônimos alternativos para o nome da entidade raiz.
| Nome | Tipo | Description |
|---|---|---|
| accentSensitive |
boolean |
Determine se o alias diferencia acentos. |
| caseSensitive |
boolean |
Determine se o alias diferencia maiúsculas de minúsculas. |
| fuzzyEditDistance |
integer (int32) |
Determine a distância de edição difusa do alias. |
| text |
string |
O texto do alias. |
CustomEntityLookupSkill
Uma habilidade procura texto de uma lista personalizada definida pelo usuário de palavras e frases.
| Nome | Tipo | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
O discriminador para tipos derivados. |
| context |
string |
Representa o nível em que as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document. |
| defaultLanguageCode |
Um valor que indica qual código de idioma usar. O padrão é |
|
| description |
string |
A descrição da habilidade que descreve as entradas, as saídas e o uso da habilidade. |
| entitiesDefinitionUri |
string |
Caminho para um arquivo JSON ou CSV que contém todo o texto de destino com o qual corresponder. Essa definição de entidade é lida no início de uma execução do indexador. Todas as atualizações para esse arquivo durante uma execução do indexador não entrarão em vigor até as execuções subsequentes. Essa configuração deve estar acessível por HTTPS. |
| globalDefaultAccentSensitive |
boolean |
Um sinalizador global para AccentSensitive. Se AccentSensitive não estiver definido em CustomEntity, esse valor será o valor padrão. |
| globalDefaultCaseSensitive |
boolean |
Um sinalizador global para CaseSensitive. Se CaseSensitive não estiver definido em CustomEntity, esse valor será o valor padrão. |
| globalDefaultFuzzyEditDistance |
integer (int32) |
Um sinalizador global para FuzzyEditDistance. Se FuzzyEditDistance não estiver definido em CustomEntity, esse valor será o valor padrão. |
| inlineEntitiesDefinition |
A definição de Entidade Personalizada embutida. |
|
| inputs |
As entradas das habilidades podem ser uma coluna no conjunto de dados de origem ou a saída de uma habilidade upstream. |
|
| name |
string |
O nome da habilidade que a identifica exclusivamente dentro do conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixado com o caractere '#'. |
| outputs |
A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como entrada por outra habilidade. |
CustomEntityLookupSkillLanguage
Os códigos de idioma com suporte para texto de entrada por CustomEntityLookupSkill.
| Valor | Description |
|---|---|
| da |
Dinamarquês |
| de |
Alemão |
| en |
Inglês |
| es |
Espanhol |
| fi |
Finlandês |
| fr |
Francês |
| it |
Italian |
| ko |
Coreano |
| pt |
Portuguese |
DefaultCognitiveServicesAccount
Um objeto vazio que representa o recurso de serviço de IA do Azure padrão para um conjunto de habilidades.
| Nome | Tipo | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
O discriminador para tipos derivados. |
| 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.
| Nome | 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 em que as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document. |
| dataToExtract |
string |
O tipo de dados a serem extraídos para a habilidade. Será definido como 'contentAndMetadata' se não for definido. |
| description |
string |
A descrição da habilidade que descreve as entradas, as saídas e o uso da habilidade. |
| inputs |
As entradas das habilidades podem ser uma coluna no conjunto de dados de origem ou a saída de uma habilidade upstream. |
|
| name |
string |
O nome da habilidade que a identifica exclusivamente dentro do conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixado com o caractere '#'. |
| outputs |
A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como entrada por outra habilidade. |
|
| parsingMode |
string |
O parsingMode para a habilidade. Será definido como "padrão" se não for definido. |
DocumentIntelligenceLayoutSkill
Uma habilidade que extrai informações de conteúdo e layout, via Azure AI Services, a partir de arquivos dentro do pipeline de enriquecimento.
| Nome | Tipo | Valor padrão | Description |
|---|---|---|---|
| @odata.type |
string:
#Microsoft. |
O discriminador para tipos derivados. |
|
| chunkingProperties |
Controla a cardinalidade para dividir o conteúdo. |
||
| context |
string |
Representa o nível em que as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document. |
|
| description |
string |
A descrição da habilidade que descreve as entradas, as saídas e o uso da habilidade. |
|
| 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 upstream. |
||
| 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, prefixado 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 entrada por outra habilidade. |
DocumentIntelligenceLayoutSkillChunkingProperties
Controla a cardinalidade para dividir o conteúdo.
| Nome | Tipo | Valor padrão | Description |
|---|---|---|---|
| maximumLength |
integer (int32) |
O comprimento máximo da parte 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 retornar.
| Valor | Description |
|---|---|
| location |
Entidades que descrevem um local físico. |
| organization |
Entidades que descrevem uma organização. |
| person |
Entidades que descrevem uma pessoa. |
| quantity |
Entidades que descrevem uma quantidade. |
| datetime |
Entidades que descrevem uma data e hora. |
| url |
Entidades que descrevem uma URL. |
|
Entidades que descrevem um endereço de email. |
EntityLinkingSkill
Usando a API de Análise de Texto, extrai entidades vinculadas do texto.
| Nome | Tipo | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
O discriminador para tipos derivados. |
| context |
string |
Representa o nível em que as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document. |
| defaultLanguageCode |
string |
Um valor que indica qual código de idioma usar. O padrão é |
| description |
string |
A descrição da habilidade que descreve as entradas, as saídas e o 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 upstream. |
|
| minimumPrecision |
number (double) minimum: 0maximum: 1 |
Um valor entre 0 e 1 que será usado apenas para incluir entidades cuja pontuação de confiança é maior que o valor especificado. Se não for definido (padrão) ou se definido explicitamente como nulo, todas as entidades serão incluídas. |
| modelVersion |
string |
A versão do modelo a ser usada ao chamar o serviço de Análise de Texto. Ele usará o padrão para o mais recente disponível quando não for especificado. Recomendamos que você não especifique esse valor, a menos que seja absolutamente necessário. |
| name |
string |
O nome da habilidade que a identifica exclusivamente dentro do conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixado com o caractere '#'. |
| outputs |
A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como entrada por outra habilidade. |
EntityRecognitionSkillLanguage
Os códigos de idioma com suporte para texto de entrada por EntityRecognitionSkill.
| Valor | Description |
|---|---|
| ar |
Árabe |
| cs |
Tcheco |
| zh-Hans |
Mandarim Simplificado |
| zh-Hant |
Chinês-Tradicional |
| da |
Dinamarquês |
| nl |
Holandês |
| en |
Inglês |
| fi |
Finlandês |
| fr |
Francês |
| de |
Alemão |
| el |
Grego |
| hu |
Húngaro |
| it |
Italian |
| ja |
Japonês |
| ko |
Coreano |
| no |
Norueguês (Bokmaal) |
| pl |
Polonês |
| pt-PT |
Português (Portugal) |
| pt-BR |
Português (Brasil) |
| ru |
Russo |
| es |
Espanhol |
| sv |
Sueco |
| tr |
Turco |
EntityRecognitionSkillV3
Usando a API de Análise de Texto, extrai entidades de diferentes tipos do texto.
| Nome | Tipo | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
O discriminador para tipos derivados. |
| categories |
Uma lista de categorias de entidade que devem ser extraídas. |
|
| context |
string |
Representa o nível em que as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document. |
| defaultLanguageCode |
Um valor que indica qual código de idioma usar. O padrão é |
|
| description |
string |
A descrição da habilidade que descreve as entradas, as saídas e o 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 upstream. |
|
| minimumPrecision |
number (double) minimum: 0maximum: 1 |
Um valor entre 0 e 1 que será usado apenas para incluir entidades cuja pontuação de confiança é maior que o valor especificado. Se não for definido (padrão) ou se definido explicitamente como nulo, todas as entidades serão incluídas. |
| modelVersion |
string |
A versão do modelo a ser usada ao chamar a API de Análise de Texto. Ele usará o padrão para o mais recente disponível quando não for especificado. Recomendamos que você não especifique esse valor, a menos que seja absolutamente necessário. |
| name |
string |
O nome da habilidade que a identifica exclusivamente dentro do conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixado com o caractere '#'. |
| outputs |
A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como entrada por outra habilidade. |
ErrorAdditionalInfo
As informações adicionais do erro de gerenciamento de recursos.
| Nome | Tipo | Description |
|---|---|---|
| info |
As informações adicionais. |
|
| type |
string |
O tipo de informação adicional. |
ErrorDetail
O detalhe do erro.
| Nome | Tipo | Description |
|---|---|---|
| additionalInfo |
As informações adicionais do erro. |
|
| code |
string |
O código de erro. |
| details |
Os detalhes do erro. |
|
| message |
string |
A mensagem de erro. |
| target |
string |
O destino do erro. |
ErrorResponse
Resposta comum de erro para todas as APIs do Azure Resource Manager devolver detalhes de erro em operações falhadas. (Isso também segue o formato de resposta de erro OData.).
| Nome | Tipo | Description |
|---|---|---|
| error |
O objeto de erro. |
ImageAnalysisSkill
Uma habilidade que analisa arquivos de imagem. Ele extrai um conjunto avançado de recursos visuais com base no conteúdo da imagem.
| Nome | Tipo | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
O discriminador para tipos derivados. |
| context |
string |
Representa o nível em que as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document. |
| defaultLanguageCode |
Um valor que indica qual código de idioma usar. O padrão é |
|
| description |
string |
A descrição da habilidade que descreve as entradas, as saídas e o 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 upstream. |
|
| name |
string |
O nome da habilidade que a identifica exclusivamente dentro do conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixado com o caractere '#'. |
| outputs |
A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como entrada por outra habilidade. |
|
| visualFeatures |
Uma lista de recursos visuais. |
ImageAnalysisSkillLanguage
Os códigos de idioma com suporte para entrada por ImageAnalysisSkill.
| Valor | Description |
|---|---|
| ar |
Árabe |
| az |
Azerbaidjano |
| bg |
Búlgaro |
| bs |
Latim bósnio |
| ca |
Catalão |
| cs |
Tcheco |
| cy |
Galês |
| da |
Dinamarquês |
| de |
Alemão |
| el |
Grego |
| en |
Inglês |
| es |
Espanhol |
| et |
Estonian |
| eu |
Basco |
| fi |
Finlandês |
| fr |
Francês |
| ga |
Irish |
| gl |
Galician |
| he |
Hebraico |
| hi |
Hindi |
| hr |
Croatian |
| hu |
Húngaro |
| id |
Indonésio |
| it |
Italian |
| ja |
Japonês |
| kk |
Kazakh |
| ko |
Coreano |
| lt |
Lituano |
| lv |
Letão |
| mk |
Macedónio |
| ms |
Malásia malaia |
| nb |
Norueguês (Bokmal) |
| nl |
Holandês |
| pl |
Polonês |
| prs |
Dari |
| pt-BR |
Portuguese-Brazil |
| pt |
Portuguese-Portugal |
| pt-PT |
Portuguese-Portugal |
| ro |
Romanian |
| ru |
Russo |
| sk |
Slovak |
| sl |
Esloveno |
| sr-Cyrl |
Sérvio - RS cirílico |
| sr-Latn |
Sérvio - RS latino |
| sv |
Sueco |
| th |
Tailandês |
| tr |
Turco |
| uk |
Ucraniano |
| vi |
Vietnamita |
| zh |
Chinês simplificado |
| zh-Hans |
Chinês simplificado |
| zh-Hant |
Chinês tradicional |
ImageDetail
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 de índice em relação ao restante 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. Esse é o padrão padrão. |
InputFieldMappingEntry
Mapeamento de campo de entrada para uma habilidade.
| Nome | Tipo | Description |
|---|---|---|
| inputs |
As entradas recursivas usadas ao criar um tipo complexo. |
|
| name |
string |
O nome da entrada. |
| source |
string |
A origem da entrada. |
| sourceContext |
string |
O contexto de origem usado para selecionar entradas recursivas. |
KeyPhraseExtractionSkill
Uma habilidade que usa a análise de texto para extração de frases-chave.
| Nome | Tipo | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
O discriminador para tipos derivados. |
| context |
string |
Representa o nível em que as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document. |
| defaultLanguageCode |
Um valor que indica qual código de idioma usar. O padrão é |
|
| description |
string |
A descrição da habilidade que descreve as entradas, as saídas e o 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 upstream. |
|
| maxKeyPhraseCount |
integer (int32) |
Um número que indica quantas frases-chave devem ser retornadas. Se ausente, todas as frases-chave identificadas serão retornadas. |
| modelVersion |
string |
A versão do modelo a ser usada ao chamar o serviço de Análise de Texto. Ele usará o padrão para o mais recente disponível quando não for especificado. Recomendamos que você não especifique esse valor, a menos que seja absolutamente necessário. |
| name |
string |
O nome da habilidade que a identifica exclusivamente dentro do conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixado com o caractere '#'. |
| outputs |
A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como entrada por outra habilidade. |
KeyPhraseExtractionSkillLanguage
Os códigos de idioma com suporte para texto de entrada por KeyPhraseExtractionSkill.
| Valor | Description |
|---|---|
| da |
Dinamarquês |
| nl |
Holandês |
| en |
Inglês |
| fi |
Finlandês |
| fr |
Francês |
| de |
Alemão |
| it |
Italian |
| ja |
Japonês |
| ko |
Coreano |
| no |
Norueguês (Bokmaal) |
| pl |
Polonês |
| pt-PT |
Português (Portugal) |
| pt-BR |
Português (Brasil) |
| ru |
Russo |
| es |
Espanhol |
| sv |
Sueco |
LanguageDetectionSkill
Uma habilidade que detecta o idioma do texto de entrada e relata um único código de idioma para cada documento enviado na solicitação. O código de idioma é emparelhado com uma pontuação que indica a confiança da análise.
| Nome | Tipo | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
O discriminador para tipos derivados. |
| context |
string |
Representa o nível em que as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document. |
| defaultCountryHint |
string |
Um código de país a ser usado como uma dica para o modelo de detecção de idioma se ele não puder desambiguar o idioma. |
| description |
string |
A descrição da habilidade que descreve as entradas, as saídas e o uso da habilidade. |
| inputs |
As entradas das habilidades podem ser uma coluna no conjunto de dados de origem ou a saída de uma habilidade upstream. |
|
| modelVersion |
string |
A versão do modelo a ser usada ao chamar o serviço de Análise de Texto. Ele usará o padrão para o mais recente disponível quando não for especificado. Recomendamos que você não especifique esse valor, a menos que seja absolutamente necessário. |
| name |
string |
O nome da habilidade que a identifica exclusivamente dentro do conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixado com o caractere '#'. |
| outputs |
A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como entrada por outra habilidade. |
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.
| Nome | Tipo | Valor padrão | Description |
|---|---|---|---|
| @odata.type |
string:
#Microsoft. |
O discriminador para tipos derivados. |
|
| context |
string |
Representa o nível em que as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document. |
|
| description |
string |
A descrição da habilidade que descreve as entradas, as saídas e o uso da habilidade. |
|
| inputs |
As entradas das habilidades podem ser uma coluna no conjunto de dados de origem ou a saída de uma habilidade upstream. |
||
| insertPostTag |
string |
A marca indica o final do texto mesclado. Por padrão, a marca é um espaço vazio. |
|
| insertPreTag |
string |
A marca indica o início do texto mesclado. Por padrão, a marca é um espaço vazio. |
|
| name |
string |
O nome da habilidade que a identifica exclusivamente dentro do conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixado com o caractere '#'. |
|
| outputs |
A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como entrada por outra habilidade. |
OcrLineEnding
Define a sequência de caracteres a ser usada entre as linhas de texto reconhecidas pela habilidade de OCR. O valor padrão é "espaço".
| 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 feed 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.
| Nome | Tipo | Valor padrão | Description |
|---|---|---|---|
| @odata.type |
string:
#Microsoft. |
O discriminador para tipos derivados. |
|
| context |
string |
Representa o nível em que as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document. |
|
| defaultLanguageCode |
Um valor que indica qual código de idioma usar. O padrão é |
||
| description |
string |
A descrição da habilidade que descreve as entradas, as saídas e o uso da habilidade. |
|
| detectOrientation |
boolean |
False |
Um valor que indica ativar ou não a detecção de orientação. O padrão é false. |
| inputs |
As entradas das habilidades podem ser uma coluna no conjunto de dados de origem ou a saída de uma habilidade upstream. |
||
| lineEnding |
Define a sequência de caracteres a ser usada entre as linhas de texto reconhecidas pela habilidade de OCR. O valor padrão é "espaço". |
||
| name |
string |
O nome da habilidade que a identifica exclusivamente dentro do conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixado com o caractere '#'. |
|
| outputs |
A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como entrada por outra habilidade. |
OcrSkillLanguage
Os códigos de idioma suportados para entrada pelo OcrSkill.
| Valor | Description |
|---|---|
| af |
Africâner |
| sq |
Albanian |
| anp |
Angika (Devanagiri) |
| ar |
Árabe |
| ast |
Asturiano |
| awa |
Hindi Awadhi (Devanagiri) |
| az |
Azerbaijão (Latino) |
| bfy |
Bagheli |
| eu |
Basco |
| be |
Bielorrusso (cirílico e latino) |
| be-cyrl |
Bielorrusso (cirílico) |
| be-latn |
Bielorrusso (alfabeto latino) |
| bho |
Hindi Bhojpuri (Devanagiri) |
| bi |
Bislama |
| brx |
Bodo (Devanágari) |
| bs |
Latim bósnio |
| 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 |
córnico |
| co |
Córsico |
| crh |
Tártaro Crimeano (Latim) |
| hr |
Croatian |
| cs |
Tcheco |
| da |
Dinamarquês |
| prs |
Dari |
| dhi |
Dhimal (Devanagiri) |
| doi |
Dogri (Devanagiri) |
| nl |
Holandês |
| en |
Inglês |
| myv |
Erzya (cirílico) |
| et |
Estonian |
| fo |
Faroês |
| fj |
Fijiano |
| fil |
Filipino |
| fi |
Finlandês |
| fr |
Francês |
| fur |
Frulian |
| gag |
Gagauz (Latim) |
| gl |
Galician |
| de |
Alemão |
| gil |
Gilbertês |
| gon |
Gondi (Devanagiri) |
| el |
Grego |
| kl |
Groenlandês |
| gvr |
Gurung (Devanágari) |
| ht |
Crioulo Haitiano |
| hlb |
Halbi (Devanagiri) |
| hni |
Hani |
| bgc |
Haryanvi |
| haw |
Havaiano |
| hi |
Hindi |
| mww |
Hmong Daw (latim) |
| hoc |
Ho (Devanagiri) |
| hu |
Húngaro |
| is |
Icelandic |
| smn |
sami de Inari |
| id |
Indonésio |
| ia |
Interlíngua |
| iu |
Inuktitut (Latino) |
| ga |
Irish |
| it |
Italian |
| 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 (latino) |
| csb |
Kashubian |
| kk-cyrl |
Cazaque (Cirílico) |
| kk-latn |
Cazaque (latino) |
| klr |
Khaling |
| kha |
Khasi |
| quc |
K'iche' |
| ko |
Coreano |
| kfq |
Korku |
| kpy |
Koryak |
| kos |
Kosraano |
| kum |
Kumyk (cirílico) |
| ku-arab |
Curdo (árabe) |
| ku-latn |
Curdo (Latim) |
| kru |
Kurux (Devanagiri) |
| ky |
Quirguistão (cirílico) |
| lkt |
Lakota |
| la |
Latim |
| lt |
Lituano |
| dsb |
Sorbian inferior |
| smj |
Lule Sami |
| lb |
Luxemburguês |
| bfz |
Mahasu Pahari (Devanagiri) |
| ms |
Malaio (latino) |
| mt |
Maltese |
| kmj |
Malto (Devanágari) |
| gv |
Manx |
| mi |
Maori |
| mr |
Marathi |
| mn |
Mongol (cirílico) |
| cnr-cyrl |
Montenegrino (cirílico) |
| cnr-latn |
Montenegrino (latino) |
| nap |
Napolitano |
| ne |
Nepalês |
| niu |
Niueano |
| nog |
Nogay |
| sme |
Sami do Norte (Latino) |
| nb |
Norueguês |
| no |
Norueguês |
| oc |
Occitânico |
| os |
Ossético |
| ps |
Pashto |
| fa |
Persa |
| pl |
Polonês |
| pt |
Portuguese |
| pa |
Punjabi (árabe) |
| ksh |
Ripuário |
| ro |
Romanian |
| rm |
Romanche |
| ru |
Russo |
| sck |
Sadri (Devanágari) |
| sm |
Samoano (alfabeto latino) |
| sa |
Sânscrito (Devanagiri) |
| sat |
Santali (Devanagiri) |
| sco |
Escoceses |
| gd |
Gaélico escocês |
| sr |
Sérvio (latino) |
| sr-Cyrl |
Sérvio (cirílico) |
| sr-Latn |
Sérvio (latino) |
| xsr |
Sherpa (Devanagari) |
| srx |
Sirmauri (Devanagiri) |
| sms |
Skolt Sami |
| sk |
Slovak |
| sl |
Esloveno |
| so |
Somali (árabe) |
| sma |
Sami do Sul |
| es |
Espanhol |
| sw |
Swahili (latim) |
| sv |
Sueco |
| tg |
Tajique (cirílico) |
| tt |
Tatar (latino) |
| tet |
Tetum |
| thf |
Thangmi |
| to |
Tonga |
| tr |
Turco |
| tk |
Turcomeno (Latim) |
| tyv |
Tuvan |
| hsb |
Alto Sorábio |
| ur |
Urdu |
| ug |
Uigure (árabe) |
| uz-arab |
Uzbeque (árabe) |
| uz-cyrl |
Uzbeque (Cirílico) |
| uz |
Uzbeque (Latino) |
| vo |
Volapuque |
| wae |
Walser |
| cy |
Galês |
| fy |
Frísia Ocidental |
| yua |
Maias yucatecos |
| za |
Zhuang |
| zu |
Zulu |
| unk |
Desconhecido (Todos) |
OutputFieldMappingEntry
Mapeamento de campo de saída para uma habilidade.
| Nome | Tipo | Description |
|---|---|---|
| name |
string |
O nome da saída definida pela habilidade. |
| targetName |
string |
O nome de destino da saída. É opcional e o nome é padrão. |
PIIDetectionSkill
Usando a API de Análise de Texto, extrai informações pessoais de um texto de entrada e oferece a opção de mascara-la.
| Nome | Tipo | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
O discriminador para tipos derivados. |
| context |
string |
Representa o nível em que as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document. |
| defaultLanguageCode |
string |
Um valor que indica qual código de idioma usar. O padrão é |
| description |
string |
A descrição da habilidade que descreve as entradas, as saídas e o uso da habilidade. |
| domain |
string |
Se especificado, definirá o domínio PII para incluir apenas um subconjunto das categorias de entidade. Os valores possíveis incluem: 'phi', 'none'. O padrão é 'none'. |
| inputs |
As entradas das habilidades podem ser uma coluna no conjunto de dados de origem ou a saída de uma habilidade upstream. |
|
| maskingCharacter |
string maxLength: 1 |
O caractere usado para mascarar o texto se o parâmetro maskingMode estiver definido para substituir. O padrão é '*'. |
| maskingMode |
Um parâmetro que fornece várias maneiras de mascarar as informações pessoais detectadas no texto de entrada. O padrão é 'none'. |
|
| minimumPrecision |
number (double) minimum: 0maximum: 1 |
Um valor entre 0 e 1 que será usado apenas para incluir entidades cuja pontuação de confiança é maior que o valor especificado. Se não for definido (padrão) ou se definido explicitamente como nulo, todas as entidades serão incluídas. |
| modelVersion |
string |
A versão do modelo a ser usada ao chamar o serviço de Análise de Texto. Ele usará o padrão para o mais recente disponível quando não for especificado. Recomendamos que você não especifique esse valor, a menos que seja absolutamente necessário. |
| name |
string |
O nome da habilidade que a identifica exclusivamente dentro do conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixado com o caractere '#'. |
| outputs |
A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como entrada por outra habilidade. |
|
| piiCategories |
string[] |
Uma lista de categorias de entidade pii que devem ser extraídas e mascaradas. |
PIIDetectionSkillMaskingMode
Uma cadeia de caracteres que indica qual maskingMode usar para mascarar as informações pessoais detectadas no texto de entrada.
| Valor | Description |
|---|---|
| none |
Nenhuma máscara ocorre e a saída maskedText não será retornada. |
| replace |
Substitui as entidades detectadas pelo caractere dado no parâmetro maskingCharacter. O caractere será repetido até o comprimento da entidade detectada para que os deslocamentos correspondam corretamente ao texto de entrada, bem como ao maskedText de saída. |
Prefer
Para solicitações HTTP PUT, instrui o serviço a retornar o recurso criado/atualizado em caso de êxito.
| Valor | Description |
|---|---|
| return=representation |
SearchIndexerDataNoneIdentity
Limpa a propriedade de identidade de uma fonte de dados.
| Nome | Tipo | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
Um fragmento de URI especificando o tipo de identidade. |
SearchIndexerDataUserAssignedIdentity
Especifica a identidade de uma fonte de dados a ser usada.
| Nome | 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 pelo usuário normalmente no formato "/subscriptions/12345678-1234-1234-12334-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId" que deveria ter sido atribuída ao serviço de pesquisa. |
SearchIndexerIndexProjection
Definição de projeções adicionais para índices de pesquisa secundários.
| Nome | Tipo | Description |
|---|---|---|
| parameters |
Um dicionário de propriedades de configuração específicas da projeção de índice. Cada nome é o nome de uma propriedade específica. Cada valor deve ser de um tipo primitivo. |
|
| selectors |
Uma lista de projeções a serem executadas em índices de pesquisa secundários. |
SearchIndexerIndexProjectionSelector
Descrição de quais dados armazenar no índice de pesquisa designado.
| Nome | 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 de chave. |
| sourceContext |
string |
Contexto de origem para as projeções. Representa a cardinalidade na qual o documento será dividido em vários subdocumentos. |
| targetIndexName |
string |
Nome do índice de pesquisa para o qual projetar. Deve ter um campo-chave com o analisador 'palavra-chave' definido. |
SearchIndexerIndexProjectionsParameters
Um dicionário de propriedades de configuração específicas da projeção de índice. Cada nome é o nome de uma propriedade específica. Cada valor deve ser de um tipo primitivo.
| Nome | Tipo | Description |
|---|---|---|
| projectionMode |
Define o comportamento das projeções de índice em relação ao restante do indexador. |
SearchIndexerKnowledgeStore
Definição de projeções adicionais para blob, tabela ou arquivos do Azure de dados enriquecidos.
| Nome | Tipo | Description |
|---|---|---|
| identity | SearchIndexerDataIdentity: |
A identidade gerenciada atribuída pelo usuário usada para conexões ao Armazenamento do Azure ao escrever projeções de knowledge store. Se a cadeia de conexão indicar uma identidade (ResourceId) e ela não for especificada, a identidade gerenciada atribuída pelo sistema é utilizada. Em atualizações para o indexador, se a identidade não for especificada, o valor permanecerá inalterado. Se definido como "nenhum", o valor dessa propriedade será limpo. |
| projections |
Uma lista de projeções adicionais a serem executadas durante a indexação. |
|
| storageConnectionString |
string |
A cadeia de conexão para as projeções da conta de armazenamento será armazenada. |
SearchIndexerKnowledgeStoreFileProjectionSelector
Definição de projeção para quais dados armazenar nos Arquivos do Azure.
| Nome | Tipo | Description |
|---|---|---|
| generatedKeyName |
string |
Nome da chave gerada na qual armazenar a projeção. |
| inputs |
Entradas aninhadas para projeções complexas. |
|
| referenceKeyName |
string |
Nome da chave de referência para projeção diferente. |
| source |
string |
Dados de origem para projeto. |
| sourceContext |
string |
Contexto de origem para projeções complexas. |
| storageContainer |
string |
Contêiner de blob para armazenar projeções. |
SearchIndexerKnowledgeStoreObjectProjectionSelector
Definição de projeção para quais dados armazenar no Blob do Azure.
| Nome | Tipo | Description |
|---|---|---|
| generatedKeyName |
string |
Nome da chave gerada na qual armazenar a projeção. |
| inputs |
Entradas aninhadas para projeções complexas. |
|
| referenceKeyName |
string |
Nome da chave de referência para projeção diferente. |
| source |
string |
Dados de origem para projeto. |
| sourceContext |
string |
Contexto de origem para projeções complexas. |
| storageContainer |
string |
Contêiner de blob para armazenar projeções. |
SearchIndexerKnowledgeStoreProjection
Objeto de contêiner para vários seletores de projeção.
| Nome | Tipo | Description |
|---|---|---|
| files |
Projeções para armazenamento de arquivos do Azure. |
|
| objects |
Projeções para armazenamento Azure Blob. |
|
| tables |
Projeções para armazenamento no Azure Table. |
SearchIndexerKnowledgeStoreTableProjectionSelector
Descrição de quais dados armazenar nas Tabelas do Azure.
| Nome | Tipo | Description |
|---|---|---|
| generatedKeyName |
string |
Nome da chave gerada na qual armazenar a projeção. |
| inputs |
Entradas aninhadas para projeções complexas. |
|
| referenceKeyName |
string |
Nome da chave de referência para projeção diferente. |
| source |
string |
Dados de origem para projeto. |
| sourceContext |
string |
Contexto de origem para projeções complexas. |
| tableName |
string |
Nome da tabela do Azure na qual os dados projetados serão armazenados. |
SearchIndexerSkillset
Uma lista de habilidades.
| Nome | Tipo | Description |
|---|---|---|
| @odata.etag |
string |
A ETag do conjunto de habilidades. |
| cognitiveServices | CognitiveServicesAccount: |
Detalhes sobre o serviço de IA do Azure a serem usados ao executar habilidades. |
| description |
string |
A descrição do conjunto de habilidades. |
| encryptionKey |
Uma descrição de uma chave de criptografia que você cria no Azure Key Vault. Essa chave é usada para fornecer um nível adicional de criptografia em repouso para a definição do seu conjunto de habilidades quando você quer total garantia de que ninguém, nem mesmo a Microsoft, pode descriptografar a definição do seu conjunto de habilidades. Depois de criptografar sua definição de conjunto de habilidades, ela sempre permanecerá criptografada. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como nula. Você pode alterar essa propriedade conforme necessário se quiser girar sua chave de criptografia; Sua definição de conjunto de habilidades não será afetada. A criptografia com chaves gerenciadas pelo cliente não está disponível para serviços de pesquisa gratuitos e só está disponível para serviços pagos criados em 1º de janeiro de 2019 ou depois de 1º de janeiro de 2019. |
|
| indexProjections |
Definição de projeções adicionais para índices de pesquisa secundários. |
|
| knowledgeStore |
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 Azure Key Vault. As chaves que você cria e gerencia podem ser usadas para criptografar ou descriptografar dados em repouso, como índices e mapas de sinônimos.
| Nome | Tipo | Description |
|---|---|---|
| accessCredentials.applicationId |
string |
Uma ID de aplicativo do AAD que recebeu as permissões de acesso necessárias para o Azure Key Vault que deve ser usada ao criptografar seus dados em repouso. A ID do aplicativo não deve ser confundida com a ID do objeto para seu aplicativo do AAD. |
| 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 pelo sistema será usada. Ao atualizar para o 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 chave do Azure Key Vault a ser usada para criptografar seus dados em repouso. |
| keyVaultKeyVersion |
string |
A versão da chave do Azure Key Vault a ser usada para criptografar seus dados em repouso. |
| keyVaultUri |
string |
O URI do Azure Key Vault, também conhecido como nome DNS, que contém a chave a ser usada para criptografar seus dados em repouso. Um URI de exemplo pode ser |
SentimentSkillLanguage
Os códigos de idioma com suporte para texto de entrada por SentimentSkill.
| Valor | Description |
|---|---|
| da |
Dinamarquês |
| nl |
Holandês |
| en |
Inglês |
| fi |
Finlandês |
| fr |
Francês |
| de |
Alemão |
| el |
Grego |
| it |
Italian |
| no |
Norueguês (Bokmaal) |
| pl |
Polonês |
| pt-PT |
Português (Portugal) |
| ru |
Russo |
| es |
Espanhol |
| sv |
Sueco |
| tr |
Turco |
SentimentSkillV3
Usando a API de Análise de Texto, avalia o texto não estruturado e, para cada registro, fornece rótulos de sentimento (como "negativo", "neutro" e "positivo") com base na pontuação de confiança mais alta encontrada pelo serviço em uma frase e no nível do documento.
| Nome | Tipo | Valor padrão | Description |
|---|---|---|---|
| @odata.type |
string:
#Microsoft. |
O discriminador para tipos derivados. |
|
| context |
string |
Representa o nível em que as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document. |
|
| defaultLanguageCode |
Um valor que indica qual código de idioma usar. O padrão é |
||
| description |
string |
A descrição da habilidade que descreve as entradas, as saídas e o uso da habilidade. |
|
| includeOpinionMining |
boolean |
False |
Se definido como true, a saída da habilidade incluirá informações da Análise de Texto para mineração de opinião, ou seja, destinos (substantivos ou verbos) e sua avaliação associada (adjetiva) no texto. O padrão é false. |
| inputs |
As entradas das habilidades podem ser uma coluna no conjunto de dados de origem ou a saída de uma habilidade upstream. |
||
| modelVersion |
string |
A versão do modelo a ser usada ao chamar o serviço de Análise de Texto. Ele usará o padrão para o mais recente disponível quando não for especificado. Recomendamos que você não especifique esse valor, a menos que seja absolutamente necessário. |
|
| name |
string |
O nome da habilidade que a identifica exclusivamente dentro do conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixado com o caractere '#'. |
|
| outputs |
A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como entrada por outra habilidade. |
ShaperSkill
Uma habilidade para remodelar as saídas. Ele cria um tipo complexo para dar suporte a campos compostos (também conhecidos como campos de várias partes).
| Nome | Tipo | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
O discriminador para tipos derivados. |
| context |
string |
Representa o nível em que as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document. |
| description |
string |
A descrição da habilidade que descreve as entradas, as saídas e o uso da habilidade. |
| inputs |
As entradas das habilidades podem ser uma coluna no conjunto de dados de origem ou a saída de uma habilidade upstream. |
|
| name |
string |
O nome da habilidade que a identifica exclusivamente dentro do conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixado com o caractere '#'. |
| outputs |
A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como entrada por outra habilidade. |
SplitSkill
Uma habilidade para dividir uma cadeia de caracteres em partes de texto.
| Nome | Tipo | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
O discriminador para tipos derivados. |
| context |
string |
Representa o nível em que as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document. |
| defaultLanguageCode |
Um valor que indica qual código de idioma usar. O padrão é |
|
| description |
string |
A descrição da habilidade que descreve as entradas, as saídas e o 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 upstream. |
|
| maximumPageLength |
integer (int32) |
O comprimento máximo de página desejado. O padrão é 10000. |
| maximumPagesToTake |
integer (int32) |
Aplicável somente quando textSplitMode é definido como 'pages'. Se especificado, o SplitSkill interromperá a divisão depois de processar as primeiras páginas 'maximumPagesToTake', a fim de melhorar o desempenho quando apenas algumas páginas iniciais forem necessárias de cada documento. |
| name |
string |
O nome da habilidade que a identifica exclusivamente dentro do conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixado com o caractere '#'. |
| outputs |
A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como entrada por outra habilidade. |
|
| pageOverlapLength |
integer (int32) |
Aplicável somente quando textSplitMode é definido como 'pages'. Se especificado, n+1º bloco começará com esse número de caracteres/tokens a partir do final da nth chunk. |
| textSplitMode |
Um valor que indica qual modo de divisão executar. |
SplitSkillLanguage
Os códigos de idioma com suporte para texto de entrada por SplitSkill.
| Valor | Description |
|---|---|
| am |
Amharic |
| bs |
Bosnian |
| cs |
Tcheco |
| da |
Dinamarquês |
| de |
Alemão |
| en |
Inglês |
| es |
Espanhol |
| et |
Estonian |
| fi |
Finlandês |
| fr |
Francês |
| he |
Hebraico |
| hi |
Hindi |
| hr |
Croatian |
| hu |
Húngaro |
| id |
Indonésio |
| is |
Icelandic |
| it |
Italian |
| ja |
Japonês |
| ko |
Coreano |
| lv |
Letão |
| nb |
Norueguês |
| nl |
Holandês |
| pl |
Polonês |
| pt |
Português (Portugal) |
| pt-br |
Português (Brasil) |
| ru |
Russo |
| sk |
Slovak |
| sl |
Esloveno |
| sr |
Sérvio |
| sv |
Sueco |
| tr |
Turco |
| ur |
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.
| Nome | Tipo | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
O discriminador para tipos derivados. |
| context |
string |
Representa o nível em que as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document. |
| defaultFromLanguageCode |
O código de idioma do qual traduzir documentos para documentos que não especificam o idioma explicitamente. |
|
| defaultToLanguageCode |
O código de idioma para traduzir documentos para documentos que não especificam o idioma explicitamente. |
|
| description |
string |
A descrição da habilidade que descreve as entradas, as saídas e o uso da habilidade. |
| inputs |
As entradas das habilidades podem ser uma coluna no conjunto de dados de origem ou a saída de uma habilidade upstream. |
|
| name |
string |
O nome da habilidade que a identifica exclusivamente dentro do conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixado com o caractere '#'. |
| outputs |
A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como entrada por outra habilidade. |
|
| suggestedFrom |
O código de idioma para traduzir documentos de quando nem a entrada fromLanguageCode nem o parâmetro defaultFromLanguageCode são fornecidos e a detecção automática de idioma não é bem-sucedida. O padrão é |
TextTranslationSkillLanguage
Os códigos de idioma com suporte para texto de entrada por TextTranslationSkill.
| Valor | Description |
|---|---|
| af |
Africâner |
| ar |
Árabe |
| bn |
Bengali |
| bs |
Bósnio (Latino) |
| bg |
Búlgaro |
| yue |
Cantonês (Tradicional) |
| ca |
Catalão |
| zh-Hans |
Chinês simplificado |
| zh-Hant |
Chinês tradicional |
| hr |
Croatian |
| cs |
Tcheco |
| da |
Dinamarquês |
| nl |
Holandês |
| en |
Inglês |
| et |
Estonian |
| fj |
Fijiano |
| fil |
Filipino |
| fi |
Finlandês |
| fr |
Francês |
| de |
Alemão |
| el |
Grego |
| ht |
Crioulo Haitiano |
| he |
Hebraico |
| hi |
Hindi |
| mww |
Hmong Daw |
| hu |
Húngaro |
| is |
Icelandic |
| id |
Indonésio |
| it |
Italian |
| ja |
Japonês |
| sw |
Kiswahili |
| tlh |
Klingon |
| tlh-Latn |
Klingon (script latino) |
| tlh-Piqd |
Klingon (script Klingon) |
| ko |
Coreano |
| lv |
Letão |
| lt |
Lituano |
| mg |
Malgaxe |
| ms |
Malay |
| mt |
Maltese |
| nb |
Norueguês |
| fa |
Persa |
| pl |
Polonês |
| pt |
Portuguese |
| pt-br |
Português (Brasil) |
| pt-PT |
Português (Portugal) |
| otq |
Querétaro Otomi |
| ro |
Romanian |
| ru |
Russo |
| sm |
Samoano |
| sr-Cyrl |
Sérvio (cirílico) |
| sr-Latn |
Sérvio (latino) |
| sk |
Slovak |
| sl |
Esloveno |
| es |
Espanhol |
| sv |
Sueco |
| ty |
Taitiano |
| ta |
Tâmil |
| te |
Telugu |
| th |
Tailandês |
| to |
Tonga |
| tr |
Turco |
| uk |
Ucraniano |
| ur |
Urdu |
| vi |
Vietnamita |
| cy |
Galês |
| yua |
Maias yucatecos |
| ga |
Irish |
| kn |
kannada |
| mi |
Maori |
| ml |
Malayalam |
| pa |
Panjabi |
VisualFeature
As cadeias de caracteres que indicam quais tipos de recursos visuais retornar.
| Valor | Description |
|---|---|
| adult |
Recursos visuais reconhecidos como pessoas adultas. |
| brands |
Recursos visuais reconhecidos como marcas comerciais. |
| categories |
Categorias. |
| description |
Descrição. |
| faces |
Recursos visuais reconhecidos como rostos de pessoas. |
| objects |
Recursos visuais reconhecidos como objetos. |
| tags |
Etiquetas. |
WebApiSkill
Uma habilidade que pode chamar um ponto de extremidade de API Web, permitindo que você estenda um conjunto de habilidades fazendo com que ele chame seu código personalizado.
| Nome | 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 pelo sistema será usada. Em atualizações para o indexador, se a identidade não for especificada, o valor permanecerá inalterado. Se definido como "nenhum", o valor dessa propriedade será limpo. |
| authResourceId |
string |
Aplica-se a habilidades personalizadas que se conectam ao código externo em uma função do Azure ou em algum outro aplicativo que fornece as transformações. Esse valor deve ser a ID do aplicativo criada para a função ou aplicativo quando ela foi registrada no Azure Active Directory. Quando especificado, a habilidade personalizada se conecta à função ou aplicativo usando uma ID gerenciada (sistema ou atribuído pelo usuário) do serviço de pesquisa e o token de acesso da função ou aplicativo, usando esse valor como a ID do recurso para criar o escopo do token de acesso. |
| batchSize |
integer (int32) |
O tamanho do lote desejado que indica o número de documentos. |
| context |
string |
Representa o nível em que as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document. |
| degreeOfParallelism |
integer (int32) |
Se definido, o número de chamadas paralelas que podem ser feitas na API Web. |
| description |
string |
A descrição da habilidade que descreve as entradas, as saídas e o uso da habilidade. |
| httpHeaders |
object |
Os cabeçalhos necessários para fazer a solicitação http. |
| httpMethod |
string |
O método para a solicitação http. |
| inputs |
As entradas das habilidades podem ser uma coluna no conjunto de dados de origem ou a saída de uma habilidade upstream. |
|
| name |
string |
O nome da habilidade que a identifica exclusivamente dentro do conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixado com o caractere '#'. |
| outputs |
A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como entrada por outra habilidade. |
|
| timeout |
string (duration) |
O tempo limite desejado para a solicitação. O padrão é 30 segundos. |
| uri |
string |
A URL da API Web. |