Partilhar via


Serviços Cognitivos do Azure para Linguagem

O Azure Cognitive Service for Language, anteriormente conhecido como conector 'Análise de Texto', deteta idioma, sentimento e muito mais do texto que fornece.

Este conector está disponível nos seguintes produtos e regiões:

Serviço Class Regiões
Estúdio Copiloto Standard Todas as regiões do Power Automate
Aplicações Lógicas Standard Todas as regiões do Logic Apps
Aplicações Power Standard Todas as regiões do Power Apps
Automatize o poder Standard Todas as regiões do Power Automate
Contato
Nome Microsoft
URL https://gallery.cortanaanalytics.com/MachineLearningAPI/Text-Analytics-2
Email mlapi@microsoft.com
Metadados do conector
Editora Microsoft
Sítio Web https://azure.microsoft.com/services/cognitive-services/text-analytics/

Observação

Este conector era anteriormente conhecido como "Text Analytics" ou "Microsoft Cognitive Services Text Analytics".

Para usar essa integração, você precisará de um recurso do Serviço Cognitivo no portal do Azure. Você receberá um ponto de extremidade e uma chave para autenticar seus aplicativos. Para estabelecer uma ligação, forneça a chave da conta, o URL do site e selecione Criar ligação. Para saber mais sobre os custos de operação da sua conexão, saiba mais aqui.

Agora você está pronto para começar a usar essa integração.

Conectando-se com o Microsoft Entra ID

Para criar conexões com o Microsoft Entra ID, você deve adicionar a função Usuário de Serviços Cognitivos à sua conta para acessar. Para usar essa conexão, você deve inserir o subdomínio exclusivo associado ao seu recurso de Serviços Cognitivos nas operações de suporte.

Operações não suportadas com a autenticação do Microsoft Entra ID

Ao usar a autenticação do Microsoft Entra ID , apenas as ações V4 são suportadas. As ações preteridas continuarão a funcionar com Access Key autenticação, mas falharão se usadas com uma conexão de ID do Microsoft Entra.

A criar uma ligação

O conector suporta os seguintes tipos de autenticação:

Chave Api ApiKey Todas as regiões Compartilhável
Padrão [DEPRECATED] Esta opção é apenas para conexões mais antigas sem um tipo de autenticação explícita e é fornecida apenas para compatibilidade com versões anteriores. Todas as regiões Não compartilhável

Chave Api

ID de autenticação: keyBasedAuth

Aplicável: Todas as regiões

ApiKey

Esta é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, a conexão também será compartilhada. Para obter mais informações, consulte a Visão geral de conectores para aplicativos de tela - Power Apps | Documentos Microsoft

