Conversational Analysis Authoring - List Projects
Listák a meglévő projekteket.
GET {Endpoint}/language/authoring/analyze-conversations/projects?api-version=2023-04-01
GET {Endpoint}/language/authoring/analyze-conversations/projects?top={top}&skip={skip}&maxpagesize={maxpagesize}&api-version=2023-04-01
URI-paraméterek
Name | In | Kötelező | Típus | Description |
---|---|---|---|---|
Endpoint
|
path | True |
string |
Támogatott Cognitive Services-végpont (pl. https://.api.cognitiveservices.azure.com). |
api-version
|
query | True |
string |
Ügyfél API-verziója. |
maxpagesize
|
query |
integer int32 |
Az egyetlen válaszba belefoglalandó erőforrások maximális száma. |
|
skip
|
query |
integer int32 |
Az első visszaadandó erőforrás gyűjteményének eltolása. |
|
top
|
query |
integer int32 |
A gyűjteményből visszatérni kívánt erőforrások maximális száma. |
Válaszok
Name | Típus | Description |
---|---|---|
200 OK |
A projektek metaadatai. |
|
Other Status Codes |
Hibaválasz. |
Biztonság
AADToken
Ezek az Azure Active Directory OAuth2-folyamatok . Az Azure-beli szerepköralapú hozzáférés-vezérléssel párosítva szabályozható a Azure Maps REST API-khoz való hozzáférés. Az Azure szerepköralapú hozzáférés-vezérlői egy vagy több Azure Maps erőforrásfiókhoz vagy alerőforrásokhoz való hozzáférés kijelölésére szolgálnak. Bármely felhasználó, csoport vagy szolgáltatásnév hozzáférést kaphat egy beépített szerepkörrel vagy egy vagy több, a REST API-khoz Azure Maps engedélyekkel rendelkező egyéni szerepkörrel.
A forgatókönyvek implementálásához javasoljuk, hogy tekintse meg a hitelesítési fogalmakat. Összefoglalva, ez a biztonsági definíció megoldást nyújt az alkalmazások modellezésére olyan objektumokon keresztül, amelyek hozzáférés-vezérlésre képesek adott API-kon és hatókörökön.
Jegyzetek
- Ez a biztonsági definíció a fejléc használatával
x-ms-client-id
jelzi, hogy az alkalmazás melyik Azure Maps erőforráshoz kér hozzáférést. Ez a Térképek felügyeleti API-ból szerezhető be.
Ez Authorization URL
az Azure nyilvános felhőpéldányára jellemző. A szuverén felhők egyedi engedélyezési URL-címekkel és Azure Active Directory-konfigurációkkal rendelkeznek.
* Az Azure szerepköralapú hozzáférés-vezérlés az Azure felügyeleti síkjáról van konfigurálva Azure Portal, PowerShell, CLI, Azure SDK-k vagy REST API-k használatával.
* A Azure Maps Web SDK használata lehetővé teszi egy alkalmazás konfigurációalapú beállítását több használati esetben.
- Jelenleg az Azure Active Directory 1.0-s vagy 2.0-s verziója támogatja a Munkahelyi, iskolai és vendégfelhasználói verziót, de nem támogatja a személyes fiókokat.
Típus:
oauth2
Folyamat:
implicit
Engedélyezési URL:
https://login.microsoftonline.com/common/oauth2/authorize
Hatókörök
Name | Description |
---|---|
https://cognitiveservices.azure.com/.default | https://cognitiveservices.azure.com/.default |
Ocp-Apim-Subscription-Key
Egy language service-erőforrás előfizetési kulcsa.
Típus:
apiKey
In:
header
Példák
Successful List Projects
Mintakérelem
GET {Endpoint}/language/authoring/analyze-conversations/projects?api-version=2023-04-01
Mintaválasz
{
"value": [
{
"createdDateTime": "2022-04-18T14:03:16Z",
"lastModifiedDateTime": "2022-04-18T14:03:16Z",
"projectKind": "Conversation",
"projectName": "myproject1",
"multilingual": false,
"description": "This is a sample conversation project.",
"language": "en"
},
{
"createdDateTime": "2022-04-18T14:03:12Z",
"lastModifiedDateTime": "2022-04-18T14:03:12Z",
"projectKind": "Conversation",
"projectName": "myproject",
"multilingual": false,
"description": "This is a sample conversation project.",
"language": "en"
}
],
"nextLink": null
}
Definíciók
Name | Description |
---|---|
Conversational |
Egy projekt metaadatait jelöli. |
Conversational |
A projekt viselkedésének meghatározásához használt beállításokat jelöli. |
Conversational |
A beolvasott projektek metaadatainak listáját jelöli. |
Error |
A hibaobjektum. |
Error |
Emberi olvasásra alkalmas hibakód. |
Error |
Hibaválasz. |
Inner |
Emberi olvasásra alkalmas hibakód. |
Inner |
Egy objektum, amely részletesebb információkat tartalmaz a hibáról. A Microsoft One API irányelvei szerint – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. |
Project |
A projekttípust jelöli. |
ConversationalAnalysisAuthoringProjectMetadata
Egy projekt metaadatait jelöli.
Name | Típus | Description |
---|---|---|
createdDateTime |
string |
A projekt létrehozásának dátumidejét jelöli. |
description |
string |
A projekt leírása. |
language |
string |
A projekt nyelve. Ez egy nyelv BCP-47-es reprezentációja. Használja például az "en" szót angolra, az "en-gb" szót angolra (UK), "es" spanyolra stb. |
lastDeployedDateTime |
string |
A projekt utolsó üzembe helyezett dátumidejét jelöli. |
lastModifiedDateTime |
string |
A projekt létrehozásának dátumidejét jelöli. |
lastTrainedDateTime |
string |
A projekt utolsó betanított dátumidejét jelöli. |
multilingual |
boolean |
Azt jelzi, hogy a projekt több nyelvhez is használható-e. |
projectKind |
A projekttípust jelöli. |
|
projectName |
string |
Az új projekt neve. |
settings |
A projekt beállításai. |
ConversationalAnalysisAuthoringProjectSettings
A projekt viselkedésének meghatározásához használt beállításokat jelöli.
Name | Típus | Description |
---|---|---|
confidenceThreshold |
number |
A legnagyobb megbízhatósággal rendelkező szándék küszöbértéke, amelynél az előrejelzés automatikusan "Nincs" értékre változik. A küszöbérték értéke 0 és 1 közötti lehet. |
ConversationalAnalysisAuthoringProjectsMetadata
A beolvasott projektek metaadatainak listáját jelöli.
Name | Típus | Description |
---|---|---|
nextLink |
string |
A következő oldal hivatkozása. |
value |
A projektek listája. |
Error
A hibaobjektum.
Name | Típus | Description |
---|---|---|
code |
A kiszolgáló által definiált hibakódok egyike. |
|
details |
Error[] |
A jelentett hibához vezető konkrét hibák részleteinek tömbje. |
innererror |
Egy objektum, amely az aktuális objektumnál pontosabb információkat tartalmaz a hibáról. |
|
message |
string |
A hiba emberi olvasásra alkalmas ábrázolása. |
target |
string |
A hiba célja. |
ErrorCode
Emberi olvasásra alkalmas hibakód.
Name | Típus | 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
Hibaválasz.
Name | Típus | Description |
---|---|---|
error |
A hibaobjektum. |
InnerErrorCode
Emberi olvasásra alkalmas hibakód.
Name | Típus | 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
Egy objektum, amely részletesebb információkat tartalmaz a hibáról. A Microsoft One API irányelvei szerint – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
Name | Típus | Description |
---|---|---|
code |
A kiszolgáló által definiált hibakódok egyike. |
|
details |
object |
Hiba részletei. |
innererror |
Egy objektum, amely az aktuális objektumnál pontosabb információkat tartalmaz a hibáról. |
|
message |
string |
Hibaüzenet. |
target |
string |
Hibacél. |
ProjectKind
A projekttípust jelöli.
Name | Típus | Description |
---|---|---|
Conversation |
string |
Egy projekt, amely természetes nyelvet fejleszt alkalmazásokba, robotokba és IoT-eszközökbe. |
Orchestration |
string |
Egy projekt, amely egyetlen projektben csatlakoztatja és vezényeli a beszélgetéseket, az egyéni kérdések megválaszolását és a LUIS-projekteket. |