Conversational Analysis Authoring - List Trained Models
Seznamy natrénované modely, které patří do projektu.
GET {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/models?api-version=2023-04-01
GET {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/models?top={top}&skip={skip}&maxpagesize={maxpagesize}&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 rozhraní API klienta. |
maxpagesize
|
query |
integer int32 |
Maximální počet prostředků, které se mají zahrnout do jedné odpovědi. |
|
skip
|
query |
integer int32 |
Posun kolekce prvního prostředku, který se má vrátit. |
|
top
|
query |
integer int32 |
Maximální počet prostředků, které se mají vrátit z kolekce. |
Odpovědi
Name | Typ | Description |
---|---|---|
200 OK |
Seznam všech natrénovaných modelů |
|
Other Status Codes |
Chybová odpověď. |
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 složené 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 pro konkrétní rozhraní API a obory.
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. Můžete ho získat z rozhraní MAPS MANAGEMENT API.
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 2.0 v současné době podporuje pracovní, školní a hosta, ale nepodporuje osobní účty.
Typ:
oauth2
Tok:
implicit
URL autorizace:
https://login.microsoftonline.com/common/oauth2/authorize
Rozsahy
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 jazyka.
Typ:
apiKey
V:
header
Příklady
Successful List Models
Ukázkový požadavek
GET {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/models?api-version=2023-04-01
Ukázková odpověď
{
"value": [
{
"label": "model1",
"modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94",
"lastTrainedDateTime": "2022-04-18T15:47:49Z",
"lastTrainingDurationInSeconds": 186,
"modelExpirationDate": "2022-10-28",
"modelTrainingConfigVersion": "2022-05-01",
"hasSnapshot": true
},
{
"label": "model2",
"modelId": "model2-20220418T052522-c63bd244dd9e4bf8adec1a7129968c99",
"lastTrainedDateTime": "2022-04-18T17:25:22Z",
"lastTrainingDurationInSeconds": 192,
"modelExpirationDate": "2022-10-28",
"modelTrainingConfigVersion": "2022-05-01",
"hasSnapshot": true
}
],
"nextLink": null
}
Definice
Name | Description |
---|---|
Conversational |
Představuje vytrénovaný model. |
Conversational |
Představuje seznam načtených natrénovaných modelů. |
Error |
Objekt chyby. |
Error |
Kód chyby čitelný pro člověka. |
Error |
Chybová odpověď. |
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. |
ConversationalAnalysisAuthoringProjectTrainedModel
Představuje vytrénovaný model.
Name | Typ | Description |
---|---|---|
hasSnapshot |
boolean |
Příznak, který označuje, jestli má natrénovaný model připravený snímek. |
label |
string |
Popisek natrénovaného modelu |
lastTrainedDateTime |
string |
Datum posledního trénování modelu. |
lastTrainingDurationInSeconds |
integer |
Doba trvání poslední žádosti o trénování modelu v sekundách. |
modelExpirationDate |
string |
Datum vypršení platnosti modelu. |
modelId |
string |
ID modelu. |
modelTrainingConfigVersion |
string |
Verze konfigurace trénování modelu. |
ConversationalAnalysisAuthoringProjectTrainedModels
Představuje seznam načtených natrénovaných modelů.
Name | Typ | Description |
---|---|---|
nextLink |
string |
Odkaz na další stránku |
value |
Seznam načtených úloh. |
Error
Objekt chyby.
Name | Typ | Description |
---|---|---|
code |
Jeden ze serverem definovaných chybových kódů. |
|
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
Chybová odpověď.
Name | Typ | Description |
---|---|---|
error |
Objekt chyby. |
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ých chybových kódů. |
|
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. |