Skillsets - Get

Serviço:: Search Service

Versão da API:: 2025-08-01-preview

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

GET {endpoint}/skillsets('{skillsetName}')?api-version=2025-08-01-preview

Parâmetros de URI

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

Cabeçalho da solicitação

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

Respostas

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

Exemplos

SearchServiceGetSkillset

Solicitação de exemplo

HTTP

GET https://previewexampleservice.search.windows.net/skillsets('myskillset')?api-version=2025-08-01-preview

Resposta de exemplo

Código de status:: 200

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "myskillset",
  "description": "Skillset for extracting entities and more",
  "skills": [
    {
      "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill",
      "name": "skill2",
      "context": "/document",
      "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",
      "context": "/document",
      "defaultLanguageCode": "en",
      "textSplitMode": "pages",
      "maximumPageLength": 4000,
      "pageOverlapLength": 0,
      "maximumPagesToTake": 0,
      "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/*",
      "defaultLanguageCode": "en",
      "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",
      "context": "/document",
      "uri": "https://contoso.example.org/",
      "httpMethod": "POST",
      "timeout": "PT5S",
      "batchSize": 1000,
      "inputs": [
        {
          "name": "text",
          "source": "/document/content",
          "inputs": []
        },
        {
          "name": "languageCode",
          "source": "/document/languageCode",
          "inputs": []
        }
      ],
      "outputs": [
        {
          "name": "customresult",
          "targetName": "result"
        }
      ],
      "httpHeaders": {}
    },
    {
      "@odata.type": "#Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill",
      "name": "docIntelligenceLayoutSkill",
      "context": "/document",
      "outputMode": "oneToMany",
      "markdownHeaderDepth": "h3",
      "outputFormat": "markdown",
      "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",
      "httpMethod": "POST",
      "timeout": "PT30S",
      "batchSize": 1,
      "degreeOfParallelism": 5,
      "apiKey": "<redacted>",
      "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"
        }
      ],
      "httpHeaders": {},
      "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.\"}}"
          }
        }
      }
    }
  ]
}

Definições

