Conversational Analysis Authoring - Export
Hiermee wordt een taak geactiveerd om de gegevens van een project te exporteren.
POST {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/:export?stringIndexType=Utf16CodeUnit&api-version=2023-04-01
POST {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/:export?format={format}&stringIndexType=Utf16CodeUnit&assetKind={assetKind}&trainedModelLabel={trainedModelLabel}&api-version=2023-04-01
URI-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
Endpoint
|
path | True |
string |
Ondersteund Cognitive Services-eindpunt (bijvoorbeeld https://.api.cognitiveservices.azure.com). |
project
|
path | True |
string |
De naam van het project dat moet worden gebruikt. |
api-version
|
query | True |
string |
Client-API-versie. |
string
|
query | True |
Hiermee geeft u de methode op die wordt gebruikt voor het interpreteren van tekenreeks offsets. Zie voor meer informatie https://aka.ms/text-analytics-offsets. |
|
asset
|
query |
string |
Soort asset dat moet worden geëxporteerd. |
|
format
|
query |
De indeling van het geëxporteerde projectbestand dat moet worden gebruikt. |
||
trained
|
query |
string |
Getraind modellabel om te exporteren. Als trainedModelLabel null is, is het standaardgedrag om de huidige werkende kopie te exporteren. |
Antwoorden
Name | Type | Description |
---|---|---|
202 Accepted |
Een geslaagde aanroep resulteert in een Operation-Location-header die wordt gebruikt om de status van de taak te controleren. Kopteksten operation-location: string |
|
Other Status Codes |
Foutreactie. |
Beveiliging
AADToken
Dit zijn de Azure Active Directory OAuth2-stromen . Wanneer het is gekoppeld aan op rollen gebaseerd toegangsbeheer van Azure, kan het worden gebruikt om de toegang tot Azure Maps REST API's te beheren. Op rollen gebaseerd toegangsbeheer van Azure wordt gebruikt om toegang tot een of meer Azure Maps resourceaccount of subresources aan te wijzen. Elke gebruiker, groep of service-principal kan toegang krijgen via een ingebouwde rol of een aangepaste rol die bestaat uit een of meer machtigingen voor Azure Maps REST API's.
Voor het implementeren van scenario's raden we u aan verificatieconcepten te bekijken. Samengevat biedt deze beveiligingsdefinitie een oplossing voor het modelleren van toepassingen via objecten die toegangsbeheer kunnen hebben voor specifieke API's en bereiken.
Notities
- Voor deze beveiligingsdefinitie is het gebruik van de
x-ms-client-id
header vereist om aan te geven tot welke Azure Maps resource de toepassing toegang aanvraagt. Dit kan worden verkregen via de Kaarten-beheer-API.
De Authorization URL
is specifiek voor het azure-exemplaar van de openbare cloud. Onafhankelijke clouds hebben unieke autorisatie-URL's en Azure Active Directory-configuraties.
* Op rollen gebaseerd toegangsbeheer van Azure wordt geconfigureerd vanuit het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.
* Gebruik van de Azure Maps Web SDK maakt configuratie van een toepassing mogelijk voor meerdere gebruiksvoorbeelden.
- Momenteel ondersteunt Azure Active Directory v1.0 of v2.0 werk, school en gasten, maar geen persoonlijke accounts.
Type:
oauth2
Stroom:
implicit
Autorisatie-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiken
Name | Description |
---|---|
https://cognitiveservices.azure.com/.default | https://cognitiveservices.azure.com/.default |
Ocp-Apim-Subscription-Key
Een abonnementssleutel voor een taalserviceresource.
Type:
apiKey
In:
header
Voorbeelden
Successful Export Project
Voorbeeldaanvraag
POST {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/:export?stringIndexType=Utf16CodeUnit&api-version=2023-04-01
Voorbeeldrespons
operation-location: {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/export/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-01
Definities
Name | Description |
---|---|
Error |
Het foutobject. |
Error |
Door mensen leesbare foutcode. |
Error |
Foutreactie. |
Exported |
De indeling van het geëxporteerde projectbestand dat moet worden gebruikt. |
Inner |
Door mensen leesbare foutcode. |
Inner |
Een object met specifiekere informatie over de fout. Volgens de richtlijnen voor Microsoft One API: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. |
String |
Hiermee geeft u de methode op die wordt gebruikt voor het interpreteren van tekenreeks offsets. Zie voor meer informatie https://aka.ms/text-analytics-offsets. |
Error
Het foutobject.
Name | Type | Description |
---|---|---|
code |
Een van een door de server gedefinieerde set foutcodes. |
|
details |
Error[] |
Een matrix met details over specifieke fouten die tot deze gerapporteerde fout hebben geleid. |
innererror |
Een object met specifiekere informatie dan het huidige object over de fout. |
|
message |
string |
Een door mensen leesbare weergave van de fout. |
target |
string |
Het doel van de fout. |
ErrorCode
Door mensen leesbare foutcode.
Name | Type | 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
Foutreactie.
Name | Type | Description |
---|---|---|
error |
Het foutobject. |
ExportedProjectFormat
De indeling van het geëxporteerde projectbestand dat moet worden gebruikt.
Name | Type | Description |
---|---|---|
Conversation |
string |
Hiermee geeft u de indeling voor een gespreksproject op. |
Luis |
string |
Hiermee geeft u de indeling op voor een toepassing die is geëxporteerd uit LUIS. |
InnerErrorCode
Door mensen leesbare foutcode.
Name | Type | 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
Een object met specifiekere informatie over de fout. Volgens de richtlijnen voor Microsoft One API: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
Name | Type | Description |
---|---|---|
code |
Een van een door de server gedefinieerde set foutcodes. |
|
details |
object |
Foutdetails. |
innererror |
Een object met specifiekere informatie dan het huidige object over de fout. |
|
message |
string |
Foutbericht. |
target |
string |
Foutdoel. |
StringIndexType
Hiermee geeft u de methode op die wordt gebruikt voor het interpreteren van tekenreeks offsets. Zie voor meer informatie https://aka.ms/text-analytics-offsets.
Name | Type | Description |
---|---|---|
Utf16CodeUnit |
string |
De offset- en lengtewaarden komen overeen met UTF-16-code-eenheden. Gebruik deze optie als uw toepassing is geschreven in een taal die Unicode ondersteunt, bijvoorbeeld Java, JavaScript. |