Question Answering Projects - Get Qnas

Riferimento

Servizio:: Azure AI Services

Versione API:: 2021-10-01

Ottiene tutti i QnA di un progetto.

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

Con parametri facoltativi:

GET {Endpoint}/language/query-knowledgebases/projects/{projectName}/qnas?api-version=2021-10-01&source={source}&top={top}&skip={skip}&maxpagesize={maxpagesize}

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
Endpoint	path	True	string	Endpoint di Servizi cognitivi supportato (ad esempio, https://.api.cognitiveservices.azure.com).
projectName	path	True	string maxLength: 100	Nome del progetto da utilizzare.
api-version	query	True	string	Versione dell'API client.
maxpagesize	query		integer (int32)	Numero massimo di risorse da includere in una singola risposta.
skip	query		integer (int32)	Offset nella raccolta della prima risorsa da restituire.
source	query		string	Origine del QnA.
top	query		integer (int32)	Numero massimo di risorse da restituire dalla raccolta.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
Ocp-Apim-Subscription-Key	True	string

Risposte

Nome	Tipo	Descrizione
200 OK	QnaAssets	Tutte le domande e risposte di un progetto.
Other Status Codes	ErrorResponse	Risposta di errore.

Sicurezza

Ocp-Apim-Subscription-Key

Tipo: apiKey
In: header

Esempio

Successful query

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:: 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"
    }
  ]
}

Definizioni

Nome	Descrizione
Error	Oggetto error.
ErrorCode	Codice di errore leggibile.
ErrorResponse	Risposta di errore.
InnerErrorCode	Codice di errore leggibile.
InnerErrorModel	Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API Microsoft One , https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
QnaAssets	Tutti gli asset QnA per il progetto.
QnaDialog	Finestra di dialogo associata al record QnA.
QnaPrompt	Richiedi una risposta.
QnaRecord	Record QnA.
RetrieveQnaRecord	Record QnA con data e ora dell'ultimo aggiornamento.
SuggestedQuestion	Domanda suggerita dalla funzionalità Di apprendimento attivo.
SuggestedQuestionsCluster	Dettagli del cluster delle domande suggerite di Active Learning.

Error

Object

Oggetto error.

Nome	Tipo	Descrizione
code	ErrorCode	Uno di un set definito dal server di codici di errore.
details	Error[]	Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato.
innererror	InnerErrorModel	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message	string	Rappresentazione leggibile dell'errore.
target	string	Destinazione dell'errore.

ErrorCode

Enumerazione

Codice di errore leggibile.

Valore	Descrizione
AzureCognitiveSearchIndexLimitReached
AzureCognitiveSearchIndexNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
Forbidden
InternalServerError
InvalidArgument
InvalidRequest
NotFound
OperationNotFound
ProjectNotFound
ServiceUnavailable
TooManyRequests
Unauthorized

ErrorResponse

Object

Risposta di errore.

Nome	Tipo	Descrizione
error	Error	Oggetto error.

InnerErrorCode

Enumerazione

Codice di errore leggibile.

Valore	Descrizione
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
ExtractionFailure
InvalidParameterValue
InvalidRequest
KnowledgeBaseNotFound

InnerErrorModel

Object

Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API Microsoft One , https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nome	Tipo	Descrizione
code	InnerErrorCode	Uno di un set definito dal server di codici di errore.
details	object	Dettagli errore.
innererror	InnerErrorModel	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message	string	Messaggio di errore.
target	string	Destinazione errore.

QnaAssets

Object

Tutti gli asset QnA per il progetto.

Nome	Tipo	Descrizione
nextLink	string
value	RetrieveQnaRecord[]	Elenco di record QnA.

QnaDialog

Object

Finestra di dialogo associata al record QnA.

Nome	Tipo	Descrizione
isContextOnly	boolean	Per contrassegnare se una richiesta è rilevante solo con una domanda precedente o meno. Se true, non includere questo QnA come risposta per le query senza contesto; in caso contrario, ignora il contesto e include questo QnA nelle risposte.
prompts	QnaPrompt[]	Elenco di richieste associate alla risposta.

QnaPrompt

Object

Richiedi una risposta.

Nome	Tipo	Descrizione
displayOrder	integer (int32)	Indice del prompt. Viene usato per l'ordinamento delle richieste.
displayText	string maxLength: 200	Testo visualizzato per rappresentare un prompt delle domande di completamento.
qna	QnaRecord	Record QnA. Il record QnAId o QnA deve essere presente in un prompt.
qnaId	integer (int32)	ID del QnA corrispondente al prompt.

QnaRecord

Object

Record QnA.

Nome	Tipo	Descrizione
activeLearningSuggestions	SuggestedQuestionsCluster[]	Elenco dei suggerimenti di Active Learning per il QnA.
answer	string minLength: 1 maxLength: 25000	Testo della risposta.
dialog	QnaDialog	Contesto di un QnA.
id	integer (int32)	ID univoco per QnA.
metadata	object	Metadati associati alla risposta, utili per classificare o filtrare le risposte alle domande.
questions	string[]	Elenco di domande associate alla risposta.
source	string maxLength: 300	Origine da cui è stato indicizzato QnA, ad esempio https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs .

RetrieveQnaRecord

Object

Record QnA con data e ora dell'ultimo aggiornamento.

Nome	Tipo	Descrizione
activeLearningSuggestions	SuggestedQuestionsCluster[]	Elenco dei suggerimenti di Active Learning per il QnA.
answer	string minLength: 1 maxLength: 25000	Testo della risposta.
dialog	QnaDialog	Contesto di un QnA.
id	integer (int32)	ID univoco per QnA.
lastUpdatedDateTime	string (date-time)	Data e ora dell'ultimo aggiornamento del QnA.
metadata	object	Metadati associati alla risposta, utili per classificare o filtrare le risposte alle domande.
questions	string[]	Elenco di domande associate alla risposta.
source	string maxLength: 300	Origine da cui è stato indicizzato QnA, ad esempio https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs .

SuggestedQuestion

Object

Domanda suggerita dalla funzionalità Di apprendimento attivo.

Nome	Tipo	Descrizione
autoSuggestedCount	integer (int32)	Numero di volte in cui la domanda è stata suggerita automaticamente dall'algoritmo di Active Learning.
question	string	Domanda suggerita dalla funzionalità Di apprendimento attivo.
userSuggestedCount	integer (int32)	Numero di volte in cui la domanda è stata suggerita in modo esplicito dall'utente.

SuggestedQuestionsCluster

Object

Dettagli del cluster delle domande suggerite di Active Learning.

Nome	Tipo	Descrizione
clusterHead	string	Domanda scelta come responsabile del cluster di domande suggerite dall'algoritmo di clustering di Active Learning.
suggestedQuestions	SuggestedQuestion[]	Elenco di tutte le domande suggerite per il QnA.

Condividi tramite

Question Answering Projects - Get Qnas

Parametri dell'URI

Intestazione della richiesta

Risposte

Sicurezza

Ocp-Apim-Subscription-Key

Esempio

Successful query

Esempio di richiesta

Risposta di esempio

Definizioni

Error

ErrorCode

ErrorResponse

InnerErrorCode

InnerErrorModel

QnaAssets

QnaDialog

QnaPrompt

QnaRecord

RetrieveQnaRecord

SuggestedQuestion

SuggestedQuestionsCluster

Risorse aggiuntive