Question Answering Projects - Create Project

Usługa:

Azure AI Services

Wersja interfejsu API:

2023-04-01

Tworzenie lub aktualizowanie projektu.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
Endpoint	path	True	string (uri)	Obsługiwany punkt końcowy usług Cognitive Services (np. https://< nazwa-zasobu.api.cognitiveservices.azure.com>).
projectName	path	True	string maxLength: 100 pattern: ^(?=[a-zA-Z0-9])[a-zA-Z0-9-]{0,98}[a-zA-Z0-9]$	Nazwa projektu.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

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	Zasób włączony dla wielu języków w projektach lub nie.
settings	ProjectSettings	Konfigurowalne ustawienia projektu.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	QuestionAnsweringProjectMetadata	Żądanie zakończyło się pomyślnie.
201 Created	QuestionAnsweringProjectMetadata	Żądanie zakończyło się pomyślnie i w rezultacie został utworzony nowy zasób.
Other Status Codes	ErrorResponse	Nieoczekiwana odpowiedź na błąd. Nagłówki x-ms-error-code: string

Zabezpieczenia

Ocp-Apim-Subscription-Key

Typ: apiKey
W: header

OAuth2Auth

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

Zakresy

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

Przykłady

Successful query

Przykładowe żądanie

HTTP

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

{
  "description": "proj1 is a test project.",
  "multilingualResource": true,
  "settings": {
    "defaultAnswer": "No good match found for your question in the Knowledgebase."
  },
  "language": "en"
}

Przykładowa odpowiedź

Kod stanu:

200

{
  "description": "proj1 is a test project.",
  "createdDateTime": "2021-05-01T15:13:22Z",
  "lastDeployedDateTime": "2021-05-01T15:13:22Z",
  "lastModifiedDateTime": "2021-05-01T15:13:22Z",
  "multilingualResource": true,
  "projectName": "proj1",
  "settings": {
    "defaultAnswer": "No good match found for your question in the Knowledgebase."
  },
  "language": "en"
}

Kod stanu:

201

{
  "description": "proj1 is a test project.",
  "createdDateTime": "2021-05-01T15:13:22Z",
  "lastDeployedDateTime": "2021-05-01T15:13:22Z",
  "lastModifiedDateTime": "2021-05-01T15:13:22Z",
  "multilingualResource": true,
  "projectName": "proj1",
  "settings": {
    "defaultAnswer": "No good match found for your question in the Knowledgebase."
  },
  "language": "en"
}

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.
ProjectSettings	Konfigurowalne ustawienia projektu.
QuestionAnsweringProjectMetadata	Reprezentuje projekt.
QuestionAnsweringProjectMetadataCreateOrUpdate	Reprezentuje projekt.

Error

Objekt

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

Wyliczanie

Kod błędu czytelny dla człowieka.

Wartość	Opis
InvalidRequest	Błąd nieprawidłowego żądania
InvalidArgument	Błąd nieprawidłowego argumentu
Unauthorized	Błąd nieautoryzowanego dostępu
Forbidden	Błąd dostępu zabronionego
NotFound	Nie znaleziono błędu
ProjectNotFound	Błąd nie znaleziono projektu
OperationNotFound	Błąd nie znaleziono operacji
AzureCognitiveSearchNotFound	Nie znaleziono błędu usługi Azure Cognitive Search
AzureCognitiveSearchIndexNotFound	Nie znaleziono błędu indeksu usługi Azure Cognitive Search
TooManyRequests	Błąd zbyt wielu żądań
AzureCognitiveSearchThrottling	Błąd ograniczania usługi Azure Cognitive Search
AzureCognitiveSearchIndexLimitReached	Błąd osiągnięto limit indeksu usługi Azure Cognitive Search
InternalServerError	Wewnętrzny błąd serwera.
ServiceUnavailable	Błąd niedostępności usługi
Timeout	Błąd przekroczenia limitu czasu
QuotaExceeded	Błąd przekroczenia limitu przydziału
Conflict	Błąd konfliktu
Warning	Błąd ostrzeżenia

ErrorResponse

Objekt

Odpowiedź na błąd.

Nazwa	Typ	Opis
error	Error	Obiekt błędu.

InnerErrorCode

Wyliczanie

Kod błędu czytelny dla człowieka.

Wartość	Opis
InvalidRequest	Błąd nieprawidłowego żądania
InvalidParameterValue	Błąd nieprawidłowej wartości parametru
KnowledgeBaseNotFound	Nie znaleziono błędu bazy wiedzy
AzureCognitiveSearchNotFound	Nie znaleziono błędu usługi Azure Cognitive Search
AzureCognitiveSearchThrottling	Błąd ograniczania usługi Azure Cognitive Search
ExtractionFailure	Błąd wyodrębniania
InvalidRequestBodyFormat	Błąd nieprawidłowego formatu treści żądania
EmptyRequest	Błąd pustego żądania
MissingInputDocuments	Błąd brakujących dokumentów wejściowych
InvalidDocument	Błąd nieprawidłowego dokumentu
ModelVersionIncorrect	Błąd nieprawidłowej wersji modelu
InvalidDocumentBatch	Błąd wsadowy nieprawidłowego dokumentu
UnsupportedLanguageCode	Nieobsługiwany błąd kodu języka
InvalidCountryHint	Błąd nieprawidłowej wskazówki dotyczącej kraju

InnerErrorModel

Objekt

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.

ProjectSettings

Objekt

Konfigurowalne ustawienia projektu.

Nazwa	Typ	Opis
defaultAnswer	string	Domyślna odpowiedź, gdy w bazie wiedzy nie znaleziono dobrego dopasowania.

QuestionAnsweringProjectMetadata

Objekt

Reprezentuje projekt.

Nazwa	Typ	Opis
createdDateTime	string (date-time)	Data i godzina utworzenia projektu.
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.
lastDeployedDateTime	string (date-time)	Reprezentuje datę ostatniego wdrożenia projektu.
lastModifiedDateTime	string (date-time)	Reprezentuje projekt ostatniej modyfikacji daty i godziny.
multilingualResource	boolean	Zasób włączony dla wielu języków w projektach lub nie.
projectName	string maxLength: 100 pattern: ^(?=[a-zA-Z0-9])[a-zA-Z0-9-]{0,98}[a-zA-Z0-9]$	Nazwa projektu.
settings	ProjectSettings	Konfigurowalne ustawienia projektu.

QuestionAnsweringProjectMetadataCreateOrUpdate

Objekt

Reprezentuje projekt.

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	Zasób włączony dla wielu języków w projektach lub nie.
settings	ProjectSettings	Konfigurowalne ustawienia projektu.