Skillsets - Create

Cria um novo conjunto de habilidades em um serviço de pesquisa.

POST {endpoint}/skillsets?api-version=2025-08-01-preview

Parâmetros do URI

Name Em Necessário Tipo Description
endpoint
path True

string

A URL do ponto de extremidade do serviço de pesquisa.

api-version
query True

string

Versão da API do cliente.

Cabeçalho do Pedido

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

string (uuid)

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

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 de IA do Azure a ser usado ao executar habilidades.

description

string

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

encryptionKey

SearchResourceEncryptionKey

Uma descrição de uma chave de criptografia que você cria no Cofre de Chaves do Azure. Essa chave é usada para fornecer um nível adicional de criptografia em repouso para sua definição de conjunto de habilidades quando você quiser garantia total de que ninguém, nem mesmo a Microsoft, pode descriptografar sua definição de conjunto de habilidades. Depois de ter criptografado sua definição de conjunto de habilidades, ela sempre permanecerá criptografada. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como null. Você pode alterar essa propriedade conforme necessário se quiser girar sua chave de criptografia; Sua definição de conjunto de habilidades não será afetada. A criptografia com chaves gerenciadas pelo cliente não está disponível para serviços de pesquisa gratuitos e só está disponível para serviços pagos criados em ou após 1º de janeiro de 2019.

indexProjections

SearchIndexerIndexProjections

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

knowledgeStore

SearchIndexerKnowledgeStore

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

Respostas

Name Tipo Description
201 Created

SearchIndexerSkillset

O conjunto de habilidades é criado com sucesso.

Other Status Codes

ErrorResponse

Resposta de erro.

Exemplos

SearchServiceCreateSkillset

Pedido de amostra

POST https://previewexampleservice.search.windows.net/skillsets?api-version=2025-08-01-preview


{
  "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,
      "unit": "azureOpenAITokens",
      "azureOpenAITokenizerParameters": {
        "encoderModelName": "cl100k_base",
        "allowedSpecialTokens": [
          "[START]",
          "[END]"
        ]
      },
      "@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"
        }
      ]
    },
    {
      "apiKey": "<api-key>",
      "commonModelParameters": {
        "model": "gpt-4o",
        "frequencyPenalty": 0,
        "presencePenalty": 0,
        "maxTokens": 0,
        "temperature": 0,
        "seed": 0,
        "stop": []
      },
      "extraParameters": {
        "safe_mode": true
      },
      "extraParametersBehavior": "error",
      "responseFormat": {
        "type": "jsonSchema",
        "jsonSchemaProperties": {
          "name": "Some Name",
          "description": "Some Description",
          "strict": true,
          "schema": {
            "type": "object",
            "properties": "{\"steps\": {\"type\": \"array\", \"description\": \"A list of reasoning steps.\", \"items\": {\"type\": \"string\"}}, \"answer\": {\"type\": \"string\", \"description\": \"The final answer.\"}}",
            "required": [
              "steps",
              "answer"
            ],
            "additionalProperties": false
          }
        }
      },
      "uri": "https://azs-grok-aoai.openai.azure.com/openai/deployments/azs-grok-gpt-4o/chat/completions",
      "timeout": "PT30S",
      "degreeOfParallelism": 5,
      "@odata.type": "#Microsoft.Skills.Custom.ChatCompletionSkill",
      "name": "chatCompletionSkill",
      "context": "/document/normalized_images/*",
      "inputs": [
        {
          "name": "text",
          "source": "/document/content"
        },
        {
          "name": "systemMessage",
          "source": "/document/system_message"
        },
        {
          "name": "userMessage",
          "source": "/document/user_message"
        },
        {
          "name": "image",
          "source": "/document/normalized_images/*"
        },
        {
          "name": "imageDetail",
          "source": "/document/detail"
        }
      ],
      "outputs": [
        {
          "name": "response",
          "targetName": "response"
        }
      ]
    }
  ],
  "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,
      "unit": "azureOpenAITokens",
      "inputs": [
        {
          "name": "text",
          "source": "/document/content",
          "inputs": []
        },
        {
          "name": "languageCode",
          "source": "/document/languageCode",
          "inputs": []
        }
      ],
      "outputs": [
        {
          "name": "textItems",
          "targetName": "pages"
        }
      ],
      "azureOpenAITokenizerParameters": {
        "encoderModelName": "cl100k_base",
        "allowedSpecialTokens": [
          "[START]",
          "[END]"
        ]
      }
    },
    {
      "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill",
      "name": "skill4",
      "context": "/document/pages/*",
      "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
      }
    },
    {
      "@odata.type": "#Microsoft.Skills.Custom.ChatCompletionSkill",
      "name": "chatCompletionSkill",
      "context": "/document/normalized_images/*",
      "uri": "https://azs-grok-aoai.openai.azure.com/openai/deployments/azs-grok-gpt-4o/chat/completions",
      "timeout": "PT30S",
      "degreeOfParallelism": 5,
      "apiKey": "<api-key>",
      "extraParametersBehavior": "error",
      "inputs": [
        {
          "name": "text",
          "source": "/document/content",
          "inputs": []
        },
        {
          "name": "systemMessage",
          "source": "/document/system_message",
          "inputs": []
        },
        {
          "name": "userMessage",
          "source": "/document/user_message",
          "inputs": []
        },
        {
          "name": "image",
          "source": "/document/normalized_images/*",
          "inputs": []
        },
        {
          "name": "imageDetail",
          "source": "/document/detail",
          "inputs": []
        }
      ],
      "outputs": [
        {
          "name": "response",
          "targetName": "response"
        }
      ],
      "commonModelParameters": {
        "model": "gpt-4o",
        "frequencyPenalty": 0,
        "presencePenalty": 0,
        "maxTokens": 0,
        "temperature": 0,
        "seed": 0,
        "stop": []
      },
      "extraParameters": {
        "safe_mode": true
      },
      "responseFormat": {
        "type": "jsonSchema",
        "jsonSchemaProperties": {
          "name": "Some Name",
          "description": "Some Description",
          "strict": true,
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "steps",
              "answer"
            ],
            "properties": "{\"steps\": {\"type\": \"array\", \"description\": \"A list of reasoning steps.\", \"items\": {\"type\": \"string\"}}, \"answer\": {\"type\": \"string\", \"description\": \"The final answer.\"}}"
          }
        }
      }
    }
  ],
  "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
