Question Answering Projects - Add Feedback

Referência

Serviço:: Azure AI Services

Versão da API:: 2023-04-15-preview

Atualize os comentários do Active Learning.

POST {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}/feedback?api-version=2023-04-15-preview

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
projectName	path	True	string	O nome do projeto a ser usado.
api-version	query	True	string	Versão da API do cliente.

Corpo da solicitação

Nome	Tipo	Description
records	FeedbackRecord[]	Uma lista de Registros de Comentários do Active Learning.

Respostas

Nome	Tipo	Description
204 No Content		Comentários gravados com êxito.
Other Status Codes	ErrorResponse	Resposta de erro.

Segurança

AADToken

Estas são as fluxos de do Azure Active Directory OAuth2. Quando emparelhado com acesso baseado em função do Azure controle, ele pode ser usado para controlar o acesso às APIs REST do Azure Mapas. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais sub-recursos ou conta de recurso do Azure Mapas. Qualquer usuário, grupo ou entidade de serviço pode receber acesso por meio de uma função interna ou uma função personalizada composta por uma ou mais permissões para APIs REST do Azure Mapas.

Para implementar cenários, recomendamos exibir conceitos de autenticação. Em resumo, essa definição de segurança fornece uma solução para modelar aplicativos por meio de objetos capazes de controlar o acesso em APIs e escopos específicos.

Anotações

Essa definição de segurança requer o uso do cabeçalho x-ms-client-id para indicar a qual recurso do Azure Mapas o aplicativo está solicitando acesso. Isso pode ser adquirido da API de gerenciamento do Mapas.

O Authorization URL é específico para a instância de nuvem pública do Azure. As nuvens soberanas têm URLs de Autorização exclusivas e configurações do Azure Active Directory. * O controle de acesso baseado em função do Azure é configurado do plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST. * O uso do SDK da Web do Azure Mapas permite a configuração baseada em configuração de um aplicativo para vários casos de uso.

Atualmente, o Azure Active Directory v1.0 ou v2.0 dá suporte a Trabalho, Escola e Convidados, mas não dá suporte a contas pessoais.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

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

Ocp-Apim-Subscription-Key

Uma chave de assinatura para um recurso de serviço de idioma.

Tipo: apiKey
Em: header

Exemplos

Successful query

Solicitação de exemplo

HTTP

POST {Endpoint}/language/authoring/query-knowledgebases/projects/proj1/feedback?api-version=2023-04-15-preview

{
  "records": [
    {
      "userId": "user1",
      "userQuestion": "hi",
      "qnaId": 1
    },
    {
      "userId": "user1",
      "userQuestion": "hello",
      "qnaId": 2
    }
  ]
}

Resposta de exemplo

Código de status:: 204

Definições

Nome	Description
ActiveLearningFeedback	Comentários sobre o Active Learning.
Error	O objeto de erro.
ErrorCode	Código de erro legível por humanos.
ErrorResponse	Resposta de erro.
FeedbackRecord	Registro de comentários do Active Learning.
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.

ActiveLearningFeedback

Comentários sobre o Active Learning.

Nome	Tipo	Description
records	FeedbackRecord[]	Uma lista de Registros de Comentários do Active Learning.

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
AzureCognitiveSearchIndexNotFound	string
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
Conflict	string
Forbidden	string
InternalServerError	string
InvalidArgument	string
InvalidRequest	string
NotFound	string
OperationNotFound	string
ProjectNotFound	string
QuotaExceeded	string
ServiceUnavailable	string
Timeout	string
TooManyRequests	string
Unauthorized	string
Warning	string

ErrorResponse

Resposta de erro.

Nome	Tipo	Description
error	Error	O objeto de erro.

FeedbackRecord

Registro de comentários do Active Learning.

Nome	Tipo	Description
qnaId	integer	ID exclusiva do QnA.
userId	string	Identificador exclusivo do usuário.
userQuestion	string	Pergunta sugerida pelo usuário para o QnA.

InnerErrorCode