Udostępnij za pośrednictwem


Question Answering Projects - Get Qnas

Pobiera wszystkie pytania dotyczące pytań i pytań w projekcie.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
projectName
path True

string

Nazwa projektu do użycia.

api-version
query True

string

Wersja interfejsu API klienta.

maxpagesize
query

integer

int32

Maksymalna liczba zasobów do uwzględnienia w pojedynczej odpowiedzi.

skip
query

integer

int32

Przesunięcie do kolekcji pierwszego zasobu, który ma zostać zwrócony.

source
query

string

Źródło pytań i pytań.

top
query

integer

int32

Maksymalna liczba zasobów do zwrócenia z kolekcji.

Odpowiedzi

Nazwa Typ Opis
200 OK

QnaAssets

Wszystkie pytania dotyczące pytań i pytań w projekcie.

Other Status Codes

ErrorResponse

Odpowiedź na błąd.

Zabezpieczenia

AADToken

Są to przepływy OAuth2 usługi Azure Active Directory. Po połączeniu z dostępem opartym na rolach platformy Azure kontroli może służyć do kontrolowania dostępu do interfejsów API REST usługi Azure Maps. Mechanizmy kontroli dostępu opartej na rolach platformy Azure służą do wyznaczania dostępu do co najmniej jednego konta zasobu usługi Azure Maps lub zasobów podrzędnych. Każdy użytkownik, grupa lub jednostka usługi mogą mieć dostęp za pośrednictwem wbudowanej roli lub roli niestandardowej składającej się z co najmniej jednego uprawnienia do interfejsów API REST usługi Azure Maps.

Aby zaimplementować scenariusze, zalecamy wyświetlenie koncepcji uwierzytelniania . Podsumowując, ta definicja zabezpieczeń zawiera rozwiązanie do modelowania aplikacji za pośrednictwem obiektów, które mogą kontrolować dostęp do określonych interfejsów API i zakresów.

Notatki

  • Ta definicja zabezpieczeń wymaga użycia nagłówka x-ms-client-id w celu wskazania, do którego zasobu usługi Azure Maps aplikacja żąda dostępu. Można to uzyskać za pomocą interfejsu API zarządzania usługami Maps.

Authorization URL jest specyficzna dla wystąpienia chmury publicznej platformy Azure. Suwerenne chmury mają unikatowe adresy URL autoryzacji i konfiguracje usługi Azure Active Directory. * Kontrola dostępu oparta na rolach platformy Azure jest konfigurowana na podstawie płaszczyzny zarządzania platformy Azure za pośrednictwem witryny Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów AZURE SDK lub interfejsów API REST. * Użycie zestawu Web SDK usługi Azure Maps umożliwia konfigurację opartą na konfiguracji aplikacji w wielu przypadkach użycia.

  • Obecnie usługa Azure Active Directory w wersji 1.0 lub 2.0 obsługuje konta służbowe, szkolne i gości, ale nie obsługuje kont osobistych.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa Opis
https://cognitiveservices.azure.com/.default https://cognitiveservices.azure.com/.default

Ocp-Apim-Subscription-Key

Klucz subskrypcji zasobu usługi językowej.

Typ: apiKey
W: header

Przykłady

Successful query

Przykładowe żądanie

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

Przykładowa odpowiedź

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

Definicje

Nazwa Opis
Error

Obiekt błędu.

ErrorCode

Kod błędu czytelny dla człowieka.

ErrorResponse

Odpowiedź na błąd.

InnerErrorCode

Kod błędu czytelny dla człowieka.

InnerErrorModel

Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi dotyczącymi interfejsu MICROSOFT One API — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

QnaAssets

Wszystkie zasoby usługi QnA dla projektu.

QnaDialog

Okno dialogowe skojarzone z rekordem usługi QnA.

QnaPrompt

Monituj o odpowiedź.

QnaRecord

Rekord QnA.

RetrieveQnaRecord

Rekord QnA z ostatnią zaktualizowaną datą i godziną.

SuggestedQuestion

Pytanie sugerowane przez funkcję Active Learning.

SuggestedQuestionsCluster

Sugerowane pytania dotyczące klastra usługi Active Learning.

Error

Obiekt błędu.

Nazwa Typ Opis
code

ErrorCode

Jeden z zdefiniowanych przez serwer zestaw kodów błędów.

details

Error[]

Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.

