Question Answering Projects - Update Qnas

Odwołanie

Usługa:: Cognitive Services - Language

Wersja interfejsu API:: 2023-04-01

Aktualizacje pytań i pytań dla projektu.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
Endpoint	path	True	string	Obsługiwany punkt końcowy usług Cognitive Services (np. https://.api.cognitiveservices.azure.com).
projectName	path	True	string	Nazwa projektu do użycia.
api-version	query	True	string	Wersja interfejsu API klienta.

Treść żądania

Nazwa	Typ	Opis
body	UpdateQnaRecord[]	Aktualizowanie parametrów pytań i pytań i pytań i pytań dla projektu.

Odpowiedzi

Nazwa	Typ	Opis
202 Accepted		Wyniki pomyślnego wywołania z nagłówkiem Operation-Location służącym do sprawdzania stanu zadania. Nagłówki Operation-Location: string
Other Status Codes	ErrorResponse	Odpowiedź na błąd.

Nazwa

Typ

Opis

202 Accepted

Wyniki pomyślnego wywołania z nagłówkiem Operation-Location służącym do sprawdzania stanu zadania.

Nagłówki

Operation-Location: string

Other Status Codes

ErrorResponse

Odpowiedź na błąd.

Zabezpieczenia

AADToken

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

Aby zaimplementować scenariusze, zalecamy wyświetlenie pojęć związanych z uwierzytelnianiem. Podsumowując, ta definicja zabezpieczeń stanowi 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.

Uwagi

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

Element Authorization URL jest specyficzny 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 z poziomu płaszczyzny zarządzania platformy Azure za pośrednictwem Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów AZURE SDK lub interfejsów API REST. * Użycie zestawu AZURE MAPS Web SDK umożliwia skonfigurowanie aplikacji na podstawie konfiguracji dla wielu przypadków 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

HTTP

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

[
  {
    "op": "add",
    "value": {
      "id": 3,
      "answer": "ans3",
      "source": "source1",
      "questions": [
        "question 3.1",
        "question 3.2"
      ],
      "metadata": {
        "k1": "v1",
        "k2": "v2"
      },
      "dialog": {
        "isContextOnly": false,
        "prompts": [
          {
            "displayOrder": 1,
            "qnaId": 11,
            "displayText": "prompt 3.1"
          },
          {
            "displayOrder": 2,
            "qnaId": 21,
            "displayText": "prompt 3.2"
          }
        ]
      }
    }
  },
  {
    "op": "replace",
    "value": {
      "id": 1,
      "answer": "ans4",
      "source": "source1",
      "questions": [
        "question 4.1",
        "question 4.2"
      ]
    }
  },
  {
    "op": "delete",
    "value": {
      "id": 2,
      "answer": "ans2",
      "source": "source1",
      "questions": [
        "question 2.1",
        "question 2.2"
      ]
    }
  }
]

Przykładowa odpowiedź

Kod stanu:: 202

Operation-Location: https:///language/authoring/query-knowledgebases/projects/proj1/qnas/jobs/job1?api-version=2023-04-01

Definicje

Nazwa	Opis
Error	Obiekt error.
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 interfejsu MICROSOFT One API — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
QnaDialog	Okno dialogowe skojarzone z rekordem usługi QnA.
QnaPrompt	Monituj o odpowiedź.
QnaRecord	Rekord usługi QnA.
SuggestedQuestion	Pytanie sugerowane przez funkcję Active Learning.
SuggestedQuestionsCluster	Sugerowane pytania dotyczące klastra w usłudze Active Learning.
updateOperationKind	Typ operacji aktualizacji dla zasobów.
UpdateQnaRecord	Rekord pytań i odpowiedzi do zaktualizowania.

Error

Obiekt error.

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

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 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	Błąd docelowy.

QnaDialog

Okno dialogowe skojarzone z rekordem usługi QnA.

Nazwa	Typ	Opis
isContextOnly	boolean	Aby zaznaczyć, czy monit ma zastosowanie tylko z poprzednim pytaniem, czy nie. Jeśli to prawda, nie dołączaj tej odpowiedzi pytań i odpowiedzi dla zapytań bez kontekstu; W przeciwnym razie ignoruje kontekst i uwzględnia tę QnA w odpowiedziach.
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 do reprezentowania monitu o pytanie.
qna	QnaRecord	Rekord usługi QnA. Rekord QnAId lub QnA musi być obecny w wierszu polecenia.
qnaId	integer	Identyfikator pytań i odpowiedzi odpowiadający monitowi.

QnaRecord

Rekord usługi 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ń i pytań i kondycji.
id	integer	Unikatowy identyfikator 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 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	Ile razy pytanie zostało sugerowane 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 w usłudze 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.

updateOperationKind

Typ operacji aktualizacji dla zasobów.

Nazwa	Typ	Opis
add	string
delete	string
replace	string

UpdateQnaRecord

Rekord pytań i odpowiedzi do zaktualizowania.

Nazwa	Typ	Opis
op	updateOperationKind	Typ operacji aktualizacji dla zasobów.
value	QnaRecord	Rekord usługi QnA.

Udostępnij za pośrednictwem

Question Answering Projects - Update Qnas

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Zabezpieczenia

AADToken

Uwagi

Zakresy

Ocp-Apim-Subscription-Key

Przykłady

Successful query

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

Error

ErrorCode

ErrorResponse

InnerErrorCode

InnerErrorModel

QnaDialog

QnaPrompt

QnaRecord

SuggestedQuestion

SuggestedQuestionsCluster

updateOperationKind

UpdateQnaRecord

Dodatkowe zasoby