AIServicesAccountIdentity

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

AIServicesAccountKey

A chave de conta de um recurso de serviço de IA do Azure anexado a um conjunto de habilidades, a ser usado com o subdomínio do recurso.

AmlSkill

A habilidade AML permite estender o enriquecimento da IA com um modelo personalizado do Azure Machine Learning (AML). Uma vez que um modelo de AML é treinado e implantado, uma habilidade de AML o integra no enriquecimento de IA.

AzureActiveDirectoryApplicationCredentials

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

AzureOpenAIEmbeddingSkill

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

AzureOpenAIModelName

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

AzureOpenAITokenizerParameters
ChatCompletionCommonModelParameters

Parâmetros de modelo de linguagem comum para Conclusão de Chat. Se omitidos, os valores padrão são usados.

ChatCompletionExtraParametersBehavior

Especifica como 'extraParameters' deve ser tratado pelo Azure AI Foundry. O padrão é 'error'.

ChatCompletionResponseFormat

Determina como a resposta do modelo de linguagem deve ser serializada. O padrão é 'texto'.

ChatCompletionResponseFormatType

Especifica como o LLM deve formatar a resposta. Valores possíveis: 'text' (cadeia simples), 'json_object' (JSON arbitrário) ou 'json_schema' (adere ao esquema fornecido).

ChatCompletionSchema

Objeto que define o esquema personalizado que o modelo usará para estruturar sua saída.

ChatCompletionSkill

Uma habilidade que chama um modelo de linguagem por meio do ponto de extremidade Conclusão de Chat do Azure AI Foundry.

CognitiveServicesAccountKey

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

ConditionalSkill

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

CustomEntity

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

CustomEntityAlias

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

CustomEntityLookupSkill

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

CustomEntityLookupSkillLanguage

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

DefaultCognitiveServicesAccount

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

DocumentExtractionSkill

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

DocumentIntelligenceLayoutSkill

Uma habilidade que extrai conteúdo e informações de layout, por meio dos Serviços de IA do Azure, de arquivos dentro do pipeline de enriquecimento.

DocumentIntelligenceLayoutSkillChunkingProperties

Controla a cardinalidade para fragmentar o conteúdo.

DocumentIntelligenceLayoutSkillChunkingUnit

Controla a cardinalidade da unidade de bloco. O padrão é 'caracteres'

DocumentIntelligenceLayoutSkillExtractionOptions

Controla a cardinalidade do conteúdo extraído do documento pela habilidade.

DocumentIntelligenceLayoutSkillMarkdownHeaderDepth

A profundidade dos cabeçalhos na saída de markdown. O padrão é h6.

DocumentIntelligenceLayoutSkillOutputFormat

Controla a cardinalidade do formato de saída. O padrão é 'markdown'.

DocumentIntelligenceLayoutSkillOutputMode

Controla a cardinalidade da saída produzida pela habilidade. O padrão é 'oneToMany'.

EntityCategory

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

EntityLinkingSkill

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

EntityRecognitionSkill

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

EntityRecognitionSkillLanguage

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

EntityRecognitionSkillV3

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

ErrorAdditionalInfo

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

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta de erro

ImageAnalysisSkill

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

ImageAnalysisSkillLanguage

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

ImageDetail

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

IndexProjectionMode

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

InputFieldMappingEntry

Mapeamento de campo de entrada para uma habilidade.

JsonSchemaProperties

Um dicionário aberto para propriedades estendidas. Obrigatório se 'tipo' == 'json_schema'

KeyPhraseExtractionSkill

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

KeyPhraseExtractionSkillLanguage

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

LanguageDetectionSkill

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

LineEnding

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

MergeSkill

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

OcrSkill

Uma habilidade que extrai texto de arquivos de imagem.

OcrSkillLanguage

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

OutputFieldMappingEntry

Mapeamento de campo de saída para uma habilidade.

PIIDetectionSkill

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

PIIDetectionSkillMaskingMode

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

SearchIndexerDataNoneIdentity

Limpa a propriedade identity de uma fonte de dados.

SearchIndexerDataUserAssignedIdentity

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

SearchIndexerIndexProjections

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

SearchIndexerIndexProjectionSelector

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

SearchIndexerIndexProjectionsParameters

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

SearchIndexerKnowledgeStore

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

SearchIndexerKnowledgeStoreFileProjectionSelector

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

SearchIndexerKnowledgeStoreObjectProjectionSelector

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

SearchIndexerKnowledgeStoreParameters

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

SearchIndexerKnowledgeStoreProjection

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

SearchIndexerKnowledgeStoreTableProjectionSelector

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

SearchIndexerSkillset

Uma lista de competências.

SearchResourceEncryptionKey

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

SentimentSkill

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

SentimentSkillLanguage

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

SentimentSkillV3

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

ShaperSkill

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

SplitSkill

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

SplitSkillEncoderModelName

Só se aplica se a unidade estiver definida como azureOpenAITokens. As opções incluem 'R50k_base', 'P50k_base', 'P50k_edit' e 'CL100k_base'. O valor padrão é 'CL100k_base'.

SplitSkillLanguage

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

SplitSkillUnit

Um valor que indica qual unidade usar.

TextSplitMode

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

TextTranslationSkill

Uma habilidade para traduzir texto de um idioma para outro.

TextTranslationSkillLanguage

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

VisionVectorizeSkill

Permite gerar uma incorporação vetorial para uma determinada entrada de imagem ou texto usando a API de Vetorização de Visão dos Serviços de IA do Azure.

VisualFeature

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

WebApiSkill

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

AIServicesAccountIdentity

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

Name Tipo Description
@odata.type string:

#Microsoft.Azure.Search.AIServicesByIdentity

Um fragmento de URI especificando o tipo de recurso de serviço de IA do Azure anexado a um conjunto de habilidades.

description

string

Descrição do recurso de serviço de IA do Azure anexado a um conjunto de habilidades.

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

