Compartilhar via


Analyze Conversations - Analyze Conversations

Analisa o enunciado da conversa de entrada.

POST {Endpoint}/language/:analyze-conversations?api-version=2023-04-01

Parâmetros de URI

Nome Em Obrigatório Tipo Description
Endpoint
path True

string

Ponto de extremidade dos Serviços Cognitivos com suporte (por exemplo, https://.api.cognitiveservices.azure.com).

api-version
query True

string

A versão da API a ser usada para esta operação.

Corpo da solicitação

ConversationalTask

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

Nome Obrigatório Tipo Description
analysisInput True

ConversationAnalysisOptions

O ConversationItem de entrada 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 de linguagem de conversa.

Respostas

Nome Tipo Description
200 OK AnalyzeConversationTaskResult:

ConversationalTaskResult

A solicitação foi bem-sucedida.

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
Flow: accessCode
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize
URL do Token: https://login.microsoftonline.com/common/oauth2/token

Escopos

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

Exemplos

SuccessfulAnalyzeConversations
SuccessfulAnalyzeConversationsArbitration
SuccessfulAnalyzeConversationsArbitrationDirectTarget

SuccessfulAnalyzeConversations

Solicitação de exemplo

POST {Endpoint}/language/:analyze-conversations?api-version=2023-04-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 de exemplo

{
  "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

Solicitação de exemplo

POST {Endpoint}/language/:analyze-conversations?api-version=2023-04-01

{
  "kind": "Conversation",
  "analysisInput": {
    "conversationItem": {
      "participantId": "1",
      "id": "1",
      "modality": "text",
      "language": "en-GB",
      "text": "trains from London"
    }
  },
  "parameters": {
    "projectName": "{project-name}",
    "deploymentName": "{deployment-name}",
    "verbose": true,
    "isLoggingEnabled": false,
    "stringIndexType": "TextElement_V8"
  }
}

Resposta de exemplo

{
  "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

Solicitação de exemplo

POST {Endpoint}/language/:analyze-conversations?api-version=2023-04-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 de exemplo

{
  "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

Nome Description
AgeResolution

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

AgeUnit

A Unidade de Idade da Medida

AnalyzeConversationResult

Representa uma resposta de análise de conversa.

AnalyzeConversationTaskKind

Enumeração de tarefas de conversa com suporte.

AnalyzeConversationTaskResultsKind

Enumeração de resultados de tarefas de conversa com suporte.

AnswersOptions

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

AnswerSpan

Objeto de intervalo de resposta do QnA.

AnswersResult

Representa a lista de respostas a perguntas.

AreaResolution

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

AreaUnit

A unidade de área de medida.

BooleanResolution

Uma resolução para expressões boolianas

ConversationalTask

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

ConversationalTaskResult

Os resultados de uma tarefa de Conversa.

ConversationAnalysisOptions

O ConversationItem de entrada e seus parâmetros opcionais

ConversationCallingOptions

A opção a ser definida para chamar um projeto de Conversa.

ConversationEntity

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

ConversationIntent

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

ConversationParameters

Esse é um conjunto de parâmetros de solicitação para projetos de Conversa Personalizada.

ConversationPrediction

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

ConversationResult

A resposta retornada por um projeto de Conversa.

ConversationTargetIntentResult

Um encerramento da resposta do projeto conversation.

ConversationTaskParameters

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

CurrencyResolution

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

DateTimeResolution

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

DateTimeSubKind

O SubKind 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ções (dados).

InformationUnit

A unidade de medida de informações (dados).

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 de modalidades de conversa com suporte.

KnowledgeBaseAnswer

Representa a resposta da base de dados 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 de entidade de comprimento.

LengthUnit

A unidade de comprimento da medida.

ListKey

O tipo de dados extra da chave de lista.

LogicalOperationKind

Operação usada para unir filtros de metadados.

LuisCallingOptions

Isso personaliza como o serviço chama projetos do LUIS em disponibilidade geral.

LuisParameters

Este é um conjunto de parâmetros de solicitação para projetos disponíveis em geral do LUIS.

LuisTargetIntentResult

É um encerramento da resposta disponível geral do LUIS.

MetadataFilter

Localize QnAs associadas à lista de metadados fornecida.

MetadataRecord

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

NoneLinkedTargetIntentResult

Um encapsulamento de resposta de intenção não vinculada.

NumberKind

O tipo da entidade de número extraída.

NumberResolution

Uma resolução para instâncias de entidade numérica.

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 do projeto.

QueryFilters

filtra sobre a base de dados de conhecimento.

QuestionAnsweringParameters

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

QuestionAnsweringTargetIntentResult

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

RangeKind

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

RankerKind

Tipo de classificador a ser usado

RegexKey

O tipo de dados extra da chave regex.

RelativeTo

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

ResolutionKind

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

role

Função do participante.

ShortAnswerOptions

Para configurar o recurso de previsão de intervalo de respostas.

SpeedResolution

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

SpeedUnit

A unidade de velocidade 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 de entidade de temperatura.

TemperatureUnit

A unidade de temperatura da medida.

TemporalModifier

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

TemporalSpanResolution

representa a resolução de uma data e/ou intervalo de tempo.

TextConversationItem

A modalidade de texto de uma conversa de entrada.

VolumeResolution

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

VolumeUnit

A unidade de volume de medida

WeightResolution

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

WeightUnit

A unidade de peso da medida.

AgeResolution

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

Nome Tipo Description
resolutionKind string:

AgeResolution

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

unit

AgeUnit

A Unidade de Idade da Medida

value

number

O valor numérico que o texto extraído denota.

AgeUnit

A Unidade de Idade da Medida

Nome Tipo Description
Day

string

Unidade de idade diária

Month

string

Unidade de idade do mês

Unspecified

string

Unidade etária não especificada

Week

string

Unidade de idade da semana

Year

string

Unidade de idade do ano

AnalyzeConversationResult

Representa uma resposta de análise de conversa.

Nome Tipo Description
detectedLanguage

string

O idioma detectado pelo sistema para a consulta na representação da linguagem BCP 47..

prediction BasePrediction:

O resultado da previsão de um projeto de conversa.

query

string

O enunciado da conversa dado pelo chamador.

AnalyzeConversationTaskKind

Enumeração de tarefas de conversa com suporte.

Nome Tipo Description
Conversation

string

Tipo de tarefa de conversa

AnalyzeConversationTaskResultsKind

Enumeração de resultados de tarefas de conversa com suporte.

Nome Tipo Description
ConversationResult

string

Tipo de tarefa de resultado da conversa

AnswersOptions

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

Nome Tipo Description
answerSpanRequest

ShortAnswerOptions

Para configurar o recurso de previsão de intervalo de respostas.

confidenceScoreThreshold

number

A pontuação mínima do limite para respostas, o valor varia de 0 a 1.

context

KnowledgeBaseAnswerContext

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

filters

QueryFilters

Filtrar QnAs com base em determinada lista de metadados e fontes de base de dados de conhecimento.

includeUnstructuredSources

boolean

(Opcional) Sinalizador para habilitar a consulta em fontes não estruturadas.

qnaId

integer

A ID exata de QnA a ser buscada na base de dados de conhecimento, esse campo tem prioridade sobre a questão.

question

string

Pergunta do usuário para consultar na base de dados de conhecimento.

rankerType

RankerKind

Tipo de classificador a ser usado.

top

integer

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

userId

string

Identificador exclusivo para o usuário.

AnswerSpan

Objeto de intervalo de resposta do QnA.

Nome Tipo Description
confidenceScore

number

A pontuação prevista de intervalo de respostas varia de 0 a 1.

length

integer

O comprimento do intervalo de respostas.

offset

integer

O deslocamento do intervalo de respostas desde o início da resposta.

text

string

Texto previsto do intervalo de respostas.

AnswersResult

Representa a lista de respostas a perguntas.

Nome Tipo Description
answers

KnowledgeBaseAnswer[]

Representa a lista de resultados da resposta.

AreaResolution

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

Nome Tipo Description
resolutionKind string:

AreaResolution

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

unit

AreaUnit

A unidade de medição da área

value

number

O valor numérico que o texto extraído denota.

AreaUnit

A unidade de área de medida.

Nome Tipo Description
Acre

string

Unidade de área do Acre

SquareCentimeter

string

Unidade de área de centímetro quadrado

SquareDecameter

string

Unidade de área de decameter quadrada

SquareDecimeter

string

Unidade de área do decimeter quadrado

SquareFoot

string

Unidade de área de pé quadrado

SquareHectometer

string

Unidade de área do hectômetro quadrado

SquareInch

string

Unidade de área de polegada quadrada

SquareKilometer

string

Unidade de área de quilômetros quadrados

SquareMeter

string

Unidade de área do medidor quadrado

SquareMile

string

Unidade de área de milha quadrada

SquareMillimeter

string

Unidade de área de milímetro quadrado

SquareYard

string

Unidade de área do pátio quadrado

Unspecified

string

Unidade de área não especificada

BooleanResolution

Uma resolução para expressões boolianas

Nome Tipo Description
resolutionKind string:

BooleanResolution

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

value

boolean

Uma resolução para expressões boolianas

ConversationalTask

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

Nome Tipo Description
analysisInput

ConversationAnalysisOptions

O ConversationItem de entrada 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 de linguagem de conversa.

ConversationalTaskResult

Os resultados de uma tarefa de Conversa.

Nome 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.

ConversationAnalysisOptions

O ConversationItem de entrada e seus parâmetros opcionais

Nome Tipo Description
conversationItem

TextConversationItem

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

ConversationCallingOptions

A opção a ser definida para chamar um projeto de Conversa.

Nome Tipo Description
isLoggingEnabled

boolean

Se for true, a consulta será salva para os clientes revisarem ainda mais a criação, a fim de melhorar a qualidade do modelo.

language

string

O idioma da consulta na representação da linguagem BCP 47.

verbose

boolean

Se for true, o serviço retornará informações mais detalhadas.

ConversationEntity

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

Nome Tipo Description
category

string

A categoria de entidade.

confidenceScore

number

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

extraInformation BaseExtraInformation[]:

A coleção de objetos de informações extras da entidade.

length

integer

O comprimento do texto.

offset

integer

O índice inicial dessa entidade na consulta.

resolutions BaseResolution[]:

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

text

string

O texto da entidade prevista.

ConversationIntent

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

Nome Tipo Description
category

string

Uma classe prevista.

confidenceScore

number

A pontuação de confiança da classe de 0,0 a 1,0.

ConversationParameters

Esse é um conjunto de parâmetros de solicitação para projetos de Conversa Personalizada.

Nome 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 a ser definida para chamar um projeto de Conversa.

targetProjectKind string:

Conversation

O tipo de um serviço de destino

ConversationPrediction

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

Nome Tipo Description
entities

ConversationEntity[]

Os resultados da extração de entidade.

intents

ConversationIntent[]

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

projectKind string:

Conversation

O tipo do projeto.

topIntent

string

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

ConversationResult

A resposta retornada por um projeto de Conversa.

Nome Tipo Description
detectedLanguage

string

O idioma detectado da consulta na representação de linguagem BCP 47.

prediction

ConversationPrediction

O resultado previsto para a consulta.

query

string

A mesma consulta fornecida na solicitação.

ConversationTargetIntentResult

Um encerramento da resposta do projeto conversation.

Nome Tipo Description
apiVersion

string

A versão da API usada para chamar um serviço de destino.

confidenceScore

number

A pontuação de previsão e ela varia de 0,0 a 1,0.

result

ConversationResult

A resposta real de um projeto de conversa.

targetProjectKind string:

Conversation

Esta é a classe base de uma previsão de intenção

ConversationTaskParameters

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

Nome Tipo Valor padrão 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 for true, o serviço manterá a consulta para revisão adicional.

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 (Graphemes) 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 for true, o serviço retornará informações mais detalhadas na resposta.

CurrencyResolution

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

Nome Tipo Description
ISO4217

string

O código alfabético baseado em outro padrão ISO, ISO 3166, que lista os códigos para nomes de país. As duas primeiras letras do código de três letras ISO 4217 são iguais ao 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 de entidade.

unit

string

A unidade da quantidade capturada na entidade extraída

value

number

O valor do dinheiro capturado na entidade extraída

DateTimeResolution

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

Nome Tipo Description
dateTimeSubKind

DateTimeSubKind

O SubKind DateTime

modifier

TemporalModifier

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

resolutionKind string:

DateTimeResolution

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

timex

string

Uma representação de data/hora do ISO 8601 estendida conforme descrito em (https://github.com/Microsoft/Recognizers-Text/blob/master/Patterns/English/English-DateTime.yaml)

value

string

A hora real que o texto extraído denota.

DateTimeSubKind

O SubKind datetime.

Nome Tipo Description
Date

string

Subdelicado de data

DateTime

string

Subdelicado DateTime

Duration

string

Subdelicação de duração

Set

string

Definir subdelicado

Time

string

Subdelicação de tempo

EntitySubtype

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

Nome Tipo Description
extraInformationKind string:

EntitySubtype

O tipo de objeto de informação extra.

value

string

O subtipo de um tipo de entidade extraído.

Error

O objeto de erro.

Nome Tipo Description
code

ErrorCode

Um de um conjunto definido pelo servidor de códigos de erro.

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 pelo ser humano do erro.

target

string

O destino do erro.

ErrorCode

Código de erro legível por humanos.

Nome Tipo Description
AzureCognitiveSearchIndexLimitReached

string

Erro atingido no limite de índice do Azure Cognitive Search

AzureCognitiveSearchIndexNotFound

string

Erro não encontrado no índice do Azure Cognitive Search

AzureCognitiveSearchNotFound

string

Erro não encontrado no Azure Cognitive Search

AzureCognitiveSearchThrottling

string

Erro de limitação do Azure Cognitive Search

Conflict

string

Erro de conflito

Forbidden

string

Erro de acesso proibido

InternalServerError

string

Erro interno do servidor

InvalidArgument

string

Erro de argumento inválido

InvalidRequest

string

Erro de solicitação inválido

NotFound

string

Erro não encontrado

OperationNotFound

string

Erro de operação não encontrada

ProjectNotFound

string

Erro não encontrado no projeto

QuotaExceeded

string

Erro de cota excedido

ServiceUnavailable

string

Erro de serviço indisponível

Timeout

string

Erro de tempo limite

TooManyRequests

string

Erro de muitas solicitações

Unauthorized

string

Erro de acesso não autorizado

Warning

string

Erro de aviso

ErrorResponse

Resposta de erro.

Nome Tipo Description
error

Error

O objeto de erro.

ExtraInformationKind

O tipo de objeto de informação extra.

Nome Tipo Description
EntitySubtype

string

Tipo de informação extra de subtipo de entidade

ListKey

string

Tipo de informação extra de chave de lista

RegexKey

string

Tipo de informação extra de chave Regex

InformationResolution

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

Nome Tipo Description
resolutionKind string:

InformationResolution

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

unit

InformationUnit

A unidade de medida de informações (dados).

value

number

O valor numérico que o texto extraído denota.

InformationUnit

A unidade de medida de informações (dados).

Nome Tipo Description
Bit

string

Unidade de informações de bits

Byte

string

Unidade de informações de byte

Gigabit

string

Unidade de informações do Gigabit

Gigabyte

string

Unidade de informações do Gigabyte

Kilobit

string

Unidade de informações do Kilobit

Kilobyte

string

Unidade de informações kilobyte

Megabit

string

Unidade de informações do Megabit

Megabyte

string

Unidade de informações do Megabyte

Petabit

string

Unidade de informações do Petabit

Petabyte

string

Unidade de informações petabyte

Terabit

string

Unidade de informações do Terabit

Terabyte

string

Unidade de informações do Terabyte

Unspecified

string

Unidade de informações não especificadas

InnerErrorCode

Código de erro legível por humanos.

Nome Tipo Description
AzureCognitiveSearchNotFound

string

Erro não encontrado no Azure Cognitive Search

AzureCognitiveSearchThrottling

string

Erro de limitação do Azure Cognitive Search

EmptyRequest

string

Erro de solicitação vazia

ExtractionFailure

string

Erro de falha de extração

InvalidCountryHint

string

Erro de dica de país inválido

InvalidDocument

string

Erro de documento inválido

InvalidDocumentBatch

string

Erro em lote de documento inválido

InvalidParameterValue

string

Erro de valor de parâmetro inválido

InvalidRequest

string

Erro de solicitação inválido

InvalidRequestBodyFormat

string

Erro de formato do corpo da solicitação inválido

KnowledgeBaseNotFound

string

Erro não encontrado na base de dados de conhecimento

MissingInputDocuments

string

Erro de documentos de entrada ausentes

ModelVersionIncorrect

string

Erro incorreto da versão do modelo

UnsupportedLanguageCode

string

Erro de código de idioma sem suporte

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 Tipo Description
code

InnerErrorCode

Um de um conjunto definido pelo servidor de códigos de erro.

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

Destino de erro.

InputModality

Enumeração de modalidades de conversa com suporte.

Nome Tipo Description
text

string

Modalidade de entrada de texto

transcript

string

Modalidade de entrada de transcrição

KnowledgeBaseAnswer

Representa a resposta da base de dados de conhecimento.

Nome Tipo Description
answer

string

Texto da resposta.

answerSpan

AnswerSpan

Objeto de intervalo de resposta do QnA em relação à pergunta do usuário.

confidenceScore

number

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

dialog

KnowledgeBaseAnswerDialog

Caixa de diálogo associada à Resposta.

id

integer

ID do resultado do QnA.

metadata

object

Metadados associados à resposta, úteis para categorizar ou filtrar respostas de pergunta.

questions

string[]

Lista de perguntas associadas à resposta.

source

string

Origem do resultado de QnA.

KnowledgeBaseAnswerContext

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

Nome Tipo Description
previousQnaId

integer

A ID de QnA do resultado da resposta superior da curva anterior.

previousUserQuery

string

Consulta de usuário anterior.

KnowledgeBaseAnswerDialog

Caixa de diálogo associada à Resposta.

Nome Tipo Description
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

KnowledgeBaseAnswerPrompt[]

Lista de prompts associados à resposta.

KnowledgeBaseAnswerPrompt

Solicite uma resposta.

Nome Tipo Description
displayOrder

integer

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

displayText

string

Texto exibido para representar um prompt de pergunta de acompanhamento.

qnaId

integer

ID de QnA correspondente ao prompt.

LengthResolution

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

Nome Tipo Description
resolutionKind string:

LengthResolution

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

unit

LengthUnit

A unidade de medida de comprimento

value

number

O valor numérico que o texto extraído denota.

LengthUnit

A unidade de comprimento da medida.

Nome Tipo Description
Centimeter

string

Unidade de comprimento de centímetro

Decameter

string

Unidade de comprimento de decameter

Decimeter

string

Unidade de comprimento do decimeter

Foot

string

Unidade de comprimento do pé

Hectometer

string

Unidade de comprimento do hectômetro

Inch

string

Unidade de comprimento de polegada

Kilometer

string

Unidade de comprimento do quilômetro

LightYear

string

Unidade de comprimento de ano-luz

Meter

string

Unidade de comprimento do medidor

Micrometer

string

Unidade de comprimento do micrometer

Mile

string

Unidade de comprimento de milha

Millimeter

string

Unidade de comprimento milimétrico

Nanometer

string

Unidade de comprimento de nanômetro

Picometer

string

Unidade de comprimento picometer

Pt

string

Unidade de comprimento do ponto

Unspecified

string

Unidade de comprimento não especificado

Yard

string

Unidade de comprimento do quintal

ListKey

O tipo de dados extra da chave de lista.

Nome Tipo Description
extraInformationKind string:

ListKey

O tipo de objeto de informação extra.

key

string

A forma canônica da entidade extraída.

LogicalOperationKind

Operação usada para unir filtros de metadados.

Nome Tipo Description
AND

string

AND lógico

OR

string

OR lógico

LuisCallingOptions

Isso personaliza como o serviço chama projetos do LUIS em disponibilidade geral.

Nome Tipo Description
bing-spell-check-subscription-key

string

A chave de assinatura a ser usada ao habilitar a verificação ortográfica do Bing

log

boolean

Salve o log para adicionar enunciados de treinamento posteriormente.

show-all-intents

boolean

Defina true para mostrar todas as intenções.

spellCheck

boolean

Habilite a verificação ortográfica.

timezoneOffset

integer

O deslocamento de fuso horário para o local da solicitação.

verbose

boolean

Habilite a resposta detalhada.

LuisParameters

Este é um conjunto de parâmetros de solicitação para projetos disponíveis em geral do LUIS.

Nome 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 projetos do LUIS em disponibilidade geral.

query

string

O enunciado a ser previsto.

targetProjectKind string:

Luis

O tipo de um serviço de destino

LuisTargetIntentResult

É um encerramento da resposta disponível geral do LUIS.

Nome Tipo Description
apiVersion

string

A versão da API usada para chamar um serviço de destino.

confidenceScore

number

A pontuação de previsão e ela varia de 0,0 a 1,0.

result

LuisResult

A resposta real de um aplicativo luis disponível em geral.

targetProjectKind string:

Luis

Esta é a classe base de uma previsão de intenção

MetadataFilter

Localize QnAs associadas à lista de metadados fornecida.

Nome Tipo Valor padrão Description
logicalOperation

LogicalOperationKind

AND

Operação usada para unir filtros de metadados.

metadata

MetadataRecord[]

Lista de metadados.

MetadataRecord

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

Nome Tipo Description
key

string

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

value

string

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

NoneLinkedTargetIntentResult

Um encapsulamento de resposta de intenção não vinculada.

Nome Tipo Description
apiVersion

string

A versão da API usada para chamar um serviço de destino.

confidenceScore

number

A pontuação de previsão e ela varia de 0,0 a 1,0.

result

ConversationResult

A resposta real de um projeto de conversa.

targetProjectKind string:

NonLinked

Esta é a classe base de uma previsão de intenção

NumberKind

O tipo da entidade de número extraída.

Nome Tipo Description
Decimal

string

Número decimal

Fraction

string

Número de fração

Integer

string

Número inteiro

Percent

string

Número percentual

Power

string

Número de energia

Unspecified

string

Tipo de número não especificado

NumberResolution

Uma resolução para instâncias de entidade numérica.

Nome Tipo Description
numberKind

NumberKind

O tipo da entidade de número extraída.

resolutionKind string:

NumberResolution

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

value

number

Uma representação numérica do que o texto extraído indica.

NumericRangeResolution

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

Nome Tipo Description
maximum

number

O valor final do intervalo.

minimum

number

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 de entidade.

OrchestrationPrediction

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

Nome 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 do projeto.

topIntent

string

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

OrdinalResolution

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

Nome Tipo Description
offset

string

O deslocamento em relação à referência (por exemplo, deslocamento = -1 indica o segundo a último)

relativeTo

RelativeTo

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

resolutionKind string:

OrdinalResolution

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

value

string

Uma expressão aritmética simples que o ordinal denota.

projectKind

O tipo do projeto.

Nome Tipo Description
Conversation

string

Tipo de conversa

Orchestration

string

Tipo de orquestração

QueryFilters

filtra sobre a base de dados de conhecimento.

Nome Tipo Valor padrão Description
logicalOperation

LogicalOperationKind

AND

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

metadataFilter

MetadataFilter

filtra sobre a base de dados de conhecimento.

sourceFilter

string[]

filtra sobre a base de dados de conhecimento.

QuestionAnsweringParameters

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

Nome 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

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

Nome Tipo Description
apiVersion

string

A versão da API usada para chamar um serviço de destino.

confidenceScore

number

A pontuação de previsão e ela varia de 0,0 a 1,0.

result

AnswersResult

A resposta gerada por um KB de Resposta a Perguntas.

targetProjectKind string:

QuestionAnswering

Esta é a classe base de uma previsão de intenção

RangeKind

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

Nome Tipo Description
Age

string

Faixa etária

Area

string

Intervalo de área

Currency

string

Intervalo de moeda

Information

string

Intervalo de informações

Length

string

Intervalo de comprimento

Number

string

Intervalo de números

Speed

string

Intervalo de velocidade

Temperature

string

Intervalo de temperatura

Volume

string

Intervalo de volume

Weight

string

Intervalo de peso

RankerKind

Tipo de classificador a ser usado

Nome Tipo Description
Default

string

Classificador padrão.

QuestionOnly

string

Classificador somente de perguntas.

RegexKey

O tipo de dados extra da chave regex.

Nome 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 regex do .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

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

Nome Tipo Description
Current

string

Estado atual

End

string

Estado final

Start

string

Estado de início

ResolutionKind

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

Nome Tipo Description
AgeResolution

string

Resolução de uma entidade etária

AreaResolution

string

Resolução de uma entidade de área

BooleanResolution

string

Resolução de uma entidade booliana

CurrencyResolution

string

Resolução de uma entidade de moeda

DateTimeResolution

string

Resolução de uma entidade de data/hora

InformationResolution

string

Resolução de uma entidade de informações

LengthResolution

string

Resolução de uma entidade de comprimento

NumberResolution

string

Resolução de uma entidade numérica

NumericRangeResolution

string

Resolução de uma entidade de intervalo numérico

OrdinalResolution

string

Resolução de uma entidade ordinal

SpeedResolution

string

Resolução de uma entidade de velocidade

TemperatureResolution

string

Resolução de uma entidade de temperatura

TemporalSpanResolution

string

Resolução de uma entidade de intervalo temporal

VolumeResolution

string

Resolução de uma entidade de volume

WeightResolution

string

Resolução de uma entidade de peso

role

Função do participante.

Nome Tipo Description
agent

string

O participante é um agente.

customer

string

O participante é um cliente.

generic

string

O participante é genérico.

ShortAnswerOptions

Para configurar o recurso de previsão de intervalo de respostas.

Nome Tipo Valor padrão Description
confidenceScoreThreshold

number

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

enable

boolean

True

Habilitar ou desabilitar a previsão do Período de Resposta.

topAnswersWithSpan

integer

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

SpeedResolution

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

Nome Tipo Description
resolutionKind string:

SpeedResolution

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

unit

SpeedUnit

A unidade de velocidade de medida

value

number

O valor numérico que o texto extraído denota.

SpeedUnit

A unidade de velocidade de medida

Nome Tipo Description
CentimetersPerMillisecond

string

Centimeters por unidade de velocidade de milissegundos

FootPerMinute

string

Unidade de velocidade de pé por minuto

FootPerSecond

string

Unidade de velocidade de pé por segundo

KilometersPerHour

string

Unidade de velocidade de quilômetros por hora

KilometersPerMillisecond

string

Quilômetros por unidade de velocidade de milissegundos

KilometersPerMinute

string

Unidade de velocidade de quilômetros por minuto

KilometersPerSecond

string

Unidade de velocidade de quilômetros por segundo

Knot

string

Unidade de velocidade de nó

MetersPerMillisecond

string

Medidores por unidade de velocidade de milissegundos

MetersPerSecond

string

Unidade de velocidade de medidores por segundo

MilesPerHour

string

Unidade de velocidade de milhas por hora

Unspecified

string

Unidade de velocidade não especificada

YardsPerMinute

string

Unidade de velocidade de jardas por minuto

YardsPerSecond

string

Jardas por segundo unidade de velocidade

StringIndexType

Tipo de índice de cadeia de caracteres

Nome Tipo Description
TextElements_v8

string

Os valores de deslocamento e comprimento retornados corresponderão a TextElements (clusters Graphemes e Grapheme) confirmando o padrão Unicode 8.0.0. Use essa opção se o aplicativo for escrito no .Net Framework ou no .Net Core e você usará StringInfo.

UnicodeCodePoint

string

Os valores de deslocamento e comprimento retornados corresponderão aos pontos de código Unicode. Use essa opção se o aplicativo for escrito em um idioma que dê suporte ao Unicode, por exemplo, Python.

Utf16CodeUnit

string

Os valores de deslocamento e comprimento retornados corresponderão às unidades de código UTF-16. Use essa opção se o aplicativo for escrito em um idioma que dê suporte ao Unicode, por exemplo Java, JavaScript.

targetProjectKind

O tipo de um serviço de destino.

Nome Tipo Description
Conversation

string

Tipo de serviço de destino de conversa

Luis

string

Tipo de serviço de destino do Luis

NonLinked

string

Tipo de serviço de destino não vinculado

QuestionAnswering

string

Tipo de serviço de destino QuestionAnswering

TemperatureResolution

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

Nome Tipo Description
resolutionKind string:

TemperatureResolution

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

unit

TemperatureUnit

A unidade de temperatura da medida.

value

number

O valor numérico que o texto extraído denota.

TemperatureUnit

A unidade de temperatura da medida.

Nome Tipo Description
Celsius

string

Unidade de temperatura Celsius

Fahrenheit

string

Unidade de temperatura Fahrenheit

Kelvin

string

Unidade de temperatura kelvin

Rankine

string

Unidade de temperatura de Rankine

Unspecified

string

Unidade de temperatura não especificada

TemporalModifier

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

Nome Tipo Description
After

string

Depois do modificador temporal

AfterApprox

string

Modificador temporal AfterApprox

AfterMid

string

Modificador temporal AfterMid

AfterStart

string

Modificador temporal AfterStart

Approx

string

Modificador temporal approx

Before

string

Antes do modificador temporal

BeforeApprox

string

Modificador temporal BeforeApprox

BeforeEnd

string

Modificador temporal BeforeEnd

BeforeStart

string

Modificador temporal BeforeStart

End

string

Modificador temporal final

Less

string

Modificador temporal menor

Mid

string

Modificador temporal médio

More

string

Modificador mais temporal

ReferenceUndefined

string

Modificador temporal ReferenceUndefined

Since

string

Desde modificador temporal

SinceEnd

string

Modificador temporal SinceEnd

Start

string

Iniciar modificador temporal

Until

string

Até modificador temporal

TemporalSpanResolution

representa a resolução de uma data e/ou intervalo de tempo.

Nome Tipo Description
begin

string

representa a resolução de uma data e/ou intervalo de tempo. Uma representação de data/hora do ISO 8601 estendida 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 no ISO 8601 (https://en.wikipedia.org/wiki/ISO_8601#Durations)

end

string

representa a resolução de uma data e/ou intervalo de tempo. Uma representação de data/hora do ISO 8601 estendida 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 de entidade.

timex

string

Um trigêmeo opcional que contém o início, o fim e a duração declarados como cadeias de caracteres formatadas iso 8601.

TextConversationItem

A modalidade de texto de uma conversa de entrada.

Nome Tipo Description
id

string

A ID de um item de conversa.

language

string

A linguagem de substituição de um item de conversa na representação de linguagem BCP 47.

modality

InputModality

Enumeração de modalidades de conversa com suporte.

participantId

string

A ID do participante de um item de conversa.

role

role

Função do participante.

text

string

A entrada de texto

VolumeResolution

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

Nome Tipo Description
resolutionKind string:

VolumeResolution

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

unit

VolumeUnit

A unidade de volume de medida

value

number

O valor numérico que o texto extraído denota.

VolumeUnit

A unidade de volume de medida

Nome Tipo Description
Barrel

string

Unidade de volume em barris.

Bushel

string

Unidade de volume em bushels.

Centiliter

string

Unidade de volume em centilitros.

Cord

string

Unidade de volume em cabos.

CubicCentimeter

string

Unidade de volume em centímetros cúbicos.

CubicFoot

string

Unidade de volume em pés cúbicos.

CubicInch

string

Unidade de volume em polegadas cúbicas.

CubicMeter

string

Unidade de volume em metros cúbicos.

CubicMile

string

Unidade de volume em milhas cúbicas.

CubicMillimeter

string

Unidade de volume em milímetros cúbicos.

CubicYard

string

Unidade de volume em metros cúbicos.

Cup

string

Unidade de volume em copos.

Decaliter

string

Unidade de volume em decalques.

FluidDram

string

Unidade de volume em drams fluidos.

FluidOunce

string

Unidade de volume em onças fluidas.

Gill

string

Unidade de volume em brânquias.

Hectoliter

string

Unidade de volume em hectolitros.

Hogshead

string

Unidade de volume em hogsheads.

Liter

string

Unidade de volume em litros.

Milliliter

string

Unidade de volume em mililitros.

Minim

string

Unidade de volume em minims.

Peck

string

Unidade de volume em bicadas.

Pinch

string

Unidade de volume em pinçadas.

Pint

string

Unidade de volume em litros.

Quart

string

Unidade de volume em quarts.

Tablespoon

string

Unidade de volume em colheres de sopa.

Teaspoon

string

Unidade de volume em colheres de chá.

Unspecified

string

Unidade de volume não especificada.

WeightResolution

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

Nome Tipo Description
resolutionKind string:

WeightResolution

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

unit

WeightUnit

A unidade de peso da medida.

value

number

O valor numérico que o texto extraído denota.

WeightUnit

A unidade de peso da medida.

Nome Tipo Description
Dram

string

Unidade de peso em drams

Gallon

string

Unidade de volume em galões

Grain

string

Unidade de peso em grãos

Gram

string

Unidade de peso em gramas

Kilogram

string

Unidade de peso em quilogramas

LongTonBritish

string

Unidade de peso em toneladas longas (britânica)

MetricTon

string

Unidade de peso em toneladas de métrica

Milligram

string

Unidade de peso em miligramas

Ounce

string

Unidade de peso em onças

PennyWeight

string

Unidade de peso em pesos-centavos

Pound

string

Unidade de peso em libras

ShortHundredWeightUS

string

Unidade de peso em centenas de pesos curtos (EUA)

ShortTonUS

string

Unidade de peso em toneladas curtas (EUA)

Stone

string

Unidade de peso em pedras

Ton

string

Unidade de peso em toneladas

Unspecified

string

Unidade de peso não especificada