innererror

InnerErrorModel

Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.

message

string

Czytelna dla człowieka reprezentacja błędu.

target

string

Element docelowy błędu.

ErrorCode

Kod błędu czytelny dla człowieka.

Nazwa Typ Opis
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

Odpowiedź na błąd.

Nazwa Typ Opis
error

Error

Obiekt błędu.

InnerErrorCode

Kod błędu czytelny dla człowieka.

Nazwa Typ Opis
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

Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi dotyczącymi interfejsu MICROSOFT One API — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nazwa Typ Opis
code

InnerErrorCode

Jeden z zdefiniowanych przez serwer zestaw kodów błędów.

details

object

Szczegóły błędu.

innererror

InnerErrorModel

Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.

message

string

Komunikat o błędzie.

target

string

Element docelowy błędu.

QnaAssets

Wszystkie zasoby usługi QnA dla projektu.

Nazwa Typ Opis
nextLink

string

value

RetrieveQnaRecord[]

Lista rekordów usługi QnA.

QnaDialog

Okno dialogowe skojarzone z rekordem usługi QnA.

Nazwa Typ Opis
isContextOnly

boolean

Aby zaznaczyć, czy monit jest odpowiedni tylko z poprzednim pytaniem, czy nie. Jeśli to prawda, nie uwzględnij tej pytań i odpowiedzi na zapytania bez kontekstu; w przeciwnym razie ignoruje kontekst i dołącza tę usługę pytań i odpowiedzi.

prompts

QnaPrompt[]

Lista monitów skojarzonych z odpowiedzią.

QnaPrompt

Monituj o odpowiedź.

Nazwa Typ Opis
displayOrder

integer

Indeks monitu. Służy do porządkowania monitów.

displayText

string

Tekst wyświetlany w celu reprezentowania monitu o pytanie.

qna

QnaRecord

Rekord QnA. Rekord QnAId lub QnA musi być obecny w wierszu polecenia.

qnaId

integer

Identyfikator pytań i odpowiedzi odpowiadający monitowi.

QnaRecord

Rekord QnA.

Nazwa Typ Opis
activeLearningSuggestions

SuggestedQuestionsCluster[]

Lista sugestii dotyczących usługi Active Learning dla pytań i pytań i pytań.

answer

string

Tekst odpowiedzi.

dialog

QnaDialog

Kontekst pytań i pytań.

id

integer

Unikatowy identyfikator QnA.

metadata

object

Metadane skojarzone z odpowiedzią, przydatne do kategoryzowania lub filtrowania odpowiedzi na pytania.

questions

string[]

Lista pytań skojarzonych z odpowiedzią.

source

string

Źródło, z którego indeksowano usługę QnA, np. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs .

RetrieveQnaRecord

Rekord QnA z ostatnią zaktualizowaną datą i godziną.

Nazwa Typ Opis
activeLearningSuggestions

SuggestedQuestionsCluster[]

Lista sugestii dotyczących usługi Active Learning dla pytań i pytań i pytań.

answer

string

Tekst odpowiedzi.

dialog

QnaDialog

Kontekst pytań i pytań.

id

integer

Unikatowy identyfikator QnA.

lastUpdatedDateTime

string

Data i godzina ostatniej aktualizacji pytań i pytań i pytań.

metadata

object

Metadane skojarzone z odpowiedzią, przydatne do kategoryzowania lub filtrowania odpowiedzi na pytania.

questions

string[]

Lista pytań skojarzonych z odpowiedzią.

source

string

Źródło, z którego indeksowano usługę QnA, np. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs .

SuggestedQuestion

Pytanie sugerowane przez funkcję Active Learning.

Nazwa Typ Opis
autoSuggestedCount

integer

Liczba sugerowanych automatycznie przez algorytm uczenia aktywnego.

question

string

Pytanie sugerowane przez funkcję Active Learning.

userSuggestedCount

integer

Liczba sugerowanych jawnie przez użytkownika pytania.

SuggestedQuestionsCluster

Sugerowane pytania dotyczące klastra usługi Active Learning.

Nazwa Typ Opis
clusterHead

string

Pytanie wybrane jako szef sugerowanych pytań klastra przez algorytm klastrowania usługi Active Learning.

suggestedQuestions

SuggestedQuestion[]

Lista wszystkich sugerowanych pytań dotyczących pytań i odpowiedzi.