Text Analysis Authoring - Swap Deployments
Vertauscht zwei vorhandene Bereitstellungen miteinander.
POST {Endpoint}/language/authoring/analyze-text/projects/{projectName}/deployments/:swap?api-version=2023-04-01
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
Endpoint
|
path | True |
string url |
Unterstützter Cognitive Services-Endpunkt (z. B. https://.api.cognitiveservices.azure.com). |
project
|
path | True |
string |
Der Name des zu verwendenden Projekts. |
api-version
|
query | True |
string |
Die API-Version, die für diesen Vorgang verwendet werden soll. |
Anforderungstext
Name | Erforderlich | Typ | Beschreibung |
---|---|---|---|
firstDeploymentName | True |
string |
Stellt den ersten Bereitstellungsnamen dar. |
secondDeploymentName | True |
string |
Stellt den zweiten Bereitstellungsnamen dar. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
202 Accepted |
Die Anforderung wurde zur Verarbeitung akzeptiert, die Verarbeitung wurde jedoch noch nicht abgeschlossen. Header Operation-Location: string |
|
Other Status Codes |
Unerwartete Fehlerantwort. |
Sicherheit
Ocp-Apim-Subscription-Key
Typ:
apiKey
In:
header
OAuth2Auth
Typ:
oauth2
Ablauf:
accessCode
Autorisierungs-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Token-URL:
https://login.microsoftonline.com/common/oauth2/token
Bereiche
Name | Beschreibung |
---|---|
https://cognitiveservices.azure.com/.default |
Beispiele
SuccessfulSwapDeployments
Beispielanforderung
POST {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/deployments/:swap?api-version=2023-04-01
{
"firstDeploymentName": "production",
"secondDeploymentName": "staging"
}
Beispiel für eine Antwort
operation-location: {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/deployments/swap/jobs/c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000?api-version=2023-04-01
Definitionen
Name | Beschreibung |
---|---|
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. |
Swap |
Stellt die Optionen zum Austauschen von zwei Bereitstellungen dar. |
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. |
SwapDeploymentsOptions
Stellt die Optionen zum Austauschen von zwei Bereitstellungen dar.
Name | Typ | Beschreibung |
---|---|---|
firstDeploymentName |
string |
Stellt den ersten Bereitstellungsnamen dar. |
secondDeploymentName |
string |
Stellt den zweiten Bereitstellungsnamen dar. |