Conversational Analysis Authoring - List Deployment Resources
Listet die dem Projekt zugewiesenen Bereitstellungsressourcen auf.
GET {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/resources?api-version=2023-11-15-preview
GET {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/resources?top={top}&skip={skip}&maxpagesize={maxpagesize}&api-version=2023-11-15-preview
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
project
|
path | True |
string |
Der Name des zu verwendenden Projekts. |
api-version
|
query | True |
string |
Client-API-Version. |
maxpagesize
|
query |
integer int32 |
Die maximale Anzahl von Ressourcen, die in eine einzelne Antwort eingeschlossen werden sollen. |
|
skip
|
query |
integer int32 |
Ein Offset in der Auflistung der ersten zurückzugebenden Ressource. |
|
top
|
query |
integer int32 |
Die maximale Anzahl von Ressourcen, die aus der Auflistung zurückgegeben werden sollen. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Die zugewiesenen Bereitstellungsressourcen. |
|
Other Status Codes |
Fehlerantwort. |
Sicherheit
AADToken
Dies sind die Azure Active Directory OAuth2 Flows. Bei Kombination mit rollenbasierten Azure-Zugriff Steuern kann es verwendet werden, um den Zugriff auf Azure Maps-REST-APIs zu steuern. Azure-rollenbasierte Zugriffssteuerungen werden verwendet, um den Zugriff auf ein oder mehrere Azure Maps-Ressourcenkonten oder -Unterressourcen zu bestimmen. Jedem Benutzer, Gruppen- oder Dienstprinzipal kann über eine integrierte Rolle oder eine benutzerdefinierte Rolle, die aus einer oder mehreren Berechtigungen für Azure Maps-REST-APIs besteht, Zugriff gewährt werden.
Um Szenarien zu implementieren, empfehlen wir, Authentifizierungskonzepteanzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung für die Modellierung von Anwendungen über Objekte, die zugriffsfähig für bestimmte APIs und Bereiche sind.
Notizen
- Diese Sicherheitsdefinition erfordert die Verwendung des
x-ms-client-id
-Headers, um anzugeben, auf welche Azure Maps-Ressource die Anwendung Zugriff anfordert. Dies kann über die Karten-Verwaltungs-APIerworben werden.
Die Authorization URL
ist spezifisch für die Öffentliche Azure-Cloudinstanz. Souveräne Clouds verfügen über eindeutige Autorisierungs-URLs und Azure Active Directory-Konfigurationen.
* Die rollenbasierte Azure-Zugriffssteuerung wird über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs konfiguriert.
* Die Verwendung des Azure Maps Web SDK ermöglicht die konfigurationsbasierte Einrichtung einer Anwendung für mehrere Anwendungsfälle.
- Derzeit unterstützt Azure Active Directory v1.0 oder v2.0 Geschäfts-, Schul- und Gästekonten, unterstützt aber keine persönlichen Konten.
Typ:
oauth2
Ablauf:
implicit
Autorisierungs-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiche
Name | Beschreibung |
---|---|
https://cognitiveservices.azure.com/.default | https://cognitiveservices.azure.com/.default |
Ocp-Apim-Subscription-Key
Ein Abonnementschlüssel für eine Sprachdienstressource.
Typ:
apiKey
In:
header
Beispiele
Successful List Deployment Resources
Beispielanforderung
GET {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/resources?api-version=2023-11-15-preview
Beispiel für eine Antwort
{
"value": [
{
"azureResourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu",
"region": "westeurope"
},
{
"azureResourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestEus",
"region": "eastus"
}
],
"nextLink": null
}
Definitionen
Name | Beschreibung |
---|---|
Conversational |
Stellt die zugewiesene Bereitstellungsressource dar. |
Conversational |
Stellt die zugewiesenen Bereitstellungsressourcen dar. |
Error |
Das Fehlerobjekt. |
Error |
Lesbarer Fehlercode. |
Error |
Fehlerantwort. |
Inner |
Lesbarer Fehlercode. |
Inner |
Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. |
ConversationalAnalysisAuthoringAssignedDeploymentResource
Stellt die zugewiesene Bereitstellungsressource dar.
Name | Typ | Beschreibung |
---|---|---|
azureResourceId |
string |
Die Ressourcen-ID. |
region |
string |
Der Ressourcenbereich. |
ConversationalAnalysisAuthoringAssignedDeploymentResources
Stellt die zugewiesenen Bereitstellungsressourcen dar.
Name | Typ | Beschreibung |
---|---|---|
nextLink |
string |
Der Link zur nächsten Seite. |
value |
Die Liste der zugewiesenen Bereitstellungsressourcen. |
Error
Das Fehlerobjekt.
Name | Typ | Beschreibung |
---|---|---|
code |
Eine serverdefinierte Gruppe von Fehlercodes. |
|
details |
Error[] |
Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben. |
innererror |
Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler. |
|
message |
string |
Eine lesbare Darstellung des Fehlers. |
target |
string |
Das Ziel des Fehlers. |
ErrorCode
Lesbarer Fehlercode.
Name | Typ | Beschreibung |
---|---|---|
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
Fehlerantwort.
Name | Typ | Beschreibung |
---|---|---|
error |
Das Fehlerobjekt. |
InnerErrorCode
Lesbarer Fehlercode.
Name | Typ | Beschreibung |
---|---|---|
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
Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
Name | Typ | Beschreibung |
---|---|---|
code |
Eine serverdefinierte Gruppe von Fehlercodes. |
|
details |
object |
Fehlerdetails. |
innererror |
Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler. |
|
message |
string |
Fehlermeldung. |
target |
string |
Fehlerziel. |