Question Answering Projects - Update Qnas

Serviço:: Azure AI Services

Versão da API:: 2021-10-01

Atualiza o QnAs de um projeto.

PATCH {Endpoint}/language/query-knowledgebases/projects/{projectName}/qnas?api-version=2021-10-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
Endpoint	path	True	string	Ponto de extremidade de Serviços Cognitivos suportado (por exemplo, https://< resource-name.api.cognitiveservices.azure.com>).
projectName	path	True	string maxLength: 100	O nome do projeto a ser usado.
api-version	query	True	string	Versão da API do cliente.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
Ocp-Apim-Subscription-Key	True	string

Corpo do Pedido

Name	Tipo	Description
body	UpdateQnaRecord[]	Atualizar parâmetros QnAs de um projeto.

Respostas

Name	Tipo	Description
202 Accepted		Uma chamada bem-sucedida resulta com um cabeçalho Operation-Location usado para verificar o status do trabalho. Cabeçalhos Operation-Location: string
Other Status Codes	ErrorResponse	Resposta de erro.

Name

Tipo

Description

202 Accepted

Uma chamada bem-sucedida resulta com um cabeçalho Operation-Location usado para verificar o status do trabalho.

Cabeçalhos

Operation-Location: string

Other Status Codes

ErrorResponse

Resposta de erro.

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

Exemplos

Successful query

Pedido de amostra

HTTP

PATCH {Endpoint}/language/query-knowledgebases/projects/proj1/qnas?api-version=2021-10-01


[
  {
    "op": "add",
    "value": {
      "id": 3,
      "answer": "ans3",
      "source": "source1",
      "questions": [
        "question 3.1",
        "question 3.2"
      ],
      "metadata": {
        "k1": "v1",
        "k2": "v2"
      },
      "dialog": {
        "isContextOnly": false,
        "prompts": [
          {
            "displayOrder": 1,
            "qnaId": 11,
            "displayText": "prompt 3.1"
          },
          {
            "displayOrder": 2,
            "qnaId": 21,
            "displayText": "prompt 3.2"
          }
        ]
      }
    }
  },
  {
    "op": "replace",
    "value": {
      "id": 1,
      "answer": "ans4",
      "source": "source1",
      "questions": [
        "question 4.1",
        "question 4.2"
      ]
    }
  },
  {
    "op": "delete",
    "value": {
      "id": 2,
      "answer": "ans2",
      "source": "source1",
      "questions": [
        "question 2.1",
        "question 2.2"
      ]
    }
  }
]

Resposta da amostra

Código de estado:: 202

Operation-Location: job1

Definições

Name	Description
Error	O objeto de erro.
ErrorCode	Código de erro legível por humanos.
ErrorResponse	Resposta de erro.
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.
QnaDialog	Caixa de diálogo associada ao QnA Record.
QnaPrompt	Solicite uma resposta.
QnaRecord	Registo QnA.
SuggestedQuestion	Pergunta sugerida pelo recurso Aprendizagem Ativa.
SuggestedQuestionsCluster	Detalhes do cluster de perguntas sugeridas pelo Ative Learning.
updateOperationKind	Atualizar o tipo de operação para ativos.
UpdateQnaRecord	Registro QnA a ser atualizado.

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
InvalidRequest
InvalidArgument
Unauthorized
Forbidden
NotFound
ProjectNotFound
OperationNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchIndexNotFound
TooManyRequests
AzureCognitiveSearchThrottling
AzureCognitiveSearchIndexLimitReached
InternalServerError
ServiceUnavailable

ErrorResponse

Object

Resposta de erro.

Name	Tipo	Description
error	Error	O objeto de erro.

InnerErrorCode

Enumeração

Código de erro legível por humanos.

Valor	Description
InvalidRequest
InvalidParameterValue
KnowledgeBaseNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
ExtractionFailure

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.

QnaDialog

Object

Caixa de diálogo associada ao QnA Record.

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 resposta para consultas sem contexto; caso contrário, ignora o contexto e inclui este QnA nas respostas.
prompts	QnaPrompt[]	Lista de prompts associados à resposta.

QnaPrompt

Object

Solicite uma resposta.

Name	Tipo	Description
displayOrder	integer (int32)	Índice do prompt. Ele é usado para ordenar os prompts.
displayText	string maxLength: 200	Texto exibido para representar um prompt de pergunta de acompanhamento.
qna	QnaRecord	Registo QnA. O registro QnAId ou QnA precisa estar presente em um prompt.
qnaId	integer (int32)	ID do QnA correspondente ao prompt.

QnaRecord

Object

Registo QnA.

Name	Tipo	Description
activeLearningSuggestions	SuggestedQuestionsCluster[]	Lista de sugestões de Aprendizagem Ativa para a QnA.
answer	string minLength: 1 maxLength: 25000	Texto da resposta.
dialog	QnaDialog	Contexto de uma QnA.
id	integer (int32)	ID exclusivo para o QnA.
metadata	object	Metadados associados à resposta, úteis para categorizar ou filtrar respostas a perguntas.
questions	string[]	Lista de perguntas associadas à resposta.
source	string maxLength: 300	Fonte a partir da qual a QnA foi indexada, por exemplo, https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs .

SuggestedQuestion

Object

Pergunta sugerida pelo recurso Aprendizagem Ativa.

Name	Tipo	Description
autoSuggestedCount	integer (int32)	O número de vezes que a pergunta foi sugerida automaticamente pelo algoritmo Ative Learning.
question	string	Pergunta sugerida pelo recurso Aprendizagem Ativa.
userSuggestedCount	integer (int32)	O número de vezes que a pergunta foi sugerida explicitamente pelo usuário.

SuggestedQuestionsCluster

Object

Detalhes do cluster de perguntas sugeridas pelo Ative Learning.

Name	Tipo	Description
clusterHead	string	Pergunta escolhida como cabeça do cluster de perguntas sugerido pelo algoritmo de agrupamento do Ative Learning.
suggestedQuestions	SuggestedQuestion[]	Lista de todas as perguntas sugeridas para a QnA.

updateOperationKind

Enumeração

Atualizar o tipo de operação para ativos.

Valor	Description
add
delete
replace

UpdateQnaRecord

Object

Registro QnA a ser atualizado.

Name	Tipo	Description
op	updateOperationKind	Atualizar o tipo de operação para ativos.
value	QnaRecord	Registo QnA.

Partilhar via

Question Answering Projects - Update Qnas

Parâmetros do URI

Cabeçalho do Pedido

Corpo do Pedido

Respostas

Segurança

Ocp-Apim-Subscription-Key

Exemplos

Successful query

Pedido de amostra

Resposta da amostra

Definições

Error

ErrorCode

ErrorResponse

InnerErrorCode

InnerErrorModel

QnaDialog

QnaPrompt

QnaRecord

SuggestedQuestion

SuggestedQuestionsCluster

updateOperationKind

UpdateQnaRecord