Question Answering Projects - Get Qnas

Referens

Tjänst:: Cognitive Services - Language

API-version:: 2023-04-01

Hämtar alla frågor och svar om ett projekt.

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

Med valfria parametrar:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
Endpoint	path	True	string	Cognitive Services-slutpunkt som stöds (t.ex. https://.api.cognitiveservices.azure.com).
projectName	path	True	string	Namnet på det projekt som ska användas.
api-version	query	True	string	Klient-API-version.
maxpagesize	query		integer int32	Det maximala antalet resurser som ska ingå i ett enda svar.
skip	query		integer int32	En förskjutning i samlingen av den första resursen som ska returneras.
source	query		string	Källa för QnA.
top	query		integer int32	Det maximala antalet resurser som ska returneras från samlingen.

Svar

Name	Typ	Description
200 OK	QnaAssets	Alla frågor och svar för ett projekt.
Other Status Codes	ErrorResponse	Felsvar.

Säkerhet

AADToken

Det här är Azure Active Directory OAuth2-flöden . När den är kopplad till rollbaserad åtkomstkontroll i Azure kan den användas för att styra åtkomsten till Azure Maps REST-API:er. Rollbaserade åtkomstkontroller i Azure används för att ange åtkomst till en eller flera Azure Maps resurskonto eller underresurser. Alla användare, grupper eller tjänstens huvudnamn kan beviljas åtkomst via en inbyggd roll eller en anpassad roll som består av en eller flera behörigheter för att Azure Maps REST-API:er.

För att implementera scenarier rekommenderar vi att du visar autentiseringsbegrepp. Sammanfattningsvis tillhandahåller den här säkerhetsdefinitionen en lösning för modellering av program via objekt som kan få åtkomstkontroll för specifika API:er och omfång.

Kommentarer

Den här säkerhetsdefinitionen x-ms-client-idkräver att huvudet används för att ange vilken Azure Maps resurs som programmet begär åtkomst till. Detta kan hämtas från Maps Management-API:et.

Authorization URL är specifikt för den offentliga Azure-molninstansen. Nationella moln har unika auktoriserings-URL:er och Azure Active Directory-konfigurationer. * Den rollbaserade Azure-åtkomstkontrollen konfigureras från Azure-hanteringsplanet via Azure Portal, PowerShell, CLI, Azure SDK:er eller REST-API:er. * Användning av Azure Maps Web SDK möjliggör konfigurationsbaserad konfiguration av ett program för flera användningsfall.

För närvarande har Azure Active Directory v1.0 eller v2.0 stöd för arbete, skola och gäster, men har inte stöd för personliga konton.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

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

Ocp-Apim-Subscription-Key

En prenumerationsnyckel för en språktjänstresurs.

Typ: apiKey
I: header

Exempel

Successful query

Exempelbegäran

HTTP

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

Exempelsvar

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

Definitioner

Name	Description
Error	Felobjektet.
ErrorCode	Felkod som kan läsas av människor.
ErrorResponse	Felsvar.
InnerErrorCode	Felkod som kan läsas av människor.
InnerErrorModel	Ett objekt som innehåller mer specifik information om felet. Enligt Microsoft One API-riktlinjer – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
QnaAssets	Alla QnA-tillgångar för projektet.
QnaDialog	Dialogruta som är associerad med QnA-post.
QnaPrompt	Fråga efter ett svar.
QnaRecord	QnA-post.
RetrieveQnaRecord	QnA-post med senast uppdaterad datum-tid.
SuggestedQuestion	Fråga som föreslås av funktionen Active Learning.
SuggestedQuestionsCluster	Active Learning föreslog frågor om klusterinformation.

Error

Felobjektet.

Name	Typ	Description
code	ErrorCode	En av en serverdefinierad uppsättning felkoder.
details	Error[]	En matris med information om specifika fel som ledde till det rapporterade felet.
innererror	InnerErrorModel	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	En mänsklig läsbar representation av felet.
target	string	Målet för felet.

ErrorCode

Felkod som kan läsas av människor.

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

Felsvar.

Name	Typ	Description
error	Error	Felobjektet.

InnerErrorCode

Felkod som kan läsas av människor.

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

Ett objekt som innehåller mer specifik information om felet. Enligt Microsoft One API-riktlinjer – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Description
code	InnerErrorCode	En av en serverdefinierad uppsättning felkoder.
details	object	Felinformation.
innererror	InnerErrorModel	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	Felmeddelande.
target	string	Felmål.

QnaAssets

Alla QnA-tillgångar för projektet.

Name	Typ	Description
nextLink	string
value	RetrieveQnaRecord[]	Lista över QnA-poster.

QnaDialog

Dialogruta som är associerad med QnA-post.

Name	Typ	Description
isContextOnly	boolean	Markera om en fråga endast är relevant med en tidigare fråga eller inte. Om det är sant ska du inte ta med denna QnA som svar för frågor utan kontext. annars ignoreras kontexten och den här QnA:en inkluderas i svar.
prompts	QnaPrompt[]	Lista över frågor som är associerade med svaret.

QnaPrompt

Fråga efter ett svar.

Name	Typ	Description
displayOrder	integer	Index för prompten. Den används för att ordna prompterna.
displayText	string	Text som visas för att representera en fråga om uppföljningsfråga.
qna	QnaRecord	QnA-post. Antingen måste QnAId- eller QnA-posten finnas i en prompt.
qnaId	integer	ID för den QnA som motsvarar prompten.

QnaRecord

QnA-post.

Name	Typ	Description
activeLearningSuggestions	SuggestedQuestionsCluster[]	Lista över Active Learning-förslag för frågor och svar.
answer	string	Svarstext.
dialog	QnaDialog	Kontext för en QnA.
id	integer	Unikt ID för QnA.
metadata	object	Metadata som är associerade med svaret, användbara för att kategorisera eller filtrera frågesvar.
questions	string[]	Lista över frågor som är associerade med svaret.
source	string	Källa från vilken QnA indexerades, t.ex. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs .

RetrieveQnaRecord

QnA-post med senast uppdaterad datum-tid.

Name	Typ	Description
activeLearningSuggestions	SuggestedQuestionsCluster[]	Lista över Active Learning-förslag för frågor och svar.
answer	string	Svarstext.
dialog	QnaDialog	Kontext för en QnA.
id	integer	Unikt ID för QnA.
lastUpdatedDateTime	string	Datum när QnA senast uppdaterades.
metadata	object	Metadata som är associerade med svaret, användbara för att kategorisera eller filtrera frågesvar.
questions	string[]	Lista över frågor som är associerade med svaret.
source	string	Källa från vilken QnA indexerades, t.ex. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs .

SuggestedQuestion

Fråga som föreslås av funktionen Active Learning.

Name	Typ	Description
autoSuggestedCount	integer	Antalet gånger som frågan föreslogs automatiskt av Active Learning-algoritmen.
question	string	Fråga som föreslås av funktionen Active Learning.
userSuggestedCount	integer	Antalet gånger som frågan uttryckligen föreslogs av användaren.

SuggestedQuestionsCluster

Active Learning föreslog frågor om klusterinformation.

Name	Typ	Description
clusterHead	string	Fråga som valts som chef för det föreslagna frågeklustret av algoritmen för Active Learning-klustring.
suggestedQuestions	SuggestedQuestion[]	Lista över alla föreslagna frågor för frågor och svar.

Dela via