Udostępnij za pośrednictwem

Question Answering Projects - Import

  • Odwołanie
Usługa:
Cognitive Services - Language
Wersja interfejsu API:
2023-04-01

Zaimportuj zasoby projektu.

POST {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}/:import?api-version=2023-04-01
Z parametrami opcjonalnymi: 
POST {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}/:import?api-version=2023-04-01&format={format}&assetKind={assetKind}

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.
assetKind
 query

string

Rodzaj zasobu projektu.
format
 query

format

Format importu lub eksportu bazy wiedzy.

Treść żądania

Nazwa Typ Opis
assets

Assets

Wszystkie zasoby dla tego projektu.
fileUri

string

Importowanie identyfikatora URI pliku danych.
metadata

CreateProjectOptions

Parametry potrzebne do utworzenia 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.

Zabezpieczenia

AADToken

Są to przepływy protokołu OAuth2 usługi Azure Active Directory . W 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 konta zasobów Azure Maps 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ęć dotyczących uwierzytelniania. Podsumowując, ta definicja zabezpieczeń udostępnia 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łówkax-ms-client-id, aby wskazać, do którego zasobu Azure Maps aplikacja żąda dostępu. Można to uzyskać za pomocą interfejsu API zarządzania mapami.

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 płaszczyzny zarządzania platformy Azure za pośrednictwem Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsów API REST. * Użycie zestawu AZURE MAPS Web SDK 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ługują 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

POST {Endpoint}/language/authoring/query-knowledgebases/projects/proj1/:import?api-version=2023-04-01

{
  "assets": {
    "synonyms": [
      {
        "alterations": [
          "wa",
          "washington",
          "washington state"
        ]
      },
      {
        "alterations": [
          "U.S",
          "usa",
          "united states of america"
        ]
      }
    ],
    "qnas": [
      {
        "lastUpdatedDateTime": "2021-05-01T17:21:14Z",
        "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": 2,
              "displayText": "prompt 1.1"
            }
          ]
        }
      },
      {
        "lastUpdatedDateTime": "2021-05-01T17:21:14Z",
        "id": 2,
        "answer": "ans2",
        "source": "source2",
        "questions": [
          "question 2.1",
          "question 2.2"
        ]
      }
    ]
  }
}

Przykładowa odpowiedź

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

Definicje

Nazwa Opis
Assets

Wszystkie zasoby dla tego projektu.
CreateProjectOptions

Parametry potrzebne do utworzenia projektu.
Error

Obiekt błędu.
ErrorCode

Kod błędu czytelny dla człowieka.
ErrorResponse

Odpowiedź na błąd.
format

Format importu lub eksportu bazy wiedzy.
ImportJobOptions

Zasoby projektu, które należy zaimportować.
ImportQnaRecord

Zaimportuj rekord QnA.
InnerErrorCode

Kod błędu czytelny dla człowieka.
InnerErrorModel

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

Konfigurowalne ustawienia projektu.
QnaDialog

Okno dialogowe skojarzone z rekordem QnA.
QnaPrompt

Monituj o odpowiedź.
QnaRecord

Rekord QnA.
SuggestedQuestion

Pytanie sugerowane przez funkcję Active Learning.
SuggestedQuestionsCluster

Sugerowane pytania dotyczące klastra w usłudze Active Learning.
WordAlterations

Kolekcja zmian wyrazów.

Assets

Wszystkie zasoby dla tego projektu.

Nazwa Typ Opis
qnas

ImportQnaRecord[]

Lista rekordów usługi QnA do zaimportowania.
synonyms

WordAlterations[]

Kolekcja synonimów.

CreateProjectOptions

Parametry potrzebne do utworzenia projektu.

Nazwa Typ Opis
description

string

Opis projektu.
language

string

Język rekordów tekstowych. Jest to reprezentacja języka BCP-47. Na przykład użyj ciągu "en" dla języka angielskiego; "es" dla języka hiszpańskiego itp. Jeśli nie zostanie ustawiona, użyj ciągu "en" dla języka angielskiego jako domyślnego.
multilingualResource

boolean

Ustaw wartość true, aby włączyć tworzenie baz wiedzy w różnych językach dla tego samego zasobu.
settings

ProjectSettings

Konfigurowalne ustawienia projektu.

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.

format

Format importu lub eksportu bazy wiedzy.

Nazwa Typ Opis
excel

string

Eksportowanie lub importowanie repliki baza wiedzy, w tym wszystkich zasobów i metadanych w formacie Tsv.
json

string

Eksportowanie lub importowanie zasobów QnA w formacie JSON.
tsv

string

Eksportowanie lub importowanie repliki baza wiedzy, w tym wszystkich zasobów i metadanych w formacie programu Excel.

ImportJobOptions

Zasoby projektu, które należy zaimportować.

Nazwa Typ Opis
assets

Assets

Wszystkie zasoby dla tego projektu.
fileUri

string

Importowanie identyfikatora URI pliku danych.
metadata

CreateProjectOptions

Parametry potrzebne do utworzenia projektu.

ImportQnaRecord

Zaimportuj rekord QnA.

Nazwa Typ Opis
activeLearningSuggestions

SuggestedQuestionsCluster[]

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

string

Tekst odpowiedzi.
dialog

QnaDialog

Kontekst pytań i odpowiedzi.
id

integer

Unikatowy identyfikator pytań i odpowiedzi.
lastUpdatedDateTime

string

Data i godzina ostatniej aktualizacji pytań i odpowiedzi.
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 .
sourceDisplayName

string

Przyjazna nazwa źródła.

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 API usługi Microsoft One — 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.

ProjectSettings

Konfigurowalne ustawienia projektu.

Nazwa Typ Opis
defaultAnswer

string

Domyślna odpowiedź, gdy w baza wiedzy nie znaleziono dobrej dopasowania.

QnaDialog

Okno dialogowe skojarzone z rekordem QnA.

Nazwa Typ Opis
isContextOnly

boolean

Aby zaznaczyć, czy monit jest istotny tylko z poprzednim pytaniem, czy nie. Jeśli ma wartość true, nie należy uwzględniać tej odpowiedzi jako odpowiedzi na zapytania bez kontekstu; w przeciwnym razie ignoruje kontekst i uwzględnia tę usługę 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 w celu reprezentowania monitu o pytanie.
qna

QnaRecord

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

integer

Identyfikator QnA odpowiadający monitowi.

QnaRecord

Rekord QnA.

Nazwa Typ Opis
activeLearningSuggestions

SuggestedQuestionsCluster[]

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

string

Tekst odpowiedzi.
dialog

QnaDialog

Kontekst pytań i odpowiedzi.
id

integer

Unikatowy identyfikator pytań i odpowiedzi.
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

Liczba sugerowanych automatycznie przez algorytm uczenia aktywnego.
question

string

Pytanie sugerowane przez funkcję Active Learning.
userSuggestedCount

integer

Liczba przypadków, gdy pytanie zostało sugerowane jawnie przez użytkownika.

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.

WordAlterations

Kolekcja zmian wyrazów.

Nazwa Typ Opis
alterations

string[]

Kolekcja zmian wyrazów.