Question Answering Projects - Get Qnas

Referência

Serviço:: Azure AI Services

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

Obtém todos os QnAs de um projeto.

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

Com parâmetros opcionais:

GET {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}/qnas?api-version=2023-04-15-preview&source={source}&top={top}&skip={skip}&maxpagesize={maxpagesize}

Parâmetros do URI

Name	Em	Necessá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.
maxpagesize	query		integer int32	O número máximo de recursos a incluir numa única resposta.
skip	query		integer int32	Um deslocamento na coleção do primeiro recurso a ser retornado.
source	query		string	Fonte do QnA.
top	query		integer int32	O número máximo de recursos a serem retornados da coleção.

Respostas

Name	Tipo	Description
200 OK	QnaAssets	Todos os QnAs de um projeto.
Other Status Codes	ErrorResponse	Resposta de erro.

Segurança

AADToken

Estes são os Fluxos de do Azure Ative Directory OAuth2. Quando emparelhado com controle de de acesso baseado em função do Azure, ele pode ser usado para controlar o acesso às APIs REST do Azure Maps. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais contas de recursos ou subrecursos do Azure Maps. 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 Maps.

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

Observações

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

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 Ative Directory. * O controle de acesso baseado em função do Azure é configurado a partir do plano de gerenciamento do Azure por meio do portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST. * O uso do SDK da Web do Azure Maps permite a configuração baseada em configuração de um aplicativo para vários casos de uso.

Atualmente, o Azure Ative Directory v1.0 ou v2.0 oferece suporte a Trabalho, Escola e Convidados, mas não oferece suporte a contas Pessoais.

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

Âmbitos

Name	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

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 200

{
  "value": [
    {
      "id": 1,
      "answer": "ans1",
      "source": "source1",
      "questions": [
        "question 1.1",
        "question 1.2"
      ],
      "metadata": {
        "k1": "v1",
        "k2": "v2"
      },
      "dialog": {
        "isContextOnly": false,
        "prompts": [
          {
            "displayOrder": 1,
            "qnaId": 11,
            "displayText": "prompt 1.1"
          },
          {
            "displayOrder": 2,
            "qnaId": 21,
            "displayText": "prompt 1.2"
          }
        ]
      },
      "lastUpdatedDateTime": "2021-05-01T17:21:14Z"
    },
    {
      "id": 2,
      "answer": "ans2",
      "source": "source2",
      "questions": [
        "question 2.1",
        "question 2.2"
      ],
      "lastUpdatedDateTime": "2021-05-01T17:21:14Z"
    }
  ]
}

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.
QnaAssets	Todos os ativos QnA para o projeto.
QnaDialog	Caixa de diálogo associada ao QnA Record.
QnaPrompt	Solicite uma resposta.
QnaRecord	Registo QnA.
RetrieveQnaRecord	Registro QnA com data-hora da última atualização.
SuggestedQuestion	Pergunta sugerida pelo recurso Aprendizagem Ativa.
SuggestedQuestionsCluster	Detalhes do cluster de perguntas sugeridas pelo Ative Learning.

Error

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

Código de erro legível por humanos.

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

Name	Tipo	Description
error	Error	O objeto de erro.

InnerErrorCode

Código de erro legível por humanos.

Name	Tipo	Description
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
EmptyRequest	string
ExtractionFailure	string
InvalidCountryHint	string
InvalidDocument	string
InvalidDocumentBatch	string
InvalidParameterValue	string
InvalidRequest	string
InvalidRequestBodyFormat	string
KnowledgeBaseNotFound	string
MissingInputDocuments	string
ModelVersionIncorrect	string
UnsupportedLanguageCode	string

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.

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.

QnaAssets

Todos os ativos QnA para o projeto.

Name	Tipo	Description
nextLink	string
value	RetrieveQnaRecord[]	Lista de registos QnA.

QnaDialog

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

Solicite uma resposta.

Name	Tipo	Description
displayOrder	integer	Índice do prompt. Ele é usado para ordenar os prompts.
displayText	string	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	ID do QnA correspondente ao prompt.

QnaRecord

Registo QnA.

Name	Tipo	Description
activeLearningSuggestions	SuggestedQuestionsCluster[]	Lista de sugestões de Aprendizagem Ativa para a QnA.
answer	string	Texto da resposta.
dialog	QnaDialog	Contexto de uma QnA.
id	integer	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	Fonte a partir da qual a QnA foi indexada, por exemplo, https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs .

RetrieveQnaRecord

Registro QnA com data-hora da última atualização.

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

SuggestedQuestion

Pergunta sugerida pelo recurso Aprendizagem Ativa.

Name	Tipo	Description
autoSuggestedCount	integer	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	O número de vezes que a pergunta foi sugerida explicitamente pelo usuário.

SuggestedQuestionsCluster

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.

Partilhar via