Conversational Analysis Authoring - Train
Aktivuje trénovací úlohu pro projekt.
POST {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/:train?api-version=2023-04-01
Parametry identifikátoru URI
Name | V | Vyžadováno | Typ | Description |
---|---|---|---|---|
Endpoint
|
path | True |
string |
Podporovaný koncový bod služeb Cognitive Services (např. https://.api.cognitiveservices.azure.com). |
project
|
path | True |
string |
Název projektu, který se má použít. |
api-version
|
query | True |
string |
Verze klientského rozhraní API |
Text požadavku
Name | Vyžadováno | Typ | Description |
---|---|---|---|
modelLabel | True |
string |
Představuje popisek výstupního modelu. |
trainingMode | True |
Představuje režim trénovací operace. |
|
evaluationOptions |
Představuje možnosti vyhodnocení. Ve výchozím nastavení je druh vyhodnocení procento, s procentem trénování jako 80 a testovacím rozdělením jako 20. |
||
trainingConfigVersion |
string |
Představuje verzi trénovací konfigurace. Ve výchozím nastavení se používá hodnota "nejnovější", která používá nejnovější vydanou verzi trénovací konfigurace. |
Odpovědi
Name | Typ | Description |
---|---|---|
202 Accepted |
Výsledky úspěšného volání s hlavičkou Operation-Location, která slouží ke kontrole stavu úlohy. Headers operation-location: string |
|
Other Status Codes |
Odpověď na chybu. |
Zabezpečení
AADToken
Toto jsou toky Azure Active Directory OAuth2 . Při spárování s řízením přístupu na základě role v Azure se dá použít k řízení přístupu k Azure Maps rozhraní REST API. Řízení přístupu na základě role v Azure slouží k určení přístupu k jednomu nebo několika Azure Maps účtu prostředku nebo dílčím prostředkům. Každému uživateli, skupině nebo instančnímu objektu je možné udělit přístup prostřednictvím předdefinované role nebo vlastní role, která se skládá z jednoho nebo více oprávnění k Azure Maps rozhraní REST API.
Pokud chcete implementovat scénáře, doporučujeme zobrazit si koncepty ověřování. Souhrnně řečeno, tato definice zabezpečení poskytuje řešení pro modelování aplikací prostřednictvím objektů schopných řízení přístupu k určitým rozhraním API a oborům.
Poznámky
- Tato definice zabezpečení vyžaduje použití hlavičky
x-ms-client-id
k označení Azure Maps prostředku, ke kterému aplikace žádá o přístup. To je možné získat z rozhraní API pro správu map.
Je Authorization URL
specifický pro instanci veřejného cloudu Azure. Suverénní cloudy mají jedinečné autorizační adresy URL a konfigurace Azure Active Directory.
* Řízení přístupu na základě role v Azure se konfiguruje z roviny správy Azure prostřednictvím Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.
* Použití sady Azure Maps Web SDK umožňuje nastavení aplikace na základě konfigurace pro více případů použití.
- Azure Active Directory verze 1.0 nebo v2.0 v současné době podporuje pracovní, školní a hosta, ale nepodporuje osobní účty.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
https://cognitiveservices.azure.com/.default | https://cognitiveservices.azure.com/.default |
Ocp-Apim-Subscription-Key
Klíč předplatného pro prostředek služby language.
Type:
apiKey
In:
header
Příklady
Successful Train Project
Sample Request
POST {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/:train?api-version=2023-04-01
{
"modelLabel": "model1",
"trainingMode": "standard",
"trainingConfigVersion": "latest",
"evaluationOptions": {
"kind": "percentage",
"testingSplitPercentage": 20,
"trainingSplitPercentage": 80
}
}
Sample Response
operation-location: {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/train/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-01
Definice
Name | Description |
---|---|
Conversational |
Představuje možnosti použité při vyhodnocování. |
Conversational |
Představuje možnosti pro spuštění nové úlohy trénování. |
Error |
Objekt chyby. |
Error |
Kód chyby čitelný pro člověka. |
Error |
Odpověď na chybu. |
Evaluation |
Představuje druh vyhodnocení. Ve výchozím nastavení je druh vyhodnocení nastavený na procento. |
Inner |
Kód chyby čitelný pro člověka. |
Inner |
Objekt obsahující konkrétnější informace o chybě. Podle pokynů k rozhraní Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. |
Training |
Představuje režim trénovací operace. |
ConversationalAnalysisAuthoringEvaluationOptions
Představuje možnosti použité při vyhodnocování.
Name | Typ | Description |
---|---|---|
kind |
Představuje druh vyhodnocení. Ve výchozím nastavení je druh vyhodnocení nastavený na procento. |
|
testingSplitPercentage |
integer |
Představuje procento rozdělení testovací datové sady. Pouze v případě, že druh hodnocení je procento. |
trainingSplitPercentage |
integer |
Představuje procento rozdělení trénovací datové sady. Pouze v případě, že druh hodnocení je procento. |
ConversationalAnalysisAuthoringTrainingJobOptions
Představuje možnosti pro spuštění nové úlohy trénování.
Name | Typ | Description |
---|---|---|
evaluationOptions |
Představuje možnosti vyhodnocení. Ve výchozím nastavení je druh vyhodnocení procento, s procentem trénování jako 80 a testovacím rozdělením jako 20. |
|
modelLabel |
string |
Představuje popisek výstupního modelu. |
trainingConfigVersion |
string |
Představuje verzi trénovací konfigurace. Ve výchozím nastavení se používá hodnota "nejnovější", která používá nejnovější vydanou verzi trénovací konfigurace. |
trainingMode |
Představuje režim trénovací operace. |
Error
Objekt chyby.
Name | Typ | Description |
---|---|---|
code |
Jeden ze serverem definované sady kódů chyb. |
|
details |
Error[] |
Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě. |
innererror |
Objekt obsahující konkrétnější informace o chybě než aktuální objekt. |
|
message |
string |
Lidsky čitelná reprezentace chyby. |
target |
string |
Cíl chyby. |
ErrorCode
Kód chyby čitelný pro člověka.
Name | Typ | Description |
---|---|---|
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
Odpověď na chybu.
Name | Typ | Description |
---|---|---|
error |
Objekt chyby. |
EvaluationKind
Představuje druh vyhodnocení. Ve výchozím nastavení je druh vyhodnocení nastavený na procento.
Name | Typ | Description |
---|---|---|
manual |
string |
Rozdělte data podle zvolené datové sady pro každý příklad v datech. |
percentage |
string |
Rozdělte data do trénovacích a testovacích sad podle procent definovaných uživatelem. |
InnerErrorCode
Kód chyby čitelný pro člověka.
Name | Typ | Description |
---|---|---|
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
Objekt obsahující konkrétnější informace o chybě. Podle pokynů k rozhraní Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
Name | Typ | Description |
---|---|---|
code |
Jeden ze serverem definované sady kódů chyb. |
|
details |
object |
Podrobnosti o chybě. |
innererror |
Objekt obsahující konkrétnější informace o chybě než aktuální objekt. |
|
message |
string |
Chybová zpráva. |
target |
string |
Cíl chyby. |
TrainingMode
Představuje režim trénovací operace.
Name | Typ | Description |
---|---|---|
advanced |
string |
Trénuje pomocí jemně vyladěných modelů transformátorů neurální sítě. Může trénovat vícejazyčné projekty. |
standard |
string |
Rychlejší trénování pro rychlejší iterace |