Text Analysis Authoring - Get Project
Pobiera szczegóły projektu.
GET {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). |
project
|
path | True |
string |
Nazwa projektu do użycia. |
api-version
|
query | True |
string |
Wersja interfejsu API klienta. |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
Metadane projektu. |
|
Other Status Codes |
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łówka
x-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 Get Project
Przykładowe żądanie
GET {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements?api-version=2023-04-01
Przykładowa odpowiedź
{
"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 błędu. |
Error |
Kod błędu czytelny dla człowieka. |
Error |
Odpowiedź na błąd. |
Inner |
Kod błędu czytelny dla człowieka. |
Inner |
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. |
Project |
Rodzaj projektu. |
Text |
Reprezentuje metadane projektu. |
Text |
Reprezentuje ustawienia używane do definiowania zachowania projektu. |
Error
Obiekt błędu.
Nazwa | Typ | Opis |
---|---|---|
code |
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 |
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 |
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 interfejsu API usługi Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
Nazwa | Typ | Opis |
---|---|---|
code |
Jeden z zdefiniowanych przez serwer zestaw kodów błędów. |
|
details |
object |
Szczegóły błędu. |
innererror |
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 |
W celu utworzenia modelu wyodrębniania w celu zidentyfikowania kategorii domen przy użyciu własnych danych. |
CustomMultiLabelClassification |
string |
Aby utworzyć model klasyfikacji do 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 |
Aby utworzyć model klasyfikacji do 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. |
TextAnalysisAuthoringProjectMetadata
Reprezentuje metadane projektu.
Nazwa | Typ | Opis |
---|---|---|
createdDateTime |
string |
Reprezentuje datę/godzinę utworzenia projektu. |
description |
string |
Opis projektu. |
language |
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. |
lastDeployedDateTime |
string |
Reprezentuje projekt data/godzina ostatniego wdrożenia. |
lastModifiedDateTime |
string |
Reprezentuje projekt ostatniej modyfikacji daty/godziny. |
lastTrainedDateTime |
string |
Reprezentuje projekt data/godzina ostatniego trenowania. |
multilingual |
boolean |
Czy projekt będzie używany w wielu językach, czy nie. |
projectKind |
Rodzaj projektu. |
|
projectName |
string |
Nowa nazwa projektu. |
settings |
Ustawienia projektu. |
|
storageInputContainerName |
string |
Nazwa kontenera magazynu. |
TextAnalysisAuthoringProjectSettings
Reprezentuje ustawienia używane do definiowania zachowania projektu.
Nazwa | Typ | Opis |
---|---|---|
confidenceThreshold |
number |
Próg klasy z najwyższą ufnością, przy którym przewidywanie zostanie automatycznie zmienione na "Brak". Wartość progu powinna należeć do przedziału od 0 do 1 włącznie. |