Text Analysis Authoring - Create Project

Odwołanie

Usługa:: Cognitive Services - Language

Wersja interfejsu API:: 2023-04-01

Tworzy nowy projekt lub aktualizuje istniejący.

PATCH {Endpoint}/language/authoring/analyze-text/projects/{projectName}?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

Media Types: "application/merge-patch+json"

Nazwa	Wymagane	Typ	Opis
language	True	string	Język projektu. Jest to reprezentacja języka BCP-47. Na przykład użyj ciągu "en" dla języka angielskiego, "en-gb" dla języka angielskiego (Wielka Brytania), "es" dla języka hiszpańskiego itp.
projectKind	True	ProjectKind	Rodzaj projektu.
projectName	True	string	Nazwa nowego projektu.
storageInputContainerName	True	string	Nazwa kontenera magazynu.
description		string	Opis projektu.
multilingual		boolean	Czy projekt będzie używany w wielu językach, czy nie.
settings		TextAnalysisAuthoringProjectSettings	Ustawienia projektu.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	TextAnalysisAuthoringProjectMetadata	Metadane zaktualizowanego projektu, jeśli już istnieje.
201 Created	TextAnalysisAuthoringProjectMetadata	Metadane utworzonego projektu.
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 Create Project

Przykładowe żądanie

HTTP

PATCH {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements?api-version=2023-04-01

{
  "projectName": "LoanAgreements",
  "language": "en",
  "projectKind": "CustomEntityRecognition",
  "description": "This is a sample dataset provided by the Azure Language service team to help users get started with [Custom named entity recognition](https://aka.ms/ct-docs). The provided sample dataset contains 20 loan agreements drawn up between two entities.",
  "multilingual": false,
  "storageInputContainerName": "loanagreements"
}

Przykładowa odpowiedź

Kod stanu:: 201

{
  "createdDateTime": "2022-04-18T13:53:03Z",
  "lastModifiedDateTime": "2022-04-18T13:53:03Z",
  "projectKind": "CustomEntityRecognition",
  "storageInputContainerName": "loanagreements",
  "projectName": "LoanAgreements",
  "multilingual": false,
  "description": "This is a sample dataset provided by the Azure Language service team to help users get started with [Custom named entity recognition](https://aka.ms/ct-docs). The provided sample dataset contains 20 loan agreements drawn up between two entities.",
  "language": "en"
}

Kod stanu:: 200

{
  "createdDateTime": "2022-04-18T13:53:03Z",
  "lastModifiedDateTime": "2022-04-18T13:53:03Z",
  "lastTrainedDateTime": "2022-04-18T14:14:28Z",
  "lastDeployedDateTime": "2022-04-18T14:49:01Z",
  "projectKind": "CustomEntityRecognition",
  "storageInputContainerName": "loanagreements",
  "projectName": "LoanAgreements",
  "multilingual": false,
  "description": "This is a sample dataset provided by the Azure Language service team to help users get started with [Custom named entity recognition](https://aka.ms/ct-docs). The provided sample dataset contains 20 loan agreements drawn up between two entities.",
  "language": "en"
}

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.
ProjectKind	Rodzaj projektu.
TextAnalysisAuthoringCreateProjectOptions	Reprezentuje opcje używane do tworzenia lub aktualizowania projektu.
TextAnalysisAuthoringProjectMetadata	Reprezentuje metadane projektu.
TextAnalysisAuthoringProjectSettings	Reprezentuje ustawienia używane do definiowania zachowania projektu.

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.

ProjectKind

Rodzaj projektu.

Nazwa	Typ	Opis
CustomEntityRecognition	string	Tworzenie modelu wyodrębniania w celu zidentyfikowania kategorii domeny przy użyciu własnych danych.
CustomMultiLabelClassification	string	Tworzenie modelu klasyfikacji w celu klasyfikowania tekstu przy użyciu własnych danych. Każdy plik może mieć jedną lub wiele etykiet. Na przykład plik 1 jest klasyfikowany jako A, B i C, a plik 2 jest klasyfikowany jako B i C.
CustomSingleLabelClassification	string	Tworzenie modelu klasyfikacji w celu klasyfikowania tekstu przy użyciu własnych danych. Każdy plik będzie miał tylko jedną etykietę. Na przykład plik 1 jest klasyfikowany jako A, a plik 2 jest klasyfikowany jako B.