Analyze Conversations - Analyze Conversations

Referência

Serviço:: Azure AI Services

Versão da API:: 2024-05-01

Analisa o enunciado da conversa de entrada.

POST {Endpoint}/language/:analyze-conversations?api-version=2024-05-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
Endpoint	path	True	string	Ponto de extremidade dos Serviços Cognitivos suportados (por exemplo, https://.api.cognitiveservices.azure.com).
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Corpo do Pedido

ConversationalTask

A entrada para uma tarefa de compreensão de linguagem de conversação.

Name	Necessário	Tipo	Description
analysisInput	True	ConversationAnalysisOptions	A entrada ConversationItem e seus parâmetros opcionais
kind	True	string: Conversation	A classe base de uma tarefa de entrada de conversa.
parameters	True	ConversationTaskParameters	Parâmetros de entrada necessários para uma tarefa de compreensão da linguagem de conversação.

Respostas

Name	Tipo	Description
200 OK	AnalyzeConversationTaskResult: ConversationalTaskResult	O pedido foi bem-sucedido.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada. Cabeçalhos x-ms-error-code: string

Name

Tipo

Description

200 OK

AnalyzeConversationTaskResult:

ConversationalTaskResult

O pedido foi bem-sucedido.

Other Status Codes

ErrorResponse

Uma resposta de erro inesperada.

Cabeçalhos

x-ms-error-code: string

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

OAuth2Auth

Tipo: oauth2
Fluxo: accessCode
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize
Token URL: https://login.microsoftonline.com/common/oauth2/token

Âmbitos

Name	Description
https://cognitiveservices.azure.com/.default

Exemplos

SuccessfulAnalyzeConversations

SuccessfulAnalyzeConversationsArbitration

SuccessfulAnalyzeConversationsArbitrationDirectTarget

SuccessfulAnalyzeConversations

Pedido de amostra

HTTP

POST {Endpoint}/language/:analyze-conversations?api-version=2024-05-01

{
  "kind": "Conversation",
  "analysisInput": {
    "conversationItem": {
      "id": "1",
      "participantId": "1",
      "text": "play In the air tonight from Phil Collins"
    }
  },
  "parameters": {
    "projectName": "{project-name}",
    "deploymentName": "{deployment-name}",
    "stringIndexType": "TextElement_V8"
  }
}

Resposta da amostra

Código de estado:: 200

{
  "kind": "ConversationResult",
  "result": {
    "query": "play In the air tonight from Phil Collins",
    "prediction": {
      "topIntent": "PlayMusic",
      "projectKind": "Conversation",
      "intents": [
        {
          "category": "PlayMusic",
          "confidenceScore": 1
        },
        {
          "category": "SearchCreativeWork",
          "confidenceScore": 0
        },
        {
          "category": "AddToPlaylist",
          "confidenceScore": 0
        }
      ],
      "entities": [
        {
          "category": "Media.Artist",
          "text": "Phil Collins",
          "offset": 29,
          "length": 12,
          "confidenceScore": 1
        }
      ]
    }
  }
}

SuccessfulAnalyzeConversationsArbitration

Pedido de amostra

HTTP

POST {Endpoint}/language/:analyze-conversations?api-version=2024-05-01

{
  "kind": "Conversation",
  "analysisInput": {
    "conversationItem": {
      "participantId": "1",
      "id": "1",
      "modality": "text",
      "language": "en-GB",
      "text": "How do I integrate QnA Maker and LUIS?"
    }
  },
  "parameters": {
    "projectName": "{project-name}",
    "deploymentName": "{deployment-name}",
    "verbose": true,
    "isLoggingEnabled": false,
    "stringIndexType": "TextElement_V8"
  }
}

Resposta da amostra

Código de estado:: 200

{
  "kind": "ConversationResult",
  "result": {
    "query": "trains from London",
    "prediction": {
      "topIntent": "Rail",
      "projectKind": "Orchestration",
      "intents": {
        "Rail": {
          "confidenceScore": 1,
          "targetProjectKind": "Conversation",
          "result": {
            "query": "trains from London",
            "prediction": {
              "topIntent": "Timetable",
              "projectKind": "Conversation",
              "intents": [
                {
                  "category": "Timetable",
                  "confidenceScore": 0.99968535
                },
                {
                  "category": "Locomotive",
                  "confidenceScore": 0.000314623
                }
              ],
              "entities": []
            }
          }
        },
        "Tree": {
          "confidenceScore": 0.2641529,
          "targetProjectKind": "QuestionAnswering"
        },
        "None": {
          "confidenceScore": 0,
          "targetProjectKind": "NonLinked"
        }
      }
    }
  }
}

SuccessfulAnalyzeConversationsArbitrationDirectTarget

Pedido de amostra

HTTP

POST {Endpoint}/language/:analyze-conversations?api-version=2024-05-01

{
  "kind": "Conversation",
  "analysisInput": {
    "conversationItem": {
      "text": "Ports and connectors",
      "participantId": "1",
      "id": "1"
    }
  },
  "parameters": {
    "projectName": "prj1",
    "deploymentName": "dep1",
    "directTarget": "qnaProject",
    "targetProjectParameters": {
      "qnaProject": {
        "targetProjectKind": "QuestionAnswering",
        "callingOptions": {
          "context": {
            "previousUserQuery": "Meet Surface Pro 4",
            "previousQnaId": 4
          },
          "top": 1,
          "question": "App Service overview"
        }
      }
    }
  }
}

Resposta da amostra

Código de estado:: 200

{
  "kind": "ConversationResult",
  "result": {
    "query": "Ports and connectors",
    "prediction": {
      "projectKind": "Orchestration",
      "topIntent": "qnaTargetApp",
      "intents": {
        "qnaTargetApp": {
          "targetProjectKind": "QuestionAnswering",
          "confidenceScore": 1,
          "result": {
            "answers": [
              {
                "questions": [
                  "App Service overview"
                ],
                "answer": "The compute resources you use are determined by the *App Service plan* that you run your apps on.",
                "confidenceScore": 0.7384000000000001,
                "id": 1,
                "source": "https://docs.microsoft.com/en-us/azure/app-service/overview",
                "metadata": {},
                "dialog": {
                  "isContextOnly": false,
                  "prompts": []
                }
              }
            ]
          }
        }
      }
    }
  }
}

Definições

Name	Description
AgeResolution	Representa o modelo de resolução da entidade Age.
AgeUnit	A unidade de medida etária
AnalyzeConversationResult	Representa uma resposta de análise de conversação.
AnalyzeConversationTaskKind	Enumeração de tarefas de conversação suportadas.
AnalyzeConversationTaskResultsKind	Enumeração de resultados de tarefas de conversação suportados.
AnswersOptions	Parâmetros para consultar uma base de dados de conhecimento.
AnswerSpan	Objeto de extensão de resposta do QnA.
AnswersResult	Representa a lista de respostas às perguntas.
AreaResolution	Representa o modelo de resolução da entidade de área.
AreaUnit	A unidade de medida da área.
BooleanResolution	Uma resolução para expressões booleanas
ConversationalTask	A entrada para uma tarefa de compreensão de linguagem de conversação.
ConversationalTaskResult	Os resultados de uma tarefa de conversação.
ConversationAnalysisOptions	A entrada ConversationItem e seus parâmetros opcionais
ConversationCallingOptions	A opção para definir para chamar um projeto de conversação.
ConversationEntity	O resultado da extração de entidade de um projeto de conversação.
ConversationIntent	O resultado da classificação de intenção de um projeto de conversação.
ConversationParameters	Este é um conjunto de parâmetros de solicitação para projetos de conversação personalizada.
ConversationPrediction	Representa a seção de previsão de um projeto de conversação.
ConversationResult	A resposta retornada por um projeto de conversação.
ConversationTargetIntentResult	Um resumo da resposta do projeto Conversation.
ConversationTaskParameters	Parâmetros de entrada necessários para uma tarefa de conversação.
CurrencyResolution	Representa o modelo de resolução da entidade monetária.
DateTimeResolution	Uma resolução para instâncias de entidade datetime.
DateTimeSubKind	O subtipo datetime.
EntitySubtype	O modelo de subtipo de entidade concreta de informações extras.
Error	O objeto de erro.
ErrorCode	Código de erro legível por humanos.
ErrorResponse	Resposta de erro.
ExtraInformationKind	O tipo de objeto de informação extra.
InformationResolution	Representa o modelo de resolução de entidade de informação (dados).
InformationUnit	A informação (dados) Unidade de medida.
InnerErrorCode	Código de erro legível por humanos.
InnerErrorModel	Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
InputModality	Enumeração das modalidades de conversação suportadas.
KnowledgeBaseAnswer	Representa a resposta da base de conhecimento.
KnowledgeBaseAnswerContext	Objeto de contexto com informações anteriores do QnA.
KnowledgeBaseAnswerDialog	Caixa de diálogo associada à Resposta.
KnowledgeBaseAnswerPrompt	Solicite uma resposta.
LengthResolution	Representa o modelo de resolução da entidade de comprimento.
LengthUnit	A unidade de medida de comprimento.
ListKey	O tipo de dados extras da chave de lista.
LogicalOperationKind	Operação usada para unir filtros de metadados.
LuisCallingOptions	Isso personaliza como o serviço chama os projetos LUIS Generally Available.
LuisParameters	Este é um conjunto de parâmetros de solicitação para projetos LUIS Generally Available.
LuisTargetIntentResult	É um resumo da resposta LUIS Generally Available.
MetadataFilter	Encontre QnAs que estão associados à lista fornecida de metadados.
MetadataRecord	Objeto para fornecer o par de valores de chave para cada metadados.
NoneLinkedTargetIntentResult	Um resumo da resposta de intenção não vinculada.
NumberKind	O tipo da entidade numérica extraída.
NumberResolution	Uma resolução para instâncias numéricas de entidades.
NumericRangeResolution	representa a resolução de intervalos numéricos.
OrchestrationPrediction	Isso representa o resultado da previsão de um projeto de orquestração.
OrdinalResolution	Uma resolução para instâncias de entidade de números ordinais.
projectKind	O tipo de projeto.
QueryFilters	filtra a base de dados de conhecimento.
QuestionAnsweringParameters	Este é um conjunto de parâmetros de solicitação para bases de conhecimento de Resposta a Perguntas.
QuestionAnsweringTargetIntentResult	É um resumo de uma resposta KB de Resposta a Perguntas.
RangeKind	O tipo de intervalo que o objeto de resolução representa.
RankerKind	Tipo de ranker a utilizar
RegexKey	O tipo de dados extra da chave regex.
RelativeTo	O ponto de referência que o número ordinal denota.
ResolutionKind	O tipo de objeto de resolução da entidade.
role	Papel do participante.
ShortAnswerOptions	Para configurar o recurso de previsão de extensão de resposta.
SpeedResolution	Representa o modelo de resolução de entidade de velocidade.
SpeedUnit	A velocidade Unidade de medida
StringIndexType	Tipo de índice de cadeia de caracteres
targetProjectKind	O tipo de um serviço de destino.
TemperatureResolution	Representa o modelo de resolução da entidade de temperatura.
TemperatureUnit	A unidade de medida de temperatura.
TemporalModifier	Um modificador opcional de uma instância de data/hora.
TemporalSpanResolution	representa a resolução de um período de data e/ou hora.
TextConversationItem	A modalidade de texto de uma conversa de entrada.
VolumeResolution	Representa o modelo de resolução da entidade de volume.
VolumeUnit	A unidade de medida volumétrica
WeightResolution	Representa o modelo de resolução da entidade de peso.
WeightUnit	A unidade de medida de peso.

AgeResolution

Object

Representa o modelo de resolução da entidade Age.

Name	Tipo	Description
resolutionKind	string: AgeResolution	O tipo de objeto de resolução da entidade.
unit	AgeUnit	A unidade de medida etária
value	number (double)	O valor numérico que o texto extraído denota.

AgeUnit

Enumeração

A unidade de medida etária

Valor	Description
Day	Unidade de idade diurna
Month	Unidade de idade do mês
Unspecified	Unidade etária não especificada
Week	Unidade de idade da semana
Year	Unidade de idade do ano

AnalyzeConversationResult

Object

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

Name	Tipo	Description
detectedLanguage	string	O sistema detetou o idioma para a consulta na representação de idioma BCP 47..
prediction	BasePrediction: ConversationPrediction OrchestrationPrediction	O resultado da previsão de um projeto de conversação.
query	string	O enunciado da conversa dado pelo interlocutor.

AnalyzeConversationTaskKind

Enumeração

Enumeração de tarefas de conversação suportadas.

Valor	Description
Conversation	Tipo de tarefa de conversação

AnalyzeConversationTaskResultsKind

Enumeração

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

Valor	Description
ConversationResult	Tipo de tarefa de resultado da conversação

AnswersOptions

Object

Parâmetros para consultar uma base de dados de conhecimento.

Name	Tipo	Description
answerSpanRequest	ShortAnswerOptions	Para configurar o recurso de previsão de extensão de resposta.
confidenceScoreThreshold	number (double) minimum: 0 maximum: 1	Pontuação mínima para respostas, o valor varia de 0 a 1.
context	KnowledgeBaseAnswerContext	Objeto de contexto com informações anteriores do QnA.
filters	QueryFilters	Filtre QnAs com base em determinada lista de metadados e fontes da base de dados de conhecimento.
includeUnstructuredSources	boolean	(Opcional) Sinalizador para habilitar a Consulta sobre Fontes Não Estruturadas.
qnaId	integer (int32)	ID QnA exato para buscar na base de conhecimento, este campo tem prioridade sobre a pergunta.
question	string	Pergunta do usuário para consulta na base de dados de conhecimento.
rankerType	RankerKind	Tipo de ranker a utilizar.
top	integer (int32)	Número máximo de respostas a devolver para a pergunta.
userId	string	Identificador exclusivo para o usuário.

AnswerSpan

Object

Objeto de extensão de resposta do QnA.

Name	Tipo	Description
confidenceScore	number (double) minimum: 0 maximum: 1	Pontuação prevista de tempo de resposta, o valor varia de 0 a 1.
length	integer (int32)	A extensão da resposta.
offset	integer (int32)	O intervalo de resposta é deslocado desde o início da resposta.
text	string	Texto previsto da extensão da resposta.

AnswersResult

Object

Representa a lista de respostas às perguntas.

Name	Tipo	Description
answers	KnowledgeBaseAnswer[]	Representa a lista Resultado da Resposta.

AreaResolution

Object

Representa o modelo de resolução da entidade de área.

Name	Tipo	Description
resolutionKind	string: AreaResolution	O tipo de objeto de resolução da entidade.
unit	AreaUnit	A área Unidade de medida
value	number (double)	O valor numérico que o texto extraído denota.

AreaUnit

Enumeração

A unidade de medida da área.

Valor	Description
Acre	Unidade de área do Acre
SquareCentimeter	Unidade de área de centímetro quadrado
SquareDecameter	Unidade de área de decámetro quadrado
SquareDecimeter	Unidade de área de decímetro quadrado
SquareFoot	Unidade de área de pé quadrado
SquareHectometer	Unidade de área do hectómetro quadrado
SquareInch	Unidade de área de polegada quadrada
SquareKilometer	Unidade de área de quilómetro quadrado
SquareMeter	Unidade de área de metro quadrado
SquareMile	Unidade de área de milha quadrada
SquareMillimeter	Unidade de área milimétrica quadrada
SquareYard	Unidade de área de quintal quadrado
Unspecified	Unidade de área não especificada

BooleanResolution

Object

Uma resolução para expressões booleanas

Name	Tipo	Description
resolutionKind	string: BooleanResolution	O tipo de objeto de resolução da entidade.
value	boolean	Uma resolução para expressões booleanas

ConversationalTask

Object

A entrada para uma tarefa de compreensão de linguagem de conversação.

Name	Tipo	Description
analysisInput	ConversationAnalysisOptions	A entrada ConversationItem e seus parâmetros opcionais
kind	string: Conversation	A classe base de uma tarefa de entrada de conversa.
parameters	ConversationTaskParameters	Parâmetros de entrada necessários para uma tarefa de compreensão da linguagem de conversação.

ConversationalTaskResult

Object

Os resultados de uma tarefa de conversação.

Name	Tipo	Description
kind	string: ConversationResult	A classe base de um resultado de tarefa de entrada de conversa.
result	AnalyzeConversationResult	Representa uma resposta de análise de conversação.

ConversationAnalysisOptions

Object

A entrada ConversationItem e seus parâmetros opcionais

Name	Tipo	Description
conversationItem	TextConversationItem	A base abstrata para uma conversa formatada de entrada do usuário (por exemplo, Texto, Transcrição).

ConversationCallingOptions

Object

A opção para definir para chamar um projeto de conversação.

Name	Tipo	Description
isLoggingEnabled	boolean	Se verdadeiro, a consulta será salva para que os clientes analisem ainda mais na criação, para melhorar a qualidade do modelo.
language	string	A linguagem da consulta na representação linguística BCP 47.
verbose	boolean	Se verdadeiro, o serviço retornará informações mais detalhadas.

ConversationEntity

Object

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

Name	Tipo	Description
category	string	A categoria de entidade.
confidenceScore	number (float)	A pontuação de confiança da entidade.
extraInformation	BaseExtraInformation[]: EntitySubtype[] ListKey[] RegexKey[]	A coleção de objetos de informação extra da entidade.
length	integer (int32)	A extensão do texto.
offset	integer (int32)	O índice inicial desta entidade na consulta.
resolutions	BaseResolution[]: AgeResolution[] AreaResolution[] BooleanResolution[] CurrencyResolution[] DateTimeResolution[] InformationResolution[] LengthResolution[] NumberResolution[] NumericRangeResolution[] OrdinalResolution[] SpeedResolution[] TemperatureResolution[] TemporalSpanResolution[] VolumeResolution[] WeightResolution[]	A coleção de objetos de resolução de entidade.
text	string	O texto da entidade prevista.

ConversationIntent

Object

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

Name	Tipo	Description
category	string	Uma classe prevista.
confidenceScore	number (float) minimum: 0 maximum: 1	O escore de confiança da turma de 0,0 a 1,0.

ConversationParameters

Object

Este é um conjunto de parâmetros de solicitação para projetos de conversação personalizada.

Name	Tipo	Description
apiVersion	string	A versão da API a ser usada ao chamar um serviço de destino específico.
callingOptions	ConversationCallingOptions	A opção para definir para chamar um projeto de conversação.
targetProjectKind	string: Conversation	O tipo de um serviço de destino

ConversationPrediction

Object

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

Name	Tipo	Description
entities	ConversationEntity[]	Os resultados da extração da entidade.
intents	ConversationIntent[]	Os resultados da classificação de intenção.
projectKind	string: Conversation	O tipo de projeto.
topIntent	string	A intenção com a pontuação mais alta.

ConversationResult

Object

A resposta retornada por um projeto de conversação.

Name	Tipo	Description
detectedLanguage	string	O idioma detetado da consulta na representação de idioma BCP 47.
prediction	ConversationPrediction	O resultado previsto para a consulta.
query	string	A mesma consulta dada no pedido.

ConversationTargetIntentResult

Object

Um resumo da resposta do projeto Conversation.

Name	Tipo	Description
apiVersion	string	A versão da API usada para chamar um serviço de destino.
confidenceScore	number (double) minimum: 0 maximum: 1	A pontuação de previsão e varia de 0,0 a 1,0.
result	ConversationResult	A resposta real de um projeto de conversação.
targetProjectKind	string: Conversation	Esta é a classe base de uma previsão de intenção

ConversationTaskParameters

Object

Parâmetros de entrada necessários para uma tarefa de conversação.

Name	Tipo	Default value	Description
deploymentName	string		O nome da implantação a ser usada.
directTarget	string		O nome de um projeto de destino para o qual encaminhar a solicitação.
isLoggingEnabled	boolean		Se verdadeiro, o serviço manterá a consulta para revisão posterior.
projectName	string		O nome do projeto a ser usado.
stringIndexType	StringIndexType	TextElements_v8	Especifica o método usado para interpretar deslocamentos de cadeia de caracteres. O padrão é Elementos de texto (grafemas) de acordo com Unicode v8.0.0. Para obter informações adicionais, consulte https://aka.ms/text-analytics-offsets.
targetProjectParameters	object		Um dicionário que representa os parâmetros para cada projeto de destino.
verbose	boolean		Se verdadeiro, o serviço retornará informações mais detalhadas na resposta.

CurrencyResolution

Object

Representa o modelo de resolução da entidade monetária.

Name	Tipo	Description
ISO4217	string	O código alfabético baseado em outra norma ISO, ISO 3166, que lista os códigos para nomes de países. As duas primeiras letras do código ISO 4217 de três letras são as mesmas que o código do nome do país e, sempre que possível, a terceira letra corresponde à primeira letra do nome da moeda.
resolutionKind	string: CurrencyResolution	O tipo de objeto de resolução da entidade.
unit	string	A unidade da quantidade capturada na entidade extraída
value	number (double)	O montante em dinheiro capturado na entidade extraída

DateTimeResolution

Object

Uma resolução para instâncias de entidade datetime.

Name	Tipo	Description
dateTimeSubKind	DateTimeSubKind	O subtipo DateTime
modifier	TemporalModifier	Um modificador opcional de uma instância de data/hora.
resolutionKind	string: DateTimeResolution	O tipo de objeto de resolução da entidade.
timex	string	Uma representação alargada de data/hora ISO 8601, conforme descrito em (https://github.com/Microsoft/Recognizers-Text/blob/master/Patterns/English/English-DateTime.yaml)
value	string	O tempo real que o texto extraído denota.

DateTimeSubKind

Enumeração

O subtipo datetime.

Valor	Description
Date	Subtipo de data
DateTime	Subtipo DateTime
Duration	Subespécie de duração
Set	Definir subtipo
Time	Subtipo de tempo

EntitySubtype

Object

O modelo de subtipo de entidade concreta de informações extras.

Name	Tipo	Description
extraInformationKind	string: EntitySubtype	O tipo de objeto de informação extra.
value	string	O Subtipo de um tipo de entidade extraída.

Error

Object

O objeto de erro.

Name	Tipo	Description
code	ErrorCode	Um de um conjunto de códigos de erro definido pelo servidor.
details	Error[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror	InnerErrorModel	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Uma representação legível por humanos do erro.
target	string	O alvo do erro.

ErrorCode

Enumeração

Código de erro legível por humanos.

Valor	Description
AzureCognitiveSearchIndexLimitReached	Erro atingido pelo limite do índice da Pesquisa Cognitiva do Azure
AzureCognitiveSearchIndexNotFound	Erro de índice da Pesquisa Cognitiva do Azure não encontrado
AzureCognitiveSearchNotFound	Erro não encontrado da Pesquisa Cognitiva do Azure
AzureCognitiveSearchThrottling	Erro de limitação da Pesquisa Cognitiva do Azure
Conflict	Erro de conflito
Forbidden	Erro de acesso proibido
InternalServerError	Erro interno do servidor
InvalidArgument	Erro de argumento inválido
InvalidRequest	Erro de solicitação inválida
NotFound	Erro não encontrado
OperationNotFound	Erro de operação não encontrado
ProjectNotFound	Erro de projeto não encontrado
QuotaExceeded	Erro de quota excedida
ServiceUnavailable	Erro de serviço indisponível
Timeout	Erro de tempo limite
TooManyRequests	Erro de muitas solicitações
Unauthorized	Erro de acesso não autorizado
Warning	Erro de aviso

ErrorResponse

Object

Resposta de erro.

Name	Tipo	Description
error	Error	O objeto de erro.

ExtraInformationKind

Enumeração

O tipo de objeto de informação extra.

Valor	Description
EntitySubtype	Tipo de informação extra do subtipo de entidade
ListKey	Listar tipo de informação extra chave
RegexKey	Tipo de informação extra da chave Regex

InformationResolution

Object

Representa o modelo de resolução de entidade de informação (dados).

Name	Tipo	Description
resolutionKind	string: InformationResolution	O tipo de objeto de resolução da entidade.
unit	InformationUnit	A informação (dados) Unidade de medida.
value	number (double)	O valor numérico que o texto extraído denota.

InformationUnit

Enumeração

A informação (dados) Unidade de medida.

Valor	Description
Bit	Unidade de informação de bits
Byte	Unidade de informação de bytes
Gigabit	Unidade de informação Gigabit
Gigabyte	Unidade de informação Gigabyte
Kilobit	Unidade de informação Kilobit
Kilobyte	Unidade de informação Kilobyte
Megabit	Unidade de informação Megabit
Megabyte	Unidade de informação Megabyte
Petabit	Unidade de informação Petabit
Petabyte	Unidade de informação Petabyte
Terabit	Unidade de informação Terabit
Terabyte	Unidade de informação Terabyte
Unspecified	Unidade de informação não especificada

InnerErrorCode

Enumeração

Código de erro legível por humanos.

Valor	Description
AzureCognitiveSearchNotFound	Erro não encontrado da Pesquisa Cognitiva do Azure
AzureCognitiveSearchThrottling	Erro de limitação da Pesquisa Cognitiva do Azure
EmptyRequest	Erro de solicitação vazia
ExtractionFailure	Erro de falha de extração
InvalidCountryHint	Erro de dica de país inválido
InvalidDocument	Erro de documento inválido
InvalidDocumentBatch	Erro de lote de documento inválido
InvalidParameterValue	Erro de valor de parâmetro inválido
InvalidRequest	Erro de solicitação inválida
InvalidRequestBodyFormat	Erro de formato de corpo de solicitação inválido
KnowledgeBaseNotFound	Erro não encontrado na base de dados de conhecimento
MissingInputDocuments	Erro de documentos de entrada ausentes
ModelVersionIncorrect	Erro de versão incorreta do modelo
UnsupportedLanguageCode	Erro de código de idioma não suportado

InnerErrorModel

Object

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

Name	Tipo	Description
code	InnerErrorCode	Um de um conjunto de códigos de erro definido pelo servidor.
details	object	Detalhes do erro.
innererror	InnerErrorModel	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Mensagem de erro.
target	string	Alvo de erro.

InputModality

Enumeração

Enumeração das modalidades de conversação suportadas.

Valor	Description
text	Modalidade de entrada de texto
transcript	Modalidade de entrada de transcrição

KnowledgeBaseAnswer

Object

Representa a resposta da base de conhecimento.

Name	Tipo	Description
answer	string	Texto da resposta.
answerSpan	AnswerSpan	Objeto de extensão de resposta do QnA com relação à pergunta do usuário.
confidenceScore	number (double) minimum: 0 maximum: 1	Pontuação de confiança da resposta, o valor varia de 0 a 1.
dialog	KnowledgeBaseAnswerDialog	Caixa de diálogo associada à Resposta.
id	integer (int32)	ID do resultado do QnA.
metadata	object	Metadados associados à resposta, úteis para categorizar ou filtrar respostas a perguntas.
questions	string[]	Lista de perguntas associadas à resposta.
source	string	Fonte do resultado QnA.

KnowledgeBaseAnswerContext

Object

Objeto de contexto com informações anteriores do QnA.

Name	Tipo	Description
previousQnaId	integer (int32)	Resultado anterior da resposta QnA ID.
previousUserQuery	string	Consulta de usuário anterior.

KnowledgeBaseAnswerDialog

Object

Caixa de diálogo associada à Resposta.

Name	Tipo	Description
isContextOnly	boolean	Para marcar se um prompt é relevante apenas com uma pergunta anterior ou não. Se verdadeiro, não inclua este QnA como resultado de pesquisa para consultas sem contexto; caso contrário, se false, ignora o contexto e inclui este QnA no resultado da pesquisa.
prompts	KnowledgeBaseAnswerPrompt[]	Lista de prompts associados à resposta.

KnowledgeBaseAnswerPrompt

Object

Solicite uma resposta.

Name	Tipo	Description
displayOrder	integer (int32)	Índice do prompt - usado na ordenação dos prompts.
displayText	string maxLength: 200	Texto exibido para representar um prompt de pergunta de acompanhamento.
qnaId	integer (int32)	ID QnA correspondente ao prompt.

LengthResolution

Object

Representa o modelo de resolução da entidade de comprimento.

Name	Tipo	Description
resolutionKind	string: LengthResolution	O tipo de objeto de resolução da entidade.
unit	LengthUnit	O comprimento Unidade de medida
value	number (double)	O valor numérico que o texto extraído denota.

LengthUnit

Enumeração

A unidade de medida de comprimento.

Valor	Description
Centimeter	Unidade de comprimento de centímetro
Decameter	Unidade de comprimento do decámetro
Decimeter	Unidade de comprimento do decímetro
Foot	Unidade de comprimento do pé
Hectometer	Unidade de comprimento do hectómetro
Inch	Unidade de comprimento de polegada
Kilometer	Unidade de quilómetro de comprimento
LightYear	Unidade de comprimento de ano leve
Meter	Unidade de comprimento do metro
Micrometer	Unidade de comprimento do micrômetro
Mile	Unidade de comprimento de milha
Millimeter	Unidade de comprimento milimétrico
Nanometer	Unidade de comprimento nanométrico
Picometer	Unidade de comprimento do pícometer
Pt	Unidade de comprimento de ponto
Unspecified	Unidade de comprimento não especificada
Yard	Unidade de comprimento do pátio

ListKey

Object

O tipo de dados extras da chave de lista.

Name	Tipo	Description
extraInformationKind	string: ListKey	O tipo de objeto de informação extra.
key	string	A forma canônica da entidade extraída.

LogicalOperationKind

Enumeração

Operação usada para unir filtros de metadados.

Valor	Description
AND	Lógica E
OR	Lógica OU

LuisCallingOptions

Object

Isso personaliza como o serviço chama os projetos LUIS Generally Available.

Name	Tipo	Description
bing-spell-check-subscription-key	string	A chave de subscrição a utilizar ao ativar a verificação ortográfica do Bing
log	boolean	Salve o log para adicionar declarações de treinamento mais tarde.
show-all-intents	boolean	Defina true para mostrar todas as intenções.
spellCheck	boolean	Habilite a verificação ortográfica.
timezoneOffset	integer (int32)	O deslocamento de fuso horário para o local da solicitação.
verbose	boolean	Habilite a resposta detalhada.

LuisParameters

Object

Este é um conjunto de parâmetros de solicitação para projetos LUIS Generally Available.

Name	Tipo	Description
apiVersion	string	A versão da API a ser usada ao chamar um serviço de destino específico.
callingOptions	LuisCallingOptions	Isso personaliza como o serviço chama os projetos LUIS Generally Available.
query	string maxLength: 500	O enunciado a prever.
targetProjectKind	string: Luis	O tipo de um serviço de destino

LuisTargetIntentResult

Object

É um resumo da resposta LUIS Generally Available.

Name	Tipo	Description
apiVersion	string	A versão da API usada para chamar um serviço de destino.
confidenceScore	number (double) minimum: 0 maximum: 1	A pontuação de previsão e varia de 0,0 a 1,0.
result	LuisResult	A resposta real de um aplicativo LUIS Generally Available.
targetProjectKind	string: Luis	Esta é a classe base de uma previsão de intenção

MetadataFilter

Object

Encontre QnAs que estão associados à lista fornecida de metadados.

Name	Tipo	Default value	Description
logicalOperation	LogicalOperationKind	AND	Operação usada para unir filtros de metadados.
metadata	MetadataRecord[]		Lista de metadados.

MetadataRecord

Object

Objeto para fornecer o par de valores de chave para cada metadados.

Name	Tipo	Description
key	string	Chave de metadados do dicionário de metadados usado no QnA.
value	string	Metadata Value do dicionário de metadados usado no QnA.

NoneLinkedTargetIntentResult

Object

Um resumo da resposta de intenção não vinculada.

Name	Tipo	Description
apiVersion	string	A versão da API usada para chamar um serviço de destino.
confidenceScore	number (double) minimum: 0 maximum: 1	A pontuação de previsão e varia de 0,0 a 1,0.
result	ConversationResult	A resposta real de um projeto de conversação.
targetProjectKind	string: NonLinked	Esta é a classe base de uma previsão de intenção

NumberKind

Enumeração

O tipo da entidade numérica extraída.

Valor	Description
Decimal	Número decimal
Fraction	Número da fração
Integer	Número inteiro
Percent	Número percentual
Power	Número de potência
Unspecified	Tipo de número não especificado

NumberResolution

Object

Uma resolução para instâncias numéricas de entidades.

Name	Tipo	Description
numberKind	NumberKind	O tipo da entidade numérica extraída.
resolutionKind	string: NumberResolution	O tipo de objeto de resolução da entidade.
value	number (double)	Uma representação numérica do que o texto extraído denota.

NumericRangeResolution

Object

representa a resolução de intervalos numéricos.

Name	Tipo	Description
maximum	number (double)	O valor final do intervalo.
minimum	number (double)	O valor inicial do intervalo.
rangeKind	RangeKind	O tipo de intervalo que o objeto de resolução representa.
resolutionKind	string: NumericRangeResolution	O tipo de objeto de resolução da entidade.

OrchestrationPrediction

Object

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

Name	Tipo	Description
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.
projectKind	string: Orchestration	O tipo de projeto.
topIntent	string	A intenção com a pontuação mais alta.

OrdinalResolution

Object

Uma resolução para instâncias de entidade de números ordinais.

Name	Tipo	Description
offset	string	O deslocamento em relação à referência (por exemplo, deslocamento = -1 indica o penúltimo)
relativeTo	RelativeTo	O ponto de referência que o número ordinal denota.
resolutionKind	string: OrdinalResolution	O tipo de objeto de resolução da entidade.
value	string	Uma expressão aritmética simples que o ordinal denota.

projectKind

Enumeração

O tipo de projeto.

Valor	Description
Conversation	Tipo de conversação
Orchestration	Tipo de orquestração

QueryFilters

Object

filtra a base de dados de conhecimento.

Name	Tipo	Default value	Description
logicalOperation	LogicalOperationKind	AND	Operação lógica usada para unir o filtro de metadados com o filtro de origem.
metadataFilter	MetadataFilter		filtra a base de dados de conhecimento.
sourceFilter	string[]		filtra a base de dados de conhecimento.

QuestionAnsweringParameters

Object

Este é um conjunto de parâmetros de solicitação para bases de conhecimento de Resposta a Perguntas.

Name	Tipo	Description
apiVersion	string	A versão da API a ser usada ao chamar um serviço de destino específico.
callingOptions	AnswersOptions	As opções enviadas para um KB de Resposta a Perguntas.
targetProjectKind	string: QuestionAnswering	O tipo de um serviço de destino

QuestionAnsweringTargetIntentResult

Object

É um resumo de uma resposta KB de Resposta a Perguntas.

Name	Tipo	Description
apiVersion	string	A versão da API usada para chamar um serviço de destino.
confidenceScore	number (double) minimum: 0 maximum: 1	A pontuação de previsão e varia de 0,0 a 1,0.
result	AnswersResult	A resposta gerada por um KB de Resposta à Pergunta.
targetProjectKind	string: QuestionAnswering	Esta é a classe base de uma previsão de intenção

RangeKind

Enumeração

O tipo de intervalo que o objeto de resolução representa.

Valor	Description
Age	Faixa etária
Area	Gama de áreas
Currency	Intervalo de moedas
Information	Gama de informações
Length	Faixa de comprimento
Number	Intervalo de números
Speed	Faixa de velocidade
Temperature	Faixa de temperatura
Volume	Intervalo de volume
Weight	Faixa de peso

RankerKind

Enumeração

Tipo de ranker a utilizar

Valor	Description
Default	Classificador padrão.
QuestionOnly	Pergunta apenas ranker.

RegexKey

Object

O tipo de dados extra da chave regex.

Name	Tipo	Description
extraInformationKind	string: RegexKey	O tipo de objeto de informação extra.
key	string	A chave do padrão regex usado na extração da entidade.
regexPattern	string	O padrão de regex .NET usado na extração da entidade. Visite https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions para obter mais informações sobre expressões regulares do .NET.

RelativeTo

Enumeração

O ponto de referência que o número ordinal denota.

Valor	Description
Current	Estado atual
End	Estado final
Start	Estado de início

ResolutionKind

Enumeração

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

Valor	Description
AgeResolution	Resolução de uma entidade etária
AreaResolution	Resolução de uma entidade territorial
BooleanResolution	Resolução de uma entidade booleana
CurrencyResolution	Resolução de uma entidade monetária
DateTimeResolution	Resolução de uma entidade de data/hora
InformationResolution	Resolução de uma entidade de informação
LengthResolution	Resolução de uma entidade de comprimento
NumberResolution	Resolução de uma entidade numérica
NumericRangeResolution	Resolução de uma entidade de intervalo numérico
OrdinalResolution	Resolução de uma entidade ordinal
SpeedResolution	Resolução de uma entidade de velocidade
TemperatureResolution	Resolução de uma entidade de temperatura
TemporalSpanResolution	Resolução de uma entidade de extensão temporal
VolumeResolution	Resolução de uma entidade de volume
WeightResolution	Resolução de uma entidade de ponderação

role

Enumeração

Papel do participante.

Valor	Description
agent	O participante é um agente.
customer	O participante é um cliente.
generic	O é um participante genérico.

ShortAnswerOptions

Object

Para configurar o recurso de previsão de extensão de resposta.

Name	Tipo	Default value	Description
confidenceScoreThreshold	number (double) minimum: 0 maximum: 1		Pontuação mínima necessária para incluir um intervalo de resposta, o valor varia de 0 a 1.
enable	boolean	True	Habilite ou desabilite a previsão de Extensão de Resposta.
topAnswersWithSpan	integer (int32) minimum: 1 maximum: 10		Número de respostas principais a serem consideradas para a previsão de span de 1 a 10.

SpeedResolution

Object

Representa o modelo de resolução de entidade de velocidade.

Name	Tipo	Description
resolutionKind	string: SpeedResolution	O tipo de objeto de resolução da entidade.
unit	SpeedUnit	A velocidade Unidade de medida
value	number (double)	O valor numérico que o texto extraído denota.

SpeedUnit

Enumeração

A velocidade Unidade de medida

Valor	Description
CentimetersPerMillisecond	Centímetros por unidade de velocidade de milissegundos
FootPerMinute	Unidade de velocidade pé por minuto
FootPerSecond	Unidade de velocidade pé por segundo
KilometersPerHour	Quilómetros por hora unidade de velocidade
KilometersPerMillisecond	Quilómetros por milissegundo unidade de velocidade
KilometersPerMinute	Quilómetros por minuto unidade de velocidade
KilometersPerSecond	Quilómetros por segundo unidade de velocidade
Knot	Unidade de velocidade do nó
MetersPerMillisecond	Metros por unidade de velocidade de milissegundos
MetersPerSecond	Medidores por segundo unidade de velocidade
MilesPerHour	Milhas por hora unidade de velocidade
Unspecified	Unidade de velocidade não especificada
YardsPerMinute	Jardas por minuto unidade de velocidade
YardsPerSecond	Jardas por segundo unidade de velocidade

StringIndexType

Enumeração

Tipo de índice de cadeia de caracteres

Valor	Description
TextElements_v8	Os valores de deslocamento e comprimento retornados corresponderão a TextElements (Graphemes e clusters Grapheme) confirmando para o padrão Unicode 8.0.0. Use esta opção se seu aplicativo estiver escrito em .Net Framework ou .Net Core e você estiver usando StringInfo.
UnicodeCodePoint	Os valores de deslocamento e comprimento retornados corresponderão aos pontos de código Unicode. Use esta opção se seu aplicativo estiver escrito em uma linguagem que suporte Unicode, por exemplo, Python.
Utf16CodeUnit	Os valores de deslocamento e comprimento retornados corresponderão às unidades de código UTF-16. Use esta opção se seu aplicativo estiver escrito em uma linguagem que suporte Unicode, por exemplo, Java, JavaScript.

targetProjectKind

Enumeração

O tipo de um serviço de destino.

Valor	Description
Conversation	Tipo de serviço de destino de conversação
Luis	Tipo de serviço de destino Luis
NonLinked	Tipo de serviço de destino não vinculado
QuestionAnswering	PerguntaRespondendo ao tipo de serviço de destino

TemperatureResolution

Object

Representa o modelo de resolução da entidade de temperatura.

Name	Tipo	Description
resolutionKind	string: TemperatureResolution	O tipo de objeto de resolução da entidade.
unit	TemperatureUnit	A unidade de medida de temperatura.
value	number (double)	O valor numérico que o texto extraído denota.

TemperatureUnit

Enumeração

A unidade de medida de temperatura.

Valor	Description
Celsius	Unidade de temperatura Celsius
Fahrenheit	Unidade de temperatura Fahrenheit
Kelvin	Unidade de temperatura Kelvin
Rankine	Unidade de temperatura Rankine
Unspecified	Unidade de temperatura não especificada

TemporalModifier

Enumeração

Um modificador opcional de uma instância de data/hora.

Valor	Description
After	Após modificador temporal
AfterApprox	Modificador temporal AfterApprox
AfterMid	Modificador temporal AfterMid
AfterStart	Modificador temporal AfterStart
Approx	Modificador temporal aproximado
Before	Antes do modificador temporal
BeforeApprox	Modificador temporal BeforeApprox
BeforeEnd	Modificador temporal BeforeEnd
BeforeStart	Modificador temporal BeforeStart
End	Modificador temporal final
Less	Menos modificador temporal
Mid	Modificador temporal médio
More	Mais modificador temporal
ReferenceUndefined	ReferênciaModificador temporal indefinido
Since	Uma vez que o modificador temporal
SinceEnd	Modificador temporal SinceEnd
Start	Iniciar modificador temporal
Until	Até o modificador temporal

TemporalSpanResolution

Object

representa a resolução de um período de data e/ou hora.

Name	Tipo	Description
begin	string	representa a resolução de um período de data e/ou hora. Uma representação alargada de data/hora ISO 8601, conforme descrito em (https://github.com/Microsoft/Recognizers-Text/blob/master/Patterns/English/English-DateTime.yaml)
duration	string	Um valor de duração opcional formatado com base na norma ISO 8601 (https://en.wikipedia.org/wiki/ISO_8601#Durations)
end	string	representa a resolução de um período de data e/ou hora. Uma representação alargada de data/hora ISO 8601, conforme descrito em (https://github.com/Microsoft/Recognizers-Text/blob/master/Patterns/English/English-DateTime.yaml)
modifier	TemporalModifier	Um modificador opcional de uma instância de data/hora.
resolutionKind	string: TemporalSpanResolution	O tipo de objeto de resolução da entidade.
timex	string	Um trio opcional contendo o início, o fim e a duração, todos declarados como strings formatadas ISO 8601.

TextConversationItem

Object

A modalidade de texto de uma conversa de entrada.

Name	Tipo	Description
id	string	A ID de um item de conversa.
language	string	A linguagem de substituição de um item de conversação na representação linguística do BCP 47.
modality	InputModality	Enumeração das modalidades de conversação suportadas.
participantId	string	O ID do participante de um item de conversa.
role	role	Papel do participante.
text	string	A entrada de texto

VolumeResolution

Object

Representa o modelo de resolução da entidade de volume.

Name	Tipo	Description
resolutionKind	string: VolumeResolution	O tipo de objeto de resolução da entidade.
unit	VolumeUnit	A unidade de medida volumétrica
value	number (double)	O valor numérico que o texto extraído denota.

VolumeUnit

Enumeração

A unidade de medida volumétrica

Valor	Description
Barrel	Unidade de volume em barris.
Bushel	Unidade de volume em alqueires.
Centiliter	Unidade de volume em centímetros.
Cord	Unidade de volume em cabos.
CubicCentimeter	Unidade de volume em centímetros cúbicos.
CubicFoot	Unidade de volume em pés cúbicos.
CubicInch	Unidade de volume em polegadas cúbicas.
CubicMeter	Unidade de volume em metros cúbicos.
CubicMile	Unidade de volume em milhas cúbicas.
CubicMillimeter	Unidade de volume em milímetros cúbicos.
CubicYard	Unidade de volume em quintais cúbicos.
Cup	Unidade de volume em copos.
Decaliter	Unidade de volume em decalitros.
FluidDram	Unidade de volume em drenos fluidos.
FluidOunce	Unidade de volume em onças fluidas.
Gill	Unidade de volume em brânquias.
Hectoliter	Unidade de volume em hectolitros.
Hogshead	Unidade de volume em cabeças de porco.
Liter	Unidade de volume em litros.
Milliliter	Unidade de volume em mililitros.
Minim	Unidade de volume em mínimos.
Peck	Unidade de volume em bicadas.
Pinch	Unidade de volume em beliscões.
Pint	Unidade de volume em pints.
Quart	Unidade de volume em quarts.
Tablespoon	Unidade de volume em colheres de sopa.
Teaspoon	Unidade de volume em colheres de chá.
Unspecified	Unidade de volume não especificada.

WeightResolution

Object

Representa o modelo de resolução da entidade de peso.

Name	Tipo	Description
resolutionKind	string: WeightResolution	O tipo de objeto de resolução da entidade.
unit	WeightUnit	A unidade de medida de peso.
value	number (double)	O valor numérico que o texto extraído denota.

WeightUnit

Enumeração

A unidade de medida de peso.

Valor	Description
Dram	Unidade de peso em drams
Gallon	Unidade de volume em galões
Grain	Unidade de peso em grãos
Gram	Unidade de peso em gramas
Kilogram	Unidade de peso em quilogramas
LongTonBritish	Unidade de peso em toneladas longas (britânico)
MetricTon	Unidade de peso em toneladas métricas
Milligram	Unidade de peso em miligramas
Ounce	Unidade de peso em onças
PennyWeight	Unidade de peso em pennyweights
Pound	Unidade de peso em libras
ShortHundredWeightUS	Unidade de peso em cem pesos curtos (EUA)
ShortTonUS	Unidade de peso em toneladas curtas (EUA)
Stone	Unidade de peso em pedras
Ton	Unidade de peso em toneladas
Unspecified	Unidade de peso não especificada

Partilhar via

Analyze Conversations - Analyze Conversations

Parâmetros do URI

Corpo do Pedido

ConversationalTask

Respostas

Segurança

Ocp-Apim-Subscription-Key

OAuth2Auth

Âmbitos

Exemplos

SuccessfulAnalyzeConversations

Pedido de amostra

Resposta da amostra

SuccessfulAnalyzeConversationsArbitration

Pedido de amostra

Resposta da amostra

SuccessfulAnalyzeConversationsArbitrationDirectTarget

Pedido de amostra

Resposta da amostra

Definições

AgeResolution

AgeUnit

AnalyzeConversationResult

AnalyzeConversationTaskKind

AnalyzeConversationTaskResultsKind

AnswersOptions

AnswerSpan

AnswersResult

AreaResolution

AreaUnit

BooleanResolution

ConversationalTask

ConversationalTaskResult

ConversationAnalysisOptions

ConversationCallingOptions

ConversationEntity

ConversationIntent

ConversationParameters

ConversationPrediction

ConversationResult

ConversationTargetIntentResult

ConversationTaskParameters

CurrencyResolution

DateTimeResolution

DateTimeSubKind

EntitySubtype

Error

ErrorCode

ErrorResponse

ExtraInformationKind

InformationResolution

InformationUnit

InnerErrorCode

InnerErrorModel

InputModality

KnowledgeBaseAnswer

KnowledgeBaseAnswerContext

KnowledgeBaseAnswerDialog

KnowledgeBaseAnswerPrompt

LengthResolution

LengthUnit

ListKey

LogicalOperationKind

LuisCallingOptions

LuisParameters

LuisTargetIntentResult

MetadataFilter

MetadataRecord

NoneLinkedTargetIntentResult

NumberKind

NumberResolution

NumericRangeResolution

OrchestrationPrediction

OrdinalResolution

projectKind

QueryFilters

QuestionAnsweringParameters

QuestionAnsweringTargetIntentResult

RangeKind