Question Answering Projects - Get Qnas

Service:

Azure AI Services

API-versie:

2021-10-01

Haalt alle QnA's van een project op.

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

Met optionele parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
Endpoint	path	True	string	Ondersteund Cognitive Services-eindpunt (bijvoorbeeld https://.api.cognitiveservices.azure.com).
projectName	path	True	string maxLength: 100	De naam van het te gebruiken project.
api-version	query	True	string	Client-API-versie.
maxpagesize	query		integer (int32)	Het maximum aantal resources dat in één antwoord moet worden opgenomen.
skip	query		integer (int32)	Een verschuiving in de verzameling van de eerste resource die moet worden geretourneerd.
source	query		string	Bron van de QnA.
top	query		integer (int32)	Het maximum aantal resources dat moet worden geretourneerd uit de verzameling.

Aanvraagkoptekst

Name	Vereist	Type	Description
Ocp-Apim-Subscription-Key	True	string

Antwoorden

Name	Type	Description
200 OK	QnaAssets	Alle QnA's van een project.
Other Status Codes	ErrorResponse	Foutreactie.

Beveiliging

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Voorbeelden

Successful query

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:

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"
    }
  ]
}

Definities

Name	Description
Error	Het foutobject.
ErrorCode	Leesbare foutcode.
ErrorResponse	Foutreactie.
InnerErrorCode	Leesbare foutcode.
InnerErrorModel	Een object met meer specifieke informatie over de fout. Volgens de richtlijnen voor Microsoft One-API- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
QnaAssets	Alle QnA-assets voor het project.
QnaDialog	Dialoogvenster dat is gekoppeld aan QnA-record.
QnaPrompt	Vraag om een antwoord.
QnaRecord	QnA-record.
RetrieveQnaRecord	QnA-record met laatst bijgewerkte datum/tijd.
SuggestedQuestion	Vraag die wordt voorgesteld door de functie Actief leren.
SuggestedQuestionsCluster	Active Learning voorgestelde vragen over clusterdetails.

Error

Object

Het foutobject.

Name	Type	Description
code	ErrorCode	Een van een door de server gedefinieerde set foutcodes.
details	Error[]	Een matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout.
innererror	InnerErrorModel	Een object met meer specifieke informatie dan het huidige object over de fout.
message	string	Een leesbare weergave van de fout.
target	string	Het doel van de fout.

ErrorCode

Inventarisatie

Leesbare foutcode.

Waarde	Description
AzureCognitiveSearchIndexLimitReached
AzureCognitiveSearchIndexNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
Forbidden
InternalServerError
InvalidArgument
InvalidRequest
NotFound
OperationNotFound
ProjectNotFound
ServiceUnavailable
TooManyRequests
Unauthorized

ErrorResponse

Object

Foutreactie.

Name	Type	Description
error	Error	Het foutobject.

InnerErrorCode

Inventarisatie

Leesbare foutcode.

Waarde	Description
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
ExtractionFailure
InvalidParameterValue
InvalidRequest
KnowledgeBaseNotFound

InnerErrorModel

Object

Een object met meer specifieke informatie over de fout. Volgens de richtlijnen voor Microsoft One-API- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Type	Description
code	InnerErrorCode	Een van een door de server gedefinieerde set foutcodes.
details	object	Foutdetails.
innererror	InnerErrorModel	Een object met meer specifieke informatie dan het huidige object over de fout.
message	string	Foutmelding.
target	string	Foutdoel.

QnaAssets

Object

Alle QnA-assets voor het project.

Name	Type	Description
nextLink	string
value	RetrieveQnaRecord[]	Lijst met QnA-records.

QnaDialog

Object

Dialoogvenster dat is gekoppeld aan QnA-record.

Name	Type	Description
isContextOnly	boolean	Als u wilt markeren of een prompt alleen relevant is voor een vorige vraag of niet. Indien waar, moet u deze QnA niet opnemen als antwoord voor query's zonder context; negeert anders context en bevat deze QnA in antwoorden.
prompts	QnaPrompt[]	Lijst met prompts die aan het antwoord zijn gekoppeld.

QnaPrompt

Object

Vraag om een antwoord.

Name	Type	Description
displayOrder	integer (int32)	Index van de prompt. Deze wordt gebruikt voor het ordenen van de prompts.
displayText	string maxLength: 200	Tekst die wordt weergegeven om een vraagprompt voor opvolgen weer te geven.
qna	QnaRecord	QnA-record. De QnAId- of QnA-record moet aanwezig zijn in een prompt.
qnaId	integer (int32)	Id van de QnA die overeenkomt met de prompt.

QnaRecord

Object

QnA-record.

Name	Type	Description
activeLearningSuggestions	SuggestedQuestionsCluster[]	Lijst met active learning-suggesties voor de QnA.
answer	string minLength: 1 maxLength: 25000	Antwoordtekst.
dialog	QnaDialog	Context van een QnA.
id	integer (int32)	Unieke id voor de QnA.
metadata	object	Metagegevens die zijn gekoppeld aan het antwoord, handig om antwoorden op vragen te categoriseren of te filteren.
questions	string[]	Lijst met vragen die aan het antwoord zijn gekoppeld.
source	string maxLength: 300	Bron van waaruit QnA is geïndexeerd, bijvoorbeeld https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs .

RetrieveQnaRecord

Object

QnA-record met laatst bijgewerkte datum/tijd.

Name	Type	Description
activeLearningSuggestions	SuggestedQuestionsCluster[]	Lijst met active learning-suggesties voor de QnA.
answer	string minLength: 1 maxLength: 25000	Antwoordtekst.
dialog	QnaDialog	Context van een QnA.
id	integer (int32)	Unieke id voor de QnA.
lastUpdatedDateTime	string (date-time)	Datum en tijd waarop de QnA voor het laatst is bijgewerkt.
metadata	object	Metagegevens die zijn gekoppeld aan het antwoord, handig om antwoorden op vragen te categoriseren of te filteren.
questions	string[]	Lijst met vragen die aan het antwoord zijn gekoppeld.
source	string maxLength: 300	Bron van waaruit QnA is geïndexeerd, bijvoorbeeld https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs .

SuggestedQuestion

Object

Vraag die wordt voorgesteld door de functie Actief leren.

Name	Type	Description
autoSuggestedCount	integer (int32)	Het aantal keren dat de vraag automatisch is voorgesteld door het Algoritme Actief leren.
question	string	Vraag die wordt voorgesteld door de functie Actief leren.
userSuggestedCount	integer (int32)	Het aantal keren dat de vraag expliciet door de gebruiker is voorgesteld.

SuggestedQuestionsCluster

Object

Active Learning voorgestelde vragen over clusterdetails.

Name	Type	Description
clusterHead	string	Vraag die is gekozen als het hoofd van het voorgestelde vragencluster door het algoritme active learning-clustering.
suggestedQuestions	SuggestedQuestion[]	Lijst met alle voorgestelde vragen voor de QnA.