Text Analysis Authoring - Train
Wyzwala zadanie szkoleniowe dla projektu.
POST {Endpoint}/language/authoring/analyze-text/projects/{projectName}/:train?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. |
Treść żądania
Nazwa | Wymagane | Typ | Opis |
---|---|---|---|
modelLabel | True |
string |
Reprezentuje etykietę modelu wyjściowego. |
trainingConfigVersion | True |
string |
Reprezentuje wersję konfiguracji trenowania. |
evaluationOptions |
Reprezentuje opcje oceny. Domyślnie rodzaj oceny to wartość procentowa, z wartością procentową podziału trenowania jako 80, a wartość procentowa podziału testowania to 20. |
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 |
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 Train Project
Przykładowe żądanie
POST {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/:train?api-version=2023-04-01
{
"modelLabel": "model1",
"trainingConfigVersion": "latest",
"evaluationOptions": {
"kind": "percentage",
"testingSplitPercentage": 20,
"trainingSplitPercentage": 80
}
}
Przykładowa odpowiedź
operation-location: {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/train/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-01
Definicje
Nazwa | Opis |
---|---|
Error |
Obiekt error. |
Error |
Kod błędu czytelny dla człowieka. |
Error |
Odpowiedź na błąd. |
Evaluation |
Reprezentuje rodzaj oceny. Domyślnie typ oceny jest ustawiony na wartość procentową. |
Inner |
Kod błędu czytelny dla człowieka. |
Inner |
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. |
Text |
Reprezentuje opcje używane do uruchamiania oceny. |
Text |
Reprezentuje opcje uruchamiania nowego zadania szkoleniowego. |
Error
Obiekt error.
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 error. |
EvaluationKind
Reprezentuje rodzaj oceny. Domyślnie typ oceny jest ustawiony na wartość procentową.
Nazwa | Typ | Opis |
---|---|---|
manual |
string |
Podziel dane zgodnie z wybranym zestawem danych dla każdego przykładu w danych. |
percentage |
string |
Podziel dane na zestawy treningowe i testowe zgodnie z wartościami procentowymi zdefiniowanymi przez użytkownika. |
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 |
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. |
TextAnalysisAuthoringEvaluationOptions
Reprezentuje opcje używane do uruchamiania oceny.
Nazwa | Typ | Opis |
---|---|---|
kind |
Reprezentuje rodzaj oceny. Domyślnie typ oceny jest ustawiony na wartość procentową. |
|
testingSplitPercentage |
integer |
Reprezentuje procent podziału zestawu danych testowych. Wymagany tylko w przypadku, gdy rodzaj oceny jest wartością procentową. |
trainingSplitPercentage |
integer |
Reprezentuje procent podziału zestawu danych trenowania. Wymagany tylko w przypadku, gdy rodzaj oceny jest wartością procentową. |
TextAnalysisAuthoringTrainingJobOptions
Reprezentuje opcje uruchamiania nowego zadania szkoleniowego.
Nazwa | Typ | Opis |
---|---|---|
evaluationOptions |
Reprezentuje opcje oceny. Domyślnie rodzaj oceny to wartość procentowa, z wartością procentową podziału trenowania jako 80, a wartość procentowa podziału testowania to 20. |
|
modelLabel |
string |
Reprezentuje etykietę modelu wyjściowego. |
trainingConfigVersion |
string |
Reprezentuje wersję konfiguracji trenowania. |