Conversational Analysis Authoring - Create Project
Vytvoří nový projekt nebo aktualizuje existující projekt.
PATCH {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}?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. |
Text požadavku
Media Types: "application/merge-patch+json"
Name | Vyžadováno | Typ | Description |
---|---|---|---|
language | True |
string |
Jazyk projektu. Toto je reprezentace jazyka BCP-47. Například pro angličtinu použijte "en", "en-gb" pro angličtinu (UK), "es" pro španělštinu atd. |
projectKind | True |
Představuje druh projektu. |
|
projectName | True |
string |
Název nového projektu. |
description |
string |
Popis projektu. |
|
multilingual |
boolean |
Určuje, jestli se projekt bude používat pro více jazyků nebo ne. |
|
settings |
Nastavení projektu. |
Odpovědi
Name | Typ | Description |
---|---|---|
200 OK |
Metadata aktualizovaného projektu, pokud již existuje. |
|
201 Created |
Metadata vytvořeného projektu. |
|
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 Create Project
Ukázkový požadavek
PATCH {Endpoint}/language/authoring/analyze-conversations/projects/myproject?api-version=2023-04-01
{
"projectName": "myproject",
"language": "en",
"projectKind": "Conversation",
"description": "This is a sample conversation project.",
"multilingual": false
}
Ukázková odpověď
{
"createdDateTime": "2022-04-18T13:53:03Z",
"lastModifiedDateTime": "2022-04-18T13:53:03Z",
"projectKind": "Conversation",
"projectName": "myproject",
"multilingual": false,
"description": "This is a sample conversation project.",
"language": "en"
}
{
"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": "Conversation",
"projectName": "myproject",
"multilingual": false,
"description": "This is a sample conversation project.",
"language": "en"
}
Definice
Name | Description |
---|---|
Conversational |
Představuje možnosti použité k vytvoření nebo aktualizaci projektu. |
Conversational |
Představuje metadata projektu. |
Conversational |
Představuje nastavení sloužící k definování chování projektu. |
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. |
Project |
Představuje druh projektu. |
ConversationalAnalysisAuthoringCreateProjectOptions
Představuje možnosti použité k vytvoření nebo aktualizaci projektu.
Name | Typ | Description |
---|---|---|
description |
string |
Popis projektu. |
language |
string |
Jazyk projektu. Toto je reprezentace jazyka BCP-47. Například pro angličtinu použijte "en", "en-gb" pro angličtinu (UK), "es" pro španělštinu atd. |
multilingual |
boolean |
Určuje, jestli se projekt bude používat pro více jazyků nebo ne. |
projectKind |
Představuje druh projektu. |
|
projectName |
string |
Název nového projektu. |
settings |
Nastavení projektu. |
ConversationalAnalysisAuthoringProjectMetadata
Představuje metadata projektu.
Name | Typ | Description |
---|---|---|
createdDateTime |
string |
Představuje datum a čas vytvoření projektu. |
description |
string |
Popis projektu. |
language |
string |
Jazyk projektu. Toto je reprezentace jazyka BCP-47. Například pro angličtinu použijte "en", "en-gb" pro angličtinu (UK), "es" pro španělštinu atd. |
lastDeployedDateTime |
string |
Představuje datum a čas posledního nasazení projektu. |
lastModifiedDateTime |
string |
Představuje datum a čas vytvoření projektu. |
lastTrainedDateTime |
string |
Představuje datum a čas posledního trénovaného projektu. |
multilingual |
boolean |
Určuje, jestli se projekt bude používat pro více jazyků nebo ne. |
projectKind |
Představuje druh projektu. |
|
projectName |
string |
Název nového projektu. |
settings |
Nastavení projektu. |
ConversationalAnalysisAuthoringProjectSettings
Představuje nastavení sloužící k definování chování projektu.
Name | Typ | Description |
---|---|---|
confidenceThreshold |
number |
Prahová hodnota záměru s nejvyšší spolehlivostí, při které se předpověď automaticky změní na "Žádná". Prahová hodnota by měla být mezi 0 a 1 (včetně). |
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. |
ProjectKind
Představuje druh projektu.
Name | Typ | Description |
---|---|---|
Conversation |
string |
Projekt, který do aplikací, robotů a zařízení IoT zabuduje přirozený jazyk. |
Orchestration |
string |
Projekt pro propojení a orchestraci projektů Konverzace, Vlastní odpovídání na otázky a LUIS v jednom projektu. |