A url do subdomínio para o serviço de IA correspondente.

AIServicesAccountKey

A chave de conta de um recurso de serviço de IA do Azure anexado a um conjunto de habilidades, a ser usado com o subdomínio do recurso.

Name Tipo Description
@odata.type string:

#Microsoft.Azure.Search.AIServicesByKey

Um fragmento de URI especificando o tipo de recurso de serviço de IA do Azure anexado a um conjunto de habilidades.

description

string

Descrição do recurso de serviço de IA do Azure anexado a um conjunto de habilidades.

key

string

A chave usada para provisionar o recurso de serviço de IA do Azure anexado a um conjunto de habilidades.

subdomainUrl

string

A url do subdomínio para o serviço de IA correspondente.

AmlSkill

A habilidade AML permite estender o enriquecimento da IA com um modelo personalizado do Azure Machine Learning (AML). Uma vez que um modelo de AML é treinado e implantado, uma habilidade de AML o integra no enriquecimento de IA.

Name Tipo Description
@odata.type string:

#Microsoft.Skills.Custom.AmlSkill

Um fragmento de URI especificando o tipo de habilidade.

context

string

Representa o nível no qual as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document.

degreeOfParallelism

integer (int32)

(Opcional) Quando especificado, indica o número de chamadas que o indexador fará em paralelo ao ponto de extremidade fornecido. Você pode diminuir esse valor se o ponto de extremidade estiver falhando sob uma carga de solicitação muito alta ou aumentá-lo se o ponto de extremidade for capaz de aceitar mais solicitações e você quiser um aumento no desempenho do indexador. Se não estiver definido, um valor padrão de 5 será usado. O grau de paralelismo pode ser definido para um máximo de 10 e um mínimo de 1.

description

string

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

inputs

InputFieldMappingEntry[]

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

key

string

(Necessário para autenticação de chave) A chave para o serviço AML.

name

string

O nome da habilidade que a identifica exclusivamente dentro do conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixada com o caractere '#'.

outputs

OutputFieldMappingEntry[]

A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como uma entrada por outra habilidade.

region

string

(Opcional para autenticação de token). A região em que o serviço AML está implantado.

resourceId

string

(Necessário para autenticação de token). A ID de recurso do Azure Resource Manager do serviço AML. Deve estar no formato subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.MachineLearningServices/workspaces/{workspace-name}/services/{service_name}.

timeout

string (duration)

(Opcional) Quando especificado, indica o tempo limite para o cliente http que faz a chamada de API.

uri

string (uri)

(Necessário para nenhuma autenticação ou autenticação de chave) O URI de pontuação do serviço AML para o qual a carga JSON será enviada. Somente o esquema de URI https é permitido.

AzureActiveDirectoryApplicationCredentials

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

Name Tipo Description
applicationId

string

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

applicationSecret

string

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

AzureOpenAIEmbeddingSkill

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

Name Tipo Description
@odata.type string:

#Microsoft.Skills.Text.AzureOpenAIEmbeddingSkill

Um fragmento de URI especificando o tipo de habilidade.

apiKey

string

Chave de API do recurso OpenAI do Azure designado.

authIdentity SearchIndexerDataIdentity:

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

context

string

Representa o nível no qual as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document.

deploymentId

string

ID da implantação do modelo OpenAI do Azure no recurso designado.

description

string

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

dimensions

