Serviço Cognitivo do Azure para Linguagem
O Serviço Cognitivo do Azure para Linguagem, anteriormente conhecido como conector de "Análise de Texto", detecta linguagem, sentimento e mais do texto que você fornece.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Standard | Todas as regiões do Power Automate |
| Aplicativos Lógicos | Standard | Todas as regiões de Aplicativos Lógicos |
| Power Apps | Standard | Todas as regiões do Power Apps |
| Power Automate | Standard | Todas as regiões do Power Automate |
| Contato | |
|---|---|
| Nome | Microsoft |
| URL | https://gallery.cortanaanalytics.com/MachineLearningAPI/Text-Analytics-2 |
| mlapi@microsoft.com |
| Metadados do conector | |
|---|---|
| Publicador | Microsoft |
| Site | https://azure.microsoft.com/services/cognitive-services/text-analytics/ |
Observação
Esse conector era conhecido anteriormente como "Análise de Texto" ou "Análise de Texto dos Serviços Cognitivos da Microsoft".
Para usar essa integração, você precisará de um recurso do Serviço Cognitivo no portal do Azure. Você obterá um ponto de extremidade e uma chave para autenticar seus aplicativos. Para fazer uma conexão, forneça a chave da conta, a URL do site e selecione Criar conexão. Para os custos de operação em sua conexão, saiba mais aqui.
Agora você está pronto para começar a usar essa integração.
Conectando-se à ID do Microsoft Entra
Para criar conexões com a ID do Microsoft Entra, você deve adicionar a função de Usuário dos Serviços Cognitivos à sua conta para acessar. Para usar essa conexão, você deve inserir o subdomínio exclusivo associado ao recurso dos Serviços Cognitivos nas operações de suporte.
Operações sem suporte com a autenticação da ID do Microsoft Entra
Ao usar a autenticação do Microsoft Entra ID , há suporte apenas para ações V4. As ações preteridas continuarão a funcionar com Access Key a autenticação, mas falharão se forem usadas com uma conexão de ID do Microsoft Entra.
Criando uma conexão
O conector dá suporte aos seguintes tipos de autenticação:
| Chave de API | ApiKey | Todas as regiões | Compartilhável |
| Padrão [PRETERIDO] | Essa 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 de API
ID de autenticação: keyBasedAuth
Aplicável: todas as regiões
ApiKey
Essa é 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 dos Conectores para aplicativos de tela – Power Apps | Microsoft Docs
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Chave de Conta | secureString | Chave de Conta dos Serviços Cognitivos | Verdade |
| URL do site | cadeia | URL do site raiz (exemplo: https://westus.api.cognitive.microsoft.com) |
Padrão [PRETERIDO]
Aplicável: todas as regiões
Essa 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.
Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Chave de Conta | secureString | Chave de Conta dos Serviços Cognitivos | Verdade |
| URL do site | cadeia | URL do site raiz (exemplo: https://westus.api.cognitive.microsoft.com). Se não for especificado, a URL do site será padronizada para https://westus.api.cognitive.microsoft.com. |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 1200 | 60 segundos |
Ações
|
Abstractive |
Enviar uma coleção de documentos de texto para resumo abstrativo |
|
Assíncrono Sentiment |
Envie uma coleção de documentos de texto para análise de sentimento. |
|
Async Custom |
Envie uma coleção de documentos de texto para análise de reconhecimento de entidade personalizada. |
|
Async Custom |
Envie uma coleção de documentos de texto para análise de classificação única personalizada. |
|
Async Custom |
Envie uma coleção de documentos de texto para análise de classificação única personalizada. |
|
Async Entity |
Envie uma coleção de documentos de texto para análise de vinculação de entidade. |
|
Async Entity |
Envie uma coleção de documentos de texto para análise de reconhecimento de entidade. |
| Async Healthcare (2022-05-01) |
Envie uma coleção de documentos de texto para análise de cuidados de saúde. |
|
Async Pii |
Envie uma coleção de documentos de texto para análise de reconhecimento de entidade pessoal. |
| 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. |
| Detectar entidades (V2) [PRETERIDO] |
Esta ação foi preterida. Em vez disso , use o Reconhecimento de Entidade Nomeada (V4 ).
|
| Detectar idioma (V3.0) |
A API retorna o idioma detectado e uma pontuação numérica entre 0 e 1. Pontuações próximas a 1 indicam 100% certeza de que o idioma identificado é verdadeiro. Consulte o suporte de linguagem para detecção de idiomas para a lista de idiomas com suporte. |
| Detectar idioma [PRETERIDO] |
Esta ação foi preterida. Em vez disso, use Detectar Idioma (V4 ).
|
| Detectar idioma [PRETERIDO] |
Esta ação foi preterida. Em vez disso, use Detectar Idioma (V4 ).
|
| Detectar informações pessoais (V3.1) |
A API retorna uma lista de entidades com informações pessoais ("SSN", "Conta Bancária" etc) no documento. Para obter a lista de tipos de entidade com suporte, verifique as categorias de entidade pii (informações de identificação pessoal) com suporte. Consulte os idiomas com suporte no Serviço Cognitivo do Azure para Idioma para obter a lista de idiomas com suporte. |
| Detectar informações pessoais (V4) (versão prévia) |
A API retorna uma lista de entidades com informações pessoais ("SSN", "Conta Bancária" etc) no documento. Para obter a lista de tipos de entidade com suporte, verifique as categorias de entidade pii (informações de identificação pessoal) com suporte. Consulte os idiomas com suporte no Serviço Cognitivo do Azure para Idioma para obter a lista de idiomas com suporte. |
| Detectar linguagem (V2) [PRETERIDO] |
Esta ação foi preterida. Em vez disso, use Detectar Idioma (V4 ).
|
| Detectar linguagem (V3.1) (versão prévia) |
A API retorna o idioma detectado e uma pontuação numérica entre 0 e 1. Pontuações próximas a 1 indicam 100% certeza de que o idioma identificado é verdadeiro. Consulte o suporte de linguagem para detecção de idiomas para a lista de idiomas com suporte. |
| Detectar linguagem (V4) (versão prévia) |
A API retorna o idioma detectado e uma pontuação numérica entre 0 e 1. Pontuações próximas a 1 indicam 100% certeza de que o idioma identificado é verdadeiro. Consulte o suporte de linguagem para detecção de idiomas para a lista de idiomas com suporte. |
| Detectar sentimento (V2) [PRETERIDO] |
Esta ação foi preterida. Em vez disso, use Sentimento (V4 ).
|
| Detectar sentimento [PRETERIDO] |
Esta ação foi preterida. Em vez disso, use Sentimento (V4 ).
|
| Detectar sentimento [PRETERIDO] |
Esta ação foi preterida. Em vez disso, use Sentimento (V4 ).
|
| Entidades [PRETERIDAS] |
Esta ação foi preterida. Em vez disso , use o Reconhecimento de Entidade Nomeada (V4 ).
|
|
Extractive |
Enviar uma coleção de documentos de texto para resumo extrativo |
| Frases-chave (V2) [PRETERIDO] |
Esta ação foi preterida. Em vez disso , use frases-chave (V4 ).
|
| Frases-chave (V3.0) |
A API retorna uma lista de cadeias de caracteres que denotam as frases-chave no texto de entrada. Consulte o suporte de linguagem para extração de frases-chave para a lista de idiomas com suporte. |
| Frases-chave (V3.1) (versão prévia) |
A API retorna uma lista de cadeias de caracteres que denotam as frases-chave no texto de entrada. Consulte o suporte de linguagem para extração de frases-chave para a lista de idiomas com suporte. |
| Frases-chave (V4) (versão prévia) |
A API retorna uma lista de cadeias de caracteres que denotam as frases-chave no texto de entrada. Consulte o suporte de linguagem para extração de frases-chave para a lista de idiomas com suporte. |
| Frases-chave [PRETERIDO] |
Esta ação foi preterida. Em vez disso , use frases-chave (V4 ).
|
| Frases-chave [PRETERIDO] |
Esta ação foi preterida. Em vez disso , use frases-chave (V4 ).
|
| 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 |
Essa ação ajuda a responder à pergunta especificada usando sua base de dados de conhecimento em seu projeto. |
| PII de conversa 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 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 com suporte, verifique as categorias de entidade NER (Reconhecimento de Entidade Nomeada) com suporte. |
| Reconhecimento de Entidade Nomeada (V3.1) (versão prévia) |
A API retorna uma lista de entidades nomeadas gerais em um determinado documento. Para obter a lista de tipos de entidade com suporte, verifique as categorias de entidade NER (Reconhecimento de Entidade Nomeada) com suporte. |
| Reconhecimento de Entidade Nomeada (V4) (versão prévia) |
A API retorna uma lista de entidades nomeadas gerais em um determinado documento. Para obter a lista de tipos de entidade com suporte, verifique as categorias de entidade NER (Reconhecimento de Entidade Nomeada) com suporte. |
| Resumo da 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. |
| 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 à análise de sentimento e à linguagem de mineração de opiniões para a lista de idiomas com suporte. |
| Sentimento (V3.1) (versão prévia) |
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, a partir do nível de um documento, até a frase e os termos-chave (destinos e avaliações). |
| Sentimento (V4) (versão prévia) |
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, a partir do nível de um documento, até a frase e os termos-chave (destinos e avaliações). |
| 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 ao idioma para a lista de idiomas com suporte. |
| Vinculação de entidade (V3.1) (versão prévia) |
A API retorna uma lista de entidades reconhecidas com links para uma base de dados de conhecimento conhecida. Consulte o suporte ao idioma para a lista de idiomas com suporte. |
| Vinculação de entidade (V4) (versão prévia) |
A API retorna uma lista de entidades reconhecidas com links para uma base de dados de conhecimento conhecida. Consulte o suporte ao idioma para a lista de idiomas com suporte. |
AbstractiveSummarization async (2022-10-01-preview)
Enviar uma coleção de documentos de texto para resumo abstrativo
Parâmetros
| Nome | Chave | Obrigató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 ISO 639-1 de 2 letras de um idioma. Por exemplo, use "en" para inglês; "es" para espanhol etc. Se não estiver definido, use "en" para inglês como padrão. |
|
|
sentenceCount
|
sentenceCount | integer |
Ele controla o número aproximado de frases nos resumos de saída. |
Retornos
Assíncrono SentimentAnalysis (2022-05-01)
Envie uma coleção de documentos de texto para análise de sentimento.
Parâmetros
| Nome | Chave | Obrigató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 ISO 639-1 de 2 letras de um idioma. Por exemplo, use "en" para inglês; "es" para espanhol etc. Se não estiver definido, use "en" para inglês como padrão. |
|
|
opinionMining
|
opinionMining | boolean |
Retornos
Async CustomEntityRecognition (2022-05-01)
Envie uma coleção de documentos de texto para análise de reconhecimento de entidade personalizada.
Parâmetros
| Nome | Chave | Obrigató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 ISO 639-1 de 2 letras de um idioma. Por exemplo, use "en" para inglês; "es" para espanhol etc. Se não estiver definido, use "en" para inglês como padrão. |
|
|
projectName
|
projectName | True | string |
Esse campo indica o nome do projeto para o modelo. |
|
deploymentName
|
deploymentName | True | string |
Esse campo indica o nome da implantação do modelo. |
Retornos
Async CustomMultiLabelClassification (2022-05-01)
Envie uma coleção de documentos de texto para análise de classificação única personalizada.
Parâmetros
| Nome | Chave | Obrigató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 ISO 639-1 de 2 letras de um idioma. Por exemplo, use "en" para inglês; "es" para espanhol etc. Se não estiver definido, use "en" para inglês como padrão. |
|
|
projectName
|
projectName | True | string |
Esse campo indica o nome do projeto para o modelo. |
|
deploymentName
|
deploymentName | True | string |
Esse campo indica o nome da implantação do modelo. |
Retornos
Async CustomSingleLabelClassification (2022-05-01)
Envie uma coleção de documentos de texto para análise de classificação única personalizada.
Parâmetros
| Nome | Chave | Obrigató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 ISO 639-1 de 2 letras de um idioma. Por exemplo, use "en" para inglês; "es" para espanhol etc. Se não estiver definido, use "en" para inglês como padrão. |
|
|
projectName
|
projectName | True | string |
Esse campo indica o nome do projeto para o modelo. |
|
deploymentName
|
deploymentName | True | string |
Esse campo indica o nome da implantação do modelo. |
Retornos
Async EntityLinking (2022-05-01)
Envie uma coleção de documentos de texto para análise de vinculação de entidade.
Parâmetros
| Nome | Chave | Obrigató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 ISO 639-1 de 2 letras de um idioma. Por exemplo, use "en" para inglês; "es" para espanhol etc. Se não estiver definido, use "en" para inglês como padrão. |
Retornos
Async EntityRecognition (2022-05-01)
Envie uma coleção de documentos de texto para análise de reconhecimento de entidade.
Parâmetros
| Nome | Chave | Obrigató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 ISO 639-1 de 2 letras de um idioma. Por exemplo, use "en" para inglês; "es" para espanhol etc. Se não estiver definido, use "en" para inglês como padrão. |
Retornos
Async Healthcare (2022-05-01)
Envie uma coleção de documentos de texto para análise de cuidados de saúde.
Parâmetros
| Nome | Chave | Obrigató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 ISO 639-1 de 2 letras de um idioma. Por exemplo, use "en" para inglês; "es" para espanhol etc. Se não estiver definido, use "en" para inglês como padrão. |
Retornos
Async PiiEntityRecognition (2022-05-01)
Envie uma coleção de documentos de texto para análise de reconhecimento de entidade pessoal.
Parâmetros
| Nome | Chave | Obrigató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 ISO 639-1 de 2 letras de um idioma. 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 o Reconhecimento de Entidade de PII. |
|
|
piiCategories
|
piiCategories | array of string |
(Opcional) descreve as categorias de PII a serem retornadas |
Retornos
Conversas (CLU) (2022-05-01)
Analisa o enunciado da conversa de entrada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
linguagem
|
language | string |
A linguagem de substituição de um item de conversa na representação de linguagem BCP 47. |
|
|
enviar SMS
|
text | True | string |
A entrada de texto |
|
projectName
|
projectName | True | string |
O nome do projeto a ser usado. |
|
deploymentName
|
deploymentName | True | string |
O nome da implantação a ser usada. |
|
detalhada
|
verbose | boolean |
Se for true, o serviço retornará informações mais detalhadas na resposta. |
Retornos
Os resultados de uma tarefa de Conversa.
- Corpo
- ConversationalTaskResult
Conversas (Orquestração) (2022-05-01)
Analisa o enunciado da conversa de entrada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
linguagem
|
language | string |
A linguagem de substituição de um item de conversa na representação de linguagem BCP 47. |
|
|
enviar SMS
|
text | True | string |
A entrada de texto |
|
projectName
|
projectName | True | string |
O nome do projeto a ser usado. |
|
deploymentName
|
deploymentName | True | string |
O nome da implantação a ser usada. |
|
detalhada
|
verbose | boolean |
Se for true, 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. |
Retornos
Os resultados de uma tarefa de Conversa.
Detectar entidades (V2) [PRETERIDO]
Esta ação foi preterida. Em vez disso , use o Reconhecimento de Entidade Nomeada (V4 ).
Retorna uma lista de entidades conhecidas e entidades nomeadas gerais ("Pessoa", "Localização", "Organização" etc) em um determinado documento.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | True | string |
Identificador de documento exclusivo e não vazio. |
|
Texto
|
text | True | string |
O texto a ser analisado. |
|
Linguagem
|
language | string |
Esta é a representação ISO 639-1 de 2 letras de um idioma. Por exemplo, use "en" para inglês; "es" para espanhol etc., |
Retornos
- Corpo
- EntitiesResults
Detectar idioma (V3.0)
A API retorna o idioma detectado e uma pontuação numérica entre 0 e 1. Pontuações próximas a 1 indicam 100% certeza de que o idioma identificado é verdadeiro. Consulte o suporte de linguagem para detecção de idiomas para a lista de idiomas com suporte.
Parâmetros
| Nome | Chave | Obrigató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 de modelo não for especificada, a API deverá usar como padrão a versão mais recente e não prévia. |
|
|
Mostrar Estatísticas
|
showStats | boolean |
(Opcional) se definido como true, a resposta conterá estatísticas de nível de documento e entrada. |
|
|
id
|
id | True | string |
Identificador de documento exclusivo e não vazio. |
|
enviar SMS
|
text | True | string | |
|
countryHint
|
countryHint | string |
Retornos
- Corpo
- LanguageResultV3
Detectar idioma [PRETERIDO]
Esta ação foi preterida. Em vez disso, use Detectar Idioma (V4 ).
Retorna o idioma detectado e uma pontuação numérica entre 0 e 1. Pontuações próximas a 1 indicam 100% certeza de que o idioma identificado é verdadeiro. Há suporte para um total de 120 idiomas.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Texto
|
text | string |
O texto a ser analisado. |
|
|
Número de idiomas
|
numberOfLanguagesToDetect | integer |
O número de idiomas a serem detectados. Definido como 1 por padrão. |
Retornos
- Corpo
- LanguageResult
Detectar idioma [PRETERIDO]
Esta ação foi preterida. Em vez disso, use Detectar Idioma (V4 ).
Retorna o idioma detectado e uma pontuação numérica entre 0 e 1. Pontuações próximas a 1 indicam 100% certeza de que o idioma identificado é verdadeiro. Há suporte para um total de 120 idiomas.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Texto
|
text | string |
O texto a ser analisado. |
Retornos
- Corpo
- LanguageResult
Detectar informações pessoais (V3.1)
A API retorna uma lista de entidades com informações pessoais ("SSN", "Conta Bancária" etc) no documento. Para obter a lista de tipos de entidade com suporte, verifique as categorias de entidade pii (informações de identificação pessoal) com suporte. Consulte os idiomas com suporte no Serviço Cognitivo do Azure para Idioma para obter a lista de idiomas com suporte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
model-version
|
model-version | string |
(Opcional) Esse valor indica qual modelo será usado para pontuação. Se uma versão de modelo não for especificada, a API deverá usar como padrão a versão mais recente e não prévia. |
|
|
showStats
|
showStats | boolean |
(Opcional) se definido como true, a resposta conterá estatísticas de nível de solicitação e documento. |
|
|
loggingOptOut
|
loggingOptOut | boolean |
(Opcional) Se definido como true, você recusará ter sua entrada de texto registrada para solução de problemas. Por padrão, o Serviço Cognitivo do Azure para Linguagem registra o texto de entrada por 48 horas, apenas para permitir a solução de problemas ao fornecer o Serviço Cognitivo do Azure para funções de processamento de linguagem natural de linguagem. Definir esse parâmetro como true desabilita o registro em log de entrada e pode limitar nossa capacidade de corrigir problemas que ocorrem. Consulte as notas de conformidade e privacidade dos https://aka.ms/cs-compliance Serviços Cognitivos 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 (Graphemes) de acordo com Unicode v8.0.0. Para obter informações adicionais, consulte https://aka.ms/text-analytics-offsets |
|
|
piiCategories
|
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 ISO 639-1 de 2 letras de um idioma. Por exemplo, use "en" para inglês; "es" para espanhol etc. Se não estiver definido, use "en" para inglês como padrão. |
Retornos
- Corpo
- PiiResult
Detectar informações pessoais (V4) (versão prévia)
A API retorna uma lista de entidades com informações pessoais ("SSN", "Conta Bancária" etc) no documento. Para obter a lista de tipos de entidade com suporte, verifique as categorias de entidade pii (informações de identificação pessoal) com suporte. Consulte os idiomas com suporte no Serviço Cognitivo do Azure para Idioma para obter a lista de idiomas com suporte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Subdomínio de Recurso ou Região
|
subdomain | True | string |
Subdomínio do Azure ou região geográfica (por exemplo, westus) |
|
model-version
|
model-version | string |
(Opcional) Esse valor indica qual modelo será usado para pontuação. Se uma versão de modelo não for especificada, a API deverá usar como padrão a versão mais recente e não prévia. |
|
|
showStats
|
showStats | boolean |
(Opcional) se definido como true, a resposta conterá estatísticas de nível de solicitação e documento. |
|
|
loggingOptOut
|
loggingOptOut | boolean |
(Opcional) Se definido como true, você recusará ter sua entrada de texto registrada para solução de problemas. Por padrão, o Serviço Cognitivo do Azure para Linguagem registra o texto de entrada por 48 horas, apenas para permitir a solução de problemas ao fornecer o Serviço Cognitivo do Azure para funções de processamento de linguagem natural de linguagem. Definir esse parâmetro como true desabilita o registro em log de entrada e pode limitar nossa capacidade de corrigir problemas que ocorrem. Consulte as notas de conformidade e privacidade dos https://aka.ms/cs-compliance Serviços Cognitivos 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 (Graphemes) de acordo com Unicode v8.0.0. Para obter informações adicionais, consulte https://aka.ms/text-analytics-offsets |
|
|
piiCategories
|
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 ISO 639-1 de 2 letras de um idioma. Por exemplo, use "en" para inglês; "es" para espanhol etc. Se não estiver definido, use "en" para inglês como padrão. |
Retornos
- Corpo
- PiiResult
Detectar linguagem (V2) [PRETERIDO]
Esta ação foi preterida. Em vez disso, use Detectar Idioma (V4 ).
Retorna o idioma detectado e uma pontuação numérica entre 0 e 1 para cada documento. Pontuações próximas a 1 indicam 100% certeza de que o idioma identificado é verdadeiro. Há suporte para um total de 120 idiomas.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | True | string |
Identificador de documento exclusivo e não vazio. |
|
Texto
|
text | True | string |
O texto a ser analisado. |
Retornos
- Corpo
- LanguageResults
Detectar linguagem (V3.1) (versão prévia)
A API retorna o idioma detectado e uma pontuação numérica entre 0 e 1. Pontuações próximas a 1 indicam 100% certeza de que o idioma identificado é verdadeiro. Consulte o suporte de linguagem para detecção de idiomas para a lista de idiomas com suporte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
model-version
|
model-version | string |
(Opcional) Esse valor indica qual modelo será usado para pontuação. Se uma versão de modelo não for especificada, a API deverá usar como padrão a versão mais recente e não prévia. |
|
|
showStats
|
showStats | boolean |
(Opcional) se definido como true, a resposta conterá estatísticas de nível de solicitação e documento. |
|
|
loggingOptOut
|
loggingOptOut | boolean |
(Opcional) Se definido como true, você recusará ter sua entrada de texto registrada para solução de problemas. Por padrão, o Serviço Cognitivo do Azure para Linguagem registra o texto de entrada por 48 horas, apenas para permitir a solução de problemas ao fornecer o Serviço Cognitivo do Azure para funções de processamento de linguagem natural de linguagem. Definir esse parâmetro como true desabilita o registro em log de entrada e pode limitar nossa capacidade de corrigir problemas que ocorrem. Consulte as notas de conformidade e privacidade dos https://aka.ms/cs-compliance Serviços Cognitivos 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 | |
|
countryHint
|
countryHint | string |
Retornos
- Corpo
- LanguageResult
Detectar linguagem (V4) (versão prévia)
A API retorna o idioma detectado e uma pontuação numérica entre 0 e 1. Pontuações próximas a 1 indicam 100% certeza de que o idioma identificado é verdadeiro. Consulte o suporte de linguagem para detecção de idiomas para a lista de idiomas com suporte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Subdomínio de Recurso ou Região
|
subdomain | True | string |
Subdomínio do Azure ou região geográfica (por exemplo, westus) |
|
model-version
|
model-version | string |
(Opcional) Esse valor indica qual modelo será usado para pontuação. Se uma versão de modelo não for especificada, a API deverá usar como padrão a versão mais recente e não prévia. |
|
|
showStats
|
showStats | boolean |
(Opcional) se definido como true, a resposta conterá estatísticas de nível de solicitação e documento. |
|
|
loggingOptOut
|
loggingOptOut | boolean |
(Opcional) Se definido como true, você recusará ter sua entrada de texto registrada para solução de problemas. Por padrão, o Serviço Cognitivo do Azure para Linguagem registra o texto de entrada por 48 horas, apenas para permitir a solução de problemas ao fornecer o Serviço Cognitivo do Azure para funções de processamento de linguagem natural de linguagem. Definir esse parâmetro como true desabilita o registro em log de entrada e pode limitar nossa capacidade de corrigir problemas que ocorrem. Consulte as notas de conformidade e privacidade dos https://aka.ms/cs-compliance Serviços Cognitivos 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 | |
|
countryHint
|
countryHint | string |
Retornos
- Corpo
- LanguageResult
Detectar sentimento (V2) [PRETERIDO]
Esta ação foi preterida. Em vez disso, use Sentimento (V4 ).
Retorna uma pontuação numérica entre 0 e 1 para cada documento. Pontuações próximas de 1 indicam sentimento positivo, enquanto pontuações próximas de 0 indicam sentimento negativo.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | True | string |
Identificador de documento exclusivo e não vazio. |
|
Texto
|
text | True | string |
O texto a ser analisado. |
|
Linguagem
|
language | string |
Esta é a representação ISO 639-1 de 2 letras de um idioma. Por exemplo, use "en" para inglês; "es" para espanhol etc., |
Retornos
- Corpo
- SentimentResults
Detectar sentimento [PRETERIDO]
Esta ação foi preterida. Em vez disso, use Sentimento (V4 ).
Retorna uma pontuação numérica entre 0 e 1. Pontuações próximas de 1 indicam sentimento positivo, enquanto pontuações próximas de 0 indicam sentimento negativo. Atualmente, há suporte para os seguintes idiomas: inglês, espanhol, francês, português.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Texto
|
text | string |
O texto a ser analisado. |
|
|
Linguagem
|
language | string |
Esta é a representação ISO 639-1 de 2 letras de um idioma. Por exemplo, use "en" para inglês; "es" para espanhol etc., |
Retornos
- Corpo
- SentimentResult
Detectar sentimento [PRETERIDO]
Esta ação foi preterida. Em vez disso, use Sentimento (V4 ).
Retorna uma pontuação numérica entre 0 e 1. Pontuações próximas de 1 indicam sentimento positivo, enquanto pontuações próximas de 0 indicam sentimento negativo.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Texto
|
text | string |
O texto a ser analisado. |
|
|
Linguagem
|
language | string |
Esta é a representação ISO 639-1 de 2 letras de um idioma. Por exemplo, use "en" para inglês; "es" para espanhol etc., |
Retornos
- Corpo
- SentimentResult
Entidades [PRETERIDAS]
Esta ação foi preterida. Em vez disso , use o Reconhecimento de Entidade Nomeada (V4 ).
Retorna uma lista de entidades conhecidas e entidades nomeadas gerais ("Pessoa", "Localização", "Organização" etc) em um determinado documento.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Texto
|
text | string |
O texto a ser analisado. |
|
|
Linguagem
|
language | string |
Esta é a representação ISO 639-1 de 2 letras de um idioma. Por exemplo, use "en" para inglês; "es" para espanhol etc., |
Retornos
- Corpo
- EntitiesResult
ExtractiveSummarization assíncrono (2022-10-01-preview)
Enviar uma coleção de documentos de texto para resumo extrativo
Parâmetros
| Nome | Chave | Obrigató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 ISO 639-1 de 2 letras de um idioma. Por exemplo, use "en" para inglês; "es" para espanhol etc. Se não estiver definido, use "en" para inglês como padrão. |
|
|
sentenceCount
|
sentenceCount | integer | ||
|
sortBy
|
sortBy | string |
Os critérios de classificação a serem usados para os resultados do Resumo Extrativo. |
Retornos
Frases-chave (V2) [PRETERIDO]
Esta ação foi preterida. Em vez disso , use frases-chave (V4 ).
Retorna uma lista de cadeias de caracteres que denotam os principais pontos de discussão no texto de entrada para cada documento.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | True | string |
Identificador de documento exclusivo e não vazio. |
|
Texto
|
text | True | string |
O texto a ser analisado. |
|
Linguagem
|
language | string |
Esta é a representação ISO 639-1 de 2 letras de um idioma. Por exemplo, use "en" para inglês; "es" para espanhol etc., |
Retornos
- Corpo
- KeyPhraseResults
Frases-chave (V3.0)
A API retorna uma lista de cadeias de caracteres que denotam as frases-chave no texto de entrada. Consulte o suporte de linguagem para extração de frases-chave para a lista de idiomas com suporte.
Parâmetros
| Nome | Chave | Obrigató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 de modelo não for especificada, a API deverá usar como padrão a versão mais recente e não prévia. |
|
|
Mostrar Estatísticas
|
showStats | boolean |
(Opcional) se definido como true, a resposta conterá estatísticas de nível de documento e entrada. |
|
|
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 ISO 639-1 de 2 letras de um idioma. Por exemplo, use "en" para inglês; "es" para espanhol etc. Se não estiver definido, use "en" para inglês como padrão. |
Retornos
- Corpo
- KeyPhraseResultV3
Frases-chave (V3.1) (versão prévia)
A API retorna uma lista de cadeias de caracteres que denotam as frases-chave no texto de entrada. Consulte o suporte de linguagem para extração de frases-chave para a lista de idiomas com suporte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
model-version
|
model-version | string |
(Opcional) Esse valor indica qual modelo será usado para pontuação. Se uma versão de modelo não for especificada, a API deverá usar como padrão a versão mais recente e não prévia. |
|
|
showStats
|
showStats | boolean |
(Opcional) se definido como true, a resposta conterá estatísticas de nível de solicitação e documento. |
|
|
loggingOptOut
|
loggingOptOut | boolean |
(Opcional) Se definido como true, você recusará ter sua entrada de texto registrada para solução de problemas. Por padrão, o Serviço Cognitivo do Azure para Linguagem registra o texto de entrada por 48 horas, apenas para permitir a solução de problemas ao fornecer o Serviço Cognitivo do Azure para funções de processamento de linguagem natural de linguagem. Definir esse parâmetro como true desabilita o registro em log de entrada e pode limitar nossa capacidade de corrigir problemas que ocorrem. Consulte as notas de conformidade e privacidade dos https://aka.ms/cs-compliance Serviços Cognitivos 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 ISO 639-1 de 2 letras de um idioma. Por exemplo, use "en" para inglês; "es" para espanhol etc. Se não estiver definido, use "en" para inglês como padrão. |
Retornos
- Corpo
- KeyPhraseResult
Frases-chave (V4) (versão prévia)
A API retorna uma lista de cadeias de caracteres que denotam as frases-chave no texto de entrada. Consulte o suporte de linguagem para extração de frases-chave para a lista de idiomas com suporte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Subdomínio de Recurso ou Região
|
subdomain | True | string |
Subdomínio do Azure ou região geográfica (por exemplo, westus) |
|
model-version
|
model-version | string |
(Opcional) Esse valor indica qual modelo será usado para pontuação. Se uma versão de modelo não for especificada, a API deverá usar como padrão a versão mais recente e não prévia. |
|
|
showStats
|
showStats | boolean |
(Opcional) se definido como true, a resposta conterá estatísticas de nível de solicitação e documento. |
|
|
loggingOptOut
|
loggingOptOut | boolean |
(Opcional) Se definido como true, você recusará ter sua entrada de texto registrada para solução de problemas. Por padrão, o Serviço Cognitivo do Azure para Linguagem registra o texto de entrada por 48 horas, apenas para permitir a solução de problemas ao fornecer o Serviço Cognitivo do Azure para funções de processamento de linguagem natural de linguagem. Definir esse parâmetro como true desabilita o registro em log de entrada e pode limitar nossa capacidade de corrigir problemas que ocorrem. Consulte as notas de conformidade e privacidade dos https://aka.ms/cs-compliance Serviços Cognitivos 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 ISO 639-1 de 2 letras de um idioma. Por exemplo, use "en" para inglês; "es" para espanhol etc. Se não estiver definido, use "en" para inglês como padrão. |
Retornos
- Corpo
- KeyPhraseResult
Frases-chave [PRETERIDO]
Esta ação foi preterida. Em vez disso , use frases-chave (V4 ).
Retorna uma lista de cadeias de caracteres que denotam os principais pontos de discussão no texto de entrada. Atualmente, há suporte para os seguintes idiomas: inglês, alemão, espanhol e japonês.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Texto
|
text | string |
O texto a ser analisado. |
|
|
Linguagem
|
language | string |
Esta é a representação ISO 639-1 de 2 letras de um idioma. Por exemplo, use "en" para inglês; "es" para espanhol etc., |
Retornos
- Corpo
- KeyPhraseResult
Frases-chave [PRETERIDO]
Esta ação foi preterida. Em vez disso , use frases-chave (V4 ).
Retorna uma lista de cadeias de caracteres que denotam os principais pontos de discussão no texto de entrada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Texto
|
text | string |
O texto a ser analisado. |
|
|
Linguagem
|
language | string |
Esta é a representação ISO 639-1 de 2 letras de um idioma. Por exemplo, use "en" para inglês; "es" para espanhol etc., |
Retornos
- Corpo
- KeyPhraseResult
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
| Nome | Chave | Obrigató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 ISO 639-1 de 2 letras de um idioma. 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 |
Retornos
Gerar resposta do Project
Essa ação ajuda a responder à pergunta especificada usando sua base de dados de conhecimento em seu projeto.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome do Projeto
|
projectName | True | string |
Este é o nome do Projeto que você deseja usar. |
|
Pergunta
|
question | string |
Pergunta do usuário a ser consultada no projeto. |
|
|
ID do Usuário
|
userId | string |
Identificador exclusivo do usuário. |
|
|
Início #
|
top | integer |
Número máximo de respostas a serem retornadas para a pergunta. |
|
|
Limite de confiança
|
confidenceScoreThreshold | float |
Pontuação mínima de limite para respostas. O valor varia de 0 a 1. |
|
|
Tipo de classificador
|
rankerType | string |
Tipo de classificador a ser usado. |
|
|
QnA ID
|
qnaId | string |
Esta é a ID de QnA exata a ser buscada do projeto. |
|
|
ID anterior do QnA
|
previousQnaId | integer |
A ID de QnA do resultado da resposta superior da curva anterior. |
|
|
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. |
|
|
value
|
value | string |
Valor de metadados do dicionário de metadados usado no QnA. |
|
|
Ingressar metadados com
|
logicalOperation | string |
Defina 'OR' ou 'AND' para a operação lógica correspondente para filtros de metadados. |
|
|
Filtro de origem
|
sourceFilter | string |
Localize QnAs associadas a qualquer uma das fontes fornecidas no projeto. |
|
|
Unir filtros com
|
logicalOperation | string |
Operação lógica usada para unir o filtro de metadados com o filtro de origem. |
|
|
Habilitar resposta precisa
|
enable | boolean |
Habilitar ou desabilitar a previsão do Período de Resposta. |
|
|
Limite de confiança
|
confidenceScoreThreshold | float |
A pontuação mínima de limite 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 de resposta precisa de 1 a 10. |
|
|
Incluir fontes não estruturadas
|
includeUnstructuredSources | boolean |
Sinalizador para habilitar a consulta em 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. |
Retornos
Representa a lista de respostas a perguntas.
- Corpo
- AnswersResult
PII de conversa 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
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
A ID de um item de conversa. |
|
participantId
|
participantId | True | string |
A ID do participante de um item de conversa. |
|
linguagem
|
language | string |
A linguagem de substituição de um item de conversa na representação de linguagem BCP 47. |
|
|
função
|
role | string |
A função do participante. |
|
|
enviar SMS
|
text | True | string |
A entrada de texto |
|
linguagem
|
language | True | string |
O idioma do item de conversa no formato BCP-47. |
|
domínio
|
domain | string |
Enumeração de domínios de conversação com suporte. |
|
|
loggingOptOut
|
loggingOptOut | boolean | ||
|
piiCategories
|
piiCategories | array of string |
Descreve as categorias de PII a serem retornadas para detecção. Se não for fornecido, serão retornadas categorias 'padrão', que variarão com o idioma. |
Retornos
Contém o status do trabalho analisar conversas enviadas junto com estatísticas relacionadas.
PII de Conversa 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
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
A ID de um item de conversa. |
|
participantId
|
participantId | True | string |
A ID do participante de um item de conversa. |
|
linguagem
|
language | string |
A linguagem de substituição de um item de conversa na representação de linguagem BCP 47. |
|
|
função
|
role | string |
A função do participante. |
|
|
itn
|
itn | string |
Representação inversa de normalização de texto de entrada. O formulário normalizado por texto inverso é o texto reconhecido da API de Fala em Texto da Microsoft, com números de telefone, números, abreviações e outras transformações aplicadas. |
|
|
maskedItn
|
maskedItn | string |
O formato Normalizado de Texto Inverso com mascaramento de palavrões aplicado. |
|
|
enviar SMS
|
text | string |
A forma de exibição do texto reconhecido da API de fala em texto, com pontuação e capitalização adicionadas. |
|
|
lexical
|
lexical | string |
A forma lexical do texto reconhecido da API de fala em texto com as palavras reais reconhecidas. |
|
|
palavra
|
word | string |
A palavra reconhecida. |
|
|
deslocamento
|
offset | integer |
Deslocamento do início do áudio de fala, em tiques. 1 tique = 100 ns. |
|
|
duração
|
duration | integer |
Duração da articulação de palavras, em tiques. 1 tique = 100 ns. |
|
|
linguagem
|
language | True | string |
O idioma do item de conversa no formato BCP-47. |
|
domínio
|
domain | string |
Enumeração de domínios de conversação com suporte. |
|
|
loggingOptOut
|
loggingOptOut | boolean | ||
|
piiCategories
|
piiCategories | array of string |
Descreve as categorias de PII a serem retornadas para detecção. Se não for fornecido, serão retornadas categorias 'padrão', que variarão com o idioma. |
|
|
includeAudioRedaction
|
includeAudioRedaction | boolean |
Sinalizar para indicar se a redação de áudio é solicitada. Por padrão, a redação de áudio não será executada. |
|
|
redactionSource
|
redactionSource | string |
Enumeração de tipos de conteúdo de transcrição com suporte. |
Retornos
Contém o status do trabalho analisar conversas enviadas junto 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 com suporte, verifique as categorias de entidade NER (Reconhecimento de Entidade Nomeada) com suporte.
Parâmetros
| Nome | Chave | Obrigató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 de modelo não for especificada, a API deverá usar como padrão a versão mais recente e não prévia. |
|
|
Mostrar Estatísticas
|
showStats | boolean |
(Opcional) se definido como true, a resposta conterá estatísticas de nível de documento e entrada. |
|
|
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 ISO 639-1 de 2 letras de um idioma. Por exemplo, use "en" para inglês; "es" para espanhol etc. Se não estiver definido, use "en" para inglês como padrão. |
Retornos
- Corpo
- EntitiesResultV3
Reconhecimento de Entidade Nomeada (V3.1) (versão prévia)
A API retorna uma lista de entidades nomeadas gerais em um determinado documento. Para obter a lista de tipos de entidade com suporte, verifique as categorias de entidade NER (Reconhecimento de Entidade Nomeada) com suporte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
model-version
|
model-version | string |
(Opcional) Esse valor indica qual modelo será usado para pontuação. Se uma versão de modelo não for especificada, a API deverá usar como padrão a versão mais recente e não prévia. |
|
|
showStats
|
showStats | boolean |
(Opcional) se definido como true, a resposta conterá estatísticas de nível de solicitação e documento. |
|
|
loggingOptOut
|
loggingOptOut | boolean |
(Opcional) Se definido como true, você recusará ter sua entrada de texto registrada para solução de problemas. Por padrão, o Serviço Cognitivo do Azure para Linguagem registra o texto de entrada por 48 horas, apenas para permitir a solução de problemas ao fornecer o Serviço Cognitivo do Azure para funções de processamento de linguagem natural de linguagem. Definir esse parâmetro como true desabilita o registro em log de entrada e pode limitar nossa capacidade de corrigir problemas que ocorrem. Consulte as notas de conformidade e privacidade dos https://aka.ms/cs-compliance Serviços Cognitivos 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 (Graphemes) 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 ISO 639-1 de 2 letras de um idioma. Por exemplo, use "en" para inglês; "es" para espanhol etc. Se não estiver definido, use "en" para inglês como padrão. |
Retornos
- Corpo
- EntitiesResult
Reconhecimento de Entidade Nomeada (V4) (versão prévia)
A API retorna uma lista de entidades nomeadas gerais em um determinado documento. Para obter a lista de tipos de entidade com suporte, verifique as categorias de entidade NER (Reconhecimento de Entidade Nomeada) com suporte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Subdomínio de Recurso ou Região
|
subdomain | True | string |
Subdomínio do Azure ou região geográfica (por exemplo, westus) |
|
model-version
|
model-version | string |
(Opcional) Esse valor indica qual modelo será usado para pontuação. Se uma versão de modelo não for especificada, a API deverá usar como padrão a versão mais recente e não prévia. |
|
|
showStats
|
showStats | boolean |
(Opcional) se definido como true, a resposta conterá estatísticas de nível de solicitação e documento. |
|
|
loggingOptOut
|
loggingOptOut | boolean |
(Opcional) Se definido como true, você recusará ter sua entrada de texto registrada para solução de problemas. Por padrão, o Serviço Cognitivo do Azure para Linguagem registra o texto de entrada por 48 horas, apenas para permitir a solução de problemas ao fornecer o Serviço Cognitivo do Azure para funções de processamento de linguagem natural de linguagem. Definir esse parâmetro como true desabilita o registro em log de entrada e pode limitar nossa capacidade de corrigir problemas que ocorrem. Consulte as notas de conformidade e privacidade dos https://aka.ms/cs-compliance Serviços Cognitivos 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 (Graphemes) 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 ISO 639-1 de 2 letras de um idioma. Por exemplo, use "en" para inglês; "es" para espanhol etc. Se não estiver definido, use "en" para inglês como padrão. |
Retornos
- Corpo
- EntitiesResult
Resumo da 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
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
A ID de um item de conversa. |
|
participantId
|
participantId | True | string |
A ID do participante de um item de conversa. |
|
linguagem
|
language | string |
A linguagem de substituição de um item de conversa na representação de linguagem BCP 47. |
|
|
função
|
role | string |
A função do participante. |
|
|
enviar SMS
|
text | True | string |
A entrada de texto |
|
linguagem
|
language | True | string |
O idioma do item de conversa no formato BCP-47. |
|
domínio
|
domain | string |
Enumeração de domínios de conversação com suporte. |
|
|
loggingOptOut
|
loggingOptOut | boolean | ||
|
summaryAspects
|
summaryAspects | True | array of string |
Retornos
Contém o status do trabalho analisar conversas enviadas junto com estatísticas relacionadas.
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 à análise de sentimento e à linguagem de mineração de opiniões para a lista de idiomas com suporte.
Parâmetros
| Nome | Chave | Obrigató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 de modelo não for especificada, a API deverá usar como padrão a versão mais recente e não prévia. |
|
|
Mostrar Estatísticas
|
showStats | boolean |
(Opcional) se definido como true, a resposta conterá estatísticas de nível de documento e entrada. |
|
|
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 ISO 639-1 de 2 letras de um idioma. Por exemplo, use "en" para inglês; "es" para espanhol etc. Se não estiver definido, use "en" para inglês como padrão. |
Retornos
- Corpo
- SentimentResponse
Sentimento (V3.1) (versão prévia)
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, a partir do nível de um documento, até a frase e os termos-chave (destinos e avaliações).
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
model-version
|
model-version | string |
(Opcional) Esse valor indica qual modelo será usado para pontuação. Se uma versão de modelo não for especificada, a API deverá usar como padrão a versão mais recente e não prévia. |
|
|
showStats
|
showStats | boolean |
(Opcional) se definido como true, a resposta conterá estatísticas de nível de solicitação e documento. |
|
|
loggingOptOut
|
loggingOptOut | boolean |
(Opcional) Se definido como true, você recusará ter sua entrada de texto registrada para solução de problemas. Por padrão, o Serviço Cognitivo do Azure para Linguagem registra o texto de entrada por 48 horas, apenas para permitir a solução de problemas ao fornecer o Serviço Cognitivo do Azure para funções de processamento de linguagem natural de linguagem. Definir esse parâmetro como true desabilita o registro em log de entrada e pode limitar nossa capacidade de corrigir problemas que ocorrem. Consulte as notas de conformidade e privacidade dos https://aka.ms/cs-compliance Serviços Cognitivos para obter detalhes adicionais e os princípios de IA responsável da Microsoft em https://www.microsoft.com/en-us/ai/responsible-ai. |
|
|
opinionMining
|
opinionMining | boolean |
(Opcional) se definido como true, a resposta conterá não apenas a previsão de sentimento, mas também os resultados de mineração de opinião (análise de sentimento baseada em aspecto). |
|
|
stringIndexType
|
stringIndexType | string |
(Opcional) Especifica o método usado para interpretar deslocamentos de cadeia de caracteres. O padrão é elementos de texto (Graphemes) 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 ISO 639-1 de 2 letras de um idioma. Por exemplo, use "en" para inglês; "es" para espanhol etc. Se não estiver definido, use "en" para inglês como padrão. |
Retornos
- Corpo
- SentimentResponse
Sentimento (V4) (versão prévia)
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, a partir do nível de um documento, até a frase e os termos-chave (destinos e avaliações).
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Subdomínio de Recurso ou Região
|
subdomain | True | string |
Subdomínio do Azure ou região geográfica (por exemplo, westus) |
|
model-version
|
model-version | string |
(Opcional) Esse valor indica qual modelo será usado para pontuação. Se uma versão de modelo não for especificada, a API deverá usar como padrão a versão mais recente e não prévia. |
|
|
showStats
|
showStats | boolean |
(Opcional) se definido como true, a resposta conterá estatísticas de nível de solicitação e documento. |
|
|
loggingOptOut
|
loggingOptOut | boolean |
(Opcional) Se definido como true, você recusará ter sua entrada de texto registrada para solução de problemas. Por padrão, o Serviço Cognitivo do Azure para Linguagem registra o texto de entrada por 48 horas, apenas para permitir a solução de problemas ao fornecer o Serviço Cognitivo do Azure para funções de processamento de linguagem natural de linguagem. Definir esse parâmetro como true desabilita o registro em log de entrada e pode limitar nossa capacidade de corrigir problemas que ocorrem. Consulte as notas de conformidade e privacidade dos https://aka.ms/cs-compliance Serviços Cognitivos para obter detalhes adicionais e os princípios de IA responsável da Microsoft em https://www.microsoft.com/en-us/ai/responsible-ai. |
|
|
opinionMining
|
opinionMining | boolean |
(Opcional) se definido como true, a resposta conterá não apenas a previsão de sentimento, mas também os resultados de mineração de opinião (análise de sentimento baseada em aspecto). |
|
|
stringIndexType
|
stringIndexType | string |
(Opcional) Especifica o método usado para interpretar deslocamentos de cadeia de caracteres. O padrão é elementos de texto (Graphemes) 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 ISO 639-1 de 2 letras de um idioma. Por exemplo, use "en" para inglês; "es" para espanhol etc. Se não estiver definido, use "en" para inglês como padrão. |
Retornos
- Corpo
- SentimentResponse
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 ao idioma para a lista de idiomas com suporte.
Parâmetros
| Nome | Chave | Obrigató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 de modelo não for especificada, a API deverá usar como padrão a versão mais recente e não prévia. |
|
|
Mostrar Estatísticas
|
showStats | boolean |
(Opcional) se definido como true, a resposta conterá estatísticas de nível de documento e entrada. |
|
|
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 ISO 639-1 de 2 letras de um idioma. Por exemplo, use "en" para inglês; "es" para espanhol etc. Se não estiver definido, use "en" para inglês como padrão. |
Retornos
- Corpo
- EntityLinkingResult
Vinculação de entidade (V3.1) (versão prévia)
A API retorna uma lista de entidades reconhecidas com links para uma base de dados de conhecimento conhecida. Consulte o suporte ao idioma para a lista de idiomas com suporte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
model-version
|
model-version | string |
(Opcional) Esse valor indica qual modelo será usado para pontuação. Se uma versão de modelo não for especificada, a API deverá usar como padrão a versão mais recente e não prévia. |
|
|
showStats
|
showStats | boolean |
(Opcional) se definido como true, a resposta conterá estatísticas de nível de solicitação e documento. |
|
|
loggingOptOut
|
loggingOptOut | boolean |
(Opcional) Se definido como true, você recusará ter sua entrada de texto registrada para solução de problemas. Por padrão, o Serviço Cognitivo do Azure para Linguagem registra o texto de entrada por 48 horas, apenas para permitir a solução de problemas ao fornecer o Serviço Cognitivo do Azure para funções de processamento de linguagem natural de linguagem. Definir esse parâmetro como true desabilita o registro em log de entrada e pode limitar nossa capacidade de corrigir problemas que ocorrem. Consulte as notas de conformidade e privacidade dos https://aka.ms/cs-compliance Serviços Cognitivos 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 (Graphemes) 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 ISO 639-1 de 2 letras de um idioma. Por exemplo, use "en" para inglês; "es" para espanhol etc. Se não estiver definido, use "en" para inglês como padrão. |
Retornos
- Corpo
- EntityLinkingResult
Vinculação de entidade (V4) (versão prévia)
A API retorna uma lista de entidades reconhecidas com links para uma base de dados de conhecimento conhecida. Consulte o suporte ao idioma para a lista de idiomas com suporte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Subdomínio de Recurso ou Região
|
subdomain | True | string |
Subdomínio do Azure ou região geográfica (por exemplo, westus) |
|
model-version
|
model-version | string |
(Opcional) Esse valor indica qual modelo será usado para pontuação. Se uma versão de modelo não for especificada, a API deverá usar como padrão a versão mais recente e não prévia. |
|
|
showStats
|
showStats | boolean |
(Opcional) se definido como true, a resposta conterá estatísticas de nível de solicitação e documento. |
|
|
loggingOptOut
|
loggingOptOut | boolean |
(Opcional) Se definido como true, você recusará ter sua entrada de texto registrada para solução de problemas. Por padrão, o Serviço Cognitivo do Azure para Linguagem registra o texto de entrada por 48 horas, apenas para permitir a solução de problemas ao fornecer o Serviço Cognitivo do Azure para funções de processamento de linguagem natural de linguagem. Definir esse parâmetro como true desabilita o registro em log de entrada e pode limitar nossa capacidade de corrigir problemas que ocorrem. Consulte as notas de conformidade e privacidade dos https://aka.ms/cs-compliance Serviços Cognitivos 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 (Graphemes) 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 ISO 639-1 de 2 letras de um idioma. Por exemplo, use "en" para inglês; "es" para espanhol etc. Se não estiver definido, use "en" para inglês como padrão. |
Retornos
- Corpo
- EntityLinkingResult
Definições
ConversationalPIITranscriptJobState
Contém o status do trabalho analisar conversas enviadas junto com estatísticas relacionadas.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
nome de exibição
|
displayName | string | |
|
createdDateTime
|
createdDateTime | date-time | |
|
expirationDateTime
|
expirationDateTime | date-time | |
|
jobId
|
jobId | string | |
|
lastUpdatedDateTime
|
lastUpdatedDateTime | date-time | |
|
status
|
status | string | |
|
Erros
|
errors | array of Error | |
|
nextLink
|
nextLink | string | |
|
estatísticas
|
statistics | ConversationRequestStatistics |
se showStats=true foi especificado na solicitação, este campo conterá informações sobre o conteúdo da solicitação. |
|
concluído
|
tasks.completed | integer |
Contagem de tarefas concluídas com êxito. |
|
falhou
|
tasks.failed | integer |
Contagem de tarefas que falharam. |
|
inProgress
|
tasks.inProgress | integer |
Contagem de tarefas em andamento no momento. |
|
total
|
tasks.total | integer |
Contagem total de tarefas enviadas como parte do trabalho. |
|
taskResult
|
tasks.taskResult | ConversationalPIITranscriptResult |
Resultado da operação de detecção e redação de informações de identificação pessoal executada em uma lista de conversas. |
ConversationRequestStatistics
se showStats=true foi especificado na solicitação, este campo conterá informações sobre o conteúdo da solicitação.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
documentsCount
|
documentsCount | integer |
Número de documentos enviados na solicitação. |
|
validDocumentsCount
|
validDocumentsCount | integer |
Número de documentos válidos. Isso exclui documentos de idiomas vazios, de tamanho excessivo ou não compatíveis. |
|
erroneousDocumentsCount
|
erroneousDocumentsCount | integer |
Número de documentos inválidos. Isso inclui documentos de idiomas vazios, de tamanho excessivo ou sem suporte. |
|
transactionsCount
|
transactionsCount | integer |
Número de transações para a solicitação. |
|
conversationsCount
|
conversationsCount | integer |
Número de conversas enviadas na solicitação. |
|
validConversationsCount
|
validConversationsCount | integer |
Número de documentos de conversas. Isso exclui documentos de idiomas vazios, de tamanho excessivo ou não compatíveis. |
|
erroneousConversationsCount
|
erroneousConversationsCount | integer |
Número de documentos inválidos. Isso inclui documentos de idiomas vazios, de tamanho excessivo ou sem suporte. |
ConversationalPIITranscriptResult
Resultado da operação de detecção e redação de informações de identificação pessoal executada em uma lista de conversas.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
lastUpdateDateTime
|
lastUpdateDateTime | date-time |
A última hora atualizada em UTC para a tarefa. |
|
status
|
status |
O status da tarefa na hora da última atualização mencionada. |
|
|
taskName
|
taskName | string | |
|
variante
|
kind | ConversationalPIIResultsKind |
Enumeração dos resultados da tarefa Análise de Conversa com suporte. |
|
results
|
results | ConversationPIITranscriptResults |
O resultado da operação de detecção e redação de PII para cada conversa. |
ConversationalPIIResultsKind
Enumeração dos resultados da tarefa Análise de Conversa com suporte.
ConversationPIITranscriptResults
O resultado da operação de detecção e redação de PII para cada conversa.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
conversationItems
|
conversations.conversationItems | array of ConversationPIITranscriptItemResult |
Enumeração dos resultados da operação de detecção e redação de PII para todos os itens de conversa em uma conversa. |
|
id
|
conversations.id | string |
Identificador de conversa exclusivo e não vazio. |
|
Avisos
|
conversations.warnings | array of InputWarning |
Avisos encontrados durante o processamento do documento. |
|
estatísticas
|
conversations.statistics | ConversationStatistics |
Se showStats=true tiver sido especificado na solicitação, esse campo conterá informações sobre o conteúdo da conversa. |
|
Erros
|
errors | array of InputError |
Erros por ID do documento. |
|
estatísticas
|
statistics | RequestStatistics |
se showStats=true foi especificado na solicitação, este campo conterá informações sobre o conteúdo da solicitação. |
|
modelVersion
|
modelVersion | string |
Esse campo indica qual modelo é usado para pontuação. |
InputError
Contém detalhes dos erros encontrados durante uma execução de trabalho.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
A ID da entrada. |
|
erro
|
error | Error |
O objeto de erro. |
InputWarning
Contém detalhes dos avisos encontrados durante uma execução de trabalho.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
codificar
|
code | string |
Código de aviso. |
|
mensagem
|
message | string |
Mensagem de aviso. |
|
targetRef
|
targetRef | string |
Uma referência de ponteiro JSON que indica o objeto de destino. |
ConversationStatistics
Se showStats=true tiver sido especificado na solicitação, esse campo conterá informações sobre o conteúdo da conversa.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
transactionsCount
|
transactionsCount | integer |
Número de unidades de texto para a solicitação. |
ConversationPIITranscriptItemResult
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string | |
|
redactedContent
|
redactedContent | ConversationalPIITranscriptRedactedTranscriptContent |
A resposta de conteúdo da transcrição gerada pelo serviço com todas as informações de identificação pessoal necessárias redigidas. |
|
entities
|
entities | array of Entity |
ConversationalPIITranscriptRedactedTranscriptContent
A resposta de conteúdo da transcrição gerada pelo serviço com todas as informações de identificação pessoal necessárias redigidas.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
itn
|
itn | string |
A saída redigida para entrada de formato normalizado de texto inverso. |
|
maskedItn
|
maskedItn | string |
A saída redigida para entrada de formato normalizado de texto inverso mascarado. |
|
enviar SMS
|
text | string |
A saída redigida para a entrada de formato de texto (Conversão de Fala em Texto da Microsoft) . |
|
lexical
|
lexical | string |
A saída redigida para entrada de formato léxico. |
|
audioTimings
|
audioTimings | array of AudioTiming |
A lista de segmentos de áudio redigidos. |
AudioTiming
As informações de tempo de áudio.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
deslocamento
|
offset | integer |
Deslocamento do início do áudio de fala, em tiques. 1 tique = 100 ns. |
|
duração
|
duration | integer |
Duração da articulação de palavras, em tiques. 1 tique = 100 ns. |
ConversationalPIITextJobState
Contém o status do trabalho analisar conversas enviadas junto com estatísticas relacionadas.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
nome de exibição
|
displayName | string | |
|
createdDateTime
|
createdDateTime | date-time | |
|
expirationDateTime
|
expirationDateTime | date-time | |
|
jobId
|
jobId | string | |
|
lastUpdatedDateTime
|
lastUpdatedDateTime | date-time | |
|
status
|
status | string | |
|
Erros
|
errors | array of Error | |
|
nextLink
|
nextLink | string | |
|
estatísticas
|
statistics | ConversationRequestStatistics |
se showStats=true foi especificado na solicitação, este campo conterá informações sobre o conteúdo da solicitação. |
|
concluído
|
tasks.completed | integer |
Contagem de tarefas concluídas com êxito. |
|
falhou
|
tasks.failed | integer |
Contagem de tarefas que falharam. |
|
inProgress
|
tasks.inProgress | integer |
Contagem de tarefas em andamento no momento. |
|
total
|
tasks.total | integer |
Contagem total de tarefas enviadas como parte do trabalho. |
|
taskResult
|
tasks.taskResult | ConversationalPIITextResult |
Resultado da operação de detecção e redação de informações de identificação pessoal executada em uma lista de conversas. |
ConversationalPIITextResult
Resultado da operação de detecção e redação de informações de identificação pessoal executada em uma lista de conversas.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
lastUpdateDateTime
|
lastUpdateDateTime | date-time |
A última hora atualizada em UTC para a tarefa. |
|
status
|
status |
O status da tarefa na hora da última atualização mencionada. |
|
|
taskName
|
taskName | string | |
|
variante
|
kind | ConversationalPIIResultsKind |
Enumeração dos resultados da tarefa Análise de Conversa com suporte. |
|
results
|
results | ConversationPIITextResults |
O resultado da operação de detecção e redação de PII para cada conversa. |
ConversationPIITextResults
O resultado da operação de detecção e redação de PII para cada conversa.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
conversationItems
|
conversations.conversationItems | array of ConversationPIITextItemResult |
Enumeração dos resultados da operação de detecção e redação de PII para todos os itens de conversa em uma conversa. |
|
id
|
conversations.id | string |
Identificador de conversa exclusivo e não vazio. |
|
Avisos
|
conversations.warnings | array of InputWarning |
Avisos encontrados durante o processamento do documento. |
|
estatísticas
|
conversations.statistics | ConversationStatistics |
Se showStats=true tiver sido especificado na solicitação, esse campo conterá informações sobre o conteúdo da conversa. |
|
Erros
|
errors | array of InputError |
Erros por ID do documento. |
|
estatísticas
|
statistics | RequestStatistics |
se showStats=true foi especificado na solicitação, este campo conterá informações sobre o conteúdo da solicitação. |
|
modelVersion
|
modelVersion | string |
Esse campo indica qual modelo é usado para pontuação. |
ConversationPIITextItemResult
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string | |
|
redactedContent
|
redactedContent | ConversationalPIITranscriptRedactedTextContent |
A resposta de conteúdo da transcrição gerada pelo serviço com todas as informações de identificação pessoal necessárias redigidas. |
|
entities
|
entities | array of Entity |
ConversationalPIITranscriptRedactedTextContent
A resposta de conteúdo da transcrição gerada pelo serviço com todas as informações de identificação pessoal necessárias redigidas.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
enviar SMS
|
text | string |
A saída redigida para a entrada de formato de texto (Conversão de Fala em Texto da Microsoft) . |
AnalyzeConversationSummarizationJobState
Contém o status do trabalho analisar conversas enviadas junto com estatísticas relacionadas.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
nome de exibição
|
displayName | string | |
|
createdDateTime
|
createdDateTime | date-time | |
|
expirationDateTime
|
expirationDateTime | date-time | |
|
jobId
|
jobId | string | |
|
lastUpdatedDateTime
|
lastUpdatedDateTime | date-time | |
|
status
|
status | string | |
|
Erros
|
errors | array of Error | |
|
nextLink
|
nextLink | string | |
|
estatísticas
|
statistics | ConversationRequestStatistics |
se showStats=true foi especificado na solicitação, este campo conterá informações sobre o conteúdo da solicitação. |
|
concluído
|
tasks.completed | integer |
Contagem de tarefas concluídas com êxito. |
|
falhou
|
tasks.failed | integer |
Contagem de tarefas que falharam. |
|
inProgress
|
tasks.inProgress | integer |
Contagem de tarefas em andamento no momento. |
|
total
|
tasks.total | integer |
Contagem total de tarefas enviadas como parte do trabalho. |
|
taskResult
|
tasks.taskResult | AnalyzeConversationSummarizationResult |
Resultado da tarefa de resumo na conversa. |
AnalyzeConversationSummarizationResult
Resultado da tarefa de resumo na conversa.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
lastUpdateDateTime
|
lastUpdateDateTime | date-time |
A última hora atualizada em UTC para a tarefa. |
|
status
|
status |
O status da tarefa na hora da última atualização mencionada. |
|
|
taskName
|
taskName | string | |
|
variante
|
kind | ConversationalSummarizationResultsKind |
Enumeração dos resultados da tarefa Análise de Conversa com suporte. |
|
results
|
results | SummaryResult |
ConversationalSummarizationResultsKind
Enumeração dos resultados da tarefa Análise de Conversa com suporte.
SummaryResult
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
summaries
|
conversations.summaries | array of SummaryResultItem | |
|
id
|
conversations.id | string |
Identificador de conversa exclusivo e não vazio. |
|
Avisos
|
conversations.warnings | array of InputWarning |
Avisos encontrados durante o processamento do documento. |
|
estatísticas
|
conversations.statistics | ConversationStatistics |
Se showStats=true tiver sido especificado na solicitação, esse campo conterá informações sobre o conteúdo da conversa. |
|
Erros
|
errors | array of InputError |
Erros por ID do documento. |
|
estatísticas
|
statistics | RequestStatistics |
se showStats=true foi especificado na solicitação, este campo conterá informações sobre o conteúdo da solicitação. |
|
modelVersion
|
modelVersion | string |
Esse campo indica qual modelo é usado para pontuação. |
SummaryResultItem
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
aspecto
|
aspect | string | |
|
enviar SMS
|
text | string |
Erro
O objeto de erro.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
codificar
|
code | ErrorCode |
Código de erro legível por humanos. |
|
mensagem
|
message | string |
Uma representação legível pelo ser humano do erro. |
|
destino
|
target | string |
O destino 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
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.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
codificar
|
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 |
Destino 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
LanguageCustomEntitiesResult
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Documentos
|
documents | array of LanguageEntitiesDocumentResult |
Resposta por documento |
LanguageCustomLabelClassificationResult
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Documentos
|
documents | array of LanguageClassificationDocumentResult |
Resposta por documento |
LanguageClassificationResult
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
categoria
|
category | string |
Tipo de classificação. |
|
confidenceScore
|
confidenceScore | double |
Pontuação de confiança entre 0 e 1 da classe reconhecida. |
LanguageClassificationDocumentResult
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
classe
|
class | array of LanguageClassificationResult | |
|
id
|
id | string |
Identificador de documento exclusivo e não vazio. |
LanguageHealthcareResult
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Documentos
|
documents | array of LanguageHealthcareEntitiesDocumentResult |
LanguageHealthcareEntitiesDocumentResult
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
entities
|
entities | array of LanguageHealthcareEntity |
Entidades de saúde. |
|
relations
|
relations | array of LanguageHealthcareRelation |
Relações de entidade de saúde. |
|
id
|
id | string |
Identificador de documento exclusivo e não vazio. |
LanguageHealthcareEntity
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
enviar SMS
|
text | string |
Texto da entidade conforme aparece na solicitação. |
|
categoria
|
category | string |
Categoria entidade de serviço de saúde. |
|
subcategory
|
subcategory | string |
(Opcional) Subtipo de entidade. |
|
deslocamento
|
offset | integer |
Posição inicial do 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. |
|
confidenceScore
|
confidenceScore | double |
Pontuação 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 entidade em fontes de dados conhecidas. |
LanguageHealthcareRelation
Cada relação é um grafo de entidade de um determinado relationType, em que todas as entidades estão conectadas e têm funções específicas dentro do contexto de relação.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
relationType
|
relationType | string |
Tipo de relação. Exemplos incluem: |
|
entities
|
entities | array of LanguageHealthcareRelationEntity |
As entidades na relação. |
LanguageHealthcareAssertion
| Nome | 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. |
LanguageHealthcareRelationEntity
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ref
|
ref | string |
Objeto de link de referência, usando um ponteiro JSON RFC 6901 (Representação do Identificador de Fragmento de URI), apontando para a entidade. |
|
função
|
role | string |
Função de entidade na relação. Por exemplo: 'linfoma de célula B grande difuso cd20-positivo' tem as seguintes entidades com suas funções em parênteses: CD20 (GeneOrProtein), Positivo (Expressão), linfoma de célula B grande difuso (Diagnóstico). |
LanguageHealthcareEntityLink
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
dataSource
|
dataSource | string |
Catálogo de Entidades. Os exemplos incluem: UMLS, CHV, MSH etc. |
|
id
|
id | string |
ID da entidade no catálogo de origem especificado. |
LanguageSentimentResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Documentos
|
documents | array of LanguageSentimentDocumentResult |
Análise de sentimento por documento. |
LanguageSentimentDocumentResult
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
sentimento
|
sentiment | string |
Sentimento previsto para documento (Negativo, Neutro, Positivo ou Misto). |
|
confidenceScores
|
confidenceScores | LanguageSentimentConfidenceScorePerLabel |
Representa as pontuações de confiança entre 0 e 1 em todas as classes de sentimento: positiva, neutra, negativa. |
|
Frases
|
sentences | array of LanguageSentenceSentiment |
Análise de sentimento no nível da sentença. |
|
id
|
id | string |
Identificador de documento exclusivo e não vazio. |
LanguageSentimentConfidenceScorePerLabel
Representa as pontuações de confiança entre 0 e 1 em todas as classes de sentimento: positiva, neutra, negativa.
| Nome | 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
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
enviar SMS
|
text | string |
O texto da frase. |
|
sentimento
|
sentiment | string |
O sentimento previsto para a frase. |
|
confidenceScores
|
confidenceScores | LanguageSentimentConfidenceScorePerLabel |
Representa as pontuações de confiança entre 0 e 1 em todas as classes de sentimento: positiva, neutra, negativa. |
|
deslocamento
|
offset | integer |
O deslocamento da sentença desde o início do documento. |
|
length
|
length | integer |
O comprimento da frase. |
|
targets
|
targets | array of LanguageSentenceTarget |
A matriz de destinos de frase para a sentença. |
|
avaliações
|
assessments | array of LanguageSentenceAssessment |
A matriz de avaliações para a sentença. |
LanguageSentenceTarget
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
sentimento
|
sentiment | string |
Sentimento direcionado na frase. |
|
confidenceScores
|
confidenceScores | LanguageTargetConfidenceScoreLabel |
Representa as pontuações de confiança em todas as classes de sentimento: positivas e negativas. |
|
deslocamento
|
offset | integer |
O deslocamento de destino desde o início da frase. |
|
length
|
length | integer |
O comprimento do destino. |
|
enviar SMS
|
text | string |
O texto de destino detectado. |
|
relations
|
relations | array of LanguageTargetRelation |
A matriz de objetos de avaliação ou de destino que está relacionada ao destino. |
LanguageSentenceAssessment
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
sentimento
|
sentiment | string |
Sentimento de avaliação na frase. |
|
confidenceScores
|
confidenceScores | LanguageTargetConfidenceScoreLabel |
Representa as pontuações de confiança em todas as classes de sentimento: positivas e negativas. |
|
deslocamento
|
offset | integer |
O deslocamento de avaliação desde o início da sentença. |
|
length
|
length | integer |
O comprimento da avaliação. |
|
enviar SMS
|
text | string |
O texto da avaliação detectado. |
|
isNegated
|
isNegated | boolean |
O indicador que representa se a avaliação é negada. |
LanguageTargetRelation
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
relationType
|
relationType | string |
O tipo relacionado ao destino. |
|
ref
|
ref | string |
O ponteiro JSON que indica o objeto vinculado. |
LanguageTargetConfidenceScoreLabel
Representa as pontuações de confiança em todas as classes de sentimento: positivas e negativas.
| Nome | 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
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Documentos
|
documents | array of LanguageEntitiesDocumentResult |
Resposta por documento |
LanguageEntitiesDocumentResult
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
entities
|
entities | array of LanguageEntity |
Entidades reconhecidas no documento. |
|
id
|
id | string |
Identificador de documento exclusivo e não vazio. |
LanguageEntity
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
enviar SMS
|
text | string |
Texto da entidade conforme aparece na solicitação. |
|
categoria
|
category | string |
Tipo de entidade. |
|
subcategory
|
subcategory | string |
(Opcional) Subtipo de entidade. |
|
deslocamento
|
offset | integer |
Posição inicial do 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. |
|
confidenceScore
|
confidenceScore | double |
Pontuação de confiança entre 0 e 1 da entidade extraída. |
LanguageEntityLinkingResult
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Documentos
|
documents | array of LanguageLinkedEntitiesDocumentResult |
Resposta por documento |
LanguageLinkedEntitiesDocumentResult
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
entities
|
entities | array of LanguageLinkedEntity |
Entidades conhecidas reconhecidas no documento. |
|
id
|
id | string |
Identificador de documento exclusivo e não vazio. |
LanguageLinkedEntity
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
nome
|
name | string |
Nome formal de vinculação de entidade. |
|
Corresponde
|
matches | array of LanguageMatch |
Lista de instâncias em que essa entidade aparece no texto. |
|
linguagem
|
language | string |
Idioma usado 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 entidade, como Wiki/Bing etc. |
|
bingId
|
bingId | string |
Identificador exclusivo da API de Pesquisa de Entidade do Bing da entidade reconhecida. |
LanguageMatch
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
confidenceScore
|
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. |
|
deslocamento
|
offset | integer |
Posição inicial para o texto de correspondência da entidade. |
|
length
|
length | integer |
Comprimento para o texto de correspondência de entidade. |
LanguagePiiResult
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Documentos
|
documents | array of LanguagePiiEntitiesDocumentResult |
Resposta por documento |
LanguagePiiEntitiesDocumentResult
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
redactedText
|
redactedText | string |
Retorna texto redigido. |
|
entities
|
entities | array of LanguageEntity |
Entidades reconhecidas no documento. |
|
id
|
id | string |
Identificador de documento exclusivo e não vazio. |
LanguageKeyPhraseResult
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Documentos
|
documents | array of LanguageKeyPhrasesDocumentResult |
Resposta por documento |
LanguageKeyPhrasesDocumentResult
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
keyPhrases
|
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
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
taskResult
|
tasks.taskResult | LanguageKeyPhraseExtractionLROResult |
LanguageAnalyzeTextJobState_CNER
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
taskResult
|
tasks.taskResult | LanguageCustomEntityRecognitionLROResult |
LanguageAnalyzeTextJobState_CSLC
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
taskResult
|
tasks.taskResult | LanguageCustomSingleLabelClassificationLROResult |
LanguageAnalyzeTextJobState_CMLC
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
taskResult
|
tasks.taskResult | LanguageCustomMultiLabelClassificationLROResult |
LanguageAnalyzeTextJobState_Entites
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
taskResult
|
tasks.taskResult | LanguageEntityRecognitionLROResult |
LanguageAnalyzeTextJobState_Pii
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
taskResult
|
tasks.taskResult | LanguagePiiEntityRecognitionLROResult |
LanguageAnalyzeTextJobState_Sentiment
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
taskResult
|
tasks.taskResult | LanguageSentimentLROResult |
LanguageAnalyzeTextJobState_HealthCare
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
taskResult
|
tasks.taskResult | LanguageHealthcareLROResult |
LanguageAnalyzeTextJobState_ExtractiveSummarization
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
taskResult
|
tasks.taskResult | ExtractiveSummarizationLROResult |
LanguageAnalyzeTextJobState_AbstractiveSummarization
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
taskResult
|
tasks.taskResult | AbstractiveSummarizationLROResult |
Um objeto que representa os resultados de uma tarefa Resumo Abstrativo. |
LanguageAnalyzeTextJobState_EntityLinking
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
taskResult
|
tasks.taskResult | LanguageEntityLinkingLROResult |
LanguageEntityRecognitionLROResult
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
results
|
results | LanguageEntitiesResult |
LanguageCustomEntityRecognitionLROResult
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
results
|
results | LanguageCustomEntitiesResult |
LanguageCustomSingleLabelClassificationLROResult
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
results
|
results | LanguageCustomLabelClassificationResult |
LanguageCustomMultiLabelClassificationLROResult
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
results
|
results | LanguageCustomLabelClassificationResult |
LanguageEntityLinkingLROResult
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
results
|
results | LanguageEntityLinkingResult |
LanguagePiiEntityRecognitionLROResult
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
results
|
results | LanguagePiiResult |
LanguageHealthcareLROResult
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
results
|
results | LanguageHealthcareResult |
LanguageSentimentLROResult
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
results
|
results | LanguageSentimentResponse |
LanguageKeyPhraseExtractionLROResult
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
results
|
results | LanguageKeyPhraseResult |
LanguageDocumentWarning
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
codificar
|
code | string |
Código de erro. |
|
mensagem
|
message | string |
Mensagem de aviso. |
|
targetRef
|
targetRef | string |
Uma referência de ponteiro JSON que indica o objeto de destino. |
DocumentError
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
ID do documento. |
|
erro
|
error | TextAnalyticsError |
TextAnalyticsError
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
codificar
|
code | string |
Código de erro. |
|
mensagem
|
message | string |
Mensagem de erro. |
|
destino
|
target | string |
Destino de erro. |
|
innererror
|
innererror | InnerError | |
|
details
|
details | array of TextAnalyticsError |
Detalhes sobre erros específicos que levaram a esse erro relatado. |
TextAnalyticsWarning
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
codificar
|
code | string |
Código de erro. |
|
mensagem
|
message | string |
Mensagem de aviso. |
|
targetRef
|
targetRef | string |
Uma referência de ponteiro JSON que indica o objeto de destino. |
InnerError
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
codificar
|
code | string |
Código de erro. |
|
mensagem
|
message | string |
Mensagem de erro. |
|
details
|
details | object |
Detalhes do erro. |
|
destino
|
target | string |
Destino de erro. |
|
innererror
|
innererror | InnerError |
SentimentResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Documentos
|
documents | array of DocumentSentiment |
Análise de sentimento por documento. |
|
Erros
|
errors | array of DocumentError |
Erros por ID do documento. |
|
estatísticas
|
statistics | RequestStatistics |
se showStats=true foi especificado na solicitação, este campo conterá informações sobre o conteúdo da solicitação. |
|
modelVersion
|
modelVersion | string |
Esse campo indica qual modelo é usado para pontuação. |
DocumentSentiment
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
Identificador de documento exclusivo e não vazio. |
|
sentimento
|
sentiment | string |
Sentimento previsto para documento (Negativo, Neutro, Positivo ou Misto). |
|
estatísticas
|
statistics | DocumentStatistics |
se showStats=true foi especificado na solicitação, este campo conterá informações sobre o conteúdo do documento. |
|
confidenceScores
|
confidenceScores | SentimentConfidenceScorePerLabel |
Representa as pontuações de confiança entre 0 e 1 em todas as classes de sentimento: positiva, neutra, negativa. |
|
Frases
|
sentences | array of SentenceSentiment |
Análise de sentimento no nível da sentença. |
|
Avisos
|
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 o conteúdo da solicitação.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
documentsCount
|
documentsCount | integer |
Número de documentos enviados na solicitação. |
|
validDocumentsCount
|
validDocumentsCount | integer |
Número de documentos válidos. Isso exclui documentos de idiomas vazios, de tamanho excessivo ou não compatíveis. |
|
erroneousDocumentsCount
|
erroneousDocumentsCount | integer |
Número de documentos inválidos. Isso inclui documentos de idiomas vazios, 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 o conteúdo do documento.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
charactersCount
|
charactersCount | integer |
Número de elementos de texto reconhecidos no documento. |
|
transactionsCount
|
transactionsCount | integer |
Número de transações para o documento. |
SentimentConfidenceScorePerLabel
Representa as pontuações de confiança entre 0 e 1 em todas as classes de sentimento: positiva, neutra, negativa.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Positivo
|
positive | double | |
|
neutro
|
neutral | double | |
|
Negativo
|
negative | double |
SentenceSentiment
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
enviar SMS
|
text | string |
O texto da frase. |
|
sentimento
|
sentiment | string |
O sentimento previsto para a frase. |
|
confidenceScores
|
confidenceScores | SentimentConfidenceScorePerLabel |
Representa as pontuações de confiança entre 0 e 1 em todas as classes de sentimento: positiva, neutra, negativa. |
|
deslocamento
|
offset | integer |
O deslocamento da sentença desde o início do documento. |
|
length
|
length | integer |
O comprimento da frase pelo padrão Unicode. |
DocumentEntities
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
Identificador de documento exclusivo e não vazio. |
|
entities
|
entities | array of Entity |
Entidades reconhecidas no documento. |
|
Avisos
|
warnings | array of TextAnalyticsWarning |
Avisos encontrados durante o processamento do documento. |
|
estatísticas
|
statistics | DocumentStatistics |
se showStats=true foi especificado na solicitação, este campo conterá informações sobre o conteúdo do documento. |
PiiDocumentEntities
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
Identificador de documento exclusivo e não vazio. |
|
redactedText
|
redactedText | string |
Retorna texto redigido. |
|
entities
|
entities | array of Entity |
Entidades reconhecidas no documento. |
|
Avisos
|
warnings | array of TextAnalyticsWarning |
Avisos encontrados durante o processamento do documento. |
|
estatísticas
|
statistics | DocumentStatistics |
se showStats=true foi especificado na solicitação, este campo conterá informações sobre o conteúdo do documento. |
Entidade
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
enviar SMS
|
text | string |
Texto da entidade conforme aparece na solicitação. |
|
categoria
|
category | string |
Tipo de entidade, como Pessoa/Localização/Organização/SSN etc. |
|
subcategory
|
subcategory | string |
Subtipo de entidade, como Idade/Ano/TimeRange etc. |
|
deslocamento
|
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. |
|
confidenceScore
|
confidenceScore | double |
Pontuação de confiança entre 0 e 1 da entidade extraída. |
EntityLinkingResult
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Documentos
|
documents | array of DocumentLinkedEntities |
Resposta por documento |
|
Erros
|
errors | array of DocumentError |
Erros por ID do documento. |
|
estatísticas
|
statistics | RequestStatistics |
se showStats=true foi especificado na solicitação, este campo conterá informações sobre o conteúdo da solicitação. |
|
modelVersion
|
modelVersion | string |
Esse campo indica qual modelo é usado para pontuação. |
DocumentLinkedEntities
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
Identificador de documento exclusivo e não vazio. |
|
entities
|
entities | array of LinkedEntity |
Entidades conhecidas reconhecidas no documento. |
|
Avisos
|
warnings | array of TextAnalyticsWarning |
Avisos encontrados durante o processamento do documento. |
|
estatísticas
|
statistics | DocumentStatistics |
se showStats=true foi especificado na solicitação, este campo conterá informações sobre o conteúdo do documento. |
LinkedEntity
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
nome
|
name | string |
Nome formal de vinculação de entidade. |
|
Corresponde
|
matches | array of Match |
Lista de instâncias em que essa entidade aparece no texto. |
|
linguagem
|
language | string |
Idioma usado 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 entidade, como Wiki/Bing etc. |
Match
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
confidenceScore
|
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. |
|
deslocamento
|
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
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
Identificador de documento exclusivo e não vazio. |
|
keyPhrases
|
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. |
|
Avisos
|
warnings | array of TextAnalyticsWarning |
Avisos encontrados durante o processamento do documento. |
|
estatísticas
|
statistics | DocumentStatistics |
se showStats=true foi especificado na solicitação, este campo conterá informações sobre o conteúdo do documento. |
DocumentLanguage
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
Identificador de documento exclusivo e não vazio. |
|
detectedLanguage
|
detectedLanguage | DetectedLanguage | |
|
Avisos
|
warnings | array of TextAnalyticsWarning |
Avisos encontrados durante o processamento do documento. |
|
estatísticas
|
statistics | DocumentStatistics |
se showStats=true foi especificado na solicitação, este campo conterá informações sobre o conteúdo do documento. |
DetectedLanguage
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
nome
|
name | string |
Nome longo de um idioma detectado (por exemplo, inglês, francês). |
|
iso6391Name
|
iso6391Name | string |
Uma representação de duas letras do idioma detectado de acordo com o padrão ISO 639-1 (por exemplo, en, fr). |
|
confidenceScore
|
confidenceScore | double |
Uma pontuação de confiança entre 0 e 1. Pontuações próximas a 1 indicam 100% certeza de que o idioma identificado é verdadeiro. |
KeyPhraseResultV3
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Documentos
|
documents | array of DocumentKeyPhrases |
Resposta por documento |
|
Erros
|
errors | array of DocumentError |
Erros por ID do documento. |
|
estatísticas
|
statistics | RequestStatistics |
se showStats=true foi especificado na solicitação, este campo conterá informações sobre o conteúdo da solicitação. |
|
modelVersion
|
modelVersion | string |
Esse campo indica qual modelo é usado para pontuação. |
EntitiesResultV3
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Documentos
|
documents | array of DocumentEntities |
Resposta por documento |
|
Erros
|
errors | array of DocumentError |
Erros por ID do documento. |
|
estatísticas
|
statistics | RequestStatistics |
se showStats=true foi especificado na solicitação, este campo conterá informações sobre o conteúdo da solicitação. |
|
modelVersion
|
modelVersion | string |
Esse campo indica qual modelo é usado para pontuação. |
PiiResult
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Documentos
|
documents | array of PiiDocumentEntities |
Resposta por documento |
|
Erros
|
errors | array of DocumentError |
Erros por ID do documento. |
|
estatísticas
|
statistics | RequestStatistics |
se showStats=true foi especificado na solicitação, este campo conterá informações sobre o conteúdo da solicitação. |
|
modelVersion
|
modelVersion | string |
Esse campo indica qual modelo é usado para pontuação. |
LanguageResultV3
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Documentos
|
documents | array of DocumentLanguage |
Resposta por documento |
|
Erros
|
errors | array of DocumentError |
Erros por ID do documento. |
|
estatísticas
|
statistics | RequestStatistics |
se showStats=true foi especificado na solicitação, este campo conterá informações sobre o conteúdo da solicitação. |
|
modelVersion
|
modelVersion | string |
Esse campo indica qual modelo é usado para pontuação. |
KeyPhraseResults
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Documentos
|
documents | array of KeyPhraseResult |
EntitiesResults
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Documentos
|
documents | array of EntitiesResult |
LanguageResults
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Documentos
|
documents | array of LanguageResult |
SentimentResults
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Documentos
|
documents | array of SentimentResult |
KeyPhraseResult
| Nome | 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 de documento exclusivo. |
EntitiesResult
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Entities
|
entities | array of object |
Uma lista de entidades desambiguadas com links para mais informações na Web (Wikipédia 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 | |
|
Idioma da Wikipédia
|
entities.wikipediaLanguage | string |
Idioma da Wikipédia da entidade. |
|
ID da Wikipédia
|
entities.wikipediaId | string |
ID da Wikipédia 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 da entidade. |
|
Subtipo
|
entities.subType | string |
Subtipo da entidade. |
|
ID
|
id | string |
O identificador de documento exclusivo. |
LanguageResult
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O identificador de documento exclusivo. |
|
detectedLanguages
|
detectedLanguages | array of DetectedLanguageV2 |
Uma lista de idiomas extraídos. |
SentimentResult
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Score
|
score | double |
Um número decimal entre 0 e 1 que indica o sentimento do documento. Uma pontuação acima de 0,7 geralmente se refere a um documento positivo, enquanto uma pontuação abaixo de 0,3 normalmente tem uma conotação negativa. Valores médios referem-se ao texto neutro. |
|
ID
|
id | string |
O identificador de documento exclusivo. |
DetectedLanguageV2
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome
|
name | string |
O nome longo de um idioma detectado (por exemplo, inglês, francês). |
|
Código de idioma
|
iso6391Name | string |
Uma representação de duas letras do idioma detectado de acordo com o padrão ISO 639-1 (por exemplo, en, fr). |
|
Score
|
score | double |
Uma pontuação de confiança entre 0 e 1. Pontuações próximas a 1 indicam 100% certeza de que o idioma identificado é verdadeiro. |
AnalyzeConversationTaskResultsKind
Enumeração de resultados de tarefas de conversa com suporte
Enumeração de resultados de tarefas de conversa com suporte
ConversationalTaskResult
Os resultados de uma tarefa de Conversa.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
variante
|
kind | AnalyzeConversationTaskResultsKind |
Enumeração de resultados de tarefas de conversa com suporte |
|
resultado
|
result | AnalyzeConversationResult |
Representa uma resposta de análise de conversa. |
ConversationalTaskResult_Orchestration
Os resultados de uma tarefa de Conversa.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
variante
|
kind | AnalyzeConversationTaskResultsKind |
Enumeração de resultados de tarefas de conversa com suporte |
|
resultado
|
result | AnalyzeConversationResult_Orchestration |
Representa uma resposta de análise de conversa. |
AnalyzeConversationResult
Representa uma resposta de análise de conversa.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
consulta
|
query | string |
O enunciado da conversa dado pelo chamador. |
|
detectedLanguage
|
detectedLanguage | string |
O idioma detectado pelo sistema para a consulta na representação da linguagem BCP 47.. |
|
previsão
|
prediction | ConversationPrediction |
Representa a seção de previsão de um projeto de conversa. |
AnalyzeConversationResult_Orchestration
Representa uma resposta de análise de conversa.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
consulta
|
query | string |
O enunciado da conversa dado pelo chamador. |
|
detectedLanguage
|
detectedLanguage | string |
O idioma detectado pelo sistema para a consulta na representação da linguagem BCP 47.. |
|
previsão
|
prediction | OrchestrationPrediction |
Isso representa o resultado da previsão de um projeto de Orquestração. |
ConversationPrediction
Representa a seção de previsão de um projeto de conversa.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
intenções
|
intents | array of ConversationIntent |
Os resultados da classificação de intenção. |
|
entities
|
entities | array of ConversationEntity |
Os resultados da extração de entidade. |
|
tipoDeProjeto
|
projectKind | string |
O tipo do projeto. |
|
topIntent
|
topIntent | string |
A intenção com a pontuação mais alta. |
ConversationIntent
O resultado da classificação de intenção de um projeto de Conversa.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
categoria
|
category | string |
Uma classe prevista. |
|
confidenceScore
|
confidenceScore | float |
A pontuação de confiança da classe de 0,0 a 1,0. |
ConversationEntity
O resultado da extração de entidade de um projeto de conversa.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
categoria
|
category | string |
A categoria de entidade. |
|
enviar SMS
|
text | string |
O texto da entidade prevista. |
|
deslocamento
|
offset | integer |
O índice inicial dessa entidade na consulta. |
|
length
|
length | integer |
O comprimento do texto. |
|
confidenceScore
|
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. |
|
extraInformation
|
extraInformation | array of BaseExtraInformation |
A coleção de objetos de informações extras da entidade. |
|
topResolution
|
topResolution | BaseResolution |
A classe base abstrata para resoluções de entidade. |
|
multipleResolutions
|
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.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
extraInformationKind
|
extraInformationKind | string |
O tipo de objeto de informação extra. |
BaseResolution
A classe base abstrata para resoluções de entidade.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
resolutionKind
|
resolutionKind | string |
O tipo de objeto de resolução de entidade. |
OrchestrationPrediction
Isso representa o resultado da previsão de um projeto de Orquestração.
| Nome | 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 do projeto. |
|
topIntent
|
topIntent | string |
A intenção com a pontuação mais alta. |
ExtractiveSummarizationResult
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Documentos
|
documents | array of ExtractedSummaryDocumentResultWithDetectedLanguage |
Resposta por documento |
ExtractedSummaryDocumentResultWithDetectedLanguage
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Frases
|
sentences | array of ExtractedSummarySentence |
Uma lista classificada de frases que representam o resumo extraído. |
|
detectedLanguage
|
detectedLanguage | DetectedLanguage |
ExtractedSummarySentence
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
enviar SMS
|
text | string |
O texto da frase extraída. |
|
rankScore
|
rankScore | double |
Um valor duplo que representa a relevância da frase dentro do resumo. Valores mais altos indicam maior importância. |
|
deslocamento
|
offset | integer |
O deslocamento de sentença desde o início do documento, com base no valor do parâmetro StringIndexType. |
|
length
|
length | integer |
O comprimento da frase. |
ExtractiveSummarizationLROResult
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
results
|
results | ExtractiveSummarizationResult |
AbstractiveSummarizationLROResult
Um objeto que representa os resultados de uma tarefa Resumo Abstrativo.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
results
|
results | AbstractiveSummarizationResult |
Um objeto que representa os resultados de resumo de pré-build de cada documento. |
AbstractiveSummarizationResult
Um objeto que representa os resultados de resumo de pré-build de cada documento.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Documentos
|
documents | array of AbstractiveSummaryDocumentResultWithDetectedLanguage |
Resposta por documento |
AbstractiveSummaryDocumentResultWithDetectedLanguage
Um objeto que representa o resultado de resumo de um único documento com o idioma detectado.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
summaries
|
summaries | array of AbstractiveSummary |
Uma lista de resumos abstrativos. |
|
id
|
id | string |
Identificador de documento exclusivo e não vazio. |
|
Avisos
|
warnings | array of LanguageDocumentWarning |
Avisos encontrados durante o processamento do documento. |
|
estatísticas
|
statistics | DocumentStatistics |
se showStats=true foi especificado na solicitação, este campo conterá informações sobre o conteúdo do documento. |
|
detectedLanguage
|
detectedLanguage | DetectedLanguage |
SummaryContext
O contexto do resumo.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
deslocamento
|
offset | integer |
Posição inicial para o contexto. O uso de diferentes valores 'stringIndexType' pode afetar o deslocamento retornado. |
|
length
|
length | integer |
O comprimento do contexto. O uso de diferentes valores 'stringIndexType' pode afetar o comprimento retornado. |
AbstractiveSummary
Um objeto que representa um único resumo com contexto para determinado documento.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
enviar SMS
|
text | string |
O texto do resumo. |
|
contexts
|
contexts | array of SummaryContext |
A lista de contexto do resumo. |
AnswersResult
Representa a lista de respostas a perguntas.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
respostas
|
answers | array of KnowledgeBaseAnswer |
Representa a lista de resultados da resposta. |
|
isUserQuestionAmbiguous
|
isUserQuestionAmbiguous | boolean |
Retorna um valor booliano se a pergunta do usuário for ambígua. |
KnowledgeBaseAnswer
Representa a resposta do projeto.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Perguntas
|
questions | array of string |
Lista de perguntas associadas à resposta. |
|
responder
|
answer | string |
Texto da resposta. |
|
Limite de confiança
|
confidenceScore | float |
Pontuação de confiança de resposta, o valor varia de 0 a 1. |
|
QnA ID
|
id | integer |
ID do resultado do QnA. |
|
fonte
|
source | string |
Origem do resultado de QnA. |
|
metadados
|
metadata | object |
Metadados associados à resposta, úteis para categorizar ou filtrar respostas de pergunta. |
|
diálogo
|
dialog | KnowledgeBaseAnswerDialog |
Caixa de diálogo associada à Resposta. |
|
answerSpan
|
answerSpan | AnswerSpan |
Objeto de intervalo de resposta do QnA. |
KnowledgeBaseAnswerDialog
Caixa de diálogo associada à Resposta.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
isContextOnly
|
isContextOnly | boolean |
Para marcar se um prompt é relevante apenas com uma pergunta anterior ou não. Se for true, não inclua este QnA como resultado da pesquisa para consultas sem contexto; caso contrário, se for falso, ignorará o contexto e incluirá esse QnA no resultado da pesquisa. |
|
prompts
|
prompts | array of KnowledgeBaseAnswerPrompt |
Lista de prompts associados à resposta. |
KnowledgeBaseAnswerPrompt
Solicite uma resposta.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
displayOrder
|
displayOrder | integer |
Índice do prompt – usado na ordenação dos prompts. |
|
qnaId
|
qnaId | integer |
ID de QnA correspondente ao prompt. |
|
displayText
|
displayText | string |
Texto exibido para representar um prompt de pergunta de acompanhamento. |
AnswerSpan
Objeto de intervalo de resposta do QnA.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
enviar SMS
|
text | string |
Texto previsto de resposta precisa. |
|
Limite de confiança
|
confidenceScore | float |
A pontuação prevista de resposta precisa varia de 0 a 1. |
|
deslocamento
|
offset | integer |
O deslocamento preciso da resposta desde o início da resposta. |
|
length
|
length | integer |
O comprimento da resposta precisa. |