Nome Tipo Description Obrigatório
Chave da conta securestring Chave de Conta dos Serviços Cognitivos Verdade
Site URL cadeia (de caracteres) URL do site raiz (exemplo: https://westus.api.cognitive.microsoft.com)

Padrão [DEPRECATED]

Aplicável: Todas as regiões

Esta opção é apenas para conexões mais antigas sem um tipo de autenticação explícita e é fornecida apenas para compatibilidade com versões anteriores.

Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Nome Tipo Description Obrigatório
Chave da conta securestring Chave de Conta dos Serviços Cognitivos Verdade
Site URL cadeia (de caracteres) URL do site raiz (Exemplo: https://westus.api.cognitive.microsoft.com). Se não for especificado, o URL do site será padronizado para https://westus.api.cognitive.microsoft.com.

Limites de Limitação

Name Chamadas Período de Renovação
Chamadas de API por conexão 1200 60 segundos

Ações

Análise de sentimento assíncrona (2022-05-01)

Envie uma coleção de documentos de texto para análise de sentimento.

Assíncrono AbstractiveSummarization (2022-10-01-preview)

Enviar uma coleção de documentos de texto para resumo abstrato

Assíncrono PiiEntityRecognition (2022-05-01)

Envie uma coleção de documentos de texto para análise de reconhecimento de entidade pessoal.

Async CustomEntityRecognition (01/05/2022)

Envie uma coleção de documentos de texto para análise personalizada de reconhecimento de entidade.

Async CustomMultiLabelClassification (01/05/2022)

Envie uma coleção de documentos de texto para análise personalizada de classificação única.

Async CustomSingleLabelClassification (01/05/2022)

Envie uma coleção de documentos de texto para análise personalizada de classificação única.

Async EntityLinking (01/05/2022)

Envie uma coleção de documentos de texto para análise de vinculação de entidades.

Async EntityRecognition (2022-05-01)

Envie uma coleção de documentos de texto para análise de reconhecimento de entidade.

Async ExtractiveSummarization (2022-10-01-pré-visualização)

Enviar uma coleção de documentos de texto para resumo extrativo

Conversas (CLU) (2022-05-01)

Analisa o enunciado da conversa de entrada.

Conversas (Orquestração) (2022-05-01)

Analisa o enunciado da conversa de entrada.

Detetar entidades (V2) [DEPRECATED]

Esta ação foi preterida. Em vez disso, use o Reconhecimento de Entidade Nomeada (V4).

Devolve uma lista de entidades conhecidas e entidades nomeadas gerais ("Pessoa", "Localização", "Organização" etc.) num determinado documento.

Detetar idioma (V2) [DEPRECATED]

Esta ação foi preterida. Em vez disso, use Detect Language (V4).

Devolve o idioma detetado e uma pontuação numérica entre 0 e 1 para cada documento. Pontuações próximas a 1 indicam 100% de certeza de que a língua identificada é verdadeira. Um total de 120 idiomas são suportados.

Detetar idioma (V3.0)

A API retorna o idioma detetado e uma pontuação numérica entre 0 e 1. Pontuações próximas a 1 indicam 100% de certeza de que a língua identificada é verdadeira. Consulte o Suporte de idiomas para deteção de idioma para obter a lista de idiomas suportados.

Detetar idioma (v3.1) (visualização)

A API retorna o idioma detetado e uma pontuação numérica entre 0 e 1. Pontuações próximas a 1 indicam 100% de certeza de que a língua identificada é verdadeira. Consulte o Suporte de idiomas para deteção de idioma para obter a lista de idiomas suportados.

Detetar idioma (V4) (visualização)

A API retorna o idioma detetado e uma pontuação numérica entre 0 e 1. Pontuações próximas a 1 indicam 100% de certeza de que a língua identificada é verdadeira. Consulte o Suporte de idiomas para deteção de idioma para obter a lista de idiomas suportados.

Detetar idioma [DEPRECATED]

Esta ação foi preterida. Em vez disso, use Detect Language (V4).

Devolve o idioma detetado e uma pontuação numérica entre 0 e 1. Pontuações próximas a 1 indicam 100% de certeza de que a língua identificada é verdadeira. Um total de 120 idiomas são suportados.

Detetar idioma [DEPRECATED]

Esta ação foi preterida. Em vez disso, use Detect Language (V4).

Devolve o idioma detetado e uma pontuação numérica entre 0 e 1. Pontuações próximas a 1 indicam 100% de certeza de que a língua identificada é verdadeira. Um total de 120 idiomas são suportados.

Detetar informações pessoais (V3.1)

A API devolve uma lista de entidades com informações pessoais ("SSN", "Conta Bancária", etc.) no documento. Para obter a lista de tipos de entidade suportados, verifique as categorias de entidade de Informações de Identificação Pessoal (PII) suportadas. Consulte Idiomas suportados no Serviço Cognitivo do Azure para Idioma para obter a lista de idiomas suportados.

Detetar informações pessoais (V4) (visualização)

A API devolve uma lista de entidades com informações pessoais ("SSN", "Conta Bancária", etc.) no documento. Para obter a lista de tipos de entidade suportados, verifique as categorias de entidade de Informações de Identificação Pessoal (PII) suportadas. Consulte Idiomas suportados no Serviço Cognitivo do Azure para Idioma para obter a lista de idiomas suportados.

Detetar sentimento (v2) [DEPRECATED]

Esta ação foi preterida. Em vez disso, use Sentiment (V4).

Devolve uma pontuação numérica entre 0 e 1 para cada documento. As pontuações próximas de 1 indicam um sentimento positivo, enquanto as pontuações próximas de 0 indicam um sentimento negativo.

Detetar sentimento [DEPRECATED]

Esta ação foi preterida. Em vez disso, use Sentiment (V4).

Devolve uma pontuação numérica entre 0 e 1. As pontuações próximas de 1 indicam um sentimento positivo, enquanto as pontuações próximas de 0 indicam um sentimento negativo. Atualmente, os seguintes idiomas são suportados: Inglês, Espanhol, Francês, Português.

Detetar sentimento [DEPRECATED]

Esta ação foi preterida. Em vez disso, use Sentiment (V4).

Devolve uma pontuação numérica entre 0 e 1. As pontuações próximas de 1 indicam um sentimento positivo, enquanto as pontuações próximas de 0 indicam um sentimento negativo.

Entidades [DEPRECATED]

Esta ação foi preterida. Em vez disso, use o Reconhecimento de Entidade Nomeada (V4).

Devolve uma lista de entidades conhecidas e entidades nomeadas gerais ("Pessoa", "Localização", "Organização" etc.) num determinado documento.

Frases-chave (V2) [PRETERIDO]

Esta ação foi preterida. Em vez disso, utilize Frases-chave (V4).

Retorna uma lista de cadeias de caracteres que denotam os principais pontos de discussão no texto de entrada de cada documento.

Frases-chave (V3.0)

A API retorna uma lista de cadeias de caracteres que indicam as frases-chave no texto de entrada. Consulte o Suporte a idiomas para Extração de frases-chave para obter a lista de idiomas suportados.

Frases-chave (v3.1) (Pré-visualização)

A API retorna uma lista de cadeias de caracteres que indicam as frases-chave no texto de entrada. Consulte o Suporte a idiomas para Extração de frases-chave para obter a lista de idiomas suportados.

Frases-chave (V4) (Pré-visualização)

A API retorna uma lista de cadeias de caracteres que indicam as frases-chave no texto de entrada. Consulte o Suporte a idiomas para Extração de frases-chave para obter a lista de idiomas suportados.

Frases-chave [DEPRECATED]

Esta ação foi preterida. Em vez disso, utilize Frases-chave (V4).

Retorna uma lista de cadeias de caracteres que denotam os principais pontos de discussão no texto de entrada. Atualmente, os seguintes idiomas são suportados: Inglês, Alemão, Espanhol e Japonês.

Frases-chave [DEPRECATED]

Esta ação foi preterida. Em vez disso, utilize Frases-chave (V4).

Retorna uma lista de cadeias de caracteres que denotam os principais pontos de discussão no texto de entrada.

Frases-chave assíncronas (2022-05-01)

Envie uma coleção de documentos de texto para análise de extração de frases-chave.

Gerar resposta do Project

Esta ação ajuda a responder à pergunta especificada usando sua base de conhecimento em seu projeto.

PII de conversação assíncrona (texto) (2022-05-15-preview)

Envie uma coleção de conversas para análise. Especifique uma ou mais tarefas exclusivas a serem executadas.

PII de conversação assíncrona (transcrição) (2022-05-15-preview)

Envie uma coleção de conversas para análise. Especifique uma ou mais tarefas exclusivas a serem executadas.

Reconhecimento de entidade nomeada (V3.0)

A API retorna uma lista de entidades nomeadas gerais em um determinado documento. Para obter a lista de tipos de entidade suportados, marque Categorias de entidade NER (Reconhecimento de Entidade Nomeada com Suporte).

Reconhecimento de entidade nomeada (v3.1) (visualização)

A API retorna uma lista de entidades nomeadas gerais em um determinado documento. Para obter a lista de tipos de entidade suportados, marque Categorias de entidade NER (Reconhecimento de Entidade Nomeada com Suporte).

Reconhecimento de entidade nomeada (v4) (visualização)

A API retorna uma lista de entidades nomeadas gerais em um determinado documento. Para obter a lista de tipos de entidade suportados, marque Categorias de entidade NER (Reconhecimento de Entidade Nomeada com Suporte).

Saúde assíncrona (2022-05-01)

Envie uma coleção de documentos de texto para análise de cuidados de saúde.

Sentimento (V3.0)

A API retorna uma previsão de sentimento, bem como pontuações de sentimento para cada classe de sentimento (Positivo, Negativo e Neutro) para o documento e cada frase dentro dele. Consulte o suporte ao idioma Análise de Sentimento e Mineração de Opinião para obter a lista de idiomas suportados.

Sentimento (v3.1) (Pré-visualização)

A API retorna uma análise de sentimento detalhada para o texto de entrada. A análise é feita em vários níveis de granularidade, desde o nível de um documento, até a frase e termos-chave (metas e avaliações).

Sentimento (V4) (Pré-visualização)

A API retorna uma análise de sentimento detalhada para o texto de entrada. A análise é feita em vários níveis de granularidade, desde o nível de um documento, até a frase e termos-chave (metas e avaliações).

Sumarização de conversa assíncrona (2022-05-15-preview)

Envie uma coleção de conversas para análise. Especifique uma ou mais tarefas exclusivas a serem executadas.

Vinculação de entidade (V3.0)

A API retorna uma lista de entidades reconhecidas com links para uma base de dados de conhecimento conhecida. Consulte o suporte a idiomas para obter a lista de idiomas suportados.

Vinculação de entidade (v3.1) (visualização)

A API retorna uma lista de entidades reconhecidas com links para uma base de dados de conhecimento conhecida. Consulte o suporte a idiomas para obter a lista de idiomas suportados.

Vinculação de entidade (V4) (visualização)

A API retorna uma lista de entidades reconhecidas com links para uma base de dados de conhecimento conhecida. Consulte o suporte a idiomas para obter a lista de idiomas suportados.

Análise de sentimento assíncrona (2022-05-01)

Envie uma coleção de documentos de texto para análise de sentimento.

Parâmetros

Name Chave Necessário Tipo Description
id
id True string

Um identificador de documento exclusivo e não vazio.

enviar SMS
text True string

O texto de entrada a ser processado.

linguagem
language string

(Opcional) Esta é a representação de 2 letras ISO 639-1 de uma língua. Por exemplo, use "en" para inglês; "es" para espanhol, etc. Se não estiver definido, use "en" para inglês como padrão.

opiniãoMineração
opinionMining boolean

Devoluções

Assíncrono AbstractiveSummarization (2022-10-01-preview)

Enviar uma coleção de documentos de texto para resumo abstrato

Parâmetros

Name Chave Necessário Tipo Description
id
id True string

Um identificador de documento exclusivo e não vazio.

enviar SMS
text True string

O texto de entrada a ser processado.

linguagem
language string

(Opcional) Esta é a representação de 2 letras ISO 639-1 de uma língua. Por exemplo, use "en" para inglês; "es" para espanhol, etc. Se não estiver definido, use "en" para inglês como padrão.

contagem de sentenças
sentenceCount integer

Controla o número aproximado de frases nos resumos de saída.

Devoluções

Assíncrono PiiEntityRecognition (2022-05-01)

Envie uma coleção de documentos de texto para análise de reconhecimento de entidade pessoal.

Parâmetros

Name Chave Necessário Tipo Description
id
id True string

Um identificador de documento exclusivo e não vazio.

enviar SMS
text True string

O texto de entrada a ser processado.

linguagem
language string

(Opcional) Esta é a representação de 2 letras ISO 639-1 de uma língua. Por exemplo, use "en" para inglês; "es" para espanhol, etc. Se não estiver definido, use "en" para inglês como padrão.

domínio
domain string

O domínio PII usado para reconhecimento de entidade PII.

piiCategorias
piiCategories array of string

(Opcional) descreve as categorias de PII a serem retornadas

Devoluções

Async CustomEntityRecognition (01/05/2022)

Envie uma coleção de documentos de texto para análise personalizada de reconhecimento de entidade.

Parâmetros

Name Chave Necessário Tipo Description
id
id True string

Um identificador de documento exclusivo e não vazio.

enviar SMS
text True string

O texto de entrada a ser processado.

linguagem
language string

(Opcional) Esta é a representação de 2 letras ISO 639-1 de uma língua. Por exemplo, use "en" para inglês; "es" para espanhol, etc. Se não estiver definido, use "en" para inglês como padrão.

nome_do_projeto
projectName True string

Este campo indica o nome do projeto para o modelo.

nomeDeImplementação
deploymentName True string

Este campo indica o nome da implantação para o modelo.

Devoluções

Async CustomMultiLabelClassification (01/05/2022)

Envie uma coleção de documentos de texto para análise personalizada de classificação única.

Parâmetros

Name Chave Necessário Tipo Description
id
id True string

Um identificador de documento exclusivo e não vazio.

enviar SMS
text True string

O texto de entrada a ser processado.

linguagem
language string

(Opcional) Esta é a representação de 2 letras ISO 639-1 de uma língua. Por exemplo, use "en" para inglês; "es" para espanhol, etc. Se não estiver definido, use "en" para inglês como padrão.

nome_do_projeto
projectName True string

Este campo indica o nome do projeto para o modelo.

nomeDeImplementação
deploymentName True string

Este campo indica o nome da implantação para o modelo.

Devoluções

Async CustomSingleLabelClassification (01/05/2022)

Envie uma coleção de documentos de texto para análise personalizada de classificação única.

Parâmetros

Name Chave Necessário Tipo Description
id
id True string

Um identificador de documento exclusivo e não vazio.

enviar SMS
text True string

O texto de entrada a ser processado.

linguagem
language string

(Opcional) Esta é a representação de 2 letras ISO 639-1 de uma língua. Por exemplo, use "en" para inglês; "es" para espanhol, etc. Se não estiver definido, use "en" para inglês como padrão.

nome_do_projeto
projectName True string

Este campo indica o nome do projeto para o modelo.

nomeDeImplementação
deploymentName True string

Este campo indica o nome da implantação para o modelo.

Devoluções

Async EntityLinking (01/05/2022)

Envie uma coleção de documentos de texto para análise de vinculação de entidades.

Parâmetros

Name Chave Necessário Tipo Description
id
id True string

Um identificador de documento exclusivo e não vazio.

enviar SMS
text True string

O texto de entrada a ser processado.

linguagem
language string

(Opcional) Esta é a representação de 2 letras ISO 639-1 de uma língua. Por exemplo, use "en" para inglês; "es" para espanhol, etc. Se não estiver definido, use "en" para inglês como padrão.

Devoluções

Async EntityRecognition (2022-05-01)

Envie uma coleção de documentos de texto para análise de reconhecimento de entidade.

Parâmetros

Name Chave Necessário Tipo Description
id
id True string

Um identificador de documento exclusivo e não vazio.

enviar SMS
text True string

O texto de entrada a ser processado.

linguagem
language string

(Opcional) Esta é a representação de 2 letras ISO 639-1 de uma língua. Por exemplo, use "en" para inglês; "es" para espanhol, etc. Se não estiver definido, use "en" para inglês como padrão.

Devoluções

Async ExtractiveSummarization (2022-10-01-pré-visualização)

Enviar uma coleção de documentos de texto para resumo extrativo

Parâmetros

Name Chave Necessário Tipo Description
id
id True string

Um identificador de documento exclusivo e não vazio.

enviar SMS
text True string

O texto de entrada a ser processado.

linguagem
language string

(Opcional) Esta é a representação de 2 letras ISO 639-1 de uma língua. Por exemplo, use "en" para inglês; "es" para espanhol, etc. Se não estiver definido, use "en" para inglês como padrão.

contagem de sentenças
sentenceCount integer
ordenarPor
sortBy string

Os critérios de classificação a utilizar para os resultados da Sumarização Extrativa.

Devoluções

Conversas (CLU) (2022-05-01)

Analisa o enunciado da conversa de entrada.

Parâmetros

Name Chave Necessário Tipo Description
linguagem
language string

A linguagem de substituição de um item de conversação na representação linguística do BCP 47.

enviar SMS
text True string

A entrada de texto

nome_do_projeto
projectName True string

O nome do projeto a ser usado.

nomeDeImplementação
deploymentName True string

O nome da implantação a ser usada.

verbose
verbose boolean

Se verdadeiro, o serviço retornará informações mais detalhadas na resposta.

Devoluções

Os resultados de uma tarefa de conversação.

Conversas (Orquestração) (2022-05-01)

Analisa o enunciado da conversa de entrada.

Parâmetros

Name Chave Necessário Tipo Description
linguagem
language string

A linguagem de substituição de um item de conversação na representação linguística do BCP 47.

enviar SMS
text True string

A entrada de texto

nome_do_projeto
projectName True string

O nome do projeto a ser usado.

nomeDeImplementação
deploymentName True string

O nome da implantação a ser usada.

verbose
verbose boolean

Se verdadeiro, o serviço retornará informações mais detalhadas na resposta.

directTarget
directTarget string

O nome de um projeto de destino para o qual encaminhar a solicitação.

targetProjectParameters
targetProjectParameters object

Um dicionário que representa os parâmetros para cada projeto de destino.

Devoluções

Os resultados de uma tarefa de conversação.

Detetar entidades (V2) [DEPRECATED]

Esta ação foi preterida. Em vez disso, use o Reconhecimento de Entidade Nomeada (V4).

Devolve uma lista de entidades conhecidas e entidades nomeadas gerais ("Pessoa", "Localização", "Organização" etc.) num determinado documento.

Parâmetros

Name Chave Necessário Tipo Description
Id
id True string

Identificador de documento exclusivo e não vazio.

Texto
text True string

O texto a analisar.

Linguagem
language string

Esta é a representação de 2 letras ISO 639-1 de uma língua. Por exemplo, use "en" para inglês; "es" para espanhol, etc.,

Devoluções

Detetar idioma (V2) [DEPRECATED]

Esta ação foi preterida. Em vez disso, use Detect Language (V4).

Devolve o idioma detetado e uma pontuação numérica entre 0 e 1 para cada documento. Pontuações próximas a 1 indicam 100% de certeza de que a língua identificada é verdadeira. Um total de 120 idiomas são suportados.

Parâmetros

Name Chave Necessário Tipo Description
Id
id True string

Identificador de documento exclusivo e não vazio.

Texto
text True string

O texto a analisar.

Devoluções

Detetar idioma (V3.0)

A API retorna o idioma detetado e uma pontuação numérica entre 0 e 1. Pontuações próximas a 1 indicam 100% de certeza de que a língua identificada é verdadeira. Consulte o Suporte de idiomas para deteção de idioma para obter a lista de idiomas suportados.

Parâmetros

Name Chave Necessário Tipo Description
Versão do modelo
model-version string

(Opcional) Esse valor indica qual modelo será usado para pontuação. Se uma versão do modelo não for especificada, a API deverá usar como padrão a versão mais recente, não visualizada.

Mostrar estatísticas
showStats boolean

(Opcional) se definido como true, a resposta conterá estatísticas de entrada e de nível de documento.

id
id True string

Identificador de documento exclusivo e não vazio.

enviar SMS
text True string
countryDica
countryHint string

Devoluções

Detetar idioma (v3.1) (visualização)

A API retorna o idioma detetado e uma pontuação numérica entre 0 e 1. Pontuações próximas a 1 indicam 100% de certeza de que a língua identificada é verdadeira. Consulte o Suporte de idiomas para deteção de idioma para obter a lista de idiomas suportados.

Parâmetros

Name Chave Necessário Tipo Description
versão-modelo
model-version string

(Opcional) Esse valor indica qual modelo será usado para pontuação. Se uma versão do modelo não for especificada, a API deverá usar como padrão a versão mais recente, não visualizada.

showStats
showStats boolean

(Opcional) se definido como true, a resposta conterá estatísticas de solicitação e nível de documento.

loggingOptOut
loggingOptOut boolean

(Opcional) Se definido como true, você opta por não ter sua entrada de texto registrada para solução de problemas. Por padrão, o Serviço Cognitivo do Azure para Idiomas registra seu texto de entrada por 48 horas, exclusivamente para permitir a solução de problemas no fornecimento do Serviço Cognitivo do Azure para funções de processamento de linguagem natural de linguagem. Definir esse parâmetro como true desativa o log de entrada e pode limitar nossa capacidade de corrigir problemas que ocorrem. Consulte as notas de Conformidade e Privacidade dos Serviços Cognitivos em https://aka.ms/cs-compliance para obter detalhes adicionais e os princípios de IA Responsável da Microsoft em https://www.microsoft.com/en-us/ai/responsible-ai.

id
id True string

Identificador de documento exclusivo e não vazio.

enviar SMS
text True string
countryDica
countryHint string

Devoluções

Detetar idioma (V4) (visualização)

A API retorna o idioma detetado e uma pontuação numérica entre 0 e 1. Pontuações próximas a 1 indicam 100% de certeza de que a língua identificada é verdadeira. Consulte o Suporte de idiomas para deteção de idioma para obter a lista de idiomas suportados.

Parâmetros

Name Chave Necessário Tipo Description
Subdomínio ou Região de Recursos
subdomain True string

Subdomínio ou região geográfica do Azure (por exemplo, westus)

versão-modelo
model-version string

(Opcional) Esse valor indica qual modelo será usado para pontuação. Se uma versão do modelo não for especificada, a API deverá usar como padrão a versão mais recente, não visualizada.

showStats
showStats boolean

(Opcional) se definido como true, a resposta conterá estatísticas de solicitação e nível de documento.

loggingOptOut
loggingOptOut boolean

(Opcional) Se definido como true, você opta por não ter sua entrada de texto registrada para solução de problemas. Por padrão, o Serviço Cognitivo do Azure para Idiomas registra seu texto de entrada por 48 horas, exclusivamente para permitir a solução de problemas no fornecimento do Serviço Cognitivo do Azure para funções de processamento de linguagem natural de linguagem. Definir esse parâmetro como true desativa o log de entrada e pode limitar nossa capacidade de corrigir problemas que ocorrem. Consulte as notas de Conformidade e Privacidade dos Serviços Cognitivos em https://aka.ms/cs-compliance para obter detalhes adicionais e os princípios de IA Responsável da Microsoft em https://www.microsoft.com/en-us/ai/responsible-ai.

id
id True string

Identificador de documento exclusivo e não vazio.

enviar SMS
text True string
countryDica
countryHint string

Devoluções

Detetar idioma [DEPRECATED]

Esta ação foi preterida. Em vez disso, use Detect Language (V4).

Devolve o idioma detetado e uma pontuação numérica entre 0 e 1. Pontuações próximas a 1 indicam 100% de certeza de que a língua identificada é verdadeira. Um total de 120 idiomas são suportados.

Parâmetros

Name Chave Necessário Tipo Description
Texto
text string

O texto a analisar.

Número de línguas
numberOfLanguagesToDetect integer

O número de idiomas a detetar. Definido como 1 por padrão.

Devoluções

Detetar idioma [DEPRECATED]

Esta ação foi preterida. Em vez disso, use Detect Language (V4).

Devolve o idioma detetado e uma pontuação numérica entre 0 e 1. Pontuações próximas a 1 indicam 100% de certeza de que a língua identificada é verdadeira. Um total de 120 idiomas são suportados.

Parâmetros

Name Chave Necessário Tipo Description
Texto
text string

O texto a analisar.

Devoluções

Detetar informações pessoais (V3.1)

A API devolve uma lista de entidades com informações pessoais ("SSN", "Conta Bancária", etc.) no documento. Para obter a lista de tipos de entidade suportados, verifique as categorias de entidade de Informações de Identificação Pessoal (PII) suportadas. Consulte Idiomas suportados no Serviço Cognitivo do Azure para Idioma para obter a lista de idiomas suportados.

Parâmetros

Name Chave Necessário Tipo Description
versão-modelo
model-version string

(Opcional) Esse valor indica qual modelo será usado para pontuação. Se uma versão do modelo não for especificada, a API deverá usar como padrão a versão mais recente, não visualizada.

showStats
showStats boolean

(Opcional) se definido como true, a resposta conterá estatísticas de solicitação e nível de documento.

loggingOptOut
loggingOptOut boolean

(Opcional) Se definido como true, você opta por não ter sua entrada de texto registrada para solução de problemas. Por padrão, o Serviço Cognitivo do Azure para Idiomas registra seu texto de entrada por 48 horas, exclusivamente para permitir a solução de problemas no fornecimento do Serviço Cognitivo do Azure para funções de processamento de linguagem natural de linguagem. Definir esse parâmetro como true desativa o log de entrada e pode limitar nossa capacidade de corrigir problemas que ocorrem. Consulte as notas de Conformidade e Privacidade dos Serviços Cognitivos em https://aka.ms/cs-compliance para obter detalhes adicionais e os princípios de IA Responsável da Microsoft em https://www.microsoft.com/en-us/ai/responsible-ai.

domínio
domain string

(Opcional), se especificado, definirá o domínio PII para incluir apenas um subconjunto das categorias de entidade. Os valores possíveis incluem: 'PHI', 'none'.

stringIndexType
stringIndexType string

(Opcional) Especifica o método usado para interpretar deslocamentos de cadeia de caracteres. O padrão é Elementos de texto (grafemas) de acordo com Unicode v8.0.0. Para obter informações adicionais, consulte https://aka.ms/text-analytics-offsets

piiCategorias
piiCategories array

(Opcional) descreve as categorias de PII a serem retornadas

id
id True string

Um identificador de documento exclusivo e não vazio.

enviar SMS
text True string

O texto de entrada a ser processado.

linguagem
language string

(Opcional) Esta é a representação de 2 letras ISO 639-1 de uma língua. Por exemplo, use "en" para inglês; "es" para espanhol, etc. Se não estiver definido, use "en" para inglês como padrão.

Devoluções

Body
PiiResult

Detetar informações pessoais (V4) (visualização)

A API devolve uma lista de entidades com informações pessoais ("SSN", "Conta Bancária", etc.) no documento. Para obter a lista de tipos de entidade suportados, verifique as categorias de entidade de Informações de Identificação Pessoal (PII) suportadas. Consulte Idiomas suportados no Serviço Cognitivo do Azure para Idioma para obter a lista de idiomas suportados.

Parâmetros

Name Chave Necessário Tipo Description
Subdomínio ou Região de Recursos
subdomain True string

Subdomínio ou região geográfica do Azure (por exemplo, westus)

versão-modelo
model-version string

(Opcional) Esse valor indica qual modelo será usado para pontuação. Se uma versão do modelo não for especificada, a API deverá usar como padrão a versão mais recente, não visualizada.

showStats
showStats boolean

(Opcional) se definido como true, a resposta conterá estatísticas de solicitação e nível de documento.

loggingOptOut
loggingOptOut boolean

(Opcional) Se definido como true, você opta por não ter sua entrada de texto registrada para solução de problemas. Por padrão, o Serviço Cognitivo do Azure para Idiomas registra seu texto de entrada por 48 horas, exclusivamente para permitir a solução de problemas no fornecimento do Serviço Cognitivo do Azure para funções de processamento de linguagem natural de linguagem. Definir esse parâmetro como true desativa o log de entrada e pode limitar nossa capacidade de corrigir problemas que ocorrem. Consulte as notas de Conformidade e Privacidade dos Serviços Cognitivos em https://aka.ms/cs-compliance para obter detalhes adicionais e os princípios de IA Responsável da Microsoft em https://www.microsoft.com/en-us/ai/responsible-ai.

domínio
domain string

(Opcional), se especificado, definirá o domínio PII para incluir apenas um subconjunto das categorias de entidade. Os valores possíveis incluem: 'PHI', 'none'.

stringIndexType
stringIndexType string

(Opcional) Especifica o método usado para interpretar deslocamentos de cadeia de caracteres. O padrão é Elementos de texto (grafemas) de acordo com Unicode v8.0.0. Para obter informações adicionais, consulte https://aka.ms/text-analytics-offsets

piiCategorias
piiCategories array

(Opcional) descreve as categorias de PII a serem retornadas

id
id True string

Um identificador de documento exclusivo e não vazio.

enviar SMS
text True string

O texto de entrada a ser processado.

linguagem
language string

(Opcional) Esta é a representação de 2 letras ISO 639-1 de uma língua. Por exemplo, use "en" para inglês; "es" para espanhol, etc. Se não estiver definido, use "en" para inglês como padrão.

Devoluções

Body
PiiResult

Detetar sentimento (v2) [DEPRECATED]

Esta ação foi preterida. Em vez disso, use Sentiment (V4).

Devolve uma pontuação numérica entre 0 e 1 para cada documento. As pontuações próximas de 1 indicam um sentimento positivo, enquanto as pontuações próximas de 0 indicam um sentimento negativo.

Parâmetros

Name Chave Necessário Tipo Description
Id
id True string

Identificador de documento exclusivo e não vazio.

Texto
text True string

O texto a analisar.

Linguagem
language string

Esta é a representação de 2 letras ISO 639-1 de uma língua. Por exemplo, use "en" para inglês; "es" para espanhol, etc.,

Devoluções

Detetar sentimento [DEPRECATED]

Esta ação foi preterida. Em vez disso, use Sentiment (V4).

Devolve uma pontuação numérica entre 0 e 1. As pontuações próximas de 1 indicam um sentimento positivo, enquanto as pontuações próximas de 0 indicam um sentimento negativo. Atualmente, os seguintes idiomas são suportados: Inglês, Espanhol, Francês, Português.

Parâmetros

Name Chave Necessário Tipo Description
Texto
text string

O texto a analisar.

Linguagem
language string

Esta é a representação de 2 letras ISO 639-1 de uma língua. Por exemplo, use "en" para inglês; "es" para espanhol, etc.,

Devoluções

Detetar sentimento [DEPRECATED]

Esta ação foi preterida. Em vez disso, use Sentiment (V4).

Devolve uma pontuação numérica entre 0 e 1. As pontuações próximas de 1 indicam um sentimento positivo, enquanto as pontuações próximas de 0 indicam um sentimento negativo.

Parâmetros

Name Chave Necessário Tipo Description
Texto
text string

O texto a analisar.

Linguagem
language string

Esta é a representação de 2 letras ISO 639-1 de uma língua. Por exemplo, use "en" para inglês; "es" para espanhol, etc.,

Devoluções

Entidades [DEPRECATED]

Esta ação foi preterida. Em vez disso, use o Reconhecimento de Entidade Nomeada (V4).

Devolve uma lista de entidades conhecidas e entidades nomeadas gerais ("Pessoa", "Localização", "Organização" etc.) num determinado documento.

Parâmetros

Name Chave Necessário Tipo Description
Texto
text string

O texto a analisar.

Linguagem
language string

Esta é a representação de 2 letras ISO 639-1 de uma língua. Por exemplo, use "en" para inglês; "es" para espanhol, etc.,

Devoluções

Frases-chave (V2) [PRETERIDO]

Esta ação foi preterida. Em vez disso, utilize Frases-chave (V4).

Retorna uma lista de cadeias de caracteres que denotam os principais pontos de discussão no texto de entrada de cada documento.

Parâmetros

Name Chave Necessário Tipo Description
Id
id True string

Identificador de documento exclusivo e não vazio.

Texto
text True string

O texto a analisar.

Linguagem
language string

Esta é a representação de 2 letras ISO 639-1 de uma língua. Por exemplo, use "en" para inglês; "es" para espanhol, etc.,

Devoluções

Frases-chave (V3.0)

A API retorna uma lista de cadeias de caracteres que indicam as frases-chave no texto de entrada. Consulte o Suporte a idiomas para Extração de frases-chave para obter a lista de idiomas suportados.

Parâmetros

Name Chave Necessário Tipo Description
Versão do modelo
model-version string

(Opcional) Esse valor indica qual modelo será usado para pontuação. Se uma versão do modelo não for especificada, a API deverá usar como padrão a versão mais recente, não visualizada.

Mostrar estatísticas
showStats boolean

(Opcional) se definido como true, a resposta conterá estatísticas de entrada e de nível de documento.

id
id True string

Um identificador de documento exclusivo e não vazio.

enviar SMS
text True string

O texto de entrada a ser processado.

linguagem
language string

(Opcional) Esta é a representação de 2 letras ISO 639-1 de uma língua. Por exemplo, use "en" para inglês; "es" para espanhol, etc. Se não estiver definido, use "en" para inglês como padrão.

Devoluções

Frases-chave (v3.1) (Pré-visualização)

A API retorna uma lista de cadeias de caracteres que indicam as frases-chave no texto de entrada. Consulte o Suporte a idiomas para Extração de frases-chave para obter a lista de idiomas suportados.

Parâmetros

Name Chave Necessário Tipo Description
versão-modelo
model-version string

(Opcional) Esse valor indica qual modelo será usado para pontuação. Se uma versão do modelo não for especificada, a API deverá usar como padrão a versão mais recente, não visualizada.

showStats
showStats boolean

(Opcional) se definido como true, a resposta conterá estatísticas de solicitação e nível de documento.

loggingOptOut
loggingOptOut boolean

(Opcional) Se definido como true, você opta por não ter sua entrada de texto registrada para solução de problemas. Por padrão, o Serviço Cognitivo do Azure para Idiomas registra seu texto de entrada por 48 horas, exclusivamente para permitir a solução de problemas no fornecimento do Serviço Cognitivo do Azure para funções de processamento de linguagem natural de linguagem. Definir esse parâmetro como true desativa o log de entrada e pode limitar nossa capacidade de corrigir problemas que ocorrem. Consulte as notas de Conformidade e Privacidade dos Serviços Cognitivos em https://aka.ms/cs-compliance para obter detalhes adicionais e os princípios de IA Responsável da Microsoft em https://www.microsoft.com/en-us/ai/responsible-ai.

id
id True string

Um identificador de documento exclusivo e não vazio.

enviar SMS
text True string

O texto de entrada a ser processado.

linguagem
language string

(Opcional) Esta é a representação de 2 letras ISO 639-1 de uma língua. Por exemplo, use "en" para inglês; "es" para espanhol, etc. Se não estiver definido, use "en" para inglês como padrão.

Devoluções

Frases-chave (V4) (Pré-visualização)

A API retorna uma lista de cadeias de caracteres que indicam as frases-chave no texto de entrada. Consulte o Suporte a idiomas para Extração de frases-chave para obter a lista de idiomas suportados.

Parâmetros

Name Chave Necessário Tipo Description
Subdomínio ou Região de Recursos
subdomain True string

Subdomínio ou região geográfica do Azure (por exemplo, westus)

versão-modelo
model-version string

(Opcional) Esse valor indica qual modelo será usado para pontuação. Se uma versão do modelo não for especificada, a API deverá usar como padrão a versão mais recente, não visualizada.

showStats
showStats boolean

(Opcional) se definido como true, a resposta conterá estatísticas de solicitação e nível de documento.

loggingOptOut
loggingOptOut boolean

(Opcional) Se definido como true, você opta por não ter sua entrada de texto registrada para solução de problemas. Por padrão, o Serviço Cognitivo do Azure para Idiomas registra seu texto de entrada por 48 horas, exclusivamente para permitir a solução de problemas no fornecimento do Serviço Cognitivo do Azure para funções de processamento de linguagem natural de linguagem. Definir esse parâmetro como true desativa o log de entrada e pode limitar nossa capacidade de corrigir problemas que ocorrem. Consulte as notas de Conformidade e Privacidade dos Serviços Cognitivos em https://aka.ms/cs-compliance para obter detalhes adicionais e os princípios de IA Responsável da Microsoft em https://www.microsoft.com/en-us/ai/responsible-ai.

id
id True string

Um identificador de documento exclusivo e não vazio.

enviar SMS
text True string

O texto de entrada a ser processado.

linguagem
language string

(Opcional) Esta é a representação de 2 letras ISO 639-1 de uma língua. Por exemplo, use "en" para inglês; "es" para espanhol, etc. Se não estiver definido, use "en" para inglês como padrão.

Devoluções

Frases-chave [DEPRECATED]

Esta ação foi preterida. Em vez disso, utilize Frases-chave (V4).

Retorna uma lista de cadeias de caracteres que denotam os principais pontos de discussão no texto de entrada. Atualmente, os seguintes idiomas são suportados: Inglês, Alemão, Espanhol e Japonês.

Parâmetros

Name Chave Necessário Tipo Description
Texto
text string

O texto a analisar.

Linguagem
language string

Esta é a representação de 2 letras ISO 639-1 de uma língua. Por exemplo, use "en" para inglês; "es" para espanhol, etc.,

Devoluções

Frases-chave [DEPRECATED]

Esta ação foi preterida. Em vez disso, utilize Frases-chave (V4).

Retorna uma lista de cadeias de caracteres que denotam os principais pontos de discussão no texto de entrada.

Parâmetros

Name Chave Necessário Tipo Description
Texto
text string

O texto a analisar.

Linguagem
language string

Esta é a representação de 2 letras ISO 639-1 de uma língua. Por exemplo, use "en" para inglês; "es" para espanhol, etc.,

Devoluções

Frases-chave assíncronas (2022-05-01)

Envie uma coleção de documentos de texto para análise de extração de frases-chave.

Parâmetros

Name Chave Necessário Tipo Description
id
id True string

Um identificador de documento exclusivo e não vazio.

enviar SMS
text True string

O texto de entrada a ser processado.

linguagem
language string

(Opcional) Esta é a representação de 2 letras ISO 639-1 de uma língua. Por exemplo, use "en" para inglês; "es" para espanhol, etc. Se não estiver definido, use "en" para inglês como padrão.

loggingOptOut
loggingOptOut boolean

Devoluções

Gerar resposta do Project

Esta ação ajuda a responder à pergunta especificada usando sua base de conhecimento em seu projeto.

Parâmetros

Name Chave Necessário Tipo Description
Nome do Projeto
projectName True string

Este é o nome do projeto que você deseja usar.

Question
question string

Pergunta do usuário para consultar o projeto.

ID de utilizador
userId string

Identificador exclusivo para o usuário.

Início #
top integer

Número máximo de respostas a devolver para a pergunta.

Limiar de Confiança
confidenceScoreThreshold float

Pontuação mínima para as respostas. O valor varia de 0 a 1.

Tipo de ranker
rankerType string

Tipo de ranker a utilizar.

QnA ID
qnaId string

Este é o ID QnA exato para buscar no projeto.

ID QnA anterior
previousQnaId integer

Resultado anterior da resposta QnA ID.

Consulta de usuário anterior
previousUserQuery string

Consulta de usuário anterior.

chave
key string

Chave de metadados do dicionário de metadados usado no QnA.

valor
value string

Metadata Value do dicionário de metadados usado no QnA.

Junte-se a metadados com
logicalOperation string

Defina 'OR' ou 'AND' para a operação lógica correspondente para filtros de metadados.

Filtro de origem
sourceFilter string

Encontre QnAs que estão associados a qualquer uma das fontes fornecidas no projeto.

Junte filtros com
logicalOperation string

Operação lógica usada para unir o filtro de metadados com o filtro de origem.

Permitir uma resposta precisa
enable boolean

Habilite ou desabilite a previsão de Extensão de Resposta.

Limiar de Confiança
confidenceScoreThreshold float

Pontuação mínima necessária para incluir uma resposta precisa, o valor varia de 0 a 1.

Início #
topAnswersWithSpan integer

Número de respostas principais a serem consideradas para a previsão precisa de respostas de 1 a 10.

Incluir fontes não estruturadas
includeUnstructuredSources boolean

Sinalizador para habilitar a consulta sobre fontes não estruturadas.

Nome da implantação
deploymentName True string

Esta é a implantação específica do projeto que você deseja usar.

Versão da API
api-version True string

Esta é a versão da API do cliente.

Devoluções

Representa a lista de respostas às perguntas.

PII de conversação assíncrona (texto) (2022-05-15-preview)

Envie uma coleção de conversas para análise. Especifique uma ou mais tarefas exclusivas a serem executadas.

Parâmetros

Name Chave Necessário Tipo Description
id
id True string

A ID de um item de conversa.

ID do participante
participantId True string

O ID do participante de um item de conversa.

linguagem
language string

A linguagem de substituição de um item de conversação na representação linguística do BCP 47.

função
role string

O papel do participante.

enviar SMS
text True string

A entrada de texto

linguagem
language True string

O idioma do item de conversação no formato BCP-47.

domínio
domain string

Enumeração de domínios de conversação suportados.

loggingOptOut
loggingOptOut boolean
piiCategorias
piiCategories array of string

Descreve as categorias de PII a serem retornadas para deteção. Se não forem fornecidas, as categorias 'padrão' serão devolvidas, variando de acordo com o idioma.

Devoluções

Contém o status do trabalho de análise de conversas enviado, juntamente com estatísticas relacionadas.

PII de conversação assíncrona (transcrição) (2022-05-15-preview)

Envie uma coleção de conversas para análise. Especifique uma ou mais tarefas exclusivas a serem executadas.

Parâmetros

Name Chave Necessário Tipo Description
id
id True string

A ID de um item de conversa.

ID do participante
participantId True string

O ID do participante de um item de conversa.

linguagem
language string

A linguagem de substituição de um item de conversação na representação linguística do BCP 47.

função
role string

O papel do participante.

ITN
itn string

Normalização de texto inverso: representação da entrada. A forma normalizada de texto inverso é o texto reconhecido da API de Fala para Texto da Microsoft, com números de telefone, números, abreviaturas e outras transformações aplicadas.

mascaradoItn
maskedItn string

O formato Texto Inverso Normalizado com mascaramento de palavrões aplicado.

enviar SMS
text string

A forma de exibição do texto reconhecido da API de fala para texto, com pontuação e maiúsculas adicionadas.

lexical
lexical string

A forma lexical do texto reconhecido da fala para o texto API com as palavras reais reconhecidas.

word
word string

A palavra reconhecida.

offset
offset integer

Deslocamento do início do áudio de fala, em ticks. 1 tick = 100 ns.

duration
duration integer

Duração da articulação de palavras, em carrapatos. 1 tick = 100 ns.

linguagem
language True string

O idioma do item de conversação no formato BCP-47.

domínio
domain string

Enumeração de domínios de conversação suportados.

loggingOptOut
loggingOptOut boolean
piiCategorias
piiCategories array of string

Descreve as categorias de PII a serem retornadas para deteção. Se não forem fornecidas, as categorias 'padrão' serão devolvidas, variando de acordo com o idioma.

incluirAudioRedaction
includeAudioRedaction boolean

Sinalizar para indicar se a redação de áudio é solicitada. Por padrão, a redação de áudio não será executada.

redaçãoFonte
redactionSource string

Enumeração de tipos de conteúdo de transcrição suportados.

Devoluções

Contém o status do trabalho de análise de conversas enviado, juntamente com estatísticas relacionadas.

Reconhecimento de entidade nomeada (V3.0)

A API retorna uma lista de entidades nomeadas gerais em um determinado documento. Para obter a lista de tipos de entidade suportados, marque Categorias de entidade NER (Reconhecimento de Entidade Nomeada com Suporte).

Parâmetros

Name Chave Necessário Tipo Description
Versão do modelo
model-version string

(Opcional) Esse valor indica qual modelo será usado para pontuação. Se uma versão do modelo não for especificada, a API deverá usar como padrão a versão mais recente, não visualizada.

Mostrar estatísticas
showStats boolean

(Opcional) se definido como true, a resposta conterá estatísticas de entrada e de nível de documento.

id
id True string

Um identificador de documento exclusivo e não vazio.

enviar SMS
text True string

O texto de entrada a ser processado.

linguagem
language string

(Opcional) Esta é a representação de 2 letras ISO 639-1 de uma língua. Por exemplo, use "en" para inglês; "es" para espanhol, etc. Se não estiver definido, use "en" para inglês como padrão.

Devoluções

Reconhecimento de entidade nomeada (v3.1) (visualização)

A API retorna uma lista de entidades nomeadas gerais em um determinado documento. Para obter a lista de tipos de entidade suportados, marque Categorias de entidade NER (Reconhecimento de Entidade Nomeada com Suporte).

Parâmetros

Name Chave Necessário Tipo Description
versão-modelo
model-version string

(Opcional) Esse valor indica qual modelo será usado para pontuação. Se uma versão do modelo não for especificada, a API deverá usar como padrão a versão mais recente, não visualizada.

showStats
showStats boolean

(Opcional) se definido como true, a resposta conterá estatísticas de solicitação e nível de documento.

loggingOptOut
loggingOptOut boolean

(Opcional) Se definido como true, você opta por não ter sua entrada de texto registrada para solução de problemas. Por padrão, o Serviço Cognitivo do Azure para Idiomas registra seu texto de entrada por 48 horas, exclusivamente para permitir a solução de problemas no fornecimento do Serviço Cognitivo do Azure para funções de processamento de linguagem natural de linguagem. Definir esse parâmetro como true desativa o log de entrada e pode limitar nossa capacidade de corrigir problemas que ocorrem. Consulte as notas de Conformidade e Privacidade dos Serviços Cognitivos em https://aka.ms/cs-compliance para obter detalhes adicionais e os princípios de IA Responsável da Microsoft em https://www.microsoft.com/en-us/ai/responsible-ai.

stringIndexType
stringIndexType string

(Opcional) Especifica o método usado para interpretar deslocamentos de cadeia de caracteres. O padrão é Elementos de texto (grafemas) de acordo com Unicode v8.0.0. Para obter informações adicionais, consulte https://aka.ms/text-analytics-offsets

id
id True string

Um identificador de documento exclusivo e não vazio.

enviar SMS
text True string

O texto de entrada a ser processado.

linguagem
language string

(Opcional) Esta é a representação de 2 letras ISO 639-1 de uma língua. Por exemplo, use "en" para inglês; "es" para espanhol, etc. Se não estiver definido, use "en" para inglês como padrão.

Devoluções

Reconhecimento de entidade nomeada (v4) (visualização)

A API retorna uma lista de entidades nomeadas gerais em um determinado documento. Para obter a lista de tipos de entidade suportados, marque Categorias de entidade NER (Reconhecimento de Entidade Nomeada com Suporte).

Parâmetros

Name Chave Necessário Tipo Description
Subdomínio ou Região de Recursos
subdomain True string

Subdomínio ou região geográfica do Azure (por exemplo, westus)

versão-modelo
model-version string

(Opcional) Esse valor indica qual modelo será usado para pontuação. Se uma versão do modelo não for especificada, a API deverá usar como padrão a versão mais recente, não visualizada.

showStats
showStats boolean

(Opcional) se definido como true, a resposta conterá estatísticas de solicitação e nível de documento.

loggingOptOut
loggingOptOut boolean

(Opcional) Se definido como true, você opta por não ter sua entrada de texto registrada para solução de problemas. Por padrão, o Serviço Cognitivo do Azure para Idiomas registra seu texto de entrada por 48 horas, exclusivamente para permitir a solução de problemas no fornecimento do Serviço Cognitivo do Azure para funções de processamento de linguagem natural de linguagem. Definir esse parâmetro como true desativa o log de entrada e pode limitar nossa capacidade de corrigir problemas que ocorrem. Consulte as notas de Conformidade e Privacidade dos Serviços Cognitivos em https://aka.ms/cs-compliance para obter detalhes adicionais e os princípios de IA Responsável da Microsoft em https://www.microsoft.com/en-us/ai/responsible-ai.

stringIndexType
stringIndexType string

(Opcional) Especifica o método usado para interpretar deslocamentos de cadeia de caracteres. O padrão é Elementos de texto (grafemas) de acordo com Unicode v8.0.0. Para obter informações adicionais, consulte https://aka.ms/text-analytics-offsets

id
id True string

Um identificador de documento exclusivo e não vazio.

enviar SMS
text True string

O texto de entrada a ser processado.

linguagem
language string

(Opcional) Esta é a representação de 2 letras ISO 639-1 de uma língua. Por exemplo, use "en" para inglês; "es" para espanhol, etc. Se não estiver definido, use "en" para inglês como padrão.

Devoluções

Saúde assíncrona (2022-05-01)

Envie uma coleção de documentos de texto para análise de cuidados de saúde.

Parâmetros

Name Chave Necessário Tipo Description
id
id True string

Um identificador de documento exclusivo e não vazio.

enviar SMS
text True string

O texto de entrada a ser processado.

linguagem
language string

(Opcional) Esta é a representação de 2 letras ISO 639-1 de uma língua. Por exemplo, use "en" para inglês; "es" para espanhol, etc. Se não estiver definido, use "en" para inglês como padrão.

Devoluções

Sentimento (V3.0)

A API retorna uma previsão de sentimento, bem como pontuações de sentimento para cada classe de sentimento (Positivo, Negativo e Neutro) para o documento e cada frase dentro dele. Consulte o suporte ao idioma Análise de Sentimento e Mineração de Opinião para obter a lista de idiomas suportados.

Parâmetros

Name Chave Necessário Tipo Description
Versão do modelo
model-version string

(Opcional) Esse valor indica qual modelo será usado para pontuação. Se uma versão do modelo não for especificada, a API deverá usar como padrão a versão mais recente, não visualizada.

Mostrar estatísticas
showStats boolean

(Opcional) se definido como true, a resposta conterá estatísticas de entrada e de nível de documento.

id
id True string

Um identificador de documento exclusivo e não vazio.

enviar SMS
text True string

O texto de entrada a ser processado.

linguagem
language string

(Opcional) Esta é a representação de 2 letras ISO 639-1 de uma língua. Por exemplo, use "en" para inglês; "es" para espanhol, etc. Se não estiver definido, use "en" para inglês como padrão.

Devoluções

Sentimento (v3.1) (Pré-visualização)

A API retorna uma análise de sentimento detalhada para o texto de entrada. A análise é feita em vários níveis de granularidade, desde o nível de um documento, até a frase e termos-chave (metas e avaliações).

Parâmetros

Name Chave Necessário Tipo Description
versão-modelo
model-version string

(Opcional) Esse valor indica qual modelo será usado para pontuação. Se uma versão do modelo não for especificada, a API deverá usar como padrão a versão mais recente, não visualizada.

showStats
showStats boolean

(Opcional) se definido como true, a resposta conterá estatísticas de solicitação e nível de documento.

loggingOptOut
loggingOptOut boolean

(Opcional) Se definido como true, você opta por não ter sua entrada de texto registrada para solução de problemas. Por padrão, o Serviço Cognitivo do Azure para Idiomas registra seu texto de entrada por 48 horas, exclusivamente para permitir a solução de problemas no fornecimento do Serviço Cognitivo do Azure para funções de processamento de linguagem natural de linguagem. Definir esse parâmetro como true desativa o log de entrada e pode limitar nossa capacidade de corrigir problemas que ocorrem. Consulte as notas de Conformidade e Privacidade dos Serviços Cognitivos em https://aka.ms/cs-compliance para obter detalhes adicionais e os princípios de IA Responsável da Microsoft em https://www.microsoft.com/en-us/ai/responsible-ai.

opiniãoMineração
opinionMining boolean

(Opcional) se definido como true, a resposta conterá não apenas a previsão de sentimento, mas também resultados de mineração de opinião (análise de sentimento baseada em aspetos).

stringIndexType
stringIndexType string

(Opcional) Especifica o método usado para interpretar deslocamentos de cadeia de caracteres. O padrão é Elementos de texto (grafemas) de acordo com Unicode v8.0.0. Para obter informações adicionais, consulte https://aka.ms/text-analytics-offsets

id
id True string

Um identificador de documento exclusivo e não vazio.

enviar SMS
text True string

O texto de entrada a ser processado.

linguagem
language string

(Opcional) Esta é a representação de 2 letras ISO 639-1 de uma língua. Por exemplo, use "en" para inglês; "es" para espanhol, etc. Se não estiver definido, use "en" para inglês como padrão.

Devoluções

Sentimento (V4) (Pré-visualização)

A API retorna uma análise de sentimento detalhada para o texto de entrada. A análise é feita em vários níveis de granularidade, desde o nível de um documento, até a frase e termos-chave (metas e avaliações).

Parâmetros

Name Chave Necessário Tipo Description
Subdomínio ou Região de Recursos
subdomain True string

Subdomínio ou região geográfica do Azure (por exemplo, westus)

versão-modelo
model-version string

(Opcional) Esse valor indica qual modelo será usado para pontuação. Se uma versão do modelo não for especificada, a API deverá usar como padrão a versão mais recente, não visualizada.

showStats
showStats boolean

(Opcional) se definido como true, a resposta conterá estatísticas de solicitação e nível de documento.

loggingOptOut
loggingOptOut boolean

(Opcional) Se definido como true, você opta por não ter sua entrada de texto registrada para solução de problemas. Por padrão, o Serviço Cognitivo do Azure para Idiomas registra seu texto de entrada por 48 horas, exclusivamente para permitir a solução de problemas no fornecimento do Serviço Cognitivo do Azure para funções de processamento de linguagem natural de linguagem. Definir esse parâmetro como true desativa o log de entrada e pode limitar nossa capacidade de corrigir problemas que ocorrem. Consulte as notas de Conformidade e Privacidade dos Serviços Cognitivos em https://aka.ms/cs-compliance para obter detalhes adicionais e os princípios de IA Responsável da Microsoft em https://www.microsoft.com/en-us/ai/responsible-ai.

opiniãoMineração
opinionMining boolean

(Opcional) se definido como true, a resposta conterá não apenas a previsão de sentimento, mas também resultados de mineração de opinião (análise de sentimento baseada em aspetos).

stringIndexType
stringIndexType string

(Opcional) Especifica o método usado para interpretar deslocamentos de cadeia de caracteres. O padrão é Elementos de texto (grafemas) de acordo com Unicode v8.0.0. Para obter informações adicionais, consulte https://aka.ms/text-analytics-offsets

id
id True string

Um identificador de documento exclusivo e não vazio.

enviar SMS
text True string

O texto de entrada a ser processado.

linguagem
language string

(Opcional) Esta é a representação de 2 letras ISO 639-1 de uma língua. Por exemplo, use "en" para inglês; "es" para espanhol, etc. Se não estiver definido, use "en" para inglês como padrão.

Devoluções

Sumarização de conversa assíncrona (2022-05-15-preview)

Envie uma coleção de conversas para análise. Especifique uma ou mais tarefas exclusivas a serem executadas.

Parâmetros

Name Chave Necessário Tipo Description
id
id True string

A ID de um item de conversa.

ID do participante
participantId True string

O ID do participante de um item de conversa.

linguagem
language string

A linguagem de substituição de um item de conversação na representação linguística do BCP 47.

função
role string

O papel do participante.

enviar SMS
text True string

A entrada de texto

linguagem
language True string

O idioma do item de conversação no formato BCP-47.

domínio
domain string

Enumeração de domínios de conversação suportados.

loggingOptOut
loggingOptOut boolean
SumárioAspectos
summaryAspects True array of string

Devoluções

Contém o status do trabalho de análise de conversas enviado, juntamente com estatísticas relacionadas.

Vinculação de entidade (V3.0)

A API retorna uma lista de entidades reconhecidas com links para uma base de dados de conhecimento conhecida. Consulte o suporte a idiomas para obter a lista de idiomas suportados.

Parâmetros

Name Chave Necessário Tipo Description
Versão do modelo
model-version string

(Opcional) Esse valor indica qual modelo será usado para pontuação. Se uma versão do modelo não for especificada, a API deverá usar como padrão a versão mais recente, não visualizada.

Mostrar estatísticas
showStats boolean

(Opcional) se definido como true, a resposta conterá estatísticas de entrada e de nível de documento.

id
id True string

Um identificador de documento exclusivo e não vazio.

enviar SMS
text True string

O texto de entrada a ser processado.

linguagem
language string

(Opcional) Esta é a representação de 2 letras ISO 639-1 de uma língua. Por exemplo, use "en" para inglês; "es" para espanhol, etc. Se não estiver definido, use "en" para inglês como padrão.

Devoluções

Vinculação de entidade (v3.1) (visualização)

A API retorna uma lista de entidades reconhecidas com links para uma base de dados de conhecimento conhecida. Consulte o suporte a idiomas para obter a lista de idiomas suportados.

Parâmetros

Name Chave Necessário Tipo Description
versão-modelo
model-version string

(Opcional) Esse valor indica qual modelo será usado para pontuação. Se uma versão do modelo não for especificada, a API deverá usar como padrão a versão mais recente, não visualizada.

showStats
showStats boolean

(Opcional) se definido como true, a resposta conterá estatísticas de solicitação e nível de documento.

loggingOptOut
loggingOptOut boolean

(Opcional) Se definido como true, você opta por não ter sua entrada de texto registrada para solução de problemas. Por padrão, o Serviço Cognitivo do Azure para Idiomas registra seu texto de entrada por 48 horas, exclusivamente para permitir a solução de problemas no fornecimento do Serviço Cognitivo do Azure para funções de processamento de linguagem natural de linguagem. Definir esse parâmetro como true desativa o log de entrada e pode limitar nossa capacidade de corrigir problemas que ocorrem. Consulte as notas de Conformidade e Privacidade dos Serviços Cognitivos em https://aka.ms/cs-compliance para obter detalhes adicionais e os princípios de IA Responsável da Microsoft em https://www.microsoft.com/en-us/ai/responsible-ai.

stringIndexType
stringIndexType string

(Opcional) Especifica o método usado para interpretar deslocamentos de cadeia de caracteres. O padrão é Elementos de texto (grafemas) de acordo com Unicode v8.0.0. Para obter informações adicionais, consulte https://aka.ms/text-analytics-offsets

id
id True string

Um identificador de documento exclusivo e não vazio.

enviar SMS
text True string

O texto de entrada a ser processado.

linguagem
language string

(Opcional) Esta é a representação de 2 letras ISO 639-1 de uma língua. Por exemplo, use "en" para inglês; "es" para espanhol, etc. Se não estiver definido, use "en" para inglês como padrão.

Devoluções

Vinculação de entidade (V4) (visualização)

A API retorna uma lista de entidades reconhecidas com links para uma base de dados de conhecimento conhecida. Consulte o suporte a idiomas para obter a lista de idiomas suportados.

Parâmetros

Name Chave Necessário Tipo Description
Subdomínio ou Região de Recursos
subdomain True string

Subdomínio ou região geográfica do Azure (por exemplo, westus)

versão-modelo
model-version string

(Opcional) Esse valor indica qual modelo será usado para pontuação. Se uma versão do modelo não for especificada, a API deverá usar como padrão a versão mais recente, não visualizada.

showStats
showStats boolean

(Opcional) se definido como true, a resposta conterá estatísticas de solicitação e nível de documento.

loggingOptOut
loggingOptOut boolean

(Opcional) Se definido como true, você opta por não ter sua entrada de texto registrada para solução de problemas. Por padrão, o Serviço Cognitivo do Azure para Idiomas registra seu texto de entrada por 48 horas, exclusivamente para permitir a solução de problemas no fornecimento do Serviço Cognitivo do Azure para funções de processamento de linguagem natural de linguagem. Definir esse parâmetro como true desativa o log de entrada e pode limitar nossa capacidade de corrigir problemas que ocorrem. Consulte as notas de Conformidade e Privacidade dos Serviços Cognitivos em https://aka.ms/cs-compliance para obter detalhes adicionais e os princípios de IA Responsável da Microsoft em https://www.microsoft.com/en-us/ai/responsible-ai.

stringIndexType
stringIndexType string

(Opcional) Especifica o método usado para interpretar deslocamentos de cadeia de caracteres. O padrão é Elementos de texto (grafemas) de acordo com Unicode v8.0.0. Para obter informações adicionais, consulte https://aka.ms/text-analytics-offsets

id
id True string

Um identificador de documento exclusivo e não vazio.

enviar SMS
text True string

O texto de entrada a ser processado.

linguagem
language string

(Opcional) Esta é a representação de 2 letras ISO 639-1 de uma língua. Por exemplo, use "en" para inglês; "es" para espanhol, etc. Se não estiver definido, use "en" para inglês como padrão.

Devoluções

Definições

ConversationalPIITranscriptJobState

Contém o status do trabalho de análise de conversas enviado, juntamente com estatísticas relacionadas.

Name Caminho Tipo Description
nome de exibição
displayName string
createdDateTime
createdDateTime date-time
expirationDateTime
expirationDateTime date-time
jobId
jobId string
lastUpdatedDateTime
lastUpdatedDateTime date-time
estado
status string
erros
errors array of Error
Próximo Link
nextLink string
statistics
statistics ConversationRequestStatistics

se showStats=true foi especificado na solicitação, este campo conterá informações sobre a carga útil da solicitação.

concluída
tasks.completed integer

Contagem de tarefas concluídas com êxito.

com falhas
tasks.failed integer

Contagem de tarefas que falharam.

emProgresso
tasks.inProgress integer

Contagem de tarefas em andamento atualmente.

total
tasks.total integer

Contagem total de tarefas enviadas como parte do trabalho.

taskResult
tasks.taskResult ConversationalPIITranscriptResult

Resultado da operação de deteção e redação de informações pessoalmente identificáveis realizada em uma lista de conversas.

ConversationRequestStatistics

se showStats=true foi especificado na solicitação, este campo conterá informações sobre a carga útil da solicitação.

Name Caminho Tipo Description
documentosContagem
documentsCount integer

Número de documentos apresentados no pedido.

validDocumentsCount
validDocumentsCount integer

Número de documentos válidos. Isso exclui documentos vazios, com limite de tamanho excessivo ou idiomas não suportados.

erroneusDocumentsCount
erroneousDocumentsCount integer

Número de documentos inválidos. Isso inclui documentos vazios, com limite de tamanho excessivo ou sem suporte.

transactionsCount
transactionsCount integer

Número de transações para a solicitação.

conversasContagem
conversationsCount integer

Número de conversas enviadas na solicitação.

validConversationsCount
validConversationsCount integer

Número de documentos de conversas. Isso exclui documentos vazios, com limite de tamanho excessivo ou idiomas não suportados.

erroneamenteConversasContagem
erroneousConversationsCount integer

Número de documentos inválidos. Isso inclui documentos vazios, com limite de tamanho excessivo ou sem suporte.

ConversationalPIITranscriptResult

Resultado da operação de deteção e redação de informações pessoalmente identificáveis realizada em uma lista de conversas.

Name Caminho Tipo Description
lastUpdateDateTime
lastUpdateDateTime date-time

A última hora atualizada em UTC para a tarefa.

estado
status

O status da tarefa na hora da última atualização mencionada.

Nome da tarefa
taskName string
tipo
kind ConversationalPIIResultsKind

Enumeração dos resultados suportados da tarefa de Análise de Conversação.

results
results ConversationPIITranscriptResults

O resultado da deteção de PII e operação de redação para cada conversa.

ConversacionalPIIResultsKind

Enumeração dos resultados suportados da tarefa de Análise de Conversação.

ConversaPIITranscriptResults

O resultado da deteção de PII e operação de redação para cada conversa.

Name Caminho Tipo Description
conversaItens
conversations.conversationItems array of ConversationPIITranscriptItemResult

Enumeração dos resultados da operação de deteção e redação de PII para todos os itens de conversa em uma conversa.

id
conversations.id string

Identificador de conversação exclusivo e não vazio.

Advertências
conversations.warnings array of InputWarning

Avisos encontrados durante o processamento do documento.

statistics
conversations.statistics ConversationStatistics

Se showStats=true foi especificado na solicitação, este campo conterá informações sobre a carga útil da conversa.

erros
errors array of InputError

Erros por ID do documento.

statistics
statistics RequestStatistics

se showStats=true foi especificado na solicitação, este campo conterá informações sobre a carga útil da solicitação.

modelVersion
modelVersion string

Este campo indica qual modelo é usado para pontuação.

InputError

Contém detalhes de erros encontrados durante a execução de um trabalho.

Name Caminho Tipo Description
id
id string

O ID da entrada.

erro
error Error

O objeto de erro.

InputWarning

Contém detalhes dos avisos encontrados durante a execução de um trabalho.

Name Caminho Tipo Description
código
code string

Código de aviso.

mensagem
message string

Mensagem de aviso.

targetRef
targetRef string

Uma referência de ponteiro JSON indicando o objeto de destino.

ConversationStatistics

Se showStats=true foi especificado na solicitação, este campo conterá informações sobre a carga útil da conversa.

Name Caminho Tipo Description
transactionsCount
transactionsCount integer

Número de unidades de texto para o pedido.

ConversationPIITranscriptItemResult

Name Caminho Tipo Description
id
id string
redactedContent
redactedContent ConversationalPIITranscriptRedactedTranscriptContent

A resposta de conteúdo de transcrição gerada pelo serviço com todas as informações de identificação pessoal necessárias redigidas.

entidades
entities array of Entity

ConversationalPIITranscriptRedactedTranscriptContent

A resposta de conteúdo de transcrição gerada pelo serviço com todas as informações de identificação pessoal necessárias redigidas.

Name Caminho Tipo Description
ITN
itn string

A saída editada para texto inverso normalizou a entrada de formato.

mascaradoItn
maskedItn string

A saída editada para texto inverso mascarado normalizou a entrada de formato.

enviar SMS
text string

A saída editada para a entrada de formato de texto (Speech to Text 'display' da Microsoft).

lexical
lexical string

A saída editada para entrada de formato lexical.

áudioHorários
audioTimings array of AudioTiming

A lista de segmentos de áudio editados.

AudioTiming

As informações de temporização de áudio.

Name Caminho Tipo Description
offset
offset integer

Deslocamento do início do áudio de fala, em ticks. 1 tick = 100 ns.

duration
duration integer

Duração da articulação de palavras, em carrapatos. 1 tick = 100 ns.

ConversationalPIITextJobState

Contém o status do trabalho de análise de conversas enviado, juntamente com estatísticas relacionadas.

Name Caminho Tipo Description
nome de exibição
displayName string
createdDateTime
createdDateTime date-time
expirationDateTime
expirationDateTime date-time
jobId
jobId string
lastUpdatedDateTime
lastUpdatedDateTime date-time
estado
status string
erros
errors array of Error
Próximo Link
nextLink string
statistics
statistics ConversationRequestStatistics

se showStats=true foi especificado na solicitação, este campo conterá informações sobre a carga útil da solicitação.

concluída
tasks.completed integer

Contagem de tarefas concluídas com êxito.

com falhas
tasks.failed integer

Contagem de tarefas que falharam.

emProgresso
tasks.inProgress integer

Contagem de tarefas em andamento atualmente.

total
tasks.total integer

Contagem total de tarefas enviadas como parte do trabalho.

taskResult
tasks.taskResult ConversationalPIITextResult

Resultado da operação de deteção e redação de informações pessoalmente identificáveis realizada em uma lista de conversas.

ConversationalPIITextResult

Resultado da operação de deteção e redação de informações pessoalmente identificáveis realizada em uma lista de conversas.

Name Caminho Tipo Description
lastUpdateDateTime
lastUpdateDateTime date-time

A última hora atualizada em UTC para a tarefa.

estado
status

O status da tarefa na hora da última atualização mencionada.

Nome da tarefa
taskName string
tipo
kind ConversationalPIIResultsKind

Enumeração dos resultados suportados da tarefa de Análise de Conversação.

results
results ConversationPIITextResults

O resultado da deteção de PII e operação de redação para cada conversa.

ConversaPIITextResults

O resultado da deteção de PII e operação de redação para cada conversa.

Name Caminho Tipo Description
conversaItens
conversations.conversationItems array of ConversationPIITextItemResult

Enumeração dos resultados da operação de deteção e redação de PII para todos os itens de conversa em uma conversa.

id
conversations.id string

Identificador de conversação exclusivo e não vazio.

Advertências
conversations.warnings array of InputWarning

Avisos encontrados durante o processamento do documento.

statistics
conversations.statistics ConversationStatistics

Se showStats=true foi especificado na solicitação, este campo conterá informações sobre a carga útil da conversa.

erros
errors array of InputError

Erros por ID do documento.

statistics
statistics RequestStatistics

se showStats=true foi especificado na solicitação, este campo conterá informações sobre a carga útil da solicitação.

modelVersion
modelVersion string

Este campo indica qual modelo é usado para pontuação.

ConversaPIITextItemResult

Name Caminho Tipo Description
id
id string
redactedContent
redactedContent ConversationalPIITranscriptRedactedTextContent

A resposta de conteúdo de transcrição gerada pelo serviço com todas as informações de identificação pessoal necessárias redigidas.

entidades
entities array of Entity

ConversationalPIITranscriptRedactedTextContent

A resposta de conteúdo de transcrição gerada pelo serviço com todas as informações de identificação pessoal necessárias redigidas.

Name Caminho Tipo Description
enviar SMS
text string

A saída editada para a entrada de formato de texto (Speech to Text 'display' da Microsoft).

AnalyzeConversationSummarizationJobState

Contém o status do trabalho de análise de conversas enviado, juntamente com estatísticas relacionadas.

Name Caminho Tipo Description
nome de exibição
displayName string
createdDateTime
createdDateTime date-time
expirationDateTime
expirationDateTime date-time
jobId
jobId string
lastUpdatedDateTime
lastUpdatedDateTime date-time
estado
status string
erros
errors array of Error
Próximo Link
nextLink string
statistics
statistics ConversationRequestStatistics

se showStats=true foi especificado na solicitação, este campo conterá informações sobre a carga útil da solicitação.

concluída
tasks.completed integer

Contagem de tarefas concluídas com êxito.

com falhas
tasks.failed integer

Contagem de tarefas que falharam.

emProgresso
tasks.inProgress integer

Contagem de tarefas em andamento atualmente.

total
tasks.total integer

Contagem total de tarefas enviadas como parte do trabalho.

taskResult
tasks.taskResult AnalyzeConversationSummarizationResult

Resultado para a tarefa de sumarização na conversa.

AnalyzeConversationSummarizationResult

Resultado para a tarefa de sumarização na conversa.

Name Caminho Tipo Description
lastUpdateDateTime
lastUpdateDateTime date-time

A última hora atualizada em UTC para a tarefa.

estado
status

O status da tarefa na hora da última atualização mencionada.

Nome da tarefa
taskName string
tipo
kind ConversationalSummarizationResultsKind

Enumeração dos resultados suportados da tarefa de Análise de Conversação.

results
results SummaryResult

ConversationalSummarizationResultsKind

Enumeração dos resultados suportados da tarefa de Análise de Conversação.

ResumoResultado

Name Caminho Tipo Description
summaries
conversations.summaries array of SummaryResultItem
id
conversations.id string

Identificador de conversação exclusivo e não vazio.

Advertências
conversations.warnings array of InputWarning

Avisos encontrados durante o processamento do documento.

statistics
conversations.statistics ConversationStatistics

Se showStats=true foi especificado na solicitação, este campo conterá informações sobre a carga útil da conversa.

erros
errors array of InputError

Erros por ID do documento.

statistics
statistics RequestStatistics

se showStats=true foi especificado na solicitação, este campo conterá informações sobre a carga útil da solicitação.

modelVersion
modelVersion string

Este campo indica qual modelo é usado para pontuação.

SummaryResultItem

Name Caminho Tipo Description
Aspeto
aspect string
enviar SMS
text string

Erro

O objeto de erro.

Name Caminho Tipo Description
código
code ErrorCode

Código de erro legível por humanos.

mensagem
message string

Uma representação legível por humanos do erro.

destino
target string

O alvo do erro.

details
details array of Error

Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.

innererror
innererror InnerErrorModel

Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

ErrorCode

Código de erro legível por humanos.

Código de erro legível por humanos.

InnerErrorModel

Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name Caminho Tipo Description
código
code InnerErrorCode

Código de erro legível por humanos.

mensagem
message string

Mensagem de erro.

details
details object

Detalhes do erro.

destino
target string

Alvo de erro.

innererror
innererror InnerErrorModel

Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

CódigoDeErroInterno

Código de erro legível por humanos.

Código de erro legível por humanos.

LanguageCustomEntitiesResult

Name Caminho Tipo Description
Documentação
documents array of LanguageEntitiesDocumentResult

Resposta por documento

LanguageCustomLabelClassificationResult

Name Caminho Tipo Description
Documentação
documents array of LanguageClassificationDocumentResult

Resposta por documento

LanguageClassificationResult

Name Caminho Tipo Description
categoria
category string

Tipo de classificação.

confiançaScore
confidenceScore double

Pontuação de confiança entre 0 e 1 da classe reconhecida.

LanguageClassificationDocumentResult

Name Caminho Tipo Description
classe
class array of LanguageClassificationResult
id
id string

Identificador de documento exclusivo e não vazio.

IdiomaHealthcareResult

Name Caminho Tipo Description
Documentação
documents array of LanguageHealthcareEntitiesDocumentResult

IdiomaHealthcareEntitiesDocumentResult

Name Caminho Tipo Description
entidades
entities array of LanguageHealthcareEntity

Entidades de saúde.

relations
relations array of LanguageHealthcareRelation

Relações com entidades de saúde.

id
id string

Identificador de documento exclusivo e não vazio.

IdiomaHealthcareEntity

Name Caminho Tipo Description
enviar SMS
text string

Texto da entidade conforme aparece na solicitação.

categoria
category string

Categoria de Entidade de Saúde.

Subcategoria
subcategory string

(Opcional) Subtipo de entidade.

offset
offset integer

Posição inicial para o texto da entidade. O uso de diferentes valores 'stringIndexType' pode afetar o deslocamento retornado.

length
length integer

Comprimento do texto da entidade. O uso de diferentes valores 'stringIndexType' pode afetar o comprimento retornado.

confiançaScore
confidenceScore double

Escore de confiança entre 0 e 1 da entidade extraída.

asserção
assertion LanguageHealthcareAssertion
nome
name string

Nome preferencial para a entidade. Exemplo: «histologicamente» teria um «nome» de «histológico».

links
links array of LanguageHealthcareEntityLink

Referências de entidades em fontes de dados conhecidas.

IdiomaHealthcareRelation

Cada relação é um gráfico de entidade de um determinado relationType, onde todas as entidades estão conectadas e têm funções específicas dentro do contexto de relação.

Name Caminho Tipo Description
relationType
relationType string

Tipo de relação. Exemplos incluem: DosageOfMedication ou 'Frequência da Medicação', etc.

entidades
entities array of LanguageHealthcareRelationEntity

As entidades na relação.

IdiomaHealthcareAssertion

Name Caminho Tipo Description
condicionalidade
conditionality string

Descreve qualquer condicionalidade na entidade.

certeza
certainty string

Descreve a certeza e a polaridade das entidades.

associação
association string

Descreve se a entidade é o assunto do texto ou se descreve outra pessoa.

IdiomaHealthcareRelationEntity

Name Caminho Tipo Description
refª
ref string

Objeto de link de referência, usando um ponteiro JSON RFC 6901 (URI Fragment Identifier Representation), apontando para a entidade .

função
role string

Papel da entidade na relação. Por exemplo: 'Linfoma difuso de grandes células B CD20-positivo' tem as seguintes entidades com seus papéis entre parênteses: CD20 (GeneOrProtein), Positivo (Expressão), linfoma difuso de grandes células B (Diagnóstico).

Name Caminho Tipo Description
dataSource
dataSource string

Catálogo de entidades. Exemplos incluem: UMLS, CHV, MSH, etc.

id
id string

ID da entidade no catálogo de origem fornecido.

LanguageSentimentResponse

Name Caminho Tipo Description
Documentação
documents array of LanguageSentimentDocumentResult

Análise de sentimento por documento.

LanguageSentimentDocumentResult

Name Caminho Tipo Description
sentimento
sentiment string

Sentimento previsto para o documento (Negativo, Neutro, Positivo ou Misto).

Pontuação de confiança
confidenceScores LanguageSentimentConfidenceScorePerLabel

Representa os escores de confiança entre 0 e 1 em todas as classes de sentimento: positivo, neutro, negativo.

frases
sentences array of LanguageSentenceSentiment

Análise de sentimento ao nível da frase.

id
id string

Identificador de documento exclusivo e não vazio.

IdiomaSentimentConfiançaScorePerLabel

Representa os escores de confiança entre 0 e 1 em todas as classes de sentimento: positivo, neutro, negativo.

Name Caminho Tipo Description
Positivo
positive double

Pontuação de confiança para sentimento positivo

neutro
neutral double

Pontuação de confiança para sentimento neutro

Negativo
negative double

Pontuação de confiança para sentimento negativo

LanguageSentenceSentiment

Name Caminho Tipo Description
enviar SMS
text string

O texto da frase.

sentimento
sentiment string

O sentimento previsto para a sentença.

Pontuação de confiança
confidenceScores LanguageSentimentConfidenceScorePerLabel

Representa os escores de confiança entre 0 e 1 em todas as classes de sentimento: positivo, neutro, negativo.

offset
offset integer

A frase deslocada desde o início do documento.

length
length integer

A duração da frase.

targets
targets array of LanguageSentenceTarget

A matriz de alvos de sentença para a sentença.

avaliações
assessments array of LanguageSentenceAssessment

O conjunto de avaliações para a sentença.

LanguageSentenceTarget

Name Caminho Tipo Description
sentimento
sentiment string

Sentimento direcionado na frase.

Pontuação de confiança
confidenceScores LanguageTargetConfidenceScoreLabel

Representa os escores de confiança em todas as classes de sentimento: positivo e negativo.

offset
offset integer

O deslocamento do alvo desde o início da frase.

length
length integer

O comprimento do alvo.

enviar SMS
text string

O texto de destino detetado.

relations
relations array of LanguageTargetRelation

A matriz de objetos de avaliação ou de destino que está relacionada ao destino.

LanguageSentenceAssessment

Name Caminho Tipo Description
sentimento
sentiment string

Sentimento de avaliação na sentença.

Pontuação de confiança
confidenceScores LanguageTargetConfidenceScoreLabel

Representa os escores de confiança em todas as classes de sentimento: positivo e negativo.

offset
offset integer

A avaliação compensada desde o início da sentença.

length
length integer

A duração da avaliação.

enviar SMS
text string

O texto da avaliação detetado.

isNegated
isNegated boolean

O indicador que representa se a avaliação é negada.

LanguageTargetRelation

Name Caminho Tipo Description
relationType
relationType string

O tipo relacionado ao destino.

refª
ref string

O ponteiro JSON que indica o objeto vinculado.

LanguageTargetConfidenceScoreLabel

Representa os escores de confiança em todas as classes de sentimento: positivo e negativo.

Name Caminho Tipo Description
Positivo
positive double

Pontuação de confiança para sentimento positivo

Negativo
negative double

Pontuação de confiança para sentimento negativo

LanguageEntitiesResult

Name Caminho Tipo Description
Documentação
documents array of LanguageEntitiesDocumentResult

Resposta por documento

LanguageEntitiesDocumentResult

Name Caminho Tipo Description
entidades
entities array of LanguageEntity

Entidades reconhecidas no documento.

id
id string

Identificador de documento exclusivo e não vazio.

LanguageEntity

Name Caminho Tipo Description
enviar SMS
text string

Texto da entidade conforme aparece na solicitação.

categoria
category string

Tipo de entidade.

Subcategoria
subcategory string

(Opcional) Subtipo de entidade.

offset
offset integer

Posição inicial para o texto da entidade. O uso de diferentes valores 'stringIndexType' pode afetar o deslocamento retornado.

length
length integer

Comprimento do texto da entidade. O uso de diferentes valores 'stringIndexType' pode afetar o comprimento retornado.

confiançaScore
confidenceScore double

Escore de confiança entre 0 e 1 da entidade extraída.

LanguageEntityLinkingResult

Name Caminho Tipo Description
Documentação
documents array of LanguageLinkedEntitiesDocumentResult

Resposta por documento

IdiomaLinkedEntitiesDocumentResult

Name Caminho Tipo Description
entidades
entities array of LanguageLinkedEntity

Entidades reconhecidas no documento.

id
id string

Identificador de documento exclusivo e não vazio.

IdiomaLinkedEntity

Name Caminho Tipo Description
nome
name string

Nome formal de vinculação de entidade.

Jogos
matches array of LanguageMatch

Lista de instâncias Esta entidade aparece no texto.

linguagem
language string

Linguagem utilizada na fonte de dados.

id
id string

Identificador exclusivo da entidade reconhecida da fonte de dados.

URL
url string

URL da página da entidade da fonte de dados.

dataSource
dataSource string

Fonte de dados usada para extrair vinculação de entidades, como Wiki/Bing, etc.

bingId
bingId string

Identificador exclusivo da API de Pesquisa de Entidade do Bing da entidade reconhecida.

LanguageMatch

Name Caminho Tipo Description
confiançaScore
confidenceScore double

Se um item bem conhecido for reconhecido, um número decimal denotando o nível de confiança entre 0 e 1 será retornado.

enviar SMS
text string

Texto da entidade conforme aparece na solicitação.

offset
offset integer

Posição inicial do texto de correspondência da entidade.

length
length integer

Comprimento do texto correspondente à entidade.

IdiomaPiiResult

Name Caminho Tipo Description
Documentação
documents array of LanguagePiiEntitiesDocumentResult

Resposta por documento

LanguagePiiEntitiesDocumentResult

Name Caminho Tipo Description
redactedText
redactedText string

Retorna texto editado.

entidades
entities array of LanguageEntity

Entidades reconhecidas no documento.

id
id string

Identificador de documento exclusivo e não vazio.

LanguageKeyPhraseResult

Name Caminho Tipo Description
Documentação
documents array of LanguageKeyPhrasesDocumentResult

Resposta por documento

LanguageKeyPhrasesDocumentResult

Name Caminho Tipo Description
frases-chave
keyPhrases array of string

Uma lista de palavras ou frases representativas. O número de frases-chave retornadas é proporcional ao número de palavras no documento de entrada.

id
id string

Identificador de documento exclusivo e não vazio.

LanguageAnalyzeTextJobState_KPE

Name Caminho Tipo Description
taskResult
tasks.taskResult LanguageKeyPhraseExtractionLROResult

LanguageAnalyzeTextJobState_CNER

Name Caminho Tipo Description
taskResult
tasks.taskResult LanguageCustomEntityRecognitionLROResult

LanguageAnalyzeTextJobState_CSLC

Name Caminho Tipo Description
taskResult
tasks.taskResult LanguageCustomSingleLabelClassificationLROResult

LanguageAnalyzeTextJobState_CMLC

Name Caminho Tipo Description
taskResult
tasks.taskResult LanguageCustomMultiLabelClassificationLROResult

LanguageAnalyzeTextJobState_Entites

Name Caminho Tipo Description
taskResult
tasks.taskResult LanguageEntityRecognitionLROResult

LanguageAnalyzeTextJobState_Pii

Name Caminho Tipo Description
taskResult
tasks.taskResult LanguagePiiEntityRecognitionLROResult

LanguageAnalyzeTextJobState_Sentiment

Name Caminho Tipo Description
taskResult
tasks.taskResult LanguageSentimentLROResult

LanguageAnalyzeTextJobState_HealthCare

Name Caminho Tipo Description
taskResult
tasks.taskResult LanguageHealthcareLROResult

LanguageAnalyzeTextJobState_ExtractiveSummarization

Name Caminho Tipo Description
taskResult
tasks.taskResult ExtractiveSummarizationLROResult

LanguageAnalyzeTextJobState_AbstractiveSummarization

Name Caminho Tipo Description
taskResult
tasks.taskResult AbstractiveSummarizationLROResult

Um objeto que representa os resultados de uma tarefa de Sumarização Abstrativa.

LanguageAnalyzeTextJobState_EntityLinking

Name Caminho Tipo Description
taskResult
tasks.taskResult LanguageEntityLinkingLROResult

LanguageEntityRecognitionLROResult

Name Caminho Tipo Description
results
results LanguageEntitiesResult

LanguageCustomEntityRecognitionLROResult

Name Caminho Tipo Description
results
results LanguageCustomEntitiesResult

LanguageCustomSingleLabelClassificationLROResult

Name Caminho Tipo Description
results
results LanguageCustomLabelClassificationResult

IdiomaCustomMultiLabelClassificationLROResult

Name Caminho Tipo Description
results
results LanguageCustomLabelClassificationResult

LanguageEntityLinkingLROResult

Name Caminho Tipo Description
results
results LanguageEntityLinkingResult

IdiomaPiiEntityRecognitionLROResult

Name Caminho Tipo Description
results
results LanguagePiiResult

IdiomaHealthcareLROResult

Name Caminho Tipo Description
results
results LanguageHealthcareResult

LanguageSentimentLROResult

Name Caminho Tipo Description
results
results LanguageSentimentResponse

LanguageKeyPhraseExtractionLROResult

Name Caminho Tipo Description
results
results LanguageKeyPhraseResult

LanguageDocumentWarning

Name Caminho Tipo Description
código
code string

Código de erro.

mensagem
message string

Mensagem de aviso.

targetRef
targetRef string

Uma referência de ponteiro JSON indicando o objeto de destino.

DocumentError

Name Caminho Tipo Description
id
id string

ID do documento.

erro
error TextAnalyticsError

TextAnalyticsError

Name Caminho Tipo Description
código
code string

Código de erro.

mensagem
message string

Mensagem de erro.

destino
target string

Alvo de erro.

innererror
innererror InnerError
details
details array of TextAnalyticsError

Detalhes sobre erros específicos que levaram a esse erro relatado.

TextAnalyticsAviso

Name Caminho Tipo Description
código
code string

Código de erro.

mensagem
message string

Mensagem de aviso.

targetRef
targetRef string

Uma referência de ponteiro JSON indicando o objeto de destino.

InnerError

Name Caminho Tipo Description
código
code string

Código de erro.

mensagem
message string

Mensagem de erro.

details
details object

Detalhes do erro.

destino
target string

Alvo de erro.

innererror
innererror InnerError

SentimentoResposta

Name Caminho Tipo Description
Documentação
documents array of DocumentSentiment

Análise de sentimento por documento.

erros
errors array of DocumentError

Erros por ID do documento.

statistics
statistics RequestStatistics

se showStats=true foi especificado na solicitação, este campo conterá informações sobre a carga útil da solicitação.

modelVersion
modelVersion string

Este campo indica qual modelo é usado para pontuação.

DocumentSentiment

Name Caminho Tipo Description
id
id string

Identificador de documento exclusivo e não vazio.

sentimento
sentiment string

Sentimento previsto para o documento (Negativo, Neutro, Positivo ou Misto).

statistics
statistics DocumentStatistics

se showStats=true foi especificado na solicitação, este campo conterá informações sobre a carga útil do documento.

Pontuação de confiança
confidenceScores SentimentConfidenceScorePerLabel

Representa os escores de confiança entre 0 e 1 em todas as classes de sentimento: positivo, neutro, negativo.

frases
sentences array of SentenceSentiment

Análise de sentimento ao nível da frase.

Advertências
warnings array of TextAnalyticsWarning

Avisos encontrados durante o processamento do documento.

RequestStatistics

se showStats=true foi especificado na solicitação, este campo conterá informações sobre a carga útil da solicitação.

Name Caminho Tipo Description
documentosContagem
documentsCount integer

Número de documentos apresentados no pedido.

validDocumentsCount
validDocumentsCount integer

Número de documentos válidos. Isso exclui documentos vazios, com limite de tamanho excessivo ou idiomas não suportados.

erroneusDocumentsCount
erroneousDocumentsCount integer

Número de documentos inválidos. Isso inclui documentos vazios, com limite de tamanho excessivo ou sem suporte.

transactionsCount
transactionsCount integer

Número de transações para a solicitação.

DocumentStatistics

se showStats=true foi especificado na solicitação, este campo conterá informações sobre a carga útil do documento.

Name Caminho Tipo Description
caracteresContagem
charactersCount integer

Número de elementos de texto reconhecidos no documento.

transactionsCount
transactionsCount integer

Número de transações para o documento.

SentimentConfidenceScorePerLabel

Representa os escores de confiança entre 0 e 1 em todas as classes de sentimento: positivo, neutro, negativo.

Name Caminho Tipo Description
Positivo
positive double
neutro
neutral double
Negativo
negative double

SentimentoSentença

Name Caminho Tipo Description
enviar SMS
text string

O texto da frase.

sentimento
sentiment string

O sentimento previsto para a sentença.

Pontuação de confiança
confidenceScores SentimentConfidenceScorePerLabel

Representa os escores de confiança entre 0 e 1 em todas as classes de sentimento: positivo, neutro, negativo.

offset
offset integer

A frase deslocada desde o início do documento.

length
length integer

O comprimento da frase pelo padrão Unicode.

DocumentEntities

Name Caminho Tipo Description
id
id string

Identificador de documento exclusivo e não vazio.

entidades
entities array of Entity

Entidades reconhecidas no documento.

Advertências
warnings array of TextAnalyticsWarning

Avisos encontrados durante o processamento do documento.

statistics
statistics DocumentStatistics

se showStats=true foi especificado na solicitação, este campo conterá informações sobre a carga útil do documento.

PiiDocumentEntities

Name Caminho Tipo Description
id
id string

Identificador de documento exclusivo e não vazio.

redactedText
redactedText string

Retorna texto editado.

entidades
entities array of Entity

Entidades reconhecidas no documento.

Advertências
warnings array of TextAnalyticsWarning

Avisos encontrados durante o processamento do documento.

statistics
statistics DocumentStatistics

se showStats=true foi especificado na solicitação, este campo conterá informações sobre a carga útil do documento.

Entidade

Name Caminho Tipo Description
enviar SMS
text string

Texto da entidade conforme aparece na solicitação.

categoria
category string

Tipo de entidade, como Pessoa/Local/Organização/SSN, etc.

Subcategoria
subcategory string

Subtipo de entidade, como Idade/Ano/Intervalo de Tempo, etc.

offset
offset integer

Posição inicial (em caracteres Unicode) para o texto da entidade.

length
length integer

Comprimento (em caracteres Unicode) para o texto da entidade.

confiançaScore
confidenceScore double

Escore de confiança entre 0 e 1 da entidade extraída.

EntityLinkingResult

Name Caminho Tipo Description
Documentação
documents array of DocumentLinkedEntities

Resposta por documento

erros
errors array of DocumentError

Erros por ID do documento.

statistics
statistics RequestStatistics

se showStats=true foi especificado na solicitação, este campo conterá informações sobre a carga útil da solicitação.

modelVersion
modelVersion string

Este campo indica qual modelo é usado para pontuação.

DocumentLinkedEntities

Name Caminho Tipo Description
id
id string

Identificador de documento exclusivo e não vazio.

entidades
entities array of LinkedEntity

Entidades reconhecidas no documento.

Advertências
warnings array of TextAnalyticsWarning

Avisos encontrados durante o processamento do documento.

statistics
statistics DocumentStatistics

se showStats=true foi especificado na solicitação, este campo conterá informações sobre a carga útil do documento.

LinkedEntity

Name Caminho Tipo Description
nome
name string

Nome formal de vinculação de entidade.

Jogos
matches array of Match

Lista de instâncias Esta entidade aparece no texto.

linguagem
language string

Linguagem utilizada na fonte de dados.

id
id string

Identificador exclusivo da entidade reconhecida da fonte de dados.

URL
url string

URL da página da entidade da fonte de dados.

dataSource
dataSource string

Fonte de dados usada para extrair vinculação de entidades, como Wiki/Bing, etc.

Match

Name Caminho Tipo Description
confiançaScore
confidenceScore double

Se um item conhecido for reconhecido, um número decimal indicando o nível de confiança entre 0 e 1 será retornado.

enviar SMS
text string

Texto da entidade conforme aparece na solicitação.

offset
offset integer

Posição inicial (em caracteres Unicode) para o texto de correspondência de entidade.

length
length integer

Comprimento (em caracteres Unicode) para o texto de correspondência de entidade.

DocumentKeyPhrases

Name Caminho Tipo Description
id
id string

Identificador de documento exclusivo e não vazio.

frases-chave
keyPhrases array of string

Uma lista de palavras ou frases representativas. O número de frases-chave retornadas é proporcional ao número de palavras no documento de entrada.

Advertências
warnings array of TextAnalyticsWarning

Avisos encontrados durante o processamento do documento.

statistics
statistics DocumentStatistics

se showStats=true foi especificado na solicitação, este campo conterá informações sobre a carga útil do documento.

Linguagem do documento

Name Caminho Tipo Description
id
id string

Identificador de documento exclusivo e não vazio.

detectedLanguage
detectedLanguage DetectedLanguage
Advertências
warnings array of TextAnalyticsWarning

Avisos encontrados durante o processamento do documento.

statistics
statistics DocumentStatistics

se showStats=true foi especificado na solicitação, este campo conterá informações sobre a carga útil do documento.

DetectedLanguage

Name Caminho Tipo Description
nome
name string

Nome longo de um idioma detetado (por exemplo, inglês, francês).

iso6391Nome
iso6391Name string

Uma representação de duas letras da língua detetada de acordo com a norma ISO 639-1 (por exemplo, en, fr).

confiançaScore
confidenceScore double

Um índice de confiança entre 0 e 1. Pontuações próximas a 1 indicam 100% de certeza de que a língua identificada é verdadeira.

KeyPhraseResultV3

Name Caminho Tipo Description
Documentação
documents array of DocumentKeyPhrases

Resposta por documento

erros
errors array of DocumentError

Erros por ID do documento.

statistics
statistics RequestStatistics

se showStats=true foi especificado na solicitação, este campo conterá informações sobre a carga útil da solicitação.

modelVersion
modelVersion string

Este campo indica qual modelo é usado para pontuação.

EntidadesResultV3

Name Caminho Tipo Description
Documentação
documents array of DocumentEntities

Resposta por documento

erros
errors array of DocumentError

Erros por ID do documento.

statistics
statistics RequestStatistics

se showStats=true foi especificado na solicitação, este campo conterá informações sobre a carga útil da solicitação.

modelVersion
modelVersion string

Este campo indica qual modelo é usado para pontuação.

PiiResult

Name Caminho Tipo Description
Documentação
documents array of PiiDocumentEntities

Resposta por documento

erros
errors array of DocumentError

Erros por ID do documento.

statistics
statistics RequestStatistics

se showStats=true foi especificado na solicitação, este campo conterá informações sobre a carga útil da solicitação.

modelVersion
modelVersion string

Este campo indica qual modelo é usado para pontuação.

LanguageResultV3

Name Caminho Tipo Description
Documentação
documents array of DocumentLanguage

Resposta por documento

erros
errors array of DocumentError

Erros por ID do documento.

statistics
statistics RequestStatistics

se showStats=true foi especificado na solicitação, este campo conterá informações sobre a carga útil da solicitação.

modelVersion
modelVersion string

Este campo indica qual modelo é usado para pontuação.

Frase-chaveResultados

Name Caminho Tipo Description
Documentação
documents array of KeyPhraseResult

EntidadesResultados

Name Caminho Tipo Description
Documentação
documents array of EntitiesResult

IdiomaResultados

Name Caminho Tipo Description
Documentação
documents array of LanguageResult

SentimentResults

Name Caminho Tipo Description
Documentação
documents array of SentimentResult

KeyPhraseResult

Name Caminho Tipo Description
Frases-chave
keyPhrases array of string

Uma lista de palavras ou frases representativas. O número de frases-chave retornadas é proporcional ao número de palavras no documento de entrada.

Id
id string

O identificador exclusivo do documento.

EntidadesResultado

Name Caminho Tipo Description
Entities
entities array of object

Uma lista de entidades desambiguadas com links para mais informações na web (Wikipedia e Bing).

Nome
entities.name string

Nome da entidade.

Correspondências
entities.matches array of object

Uma lista de correspondências para a entidade.

items
entities.matches object
Língua da Wikipédia
entities.wikipediaLanguage string

Idioma da Wikipédia da entidade.

Id da Wikipédia
entities.wikipediaId string

Wikipedia Id da entidade.

URL da Wikipédia
entities.wikipediaUrl string

URL da Wikipédia da entidade.

Bing Id
entities.bingId string

ID do Bing da entidade.

Tipo
entities.type string

Tipo de entidade.

Subtipo
entities.subType string

Subtipo da entidade.

Id
id string

O identificador exclusivo do documento.

IdiomaResultado

Name Caminho Tipo Description
Id
id string

O identificador exclusivo do documento.

detectedLanguages
detectedLanguages array of DetectedLanguageV2

Uma lista de idiomas extraídos.

SentimentResult

Name Caminho Tipo Description
Score
score double

Um número decimal entre 0 e 1 denotando o sentimento do documento. Uma pontuação acima de 0,7 geralmente refere-se a um documento positivo, enquanto uma pontuação abaixo de 0,3 normalmente tem uma conotação negativa. Os valores médios referem-se a texto neutro.

Id
id string

O identificador exclusivo do documento.

DetectedLanguageV2

Name Caminho Tipo Description
Nome
name string

O nome longo de um idioma detetado (por exemplo, inglês, francês).

Código do Idioma
iso6391Name string

Uma representação de duas letras da língua detetada de acordo com a norma ISO 639-1 (por exemplo, en, fr).

Score
score double

Um índice de confiança entre 0 e 1. Pontuações próximas a 1 indicam 100% de certeza de que a língua identificada é verdadeira.

AnalyzeConversationTaskResultsKind

Enumeração de resultados de tarefas de conversação suportados

Enumeração de resultados de tarefas de conversação suportados

ConversationalTaskResult

Os resultados de uma tarefa de conversação.

Name Caminho Tipo Description
tipo
kind AnalyzeConversationTaskResultsKind

Enumeração de resultados de tarefas de conversação suportados

Resultado
result AnalyzeConversationResult

Representa uma resposta de análise de conversação.

ConversationalTaskResult_Orchestration

Os resultados de uma tarefa de conversação.

Name Caminho Tipo Description
tipo
kind AnalyzeConversationTaskResultsKind

Enumeração de resultados de tarefas de conversação suportados

Resultado
result AnalyzeConversationResult_Orchestration

Representa uma resposta de análise de conversação.

AnalyzeConversationResult

Representa uma resposta de análise de conversação.

Name Caminho Tipo Description
consulta
query string

O enunciado da conversa dado pelo interlocutor.

detectedLanguage
detectedLanguage string

O sistema detetou o idioma para a consulta na representação de idioma BCP 47..

predição
prediction ConversationPrediction

Representa a seção de previsão de um projeto de conversação.

AnalyzeConversationResult_Orchestration

Representa uma resposta de análise de conversação.

Name Caminho Tipo Description
consulta
query string

O enunciado da conversa dado pelo interlocutor.

detectedLanguage
detectedLanguage string

O sistema detetou o idioma para a consulta na representação de idioma BCP 47..

predição
prediction OrchestrationPrediction

Isso representa o resultado da previsão de um projeto de orquestração.

ConversaPrevisão

Representa a seção de previsão de um projeto de conversação.

Name Caminho Tipo Description
intenções
intents array of ConversationIntent

Os resultados da classificação de intenção.

entidades
entities array of ConversationEntity

Os resultados da extração da entidade.

tipoDeProjeto
projectKind string

O tipo de projeto.

topIntent
topIntent string

A intenção com a pontuação mais alta.

Intenção de conversação

O resultado da classificação de intenção de um projeto de conversação.

Name Caminho Tipo Description
categoria
category string

Uma classe prevista.

confiançaScore
confidenceScore float

O escore de confiança da turma de 0,0 a 1,0.

ConversaEntidade

O resultado da extração de entidade de um projeto de conversação.

Name Caminho Tipo Description
categoria
category string

A categoria de entidade.

enviar SMS
text string

O texto da entidade prevista.

offset
offset integer

O índice inicial desta entidade na consulta.

length
length integer

A extensão do texto.

confiançaScore
confidenceScore float

A pontuação de confiança da entidade.

Resoluções
resolutions array of BaseResolution

A coleção de objetos de resolução de entidade.

extraInformação
extraInformation array of BaseExtraInformation

A coleção de objetos de informação extra da entidade.

topResolução
topResolution BaseResolution

A classe base abstrata para resoluções de entidade.

múltiplaResoluções
multipleResolutions boolean

O indicador que representa se a matriz de resoluções tinha vários itens.

BaseExtraInformation

O objeto base abstrato para informações extras da entidade.

Name Caminho Tipo Description
extraInformationKind
extraInformationKind string

O tipo de objeto de informação extra.

Resolução de Base

A classe base abstrata para resoluções de entidade.

Name Caminho Tipo Description
resoluçãoKind
resolutionKind string

O tipo de objeto de resolução da entidade.

OrchestrationPrediction

Isso representa o resultado da previsão de um projeto de orquestração.

Name Caminho Tipo Description
intenções
intents object

Um dicionário que contém todas as intenções. Uma chave é um nome de intenção e um valor é sua pontuação de confiança e tipo de destino. O valor da intenção superior também contém a resposta real do projeto de destino.

tipoDeProjeto
projectKind string

O tipo de projeto.

topIntent
topIntent string

A intenção com a pontuação mais alta.

ExtractiveSummarizationResult

Name Caminho Tipo Description
Documentação
documents array of ExtractedSummaryDocumentResultWithDetectedLanguage

Resposta por documento

ExtractedSummaryDocumentResultWithDetectedLanguage

Name Caminho Tipo Description
frases
sentences array of ExtractedSummarySentence

Uma lista classificada de frases que representam o resumo extraído.

detectedLanguage
detectedLanguage DetectedLanguage

ExtractedSummarySentence

Name Caminho Tipo Description
enviar SMS
text string

O texto extraído da frase.

rankScore
rankScore double

Um valor duplo que representa a relevância da frase dentro do resumo. Valores mais altos indicam maior importância.

offset
offset integer

O deslocamento da frase desde o início do documento, com base no valor do parâmetro StringIndexType.

length
length integer

A duração da frase.

ExtractiveSummarizationLROResult

Name Caminho Tipo Description
results
results ExtractiveSummarizationResult

AbstraçãoResumoLROResult

Um objeto que representa os resultados de uma tarefa de Sumarização Abstrativa.

Name Caminho Tipo Description
results
results AbstractiveSummarizationResult

Um objeto que representa os resultados de resumo pré-compilação de cada documento.

AbstractiveSummarizationResult

Um objeto que representa os resultados de resumo pré-compilação de cada documento.

Name Caminho Tipo Description
Documentação
documents array of AbstractiveSummaryDocumentResultWithDetectedLanguage

Resposta por documento

AbstractiveSummaryDocumentResultWithDetectedLanguage

Um objeto que representa o resultado de resumo de um único documento com idioma detetado.

Name Caminho Tipo Description
summaries
summaries array of AbstractiveSummary

Uma lista de resumos abstratos.

id
id string

Identificador de documento exclusivo e não vazio.

Advertências
warnings array of LanguageDocumentWarning

Avisos encontrados durante o processamento do documento.

statistics
statistics DocumentStatistics

se showStats=true foi especificado na solicitação, este campo conterá informações sobre a carga útil do documento.

detectedLanguage
detectedLanguage DetectedLanguage

SummaryContext

O contexto do resumo.

Name Caminho Tipo Description
offset
offset integer

Posição inicial para o contexto. O uso de diferentes valores 'stringIndexType' pode afetar o deslocamento retornado.

length
length integer

A extensão do contexto. O uso de diferentes valores 'stringIndexType' pode afetar o comprimento retornado.

ResumoResumo Abstrativo

Um objeto que representa um único resumo com contexto para determinado documento.

Name Caminho Tipo Description
enviar SMS
text string

O texto do resumo.

contexts
contexts array of SummaryContext

A lista de contexto do resumo.

RespostasResultado

Representa a lista de respostas às perguntas.

Name Caminho Tipo Description
answers
answers array of KnowledgeBaseAnswer

Representa a lista Resultado da Resposta.

isUserQuestionAmbiguous
isUserQuestionAmbiguous boolean

Retorna um valor booleano se a pergunta do usuário for ambígua.

KnowledgeBaseAnswer

Representa a resposta do projeto.

Name Caminho Tipo Description
perguntas
questions array of string

Lista de perguntas associadas à resposta.

resposta
answer string

Texto da resposta.

Limiar de Confiança
confidenceScore float

Pontuação de confiança da resposta, o valor varia de 0 a 1.

QnA ID
id integer

ID do resultado do QnA.

origem
source string

Fonte do resultado QnA.

metadados
metadata object

Metadados associados à resposta, úteis para categorizar ou filtrar respostas a perguntas.

diálogo
dialog KnowledgeBaseAnswerDialog

Caixa de diálogo associada à Resposta.

answerSpan
answerSpan AnswerSpan

Objeto de extensão de resposta do QnA.

KnowledgeBaseAnswerDialog

Caixa de diálogo associada à Resposta.

Name Caminho Tipo Description
isContextOnly
isContextOnly boolean

Para marcar se um prompt é relevante apenas com uma pergunta anterior ou não. Se verdadeiro, não inclua este QnA como resultado de pesquisa para consultas sem contexto; caso contrário, se false, ignora o contexto e inclui este QnA no resultado da pesquisa.

Prompts
prompts array of KnowledgeBaseAnswerPrompt

Lista de prompts associados à resposta.

KnowledgeBaseAnswerPrompt

Solicite uma resposta.

Name Caminho Tipo Description
displayEncomendar
displayOrder integer

Índice do prompt - usado na ordenação dos prompts.

qnaId
qnaId integer

ID QnA correspondente ao prompt.

displayText
displayText string

Texto exibido para representar um prompt de pergunta de acompanhamento.

AnswerSpan

Objeto de extensão de resposta do QnA.

Name Caminho Tipo Description
enviar SMS
text string

Texto previsto de resposta precisa.

Limiar de Confiança
confidenceScore float

Pontuação prevista de resposta precisa, o valor varia de 0 a 1.

offset
offset integer

A resposta precisa desloca-se desde o início da resposta.

length
length integer

A extensão da resposta precisa.