integer (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

InputFieldMappingEntry[]

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

modelName

AzureOpenAIModelName

O nome do modelo de incorporação implantado no caminho deploymentId fornecido.

name

string

O nome da habilidade que a identifica exclusivamente dentro do conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixada com o caractere '#'.

outputs

OutputFieldMappingEntry[]

A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como uma entrada por outra habilidade.

resourceUri

string (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
text-embedding-3-large
text-embedding-3-small
gpt-4o
gpt-4o-mini
gpt-4.1
gpt-4.1-mini
gpt-4.1-nano

AzureOpenAITokenizerParameters

Name Tipo Description
allowedSpecialTokens

string[]

(Opcional) Só se aplica se a unidade estiver definida como azureOpenAITokens. Este parâmetro define uma coleção de tokens especiais que são permitidos dentro do processo de tokenização.

encoderModelName

SplitSkillEncoderModelName

Só se aplica se a unidade estiver definida como azureOpenAITokens. As opções incluem 'R50k_base', 'P50k_base', 'P50k_edit' e 'CL100k_base'. O valor padrão é 'CL100k_base'.

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

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

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

0.7

Temperatura de amostragem. O padrão é 0,7.

ChatCompletionExtraParametersBehavior

Especifica como 'extraParameters' deve ser tratado pelo Azure AI Foundry. O padrão é 'error'.

Valor Description
pass-through
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

JsonSchemaProperties

Um dicionário aberto para propriedades estendidas. Obrigatório se 'tipo' == 'json_schema'

type

ChatCompletionResponseFormatType

text

Especifica como o LLM deve formatar a resposta. Valores possíveis: 'text' (cadeia simples), 'json_object' (JSON arbitrário) ou 'json_schema' (adere ao esquema fornecido).

ChatCompletionResponseFormatType

Especifica como o LLM deve formatar a resposta. Valores possíveis: 'text' (cadeia simples), 'json_object' (JSON arbitrário) ou 'json_schema' (adere ao esquema fornecido).

Valor Description
text
jsonObject
jsonSchema

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 padrão é 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'.

ChatCompletionSkill

Uma habilidade que chama um modelo de linguagem por meio do ponto de extremidade Conclusão de Chat do Azure AI Foundry.

Name Tipo Default value Description
@odata.type string:

#Microsoft.Skills.Custom.ChatCompletionSkill

Um fragmento de URI especificando o tipo de habilidade.

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.

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.

commonModelParameters

ChatCompletionCommonModelParameters

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.

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.

extraParameters

object

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

ChatCompletionExtraParametersBehavior

error

Como os parâmetros extras são manipulados pelo Azure AI Foundry. O padrão é 'erro'.

httpHeaders

object

Os cabeçalhos necessários para fazer a solicitação http.

httpMethod

string

O método para a solicitação http.

inputs

InputFieldMappingEntry[]

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

name

string

O nome da habilidade que a identifica exclusivamente dentro do conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixada com o caractere '#'.

outputs

OutputFieldMappingEntry[]

A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como uma entrada por outra habilidade.

responseFormat

ChatCompletionResponseFormat

Determina como o LLM deve formatar sua resposta. O padrão é o tipo de resposta 'texto'.

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.

CognitiveServicesAccountKey

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

Name Tipo Description
@odata.type string:

#Microsoft.Azure.Search.CognitiveServicesByKey

Um fragmento de URI especificando o tipo de recurso de serviço de IA do Azure anexado a um conjunto de habilidades.

description

string

Descrição do recurso de serviço de IA do Azure anexado a um conjunto de habilidades.

key

string

A chave usada para provisionar o recurso de serviço de IA do Azure anexado a um conjunto de habilidades.

ConditionalSkill

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

Name Tipo Description
@odata.type string:

#Microsoft.Skills.Util.ConditionalSkill

Um fragmento de URI especificando o tipo de habilidade.

context

string

Representa o nível no qual as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document.

description

string

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

inputs

InputFieldMappingEntry[]

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

name

string

O nome da habilidade que a identifica exclusivamente dentro do conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixada com o caractere '#'.

outputs

OutputFieldMappingEntry[]

A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como uma entrada por outra habilidade.

CustomEntity

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

Name Tipo Description
accentSensitive

boolean

É 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

CustomEntityAlias[]

Uma matriz de objetos complexos que podem ser usados para especificar grafias alternativas ou sinônimos para o nome da entidade raiz.

caseSensitive

boolean

É 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 que não diferenciam maiúsculas de minúsculas de "Microsoft" podem ser: microsoft, microSoft, MICROSOFT.

defaultAccentSensitive

boolean

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

defaultCaseSensitive

boolean

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

defaultFuzzyEditDistance

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

id

string

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

name

string

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

subtype

string

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

type

string

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

CustomEntityAlias

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

Name Tipo Description
accentSensitive

boolean

Determine se o alias é sensível ao acento.

caseSensitive

boolean

Determine se o alias diferencia maiúsculas de minúsculas.

fuzzyEditDistance

integer (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.Skills.Text.CustomEntityLookupSkill

Um fragmento de URI especificando o tipo de habilidade.

context

string

Representa o nível no qual as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document.

defaultLanguageCode

CustomEntityLookupSkillLanguage

Um valor que indica qual código de idioma usar. A predefinição é en.

description

string

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

entitiesDefinitionUri

string

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

globalDefaultAccentSensitive

boolean

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

globalDefaultCaseSensitive

boolean

Um sinalizador global para CaseSensitive. Se CaseSensitive não estiver definido em CustomEntity, esse valor será o valor padrão.

globalDefaultFuzzyEditDistance

integer (int32)

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

inlineEntitiesDefinition

CustomEntity[]

A definição CustomEntity embutida.

inputs

InputFieldMappingEntry[]

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

name

string

O nome da habilidade que a identifica exclusivamente dentro do conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixada com o caractere '#'.

outputs

OutputFieldMappingEntry[]

A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como uma entrada por outra habilidade.

CustomEntityLookupSkillLanguage

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

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.Azure.Search.DefaultCognitiveServices

Um fragmento de URI especificando o tipo de recurso de serviço de IA do Azure anexado a um conjunto de habilidades.

description

string

Descrição do recurso de serviço de IA do Azure anexado a um conjunto de habilidades.

DocumentExtractionSkill

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

Name Tipo Description
@odata.type string:

#Microsoft.Skills.Util.DocumentExtractionSkill

Um fragmento de URI especificando o tipo de habilidade.

configuration

object

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

context

string

Representa o nível no qual as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document.

dataToExtract

string

O tipo de dados a serem extraídos para a habilidade. Será definido como 'contentAndMetadata' se não estiver definido.

description

string

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

inputs

InputFieldMappingEntry[]

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

name

string

O nome da habilidade que a identifica exclusivamente dentro do conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixada com o caractere '#'.

outputs

OutputFieldMappingEntry[]

A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como uma entrada por outra habilidade.

parsingMode

string

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

DocumentIntelligenceLayoutSkill

Uma habilidade que extrai conteúdo e informações de layout, por meio dos Serviços de IA do Azure, de arquivos dentro do pipeline de enriquecimento.

Name Tipo Default value Description
@odata.type string:

#Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill

Um fragmento de URI especificando o tipo de habilidade.

chunkingProperties

DocumentIntelligenceLayoutSkillChunkingProperties

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

DocumentIntelligenceLayoutSkillExtractionOptions[]

Controla a cardinalidade do conteúdo extraído do documento pela habilidade

inputs

InputFieldMappingEntry[]

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

markdownHeaderDepth

DocumentIntelligenceLayoutSkillMarkdownHeaderDepth

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

DocumentIntelligenceLayoutSkillOutputFormat

markdown

Controla a cardinalidade do formato de saída. O padrão é 'markdown'.

outputMode

DocumentIntelligenceLayoutSkillOutputMode

oneToMany

Controla a cardinalidade da saída produzida pela habilidade. O padrão é 'oneToMany'.

outputs

OutputFieldMappingEntry[]

A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como uma entrada por outra habilidade.

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

DocumentIntelligenceLayoutSkillChunkingUnit

characters

A unidade do pedaço.

DocumentIntelligenceLayoutSkillChunkingUnit

Controla a cardinalidade da unidade de bloco. O padrão é 'caracteres'

Valor Description
characters

Especifica bloco por caracteres.

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.

DocumentIntelligenceLayoutSkillMarkdownHeaderDepth

A profundidade dos cabeçalhos na saída de markdown. O padrão é h6.

Valor Description
h1

Nível de cabeçalho 1.

h2

Nível de cabeçalho 2.

h3

Nível de cabeçalho 3.

h4

Nível de cabeçalho 4.

h5

Nível de cabeçalho 5.

h6

Nível de cabeçalho 6.

DocumentIntelligenceLayoutSkillOutputFormat

Controla a cardinalidade do formato de saída. O padrão é 'markdown'.

Valor Description
text

Especifique o formato da saída como texto.

markdown

Especifique o formato da saída como markdown.

DocumentIntelligenceLayoutSkillOutputMode

Controla a cardinalidade da saída produzida pela habilidade. O padrão é 'oneToMany'.

Valor Description
oneToMany

Especifique que a saída deve ser analisada como 'oneToMany'.

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.

email

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.Skills.Text.V3.EntityLinkingSkill

Um fragmento de URI especificando o tipo de habilidade.

context

string

Representa o nível no qual as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document.

defaultLanguageCode

string

Um valor que indica qual código de idioma usar. A predefinição é en.

description

string

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

inputs

InputFieldMappingEntry[]

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

minimumPrecision

number (double)

minimum: 0
maximum: 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

OutputFieldMappingEntry[]

A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como uma entrada por outra habilidade.

EntityRecognitionSkill

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

Name Tipo Description
@odata.type string:

#Microsoft.Skills.Text.EntityRecognitionSkill

Um fragmento de URI especificando o tipo de habilidade.

categories

EntityCategory[]

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

context

string

Representa o nível no qual as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document.

defaultLanguageCode

EntityRecognitionSkillLanguage

Um valor que indica qual código de idioma usar. A predefinição é en.

description

string

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

includeTypelessEntities

boolean

Determina se devem ou não incluir entidades que são bem conhecidas, mas não estão em conformidade com um tipo predefinido. Se essa configuração não estiver definida (padrão), definida como nula ou definida como falsa, as entidades que não estiverem em conformidade com um dos tipos predefinidos não serão exibidas.

inputs

InputFieldMappingEntry[]

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

minimumPrecision

number (double)

Um valor entre 0 e 1 que deve ser usado para incluir apenas entidades cuja pontuação de confiança é maior do que o valor especificado. Se não estiver definido (padrão), ou se explicitamente definido como nulo, todas as entidades serão incluídas.

name

string

O nome da habilidade que a identifica exclusivamente dentro do conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixada com o caractere '#'.

outputs

OutputFieldMappingEntry[]

A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como uma entrada por outra habilidade.

EntityRecognitionSkillLanguage

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

Valor Description
ar

Árabe

cs

Checo

zh-Hans

Chinese-Simplified

zh-Hant

Chinese-Traditional

da

Dinamarquês

nl

Holandê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.Skills.Text.V3.EntityRecognitionSkill

Um fragmento de URI especificando o tipo de habilidade.

categories

string[]

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

context

string

Representa o nível no qual as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document.

defaultLanguageCode

string

Um valor que indica qual código de idioma usar. A predefinição é en.

description

string

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

inputs

InputFieldMappingEntry[]

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

minimumPrecision

number (double)

minimum: 0
maximum: 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

OutputFieldMappingEntry[]

A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como uma entrada por outra habilidade.

ErrorAdditionalInfo

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

Name Tipo Description
info

object

As informações adicionais.

type

string

O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Name Tipo Description
additionalInfo

ErrorAdditionalInfo[]

O erro informações adicionais.

code

string

O código de erro.

details

ErrorDetail[]

Os detalhes do erro.

message

string

A mensagem de erro.

target

string

O destino do erro.

ErrorResponse

Resposta de erro

Name Tipo Description
error

ErrorDetail

O objeto de erro.

ImageAnalysisSkill

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

Name Tipo Description
@odata.type string:

#Microsoft.Skills.Vision.ImageAnalysisSkill

Um fragmento de URI especificando o tipo de habilidade.

context

string

Representa o nível no qual as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document.

defaultLanguageCode

ImageAnalysisSkillLanguage

Um valor que indica qual código de idioma usar. A predefinição é en.

description

string

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

details

ImageDetail[]

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

inputs

InputFieldMappingEntry[]

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

name

string

O nome da habilidade que a identifica exclusivamente dentro do conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixada com o caractere '#'.

outputs

OutputFieldMappingEntry[]

A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como uma entrada por outra habilidade.

visualFeatures

VisualFeature[]

Uma lista de recursos visuais.

ImageAnalysisSkillLanguage

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

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

Holandês

pl

Polaco

prs

Dári

pt-BR

Portuguese-Brazil

pt

Portuguese-Portugal

pt-PT

Portuguese-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

Chineses (Simplificado)

zh-Hans

Chineses (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

InputFieldMappingEntry[]

As entradas recursivas usadas ao criar um tipo complexo.

name

string

O nome da entrada.

source

string

A fonte da entrada.

sourceContext

string

O contexto de origem usado para selecionar entradas recursivas.

JsonSchemaProperties

Um dicionário aberto para propriedades estendidas. Obrigatório se 'tipo' == 'json_schema'

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 aderirá

schema

ChatCompletionSchema

Objeto que define o esquema personalizado que o modelo usará para estruturar sua saída.

strict

boolean

True

Se a resposta do modelo deve ou não usar saídas estruturadas. O padrão é true

KeyPhraseExtractionSkill

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

Name Tipo Description
@odata.type string:

#Microsoft.Skills.Text.KeyPhraseExtractionSkill

Um fragmento de URI especificando o tipo de habilidade.

context

string

Representa o nível no qual as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document.

defaultLanguageCode

KeyPhraseExtractionSkillLanguage

Um valor que indica qual código de idioma usar. A predefinição é en.

description

string

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

inputs

InputFieldMappingEntry[]

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

maxKeyPhraseCount

integer (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

OutputFieldMappingEntry[]

A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como uma entrada por outra habilidade.

KeyPhraseExtractionSkillLanguage

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

Valor Description
da

Dinamarquês

nl

Holandê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.Skills.Text.LanguageDetectionSkill

Um fragmento de URI especificando o tipo de habilidade.

context

string

Representa o nível no qual as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document.

defaultCountryHint

string

Um código de país para usar como uma dica para o modelo de deteção de idioma se ele não puder desambiguar o idioma.

description

string

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

inputs

InputFieldMappingEntry[]

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

modelVersion

string

A versão do modelo a ser usada ao chamar o serviço de Análise de Texto. O padrão será o mais recente disponível quando não especificado. Recomendamos que você não especifique esse valor, a menos que seja absolutamente necessário.

name

string

O nome da habilidade que a identifica exclusivamente dentro do conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixada com o caractere '#'.

outputs

OutputFieldMappingEntry[]

A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como uma entrada por outra habilidade.

LineEnding

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

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').

MergeSkill

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

Name Tipo Default value Description
@odata.type string:

#Microsoft.Skills.Text.MergeSkill

Um fragmento de URI especificando o tipo de habilidade.

context

string

Representa o nível no qual as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document.

description

string

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

inputs

InputFieldMappingEntry[]

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

insertPostTag

string

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

insertPreTag

string

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

name

string

O nome da habilidade que a identifica exclusivamente dentro do conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixada com o caractere '#'.

outputs

OutputFieldMappingEntry[]

A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como uma entrada por outra habilidade.

OcrSkill

Uma habilidade que extrai texto de arquivos de imagem.

Name Tipo Default value Description
@odata.type string:

#Microsoft.Skills.Vision.OcrSkill

Um fragmento de URI especificando o tipo de habilidade.

context

string

Representa o nível no qual as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document.

defaultLanguageCode

OcrSkillLanguage

Um valor que indica qual código de idioma usar. A predefinição é en.

description

string

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

detectOrientation

boolean

False

Um valor que indica para ativar ou não a deteção de orientação. O valor padrão é falso.

inputs

InputFieldMappingEntry[]

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

lineEnding

LineEnding

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

name

string

O nome da habilidade que a identifica exclusivamente dentro do conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixada com o caractere '#'.

outputs

OutputFieldMappingEntry[]

A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como uma entrada por outra habilidade.

OcrSkillLanguage

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

Valor Description
af

Afrikaans

sq

Albanês

anp

Angika (Devanagiri)

ar

Árabe

ast

Asturiano

awa

Awadhi-Hindi (Devanagiri)

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 (Devanagiri)

bi

Bislama

brx

Bodo (Devanagiri)

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

Chineses (Simplificado)

zh-Hant

Chinês (Tradicional)

kw

Cornualha

co

Córsega

crh

Tártaro da Crimeia (latim)

hr

Croata

cs

Checo

da

Dinamarquês

prs

Dári

dhi

Dhimal (Devanagiri)

doi

Dogri (Devanagiri)

nl

Holandês

en

Inglês

myv

Erzya (cirílico)

et

Estónio

fo

Faroense

fj

Fijiano

fil

Filipino

fi

Finlandês

fr

Francês

fur

Fruliano

gag

Gagauz (latim)

gl

Galego

de

Alemão

gil

Gilbertese

gon

Gondi (Devanagiri)

el

Grego

kl

Gronelândia

gvr

Gurung (Devanagiri)

ht

Crioulo haitiano

hlb

Halbi (Devanagiri)

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 (Latino)

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 (Devanagiri)

ky

Quirguistão (cirílico)

lkt

Lakota

la

Latim

lt

Lituano

dsb

Baixo Sorbian

smj

Lule Sami

lb

Luxemburguês

bfz

Mahasu Pahari (Devanagiri)

ms

Malaio (Latim)

mt

Maltês

kmj

Malto (Devanagiri)

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

Niuean

nog

Nogay

sme

Sami do Norte (Latim)

nb

Norueguês

no

Norueguês

oc

Occitano

os

Ossético

ps

Pashto

fa

Persa

pl

Polaco

pt

Português

pa

Punjabi (árabe)

ksh

Ripuariano

ro

Romeno

rm

Romanche

ru

Russo

sck

Sadri (Devanagiri)

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 (Devanagiri)

srx

Sirmauri (Devanagiri)

sms

Skolt Sami

sk

Eslovaco

sl

Esloveno

so

Somali (árabe)

sma

Sami Meridional

es

Espanhol

sw

Swahili (latim)

sv

Sueco

tg

Tajique (cirílico)

tt

Tártaro (Latim)

tet

Tétum

thf

Thangmi

to

Tonga

tr

Turco (língua)

tk

Turquemeno (latim)

tyv

Tuvan

hsb

Alto Sorábio

ur

Língua Urdu

ug

Uigur (árabe)

uz-arab

Uzbeque (árabe)

uz-cyrl

Usbeque (Cirílico)

uz

Uzbeque (Latim)

vo

Volapük

wae

Walser

cy

Galês

fy

Frísio Ocidental

yua

Iucatego

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.Skills.Text.PIIDetectionSkill

Um fragmento de URI especificando o tipo de habilidade.

context

string

Representa o nível no qual as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document.

defaultLanguageCode

string

Um valor que indica qual código de idioma usar. A predefinição é en.

description

string

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

domain

string

Se especificado, definirá o domínio PII para incluir apenas um subconjunto das categorias de entidade. Os valores possíveis incluem: 'phi', 'none'. O padrão é 'nenhum'.

inputs

InputFieldMappingEntry[]

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

maskingCharacter

string

maxLength: 1

O caractere usado para mascarar o texto se o parâmetro maskingMode estiver definido para substituir. O padrão é '*'.

maskingMode

PIIDetectionSkillMaskingMode

Um parâmetro que fornece várias maneiras de mascarar as informações pessoais detetadas no texto de entrada. O padrão é 'nenhum'.

minimumPrecision

number (double)

minimum: 0
maximum: 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

OutputFieldMappingEntry[]

A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como uma entrada por outra habilidade.

piiCategories

string[]

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

PIIDetectionSkillMaskingMode

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

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.Azure.Search.DataNoneIdentity

Um fragmento de URI especificando o tipo de identidade.

SearchIndexerDataUserAssignedIdentity

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

Name Tipo Description
@odata.type string:

#Microsoft.Azure.Search.DataUserAssignedIdentity

Um fragmento de URI especificando o tipo de identidade.

userAssignedIdentity

string

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

SearchIndexerIndexProjections

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

Name Tipo Description
parameters

SearchIndexerIndexProjectionsParameters

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

selectors

SearchIndexerIndexProjectionSelector[]

Uma lista de projeções a serem realizadas para índices de pesquisa secundários.

SearchIndexerIndexProjectionSelector

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

Name Tipo Description
mappings

InputFieldMappingEntry[]

Mapeamentos para a projeção, ou qual fonte deve ser mapeada para qual campo no índice de destino.

parentKeyFieldName

string

Nome do campo no índice de pesquisa para o qual mapear o valor da chave do documento pai. Deve ser um campo de cadeia de caracteres filtrável e não o campo chave.

sourceContext

string

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

targetIndexName

string

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

SearchIndexerIndexProjectionsParameters

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

Name Tipo Description
projectionMode

IndexProjectionMode

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

SearchIndexerKnowledgeStore

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

Name Tipo Description
identity SearchIndexerDataIdentity:

A identidade gerenciada atribuída pelo usuário usada para conexões com o Armazenamento do Azure ao escrever projeções de armazenamento de conhecimento. Se a cadeia de conexão indicar uma identidade (ResourceId) e não for especificada, 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.

parameters

SearchIndexerKnowledgeStoreParameters

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

projections

SearchIndexerKnowledgeStoreProjection[]

Uma lista de projeções adicionais a serem executadas durante a indexação.

storageConnectionString

string

A cadeia de conexão para as projeções da conta de armazenamento será armazenada em.

SearchIndexerKnowledgeStoreFileProjectionSelector

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

Name Tipo Description
generatedKeyName

string

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

inputs

InputFieldMappingEntry[]

Entradas aninhadas para projeções complexas.

referenceKeyName

string

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

source

string

Fonte dos dados para o projeto.

sourceContext

string

Contexto de origem para projeções complexas.

storageContainer

string

Recipiente de blob para armazenar projeções.

SearchIndexerKnowledgeStoreObjectProjectionSelector

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

Name Tipo Description
generatedKeyName

string

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

inputs

InputFieldMappingEntry[]

Entradas aninhadas para projeções complexas.

referenceKeyName

string

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

source

string

Fonte dos dados para o projeto.

sourceContext

string

Contexto de origem para projeções complexas.

storageContainer

string

Recipiente de blob para armazenar projeções.

SearchIndexerKnowledgeStoreParameters

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

Name Tipo Default value Description
synthesizeGeneratedKeyName

boolean

False

Se as projeções devem ou não sintetizar um nome de chave gerado, caso ainda não esteja presente.

SearchIndexerKnowledgeStoreProjection

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

Name Tipo Description
files

SearchIndexerKnowledgeStoreFileProjectionSelector[]

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

objects

SearchIndexerKnowledgeStoreObjectProjectionSelector[]

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

tables

SearchIndexerKnowledgeStoreTableProjectionSelector[]

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

SearchIndexerKnowledgeStoreTableProjectionSelector

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

Name Tipo Description
generatedKeyName

string

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

inputs

InputFieldMappingEntry[]

Entradas aninhadas para projeções complexas.

referenceKeyName

string

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

source

string

Fonte dos dados para o projeto.

sourceContext

string

Contexto de origem para projeções complexas.

tableName

string

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

SearchIndexerSkillset

Uma lista de competências.

Name Tipo Description
@odata.etag

string

O ETag do conjunto de competências.

cognitiveServices CognitiveServicesAccount:

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

description

string

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

encryptionKey

SearchResourceEncryptionKey

Uma descrição de uma chave de criptografia que você cria no Cofre de Chaves do Azure. Essa chave é usada para fornecer um nível adicional de criptografia em repouso para sua definição de conjunto de habilidades quando você quiser garantia total de que ninguém, nem mesmo a Microsoft, pode descriptografar sua definição de conjunto de habilidades. Depois de ter criptografado sua definição de conjunto de habilidades, ela sempre permanecerá criptografada. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como null. Você pode alterar essa propriedade conforme necessário se quiser girar sua chave de criptografia; Sua definição de conjunto de habilidades não será afetada. A criptografia com chaves gerenciadas pelo cliente não está disponível para serviços de pesquisa gratuitos e só está disponível para serviços pagos criados em ou após 1º de janeiro de 2019.

indexProjections

SearchIndexerIndexProjections

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

knowledgeStore

SearchIndexerKnowledgeStore

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

name

string

O nome do conjunto de habilidades.

skills SearchIndexerSkill[]:

Uma lista de habilidades no conjunto de habilidades.

SearchResourceEncryptionKey

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

Name Tipo Description
accessCredentials

AzureActiveDirectoryApplicationCredentials

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

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 https://my-keyvault-name.vault.azure.net.

SentimentSkill

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

Name Tipo Description
@odata.type string:

#Microsoft.Skills.Text.SentimentSkill

Um fragmento de URI especificando o tipo de habilidade.

context

string

Representa o nível no qual as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document.

defaultLanguageCode

SentimentSkillLanguage

Um valor que indica qual código de idioma usar. A predefinição é en.

description

string

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

inputs

InputFieldMappingEntry[]

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

name

string

O nome da habilidade que a identifica exclusivamente dentro do conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixada com o caractere '#'.

outputs

OutputFieldMappingEntry[]

A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como uma entrada por outra habilidade.

SentimentSkillLanguage

Deprecated. Os códigos de idioma suportados 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

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.Skills.Text.V3.SentimentSkill

Um fragmento de URI especificando o tipo de habilidade.

context

string

Representa o nível no qual as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document.

defaultLanguageCode

string

Um valor que indica qual código de idioma usar. A predefinição é en.

description

string

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

includeOpinionMining

boolean

False

Se definido como true, o resultado da habilidade incluirá informações do Text Analytics para mineração de opinião, ou seja, alvos (substantivos ou verbos) e sua avaliação associada (adjetivo) no texto. O valor padrão é falso.

inputs

InputFieldMappingEntry[]

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

modelVersion

string

A versão do modelo a ser usada ao chamar o serviço de Análise de Texto. O padrão será o mais recente disponível quando não especificado. Recomendamos que você não especifique esse valor, a menos que seja absolutamente necessário.

name

string

O nome da habilidade que a identifica exclusivamente dentro do conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixada com o caractere '#'.

outputs

OutputFieldMappingEntry[]

A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como uma entrada por outra habilidade.

ShaperSkill

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

Name Tipo Description
@odata.type string:

#Microsoft.Skills.Util.ShaperSkill

Um fragmento de URI especificando o tipo de habilidade.

context

string

Representa o nível no qual as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document.

description

string

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

inputs

InputFieldMappingEntry[]

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

name

string

O nome da habilidade que a identifica exclusivamente dentro do conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixada com o caractere '#'.

outputs

OutputFieldMappingEntry[]

A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como uma entrada por outra habilidade.

SplitSkill

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

Name Tipo Description
@odata.type string:

#Microsoft.Skills.Text.SplitSkill

Um fragmento de URI especificando o tipo de habilidade.

azureOpenAITokenizerParameters

AzureOpenAITokenizerParameters

Só se aplica se a unidade estiver definida como azureOpenAITokens. Se especificado, o splitSkill usará esses parâmetros ao executar a tokenização. Os parâmetros são um 'encoderModelName' válido e uma propriedade opcional 'allowedSpecialTokens'.

context

string

Representa o nível no qual as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document.

defaultLanguageCode

SplitSkillLanguage

Um valor que indica qual código de idioma usar. A predefinição é en.

description

string

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

inputs

InputFieldMappingEntry[]

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

maximumPageLength

integer (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

OutputFieldMappingEntry[]

A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como uma entrada por outra habilidade.

pageOverlapLength

integer (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

TextSplitMode

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

unit

SplitSkillUnit

Só se aplica se textSplitMode estiver definido como páginas. Há dois valores possíveis. A escolha dos valores decidirá a medida do comprimento (maximumPageLength e pageOverlapLength). O padrão é 'caracteres', o que significa que o comprimento será medido por caractere.

SplitSkillEncoderModelName

Só se aplica se a unidade estiver definida como azureOpenAITokens. As opções incluem 'R50k_base', 'P50k_base', 'P50k_edit' e 'CL100k_base'. O valor padrão é 'CL100k_base'.

Valor Description
r50k_base

Refere-se a um modelo base treinado com um vocabulário de 50.000 tokens, frequentemente usado em tarefas gerais de processamento de linguagem natural.

p50k_base

Um modelo base com um vocabulário de 50.000 tokens, otimizado para tarefas baseadas em prompt.

p50k_edit

Semelhante ao p50k_base mas ajustado para tarefas de edição ou reformulação com um vocabulário de 50.000 tokens.

cl100k_base

Um modelo base com um vocabulário de 100.000 tokens.

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

Holandê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)

SplitSkillUnit

Um valor que indica qual unidade usar.

Valor Description
characters

O comprimento será medido por caráter.

azureOpenAITokens

O comprimento será medido por um tokenizador AzureOpenAI da biblioteca tiktoken.

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.Skills.Text.TranslationSkill

Um fragmento de URI especificando o tipo de habilidade.

context

string

Representa o nível no qual as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document.

defaultFromLanguageCode

TextTranslationSkillLanguage

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

defaultToLanguageCode

TextTranslationSkillLanguage

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

description

string

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

inputs

InputFieldMappingEntry[]

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

name

string

O nome da habilidade que a identifica exclusivamente dentro do conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixada com o caractere '#'.

outputs

OutputFieldMappingEntry[]

A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como uma entrada por outra habilidade.

suggestedFrom

TextTranslationSkillLanguage

O código de idioma para traduzir documentos de quando nem a entrada fromLanguageCode nem o parâmetro defaultFromLanguageCode são fornecidos e a deteção automática de idioma não é bem-sucedida. A predefinição é en.

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

Chineses (Simplificado)

zh-Hant

Chinês (Tradicional)

hr

Croata

cs

Checo

da

Dinamarquês

nl

Holandê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

Tâmil

te

Telugu

th

Tailandês

to

Tonga

tr

Turco (língua)

uk

Ucraniano

ur

Língua Urdu

vi

Vietnamita

cy

Galês

yua

Iucatego

ga

Irlandês

kn

Canarês

mi

Maori

ml

Malaiala

pa

Punjabi

VisionVectorizeSkill

Permite gerar uma incorporação vetorial para uma determinada entrada de imagem ou texto usando a API de Vetorização de Visão dos Serviços de IA do Azure.

Name Tipo Description
@odata.type string:

#Microsoft.Skills.Vision.VectorizeSkill

Um fragmento de URI especificando o tipo de habilidade.

context

string

Representa o nível no qual as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document.

description

string

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

inputs

InputFieldMappingEntry[]

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

modelVersion

string

A versão do modelo a ser usada ao chamar o serviço AI Services Vision. O padrão será o mais recente disponível quando não especificado.

name

string

O nome da habilidade que a identifica exclusivamente dentro do conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixada com o caractere '#'.

outputs

OutputFieldMappingEntry[]

A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como uma entrada por outra habilidade.

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.Skills.Custom.WebApiSkill

Um fragmento de URI especificando o tipo de habilidade.

authIdentity SearchIndexerDataIdentity:

A identidade gerenciada atribuída pelo usuário usada para conexões de saída. Se um authResourceId for fornecido e não for especificado, a identidade gerenciada atribuída ao sistema será usada. Nas atualizações do indexador, se a identidade não for especificada, o valor permanecerá inalterado. Se definido como "nenhum", o valor dessa propriedade será limpo.

authResourceId

string

Aplica-se a habilidades personalizadas que se conectam a código externo em uma função do Azure ou em algum outro aplicativo que fornece as transformações. Esse valor deve ser a ID do aplicativo criada para a função ou aplicativo quando ela foi registrada no Azure Ative Directory. Quando especificada, a habilidade personalizada se conecta à função ou aplicativo usando uma ID gerenciada (atribuída pelo sistema ou pelo usuário) do serviço de pesquisa e o token de acesso da função ou aplicativo, usando esse valor como a id do recurso para criar o escopo do token de acesso.

batchSize

integer (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

InputFieldMappingEntry[]

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

name

string

O nome da habilidade que a identifica exclusivamente dentro do conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixada com o caractere '#'.

outputs

OutputFieldMappingEntry[]

A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como uma entrada por outra habilidade.

timeout

string (duration)

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

uri

string

A url para a API da Web.