Nome	Description
AIServicesAccountIdentity	A conta multirregional 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 de IA com um modelo personalizado de AML (Azure Machine Learning). Depois que um modelo AML é treinado e implantado, uma habilidade AML o integra ao enriquecimento da IA.
AzureActiveDirectoryApplicationCredentials	Credenciais de um aplicativo registrado criado para o serviço de pesquisa, usado para acesso autenticado às chaves de criptografia armazenadas no Azure Key Vault.
AzureOpenAIEmbeddingSkill	Permite gerar uma inserção de vetor para uma determinada entrada de texto usando o recurso OpenAI do Azure.
AzureOpenAIModelName	O nome do modelo do Azure Open AI que será chamado.
AzureOpenAITokenizerParameters
ChatCompletionCommonModelParameters	Parâmetros de modelo de linguagem comum para conclusões de chat. Se omitido, os valores padrão serã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 é 'text'.
ChatCompletionResponseFormatType	Especifica como o LLM deve formatar a resposta. Valores possíveis: 'text' (string 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ões 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 cenários que exigem uma operação booleana para determinar 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 ou sinônimos alternativos para o nome da entidade raiz.
CustomEntityLookupSkill	Uma habilidade procura texto de uma lista personalizada de palavras e frases definida pelo usuário.
CustomEntityLookupSkillLanguage	Os códigos de idioma com suporte para texto de entrada por CustomEntityLookupSkill.
DefaultCognitiveServicesAccount	Um objeto vazio que representa o recurso de serviço de IA do Azure padrão para um conjunto de habilidades.
DocumentExtractionSkill	Uma habilidade que extrai conteúdo de um arquivo dentro do pipeline de enriquecimento.
DocumentIntelligenceLayoutSkill	Uma habilidade que extrai informações de conteúdo e layout, por meio dos Serviços de IA do Azure, de arquivos dentro do pipeline de enriquecimento.
DocumentIntelligenceLayoutSkillChunkingProperties	Controla a cardinalidade para dividir o conteúdo.
DocumentIntelligenceLayoutSkillChunkingUnit	Controla a cardinalidade da unidade de blocos. 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 retornar.
EntityLinkingSkill	Usando a API de Análise de Texto, extrai entidades vinculadas do texto.
EntityRecognitionSkill	Essa habilidade foi descontinuada. Use o V3. EntityRecognitionSkill em vez disso.
EntityRecognitionSkillLanguage	Preterido. Os códigos de idioma com suporte para texto de entrada por EntityRecognitionSkill.
EntityRecognitionSkillV3	Usando a API de Análise de Texto, extrai entidades de diferentes tipos do texto.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
ImageAnalysisSkill	Uma habilidade que analisa arquivos de imagem. Ele extrai um rico conjunto de recursos visuais com base no conteúdo da imagem.
ImageAnalysisSkillLanguage	Os códigos de idioma com suporte para entrada por ImageAnalysisSkill.
ImageDetail	Uma cadeia de caracteres que indica quais detalhes específicos do domínio retornar.
IndexProjectionMode	Define o comportamento das projeções de índice em relação ao restante do indexador.
InputFieldMappingEntry	Mapeamento de campo de entrada para uma habilidade.
JsonSchemaProperties	Um dicionário aberto para propriedades estendidas. Obrigatório se 'type' == 'json_schema'
KeyPhraseExtractionSkill	Uma habilidade que usa análise de texto para extração de frases-chave.
KeyPhraseExtractionSkillLanguage	Os códigos de idioma com suporte para texto de entrada por KeyPhraseExtractionSkill.
LanguageDetectionSkill	Uma habilidade que detecta o idioma do texto de entrada e relata um único código de idioma para cada documento enviado na solicitação. O código de idioma é emparelhado com uma pontuação que indica a confiança da análise.
LineEnding	Define a sequência de caracteres a ser usada entre as linhas de texto reconhecidas pela habilidade de OCR. O valor padrão é "espaço".
MergeSkill	Uma habilidade para mesclar duas ou mais strings em uma única string 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 detectadas no texto de entrada.
SearchIndexerDataNoneIdentity	Limpa a propriedade de identidade de uma fonte de dados.
SearchIndexerDataUserAssignedIdentity	Especifica a identidade de uma fonte de dados a ser usada.
SearchIndexerIndexProjections	Definição de projeções adicionais para índices de pesquisa secundários.
SearchIndexerIndexProjectionSelector	Descrição de quais dados armazenar no índice de pesquisa designado.
SearchIndexerIndexProjectionsParameters	Um dicionário de propriedades de configuração específicas 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 blob, tabela ou arquivos do Azure de dados enriquecidos.
SearchIndexerKnowledgeStoreFileProjectionSelector	Definição de projeção para quais dados armazenar nos Arquivos do Azure.
SearchIndexerKnowledgeStoreObjectProjectionSelector	Definição de projeção para quais dados armazenar no Blob do Azure.
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 de quais dados armazenar em Tabelas do Azure.
SearchIndexerSkillset	Uma lista de habilidades.
SearchResourceEncryptionKey	Uma chave de criptografia gerenciada pelo cliente no Azure Key Vault. As chaves que você cria e gerencia podem ser usadas para criptografar ou descriptografar dados em repouso, como índices e mapas de sinônimos.
SentimentSkill	Essa habilidade foi descontinuada. Use o V3. SentimentSkill em vez disso.
SentimentSkillLanguage	Preterido. Os códigos de idioma com suporte para texto de entrada por SentimentSkill.
SentimentSkillV3	Usando a API de Análise de Texto, avalia o texto não estruturado e, para cada registro, fornece rótulos de sentimento (como "negativo", "neutro" e "positivo") com base na pontuação de confiança mais alta encontrada pelo serviço em um nível de frase e documento.
ShaperSkill	Uma habilidade para remodelar os resultados. Ele cria um tipo complexo para dar suporte a campos compostos (também conhecidos como campos de várias partes).
SplitSkill	Uma habilidade para dividir uma cadeia de caracteres em 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 com suporte 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 com suporte para texto de entrada por TextTranslationSkill.
VisionVectorizeSkill	Permite gerar uma inserção de vetor para uma determinada imagem ou entrada de 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 retornar.
WebApiSkill	Uma habilidade que pode chamar um ponto de extremidade da API Web, permitindo que você estenda um conjunto de habilidades fazendo com que ele chame seu código personalizado.

AIServicesAccountIdentity

Objeto

A conta multirregional de um recurso de serviço de IA do Azure anexado a um conjunto de habilidades.

Nome	Tipo	Description
@odata.type	string: #Microsoft.Azure.Search.AIServicesByIdentity	Um fragmento de URI que especifica o tipo de recurso de serviço de IA do Azure anexado a um conjunto de habilidades.
description	string	Descrição do recurso de serviço de IA do Azure anexado a um conjunto de habilidades.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	A identidade gerenciada atribuída pelo usuário usada para conexões com o Serviço de IA. Se não for especificado, a identidade gerenciada atribuída pelo sistema será usada. Nas atualizações do conjunto de habilidades, se a identidade não for especificada, o valor permanecerá inalterado. Se definido como "nenhum", o valor dessa propriedade será limpo.
subdomainUrl	string	O URL do subdomínio para o serviço de IA correspondente.

AIServicesAccountKey

Objeto

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.

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

AmlSkill

Objeto

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

Nome	Tipo	Description
@odata.type	string: #Microsoft.Skills.Custom.AmlSkill	Um fragmento de URI especificando o tipo de habilidade.
context	string	Representa o nível em que as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document.
degreeOfParallelism	integer (int32)	(Opcional) Quando especificado, indica o número de chamadas que o indexador fará em paralelo ao ponto de extremidade que você forneceu. 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 for definido, um valor padrão de 5 será usado. O degreeOfParallelism pode ser definido como 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 upstream.
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 no conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixado com o caractere '#'.
outputs	OutputFieldMappingEntry[]	A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como uma entrada por outra habilidade.
region	string	(Opcional para autenticação de token). A região em que o serviço AML é implantado.
resourceId	string	(Necessário para autenticação de token). A ID de recurso do Azure Resource Manager do serviço AML. Ele 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 à 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

Objeto

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

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

AzureOpenAIEmbeddingSkill

Objeto

Permite gerar uma inserção de vetor para uma determinada entrada de texto usando o recurso OpenAI do Azure.

Nome	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: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	A identidade gerenciada atribuída pelo usuário usada para conexões de saída.
context	string	Representa o nível em que as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document.
deploymentId	string	ID da implantação 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 inserções de saída resultantes devem ter. Compatível apenas com 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 upstream.
modelName	AzureOpenAIModelName	O nome do modelo de inserção implantado no caminho deploymentId fornecido.
name	string	O nome da habilidade que a identifica exclusivamente no conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixado com o caractere '#'.
outputs	OutputFieldMappingEntry[]	A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como uma entrada por outra habilidade.
resourceUri	string (uri)	O URI do recurso OpenAI do Azure.

AzureOpenAIModelName

Enumeração

O nome do modelo do Azure Open AI 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

Objeto

Nome	Tipo	Description
allowedSpecialTokens	string[]	(Opcional) Só se aplica se a unidade estiver definida como azureOpenAITokens. Esse parâmetro define uma coleção de tokens especiais que são permitidos no processo de geração de tokens.
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

Objeto

Parâmetros de modelo de linguagem comum para conclusões de chat. Se omitido, os valores padrão serão usados.

Nome	Tipo	Valor padrão	Description
frequencyPenalty	number	0	Um float no intervalo [-2,2] que reduz ou aumenta a probabilidade de tokens repetidos. O padrão é 0.
maxTokens	integer (int32)		Número máximo de tokens a serem gerados.
model	string		O nome do modelo a ser usado (por exemplo, 'gpt-4o', etc.). O padrão é nulo se não for especificado.
presencePenalty	number	0	Um float no intervalo [-2,2] que penaliza novos tokens com base em sua presença existente. O padrão é 0.
seed	integer (int32)		Semente aleatória para controlar saídas determinísticas. Se omitido, a randomização é usada.
stop	string[]		Lista de sequências de parada que interromperão a geração de texto. O padrão é nenhum.
temperature	number	0.7	Temperatura de amostragem. O padrão é 0,7.

ChatCompletionExtraParametersBehavior

Enumeração

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

Objeto

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

Nome	Tipo	Valor padrão	Description
jsonSchemaProperties	JsonSchemaProperties		Um dicionário aberto para propriedades estendidas. Obrigatório se 'type' == 'json_schema'
type	ChatCompletionResponseFormatType	text	Especifica como o LLM deve formatar a resposta. Valores possíveis: 'text' (string simples), 'json_object' (JSON arbitrário) ou 'json_schema' (adere ao esquema fornecido).

ChatCompletionResponseFormatType

Enumeração

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

Valor	Description
text
jsonObject
jsonSchema

ChatCompletionSchema

Objeto

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

Nome	Tipo	Valor padrão	Description
additionalProperties	boolean	False	Controla se é permitido que um objeto contenha chaves/valores adicionais que não foram definidos no esquema JSON. O padrão é false.
properties	string		Uma cadeia de caracteres formatada em JSON que define as propriedades e restrições do esquema de saída para o modelo.
required	string[]		Uma matriz dos nomes de propriedade que devem fazer parte da resposta do modelo. Todas as propriedades devem ser incluídas para saídas estruturadas.
type	string	object	Tipo de representação de esquema. Geralmente 'objeto'. O padrão é 'object'.

ChatCompletionSkill

Objeto

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

Nome	Tipo	Valor padrão	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. Tanto apiKey quanto authIdentity não podem ser especificados ao mesmo tempo.
authIdentity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity		A identidade gerenciada atribuída pelo usuário usada para conexões de saída. Se um authResourceId for fornecido e não for especificado, a identidade gerenciada atribuída pelo sistema será usada. 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 ao código externo em uma função do Azure ou algum outro aplicativo que fornece as transformações. Esse valor deve ser a ID do aplicativo criada para a função ou aplicativo quando ele foi registrado no Azure Active Directory. Quando especificada, a habilidade personalizada se conecta à função ou ao aplicativo usando um ID gerenciado (atribuído pelo sistema ou pelo usuário) do serviço de pesquisa e o token de acesso da função ou do aplicativo, usando esse valor como o ID do recurso para criar o escopo do token de acesso.
batchSize	integer (int32)		O tamanho do lote desejado que indica o número de documentos.
commonModelParameters	ChatCompletionCommonModelParameters		Parâmetros de modelo de linguagem comum que os clientes podem ajustar. Se omitido, padrões razoáveis serão aplicados.
context	string		Representa o nível em que as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document.
degreeOfParallelism	integer (int32)		Se definido, o número de chamadas paralelas que podem ser feitas para a API 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 acrescentados à 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 tratados pelo Azure AI Foundry. O padrão é 'error'.
httpHeaders	object		Os cabeçalhos necessários para fazer a solicitação http.
httpMethod	string		O método para a solicitação http.
inputs	InputFieldMappingEntry[]		As entradas das habilidades podem ser uma coluna no conjunto de dados de origem ou a saída de uma habilidade upstream.
name	string		O nome da habilidade que a identifica exclusivamente no conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixado com o caractere '#'.
outputs	OutputFieldMappingEntry[]		A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como uma entrada por outra habilidade.
responseFormat	ChatCompletionResponseFormat		Determina como o LLM deve formatar sua resposta. O padrão é o tipo de resposta 'text'.
timeout	string (duration)		O tempo limite desejado para a solicitação. O padrão é 30 segundos.
uri	string		A url da API Web.

CognitiveServicesAccountKey

Objeto

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.

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

ConditionalSkill

Objeto

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

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

CustomEntity

Objeto

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

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

CustomEntityAlias

Objeto

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

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

CustomEntityLookupSkill

Objeto

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

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

CustomEntityLookupSkillLanguage

Enumeração

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

Valor	Description
da	Dinamarquês
de	German
en	Inglês
es	Spanish
fi	Finlandês
fr	French
it	Italian
ko	Korean
pt	Portuguese

DefaultCognitiveServicesAccount

Objeto

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

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

DocumentExtractionSkill

Objeto

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

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

DocumentIntelligenceLayoutSkill

Objeto

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

Nome	Tipo	Valor padrão	Description
@odata.type	string: #Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill		Um fragmento de URI especificando o tipo de habilidade.
chunkingProperties	DocumentIntelligenceLayoutSkillChunkingProperties		Controla a cardinalidade para dividir o conteúdo.
context	string		Representa o nível em que as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document.
description	string		A descrição da habilidade que descreve as entradas, 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 upstream.
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 no conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixado com o caractere '#'.
outputFormat	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

Objeto

Controla a cardinalidade para dividir o conteúdo.

Nome	Tipo	Valor padrão	Description
maximumLength	integer (int32)		O comprimento máximo da parte em caracteres. O padrão é 500.
overlapLength	integer (int32)		O comprimento da sobreposição fornecida entre dois blocos de texto. O padrão é 0.
unit	DocumentIntelligenceLayoutSkillChunkingUnit	characters	A unidade do pedaço.

DocumentIntelligenceLayoutSkillChunkingUnit

Enumeração

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

Valor	Description
characters	Especifica a parte por caracteres.

DocumentIntelligenceLayoutSkillExtractionOptions

Enumeração

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

Enumeração

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

Enumeração

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

Enumeração

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

Enumeração

Uma cadeia de caracteres que indica quais categorias de entidade retornar.

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

EntityLinkingSkill

Objeto

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

Nome	Tipo	Description
@odata.type	string: #Microsoft.Skills.Text.V3.EntityLinkingSkill	Um fragmento de URI especificando o tipo de habilidade.
context	string	Representa o nível em que as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document.
defaultLanguageCode	string	Um valor que indica qual código de idioma usar. O padrão é `en`.
description	string	A descrição da habilidade que descreve as entradas, 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 upstream.
minimumPrecision	number (double) minimum: 0 maximum: 1	Um valor entre 0 e 1 que pode ser usado para incluir apenas entidades cuja pontuação de confiança é maior que o valor especificado. Se não for definido (padrão) ou se for 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 no conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixado com o caractere '#'.
outputs	OutputFieldMappingEntry[]	A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como uma entrada por outra habilidade.

EntityRecognitionSkill

Objeto

Essa habilidade foi descontinuada. Use o V3. EntityRecognitionSkill em vez disso.

Nome	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 entidade que devem ser extraídas.
context	string	Representa o nível em que as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document.
defaultLanguageCode	EntityRecognitionSkillLanguage	Um valor que indica qual código de idioma usar. O padrão é `en`.
description	string	A descrição da habilidade que descreve as entradas, saídas e uso da habilidade.
includeTypelessEntities	boolean	Determina se deve 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 upstream.
minimumPrecision	number (double)	Um valor entre 0 e 1 que pode ser usado para incluir apenas entidades cuja pontuação de confiança é maior que o valor especificado. Se não for definido (padrão) ou se for explicitamente definido como nulo, todas as entidades serão incluídas.
name	string	O nome da habilidade que a identifica exclusivamente no conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixado com o caractere '#'.
outputs	OutputFieldMappingEntry[]	A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como uma entrada por outra habilidade.

EntityRecognitionSkillLanguage

Enumeração

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

Valor	Description
ar	Árabe
cs	Tcheco
zh-Hans	Chinese-Simplified
zh-Hant	Chinese-Traditional
da	Dinamarquês
nl	Holandês
en	Inglês
fi	Finlandês
fr	French
de	German
el	Grego
hu	Húngaro
it	Italian
ja	Japanese
ko	Korean
no	Norueguês (Bokmaal)
pl	Polonês
pt-PT	Português (Portugal)
pt-BR	Português (Brasil)
ru	Russian
es	Spanish
sv	Sueco
tr	Turco

EntityRecognitionSkillV3

Objeto

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

Nome	Tipo	Description
@odata.type	string: #Microsoft.Skills.Text.V3.EntityRecognitionSkill	Um fragmento de URI especificando o tipo de habilidade.
categories	string[]	Uma lista de categorias de entidade que devem ser extraídas.
context	string	Representa o nível em que as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document.
defaultLanguageCode	string	Um valor que indica qual código de idioma usar. O padrão é `en`.
description	string	A descrição da habilidade que descreve as entradas, 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 upstream.
minimumPrecision	number (double) minimum: 0 maximum: 1	Um valor entre 0 e 1 que pode ser usado para incluir apenas entidades cuja pontuação de confiança é maior que o valor especificado. Se não for definido (padrão) ou se for 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 no conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixado com o caractere '#'.
outputs	OutputFieldMappingEntry[]	A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como uma entrada por outra habilidade.

ErrorAdditionalInfo

Objeto

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

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

ErrorDetail

Objeto

O detalhe do erro.

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

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

ImageAnalysisSkill

Objeto

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

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

ImageAnalysisSkillLanguage

Enumeração

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

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

ImageDetail

Enumeração

Uma cadeia de caracteres que indica quais detalhes específicos do domínio retornar.

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

IndexProjectionMode

Enumeração

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

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

InputFieldMappingEntry

Objeto

Mapeamento de campo de entrada para uma habilidade.

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

JsonSchemaProperties

Objeto

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

Nome	Tipo	Valor padrão	Description
description	string		Descrição do esquema json ao qual o modelo irá aderir.
name	string		Nome do esquema json ao qual o modelo seguirá
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

Objeto

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

Nome	Tipo	Description
@odata.type	string: #Microsoft.Skills.Text.KeyPhraseExtractionSkill	Um fragmento de URI especificando o tipo de habilidade.
context	string	Representa o nível em que as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document.
defaultLanguageCode	KeyPhraseExtractionSkillLanguage	Um valor que indica qual código de idioma usar. O padrão é `en`.
description	string	A descrição da habilidade que descreve as entradas, 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 upstream.
maxKeyPhraseCount	integer (int32)	Um número que indica quantas frases-chave devem ser retornadas. Se ausente, 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 no conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixado com o caractere '#'.
outputs	OutputFieldMappingEntry[]	A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como uma entrada por outra habilidade.

KeyPhraseExtractionSkillLanguage

Enumeração

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

Valor	Description
da	Dinamarquês
nl	Holandês
en	Inglês
fi	Finlandês
fr	French
de	German
it	Italian
ja	Japanese
ko	Korean
no	Norueguês (Bokmaal)
pl	Polonês
pt-PT	Português (Portugal)
pt-BR	Português (Brasil)
ru	Russian
es	Spanish
sv	Sueco

LanguageDetectionSkill

Objeto

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

Nome	Tipo	Description
@odata.type	string: #Microsoft.Skills.Text.LanguageDetectionSkill	Um fragmento de URI especificando o tipo de habilidade.
context	string	Representa o nível em que as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document.
defaultCountryHint	string	Um código de país a ser usado como uma dica para o modelo de detecção de idioma se ele não puder remover a ambiguidade do 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 upstream.
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 no conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixado com o caractere '#'.
outputs	OutputFieldMappingEntry[]	A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como uma entrada por outra habilidade.

LineEnding

Enumeração

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

Valor	Description
space	As linhas são separadas por um único caractere de espaço.
carriageReturn	As linhas são separadas por um caractere de retorno de carro ('\r').
lineFeed	As linhas são separadas por um único caractere de 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

Objeto

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

Nome	Tipo	Description
@odata.type	string: #Microsoft.Skills.Text.MergeSkill	Um fragmento de URI especificando o tipo de habilidade.
context	string	Representa o nível em que as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document.
description	string	A descrição da habilidade que descreve as entradas, 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 upstream.
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 no conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixado com o caractere '#'.
outputs	OutputFieldMappingEntry[]	A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como uma entrada por outra habilidade.

OcrSkill

Objeto

Uma habilidade que extrai texto de arquivos de imagem.

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

OcrSkillLanguage

Enumeração

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

Valor	Description
af	Africâner
sq	Albanês
anp	Angika (Devanagiri)
ar	Árabe
ast	Asturiano
awa	Awadhi-Hindi (Devanagiri)
az	Azerbaijano (latim)
bfy	Bagheli
eu	Basco
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	Latim bósnio
bra	Brajbha
br	Bretão
bg	Búlgaro
bns	Bundeli
bua	Buriate (cirílico)
ca	Catalão
ceb	Cebuano
rab	Chamling
ch	Chamorro
hne	Chhattisgarhi (Devanagiri)
zh-Hans	Chinês simplificado
zh-Hant	Chinês tradicional
kw	Córnico
co	Corso
crh	Tártaro da Crimeia (latim)
hr	Croata
cs	Tcheco
da	Dinamarquês
prs	Dari
dhi	Dhimal (Devanagiri)
doi	Dogri (Devanagiri)
nl	Holandês
en	Inglês
myv	Erzya (cirílico)
et	Estoniano
fo	Faroês
fj	Fijiano
fil	Filipino
fi	Finlandês
fr	French
fur	Fruliano
gag	Gagauz (latim)
gl	Galego
de	German
gil	Gilbertês
gon	Gondi (Devanagiri)
el	Grego
kl	Gronelandês
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	Icelandic
smn	Inari Sami
id	Indonesian
ia	Interlíngua
iu	Inuktitut (Latino)
ga	Irlandês
it	Italian
ja	Japanese
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	Cassúbio
kk-cyrl	Cazaque (cirílico)
kk-latn	Cazaque (latim)
klr	Khaling
kha	Khasi
quc	Quiché
ko	Korean
kfq	Korku
kpy	Koryak
kos	Kosraean
kum	Kumyk (cirílico)
ku-arab	Curdo (árabe)
ku-latn	Curdo (latim)
kru	Kurukh (Devanagiri)
ky	Quirguiz (cirílico)
lkt	Lakota
la	Latim
lt	Lituano
dsb	Baixo sorábio
smj	Lule Sami
lb	Luxemburguês
bfz	Mahasu Pahari (Devanagiri)
ms	Malaio (latim)
mt	Maltês
kmj	Malto (Devanagiri)
gv	Manx
mi	Maori
mr	Marati
mn	Mongol (Cirílico)
cnr-cyrl	Montenegrino (cirílico)
cnr-latn	Montenegrino (latim)
nap	Napolitano
ne	Nepalês
niu	Niueano
nog	Nogay
sme	Sami do Norte (latim)
nb	Norueguês
no	Norueguês
oc	Occitano
os	Ossético
ps	Pashto
fa	Persa
pl	Polonês
pt	Portuguese
pa	Punjabi (árabe)
ksh	Ripuarian
ro	Romeno
rm	Romanche
ru	Russian
sck	Sadri (Devanagiri)
sm	Samoano (latim)
sa	Sânscrito (Devanagiri)
sat	Santali (Devanagiri)
sco	Scots
gd	Gaélico escocês
sr	Sérvio (Latino)
sr-Cyrl	Sérvio (Cirílico)
sr-Latn	Sérvio (Latino)
xsr	Sherpa (Devanagiri)
srx	Sirmauri (Devanagiri)
sms	Skolt Sami
sk	Eslovaco
sl	Esloveno
so	Somali (árabe)
sma	Sami do Sul
es	Spanish
sw	Suaíli (latim)
sv	Sueco
tg	Tadjique (Cirílico)
tt	Tártaro (latim)
tet	Tétum
thf	Thangmi
to	Tonga
tr	Turco
tk	Turcomano (latim)
tyv	Tuvan
hsb	Sorábio Alto
ur	Urdu
ug	Uigur (árabe)
uz-arab	Uzbeque (árabe)
uz-cyrl	Uzbeque (Cirílico)
uz	Uzbeque (latino)
vo	Volapuque
wae	Walser
cy	Galês
fy	Frísio Ocidental
yua	Yucatec Maya
za	Zhuang
zu	Zulu
unk	Desconhecido (Todos)

OutputFieldMappingEntry

Objeto

Mapeamento de campo de saída para uma habilidade.

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

PIIDetectionSkill

Objeto

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

Nome	Tipo	Description
@odata.type	string: #Microsoft.Skills.Text.PIIDetectionSkill	Um fragmento de URI especificando o tipo de habilidade.
context	string	Representa o nível em que as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document.
defaultLanguageCode	string	Um valor que indica qual código de idioma usar. O padrão é `en`.
description	string	A descrição da habilidade que descreve as entradas, 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', 'nenhum'. 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 upstream.
maskingCharacter	string maxLength: 1	O caractere usado para mascarar o texto se o parâmetro maskingMode estiver definido para substituir. O padrão é '*'.
maskingMode	PIIDetectionSkillMaskingMode	Um parâmetro que fornece várias maneiras de mascarar as informações pessoais detectadas no texto de entrada. O padrão é 'nenhum'.
minimumPrecision	number (double) minimum: 0 maximum: 1	Um valor entre 0 e 1 que pode ser usado para incluir apenas entidades cuja pontuação de confiança é maior que o valor especificado. Se não for definido (padrão) ou se for 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 no conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixado com o caractere '#'.
outputs	OutputFieldMappingEntry[]	A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como uma entrada por outra habilidade.
piiCategories	string[]	Uma lista de categorias de entidade de PII que devem ser extraídas e mascaradas.

PIIDetectionSkillMaskingMode

Enumeração

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

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

SearchIndexerDataNoneIdentity

Objeto

Limpa a propriedade de identidade de uma fonte de dados.

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

SearchIndexerDataUserAssignedIdentity

Objeto

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

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

SearchIndexerIndexProjections

Objeto

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

Nome	Tipo	Description
parameters	SearchIndexerIndexProjectionsParameters	Um dicionário de propriedades de configuração específicas 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 executadas em índices de pesquisa secundários.

SearchIndexerIndexProjectionSelector

Objeto

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

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

SearchIndexerIndexProjectionsParameters

Objeto

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.

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

SearchIndexerKnowledgeStore

Objeto

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

Nome	Tipo	Description
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	A identidade gerenciada atribuída pelo usuário usada para conexões com o Armazenamento do Azure ao gravar projeções do repositório de conhecimento. Se a cadeia de conexão indicar uma identidade (ResourceId) e ela não for especificada, a identidade gerenciada atribuída pelo 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.

SearchIndexerKnowledgeStoreFileProjectionSelector

Objeto

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

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

SearchIndexerKnowledgeStoreObjectProjectionSelector

Objeto

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

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

SearchIndexerKnowledgeStoreParameters

Objeto

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.

Nome	Tipo	Valor padrão	Description
synthesizeGeneratedKeyName	boolean	False	Se as projeções devem ou não sintetizar um nome de chave gerado se ainda não estiver presente.

SearchIndexerKnowledgeStoreProjection

Objeto

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

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

SearchIndexerKnowledgeStoreTableProjectionSelector

Objeto

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

Nome	Tipo	Description
generatedKeyName	string	Nome da chave gerada para armazenar a projeção.
inputs	InputFieldMappingEntry[]	Entradas aninhadas para projeções complexas.
referenceKeyName	string	Nome da chave de referência para diferentes projeções.
source	string	Dados de origem 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

Objeto

Uma lista de habilidades.

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

SearchResourceEncryptionKey

Objeto

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

Nome	Tipo	Description
accessCredentials	AzureActiveDirectoryApplicationCredentials	Credenciais opcionais do Azure Active Directory usadas para acessar o Azure Key Vault. Não é necessário se estiver usando a identidade gerenciada.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Uma identidade gerenciada explícita a ser usada para essa chave de criptografia. Se não for especificado e a propriedade de credenciais de acesso for nula, a identidade gerenciada atribuída pelo sistema será usada. Na atualização do recurso, se a identidade explícita não for especificada, ela permanecerá inalterada. Se "none" for especificado, o valor dessa propriedade será limpo.
keyVaultKeyName	string	O nome da chave do Azure Key Vault a ser usada para criptografar seus dados em repouso.
keyVaultKeyVersion	string	A versão da chave do Azure Key Vault a ser usada para criptografar seus dados em repouso.
keyVaultUri	string	O URI do Azure Key Vault, também conhecido como nome DNS, que contém a chave a ser usada para criptografar seus dados em repouso. Um exemplo de URI pode ser `https://my-keyvault-name.vault.azure.net`.

SentimentSkill

Objeto

Essa habilidade foi descontinuada. Use o V3. SentimentSkill em vez disso.

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

SentimentSkillLanguage

Enumeração

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

Valor	Description
da	Dinamarquês
nl	Holandês
en	Inglês
fi	Finlandês
fr	French
de	German
el	Grego
it	Italian
no	Norueguês (Bokmaal)
pl	Polonês
pt-PT	Português (Portugal)
ru	Russian
es	Spanish
sv	Sueco
tr	Turco

SentimentSkillV3

Objeto

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

Nome	Tipo	Valor padrão	Description
@odata.type	string: #Microsoft.Skills.Text.V3.SentimentSkill		Um fragmento de URI especificando o tipo de habilidade.
context	string		Representa o nível em que as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document.
defaultLanguageCode	string		Um valor que indica qual código de idioma usar. O padrão é `en`.
description	string		A descrição da habilidade que descreve as entradas, saídas e uso da habilidade.
includeOpinionMining	boolean	False	Se definido como true, a saída da habilidade incluirá informações da Análise de Texto para mineração de opinião, ou seja, destinos (substantivos ou verbos) e sua avaliação associada (adjetivo) no texto. O padrão é false.
inputs	InputFieldMappingEntry[]		As entradas das habilidades podem ser uma coluna no conjunto de dados de origem ou a saída de uma habilidade upstream.
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 no conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixado com o caractere '#'.
outputs	OutputFieldMappingEntry[]		A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como uma entrada por outra habilidade.

ShaperSkill

Objeto

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

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

SplitSkill

Objeto

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

Nome	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 geração de tokens. Os parâmetros são um 'encoderModelName' válido e uma propriedade 'allowedSpecialTokens' opcional.
context	string	Representa o nível em que as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document.
defaultLanguageCode	SplitSkillLanguage	Um valor que indica qual código de idioma usar. O padrão é `en`.
description	string	A descrição da habilidade que descreve as entradas, 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 upstream.
maximumPageLength	integer (int32)	O comprimento máximo de página desejado. O padrão é 10000.
maximumPagesToTake	integer (int32)	Aplicável somente quando textSplitMode está definido como 'pages'. Se especificado, o SplitSkill interromperá a divisão após o processamento das primeiras páginas 'maximumPagesToTake', para 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 no conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixado com o caractere '#'.
outputs	OutputFieldMappingEntry[]	A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como uma entrada por outra habilidade.
pageOverlapLength	integer (int32)	Aplicável somente quando textSplitMode está definido como 'pages'. Se especificado, n+1º pedaço começará com esse número de caracteres/tokens a partir do final do enésimo 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. Existem dois valores possíveis. A escolha dos valores decidirá a medida de comprimento (maximumPageLength e pageOverlapLength). O padrão é 'caracteres', o que significa que o comprimento será medido por caractere.

SplitSkillEncoderModelName

Enumeração

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, geralmente 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 básico com um vocabulário de 100.000 tokens.

SplitSkillLanguage

Enumeração

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

Valor	Description
am	Amárico
bs	Bósnio
cs	Tcheco
da	Dinamarquês
de	German
en	Inglês
es	Spanish
et	Estoniano
fi	Finlandês
fr	French
he	Hebraico
hi	Híndi
hr	Croata
hu	Húngaro
id	Indonesian
is	Icelandic
it	Italian
ja	Japanese
ko	Korean
lv	Letão
nb	Norueguês
nl	Holandês
pl	Polonês
pt	Português (Portugal)
pt-br	Português (Brasil)
ru	Russian
sk	Eslovaco
sl	Esloveno
sr	Sérvio
sv	Sueco
tr	Turco
ur	Urdu
zh	Chinês (simplificado)

SplitSkillUnit

Enumeração

Um valor que indica qual unidade usar.

Valor	Description
characters	O comprimento será medido por caractere.
azureOpenAITokens	O comprimento será medido por um tokenizador AzureOpenAI da biblioteca tiktoken.

TextSplitMode

Enumeração

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

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

TextTranslationSkill

Objeto

Uma habilidade para traduzir texto de um idioma para outro.

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

TextTranslationSkillLanguage

Enumeração

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

Valor	Description
af	Africâner
ar	Árabe
bn	Bengali
bs	Bósnio (Latino)
bg	Búlgaro
yue	Cantonês (tradicional)
ca	Catalão
zh-Hans	Chinês simplificado
zh-Hant	Chinês tradicional
hr	Croata
cs	Tcheco
da	Dinamarquês
nl	Holandês
en	Inglês
et	Estoniano
fj	Fijiano
fil	Filipino
fi	Finlandês
fr	French
de	German
el	Grego
ht	Crioulo Haitiano
he	Hebraico
hi	Híndi
mww	Hmong daw
hu	Húngaro
is	Icelandic
id	Indonesian
it	Italian
ja	Japanese
sw	Suaíli
tlh	Klingon
tlh-Latn	Klingon (alfabeto latino)
tlh-Piqd	Klingon (escrita klingon)
ko	Korean
lv	Letão
lt	Lituano
mg	Malgaxe
ms	Malaio
mt	Maltês
nb	Norueguês
fa	Persa
pl	Polonês
pt	Portuguese
pt-br	Português (Brasil)
pt-PT	Português (Portugal)
otq	Querétaro Otomi
ro	Romeno
ru	Russian
sm	Samoano
sr-Cyrl	Sérvio (Cirílico)
sr-Latn	Sérvio (Latino)
sk	Eslovaco
sl	Esloveno
es	Spanish
sv	Sueco
ty	Taitiano
ta	Tâmil
te	Télugo
th	Tailandês
to	Tonga
tr	Turco
uk	Ucraniano
ur	Urdu
vi	Vietnamita
cy	Galês
yua	Yucatec Maya
ga	Irlandês
kn	canarim
mi	Maori
ml	Malaiala
pa	Punjabi

VisionVectorizeSkill

Objeto

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

Nome	Tipo	Description
@odata.type	string: #Microsoft.Skills.Vision.VectorizeSkill	Um fragmento de URI especificando o tipo de habilidade.
context	string	Representa o nível em que as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document.
description	string	A descrição da habilidade que descreve as entradas, 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 upstream.
modelVersion	string	A versão do modelo a ser usada ao chamar o serviço de Visão dos Serviços de IA. O padrão será o mais recente disponível quando não especificado.
name	string	O nome da habilidade que a identifica exclusivamente no conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixado com o caractere '#'.
outputs	OutputFieldMappingEntry[]	A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como uma entrada por outra habilidade.

VisualFeature

Enumeração

As cadeias de caracteres que indicam quais tipos de recursos visuais retornar.

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

WebApiSkill

Objeto

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

Nome	Tipo	Description
@odata.type	string: #Microsoft.Skills.Custom.WebApiSkill	Um fragmento de URI especificando o tipo de habilidade.
authIdentity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	A identidade gerenciada atribuída pelo usuário usada para conexões de saída. Se um authResourceId for fornecido e não for especificado, a identidade gerenciada atribuída pelo sistema será usada. 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 ao código externo em uma função do Azure ou algum outro aplicativo que fornece as transformações. Esse valor deve ser a ID do aplicativo criada para a função ou aplicativo quando ele foi registrado no Azure Active Directory. Quando especificada, a habilidade personalizada se conecta à função ou ao aplicativo usando um ID gerenciado (atribuído pelo sistema ou pelo usuário) do serviço de pesquisa e o token de acesso da função ou do aplicativo, usando esse valor como o ID do recurso para criar o escopo do token de acesso.
batchSize	integer (int32)	O tamanho do lote desejado que indica o número de documentos.
context	string	Representa o nível em que as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document.
degreeOfParallelism	integer (int32)	Se definido, o número de chamadas paralelas que podem ser feitas para a API 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 upstream.
name	string	O nome da habilidade que a identifica exclusivamente no conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixado com o caractere '#'.
outputs	OutputFieldMappingEntry[]	A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como 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 da API Web.