Conversational Analysis Authoring - Import
Löst einen Auftrag zum Importieren eines Projekts aus. Wenn bereits ein Projekt mit demselben Namen existiert, werden die Daten dieses Projekts ersetzt.
POST {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/:import?api-version=2023-04-01
POST {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/:import?format={format}&api-version=2023-04-01
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
Endpoint
|
path | True |
string |
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 |
Client-API-Version. |
format
|
query |
Das Format der zu verwendenden exportierten Projektdatei. |
Anforderungstext
Name | Erforderlich | Typ | Beschreibung |
---|---|---|---|
metadata | True |
Stellt die Projektmetadaten dar. |
|
projectFileVersion | True |
string |
Die Version der exportierten Datei. |
stringIndexType | True |
Gibt die Methode an, die zum Interpretieren von Zeichenfolgenoffsets verwendet wird. Weitere Informationen finden Sie unter https://aka.ms/text-analytics-offsets. |
|
assets | ConversationalAnalysisAuthoringExportedProjectAssets: |
Stellt die Projektressourcen dar. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
202 Accepted |
Ein erfolgreicher Aufruf enthält einen Operation-Location-Header, mit dem der Auftragsstatus überprüft wird. Headers operation-location: string |
|
Other Status Codes |
Fehlerantwort. |
Sicherheit
AADToken
Dies sind die Azure Active Directory OAuth2 Flows. Wenn sie mit der rollenbasierten Zugriffssteuerung in Azure gekoppelt ist, kann sie verwendet werden, um den Zugriff auf Azure Maps REST-APIs zu steuern. Rollenbasierte Zugriffssteuerungen in Azure werden verwendet, um den Zugriff auf ein oder mehrere Azure Maps Ressourcenkonto oder Unterressourcen festzulegen. Jedem Benutzer, jeder Gruppe oder jedem Dienstprinzipal kann Zugriff über eine integrierte Rolle oder eine benutzerdefinierte Rolle gewährt werden, die aus einer oder mehreren Berechtigungen für Azure Maps REST-APIs besteht.
Zum Implementieren von Szenarien empfiehlt es sich, Authentifizierungskonzepte anzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung zum Modellieren von Anwendungen über Objekte, die auf bestimmte APIs und Bereiche zugreifen können.
Hinweise
- 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 Kartenverwaltungs-API abgerufen werden.
Der Authorization URL
ist spezifisch für die öffentliche Azure-Cloud-instance. Sovereign Clouds verfügen über eindeutige Autorisierungs-URLs und Azure Active Directory-Konfigurationen.
* Die rollenbasierte Zugriffssteuerung in Azure wird über die Azure-Verwaltungsebene über 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 Work, School und Guests, aber keine persönlichen Konten.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Beschreibung |
---|---|
https://cognitiveservices.azure.com/.default | https://cognitiveservices.azure.com/.default |
Ocp-Apim-Subscription-Key
Ein Abonnementschlüssel für eine Sprachdienstressource.
Type:
apiKey
In:
header
Beispiele
Successful Import Project
Sample Request
POST {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/:import?api-version=2023-04-01
{
"projectFileVersion": "2022-05-01",
"stringIndexType": "Utf16CodeUnit",
"metadata": {
"projectKind": "Conversation",
"settings": {
"confidenceThreshold": 0.7
},
"projectName": "EmailApp",
"multilingual": true,
"description": "Trying out CLU",
"language": "en-us"
},
"assets": {
"projectKind": "Conversation",
"intents": [
{
"category": "Read"
},
{
"category": "Delete"
}
],
"entities": [
{
"category": "Sender"
},
{
"category": "Number",
"regex": {
"expressions": [
{
"regexKey": "UK Phone numbers",
"language": "en-us",
"regexPattern": "/^\\(?([0-9]{3})\\)?[-.\\s]?([0-9]{3})[-.\\s]?([0-9]{4})$/"
}
]
}
}
],
"utterances": [
{
"text": "Open Blake's email",
"dataset": "Train",
"intent": "Read",
"entities": [
{
"category": "Sender",
"offset": 5,
"length": 5
}
]
},
{
"text": "Delete last email",
"language": "en-gb",
"dataset": "Test",
"intent": "Delete",
"entities": []
}
]
}
}
Sample Response
operation-location: {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/import/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-01
Definitionen
Name | Beschreibung |
---|---|
Composition |
Das Verhalten, das befolgt werden soll, wenn sich die Komponenten der Entität miteinander überlappen. |
Conversational |
Stellt eine Entität mit ihren Komponenten dar. |
Conversational |
Stellt eine exportierte Absicht eines Konversationsprojekts dar. |
Conversational |
Stellt die exportierten Ressourcen eines Konversationsprojekts dar. |
Conversational |
Stellt eine exportierte Äußerung für ein Konversationsprojekt dar. |
Conversational |
Stellt die Optionen dar, die zum Erstellen oder Aktualisieren eines Projekts verwendet werden. |
Conversational |
Definiert die Orchestrierungsdetails für ein Conversational-Projektziel. |
Conversational |
Stellt die Orchestrierungsoptionen für ein Conversational-Projektziel dar. |
Conversational |
Stellt eine Listenkomponente einer Entität dar. |
Conversational |
Stellt eine Liste von Synonymen innerhalb einer Listenkomponente dar. |
Conversational |
Stellt eine Regex-Komponente einer Entität dar. |
Conversational |
Stellt einen regex-Ausdruck innerhalb einer regex-Komponente dar. Dieser Ausdruck folgt der .NET-Regex-Syntax. Weitere Informationen finden Sie hier: https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions |
Conversational |
Stellt eine Unterliste in einer Listenkomponente dar. |
Conversational |
Definiert die Orchestrierungsdetails für ein LUIS-Anwendungsziel. |
Conversational |
Stellt die Orchestrierungsoptionen für ein LUIS-Anwendungsziel dar. |
Conversational |
Stellt eine exportierte vordefinierte Entitätskomponente dar. |
Conversational |
Stellt ein exportiertes Projekt dar. |
Conversational |
Definiert die Orchestrierungsdetails für ein Projektziel für fragende Antworten. |
Conversational |
Stellt die Orchestrierungsoptionen für ein Projektziel für fragende Antworten dar. |
Conversational |
Stellt eine Entitätsbezeichnung für eine Äußerung dar. |
Conversational |
Stellt eine exportierte Absicht für ein Orchestrierungsprojekt dar. |
Conversational |
Stellt die Ressourcen eines Orchestrierungsprojekts dar. |
Conversational |
Stellt eine Äußerung eines Orchestrierungsprojekts dar. |
Conversational |
Stellt die Einstellungen dar, die zum Definieren des Projektverhaltens verwendet werden. |
Error |
Das Fehlerobjekt. |
Error |
Für Menschen lesbarer Fehlercode. |
Error |
Fehlerantwort. |
Exported |
Das Format der zu verwendenden exportierten Projektdatei. |
Inner |
Für Menschen 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. |
Project |
Stellt die Projektart dar. |
String |
Gibt die Methode an, die zum Interpretieren von Zeichenfolgenoffsets verwendet wird. Weitere Informationen finden Sie unter https://aka.ms/text-analytics-offsets. |
CompositionSetting
Das Verhalten, das befolgt werden soll, wenn sich die Komponenten der Entität miteinander überlappen.
Name | Typ | Beschreibung |
---|---|---|
combineComponents |
string |
Wenn zwei oder mehr Komponenten im Text gefunden werden und sich überlappen, werden die Spannweiten der Komponenten zu einer Spanne zusammengeführt, die alle kombiniert. |
requireExactOverlap |
string |
Alle Komponenten müssen sich mit genau den gleichen Zeichen im Text überlappen, damit die Entität zurückgegeben werden kann. Wenn eine der definierten Komponenten nicht abgeglichen oder vorhergesagt wird, wird die Entität nicht zurückgegeben. |
returnLongestOverlap |
string |
Wenn zwei oder mehr Komponenten im Text gefunden werden und sich überlappen, wird die Komponente mit dem längsten Zeichensatz zurückgegeben. |
separateComponents |
string |
Die Abgleichung oder Vorhersage jeder Komponente wird als separate Instanz der Entität zurückgegeben. |
ConversationalAnalysisAuthoringConversationExportedEntity
Stellt eine Entität mit ihren Komponenten dar.
Name | Typ | Beschreibung |
---|---|---|
category |
string |
Die Kategorie der Entität. |
compositionSetting |
Das Verhalten, das befolgt werden soll, wenn sich die Komponenten der Entität miteinander überlappen. |
|
list |
Die Listenkomponente der Entität. |
|
prebuilts |
Die vordefinierten Entitätskomponenten. |
|
regex |
Die Regex-Komponente der Entität. |
|
requiredComponents |
string[] |
Die erforderlichen Komponenten. Zulässige Werte sind "learned", "list", "prebuilts" und "regex". |
ConversationalAnalysisAuthoringConversationExportedIntent
Stellt eine exportierte Absicht eines Konversationsprojekts dar.
Name | Typ | Beschreibung |
---|---|---|
category |
string |
Die Absichtskategorie. |
ConversationalAnalysisAuthoringConversationExportedProjectAssets
Stellt die exportierten Ressourcen eines Konversationsprojekts dar.
Name | Typ | Beschreibung |
---|---|---|
entities |
Die im Projekt definierten Entitäten. |
|
intents |
Die im Projekt definierten Absichten. |
|
projectKind |
string:
Conversation |
Der Projekttyp, der die Ressourcen enthält. |
utterances |
Conversational |
Die im Projekt definierten Äußerungen. |
ConversationalAnalysisAuthoringConversationExportedUtterance
Stellt eine exportierte Äußerung für ein Konversationsprojekt dar.
Name | Typ | Beschreibung |
---|---|---|
dataset |
string |
Das Dataset für diese Äußerung. Zulässige Werte sind "Train" und "Test". |
entities |
Conversational |
Stellt die Entitätsbezeichnungen der Äußerung dar. |
intent |
string |
Die Absicht der Äußerung. |
language |
string |
Stellt die Sprache der Äußerung dar. Dies ist BCP-47-Darstellung einer Sprache. Verwenden Sie beispielsweise "en" für Englisch, "en-gb" für Englisch (UK), "es" für Spanisch usw. |
text |
string |
Der Äußerungstext. |
ConversationalAnalysisAuthoringCreateProjectOptions
Stellt die Optionen dar, die zum Erstellen oder Aktualisieren eines Projekts verwendet werden.
Name | Typ | Beschreibung |
---|---|---|
description |
string |
Die Projektbeschreibung. |
language |
string |
Die Projektsprache. Dies ist BCP-47-Darstellung einer Sprache. Verwenden Sie beispielsweise "en" für Englisch, "en-gb" für Englisch (UK), "es" für Spanisch usw. |
multilingual |
boolean |
Gibt an, ob das Projekt für mehrere Sprachen verwendet wird oder nicht. |
projectKind |
Stellt die Projektart dar. |
|
projectName |
string |
Der neue Projektname. |
settings |
Die Projekteinstellungen. |
ConversationalAnalysisAuthoringExportedConversationOrchestration
Definiert die Orchestrierungsdetails für ein Conversational-Projektziel.
Name | Typ | Beschreibung |
---|---|---|
deploymentName |
string |
Der Name der Zielbereitstellung. |
projectName |
string |
Der Name des Zielprojekts. |
ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions
Stellt die Orchestrierungsoptionen für ein Conversational-Projektziel dar.
Name | Typ | Beschreibung |
---|---|---|
conversationOrchestration |
Conversational |
Die Conversational-Projektzieldetails. |
targetProjectKind |
string:
Conversation |
Die Art des Ziels, das im Orchestrierungsflow verwendet wird. |
ConversationalAnalysisAuthoringExportedEntityList
Stellt eine Listenkomponente einer Entität dar.
Name | Typ | Beschreibung |
---|---|---|
sublists |
Die Unterlisten der Listenkomponente. |
ConversationalAnalysisAuthoringExportedEntityListSynonym
Stellt eine Liste von Synonymen innerhalb einer Listenkomponente dar.
Name | Typ | Beschreibung |
---|---|---|
language |
string |
Stellt die Sprache der Synonyme dar. Dies ist BCP-47-Darstellung einer Sprache. Verwenden Sie beispielsweise "en" für Englisch, "en-gb" für Englisch (UK), "es" für Spanisch usw. |
values |
string[] |
Die Liste der Synonyme. |
ConversationalAnalysisAuthoringExportedEntityRegex
Stellt eine Regex-Komponente einer Entität dar.
Name | Typ | Beschreibung |
---|---|---|
expressions |
Conversational |
Die regex-Ausdrücke der regex-Komponente. Diese Ausdrücke folgen der .NET regex-Syntax. Weitere Informationen finden Sie hier: https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions |
ConversationalAnalysisAuthoringExportedEntityRegexExpression
Stellt einen regex-Ausdruck innerhalb einer regex-Komponente dar. Dieser Ausdruck folgt der .NET-Regex-Syntax. Weitere Informationen finden Sie hier: https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions
Name | Typ | Beschreibung |
---|---|---|
language |
string |
Stellt die Sprache des regex-Ausdrucks dar. Dies ist BCP-47-Darstellung einer Sprache. Verwenden Sie beispielsweise "en" für Englisch, "en-gb" für Englisch (UK), "es" für Spanisch usw. |
regexKey |
string |
Der Schlüssel des regex-Ausdrucks. |
regexPattern |
string |
Das Regex-Muster. |
ConversationalAnalysisAuthoringExportedEntitySublist
Stellt eine Unterliste in einer Listenkomponente dar.
Name | Typ | Beschreibung |
---|---|---|
listKey |
string |
Der Schlüssel der Unterliste. |
synonyms |
Die Ausdrücke von, die der Unterliste entsprechen. |
ConversationalAnalysisAuthoringExportedLuisOrchestration
Definiert die Orchestrierungsdetails für ein LUIS-Anwendungsziel.
Name | Typ | Beschreibung |
---|---|---|
appId |
string |
Die LUIS-Anwendungs-ID. |
appVersion |
string |
Die Zielversions-ID. |
slotName |
string |
Der Name des Zielslots. |
ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions
Stellt die Orchestrierungsoptionen für ein LUIS-Anwendungsziel dar.
Name | Typ | Beschreibung |
---|---|---|
luisOrchestration |
Die Luis-Anwendungszieldetails. |
|
targetProjectKind |
string:
Luis |
Die Art des Ziels, das im Orchestrierungsflow verwendet wird. |
ConversationalAnalysisAuthoringExportedPrebuiltEntity
Stellt eine exportierte vordefinierte Entitätskomponente dar.
Name | Typ | Beschreibung |
---|---|---|
category |
string |
Die vordefinierte Entitätskategorie. |
ConversationalAnalysisAuthoringExportedProject
Stellt ein exportiertes Projekt dar.
Name | Typ | Beschreibung |
---|---|---|
assets | ConversationalAnalysisAuthoringExportedProjectAssets: |
Stellt die Projektressourcen dar. |
metadata |
Stellt die Projektmetadaten dar. |
|
projectFileVersion |
string |
Die Version der exportierten Datei. |
stringIndexType |
Gibt die Methode an, die zum Interpretieren von Zeichenfolgenoffsets verwendet wird. Weitere Informationen finden Sie unter https://aka.ms/text-analytics-offsets. |
ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration
Definiert die Orchestrierungsdetails für ein Projektziel für fragende Antworten.
Name | Typ | Beschreibung |
---|---|---|
projectName |
string |
Der Name des Zielprojekts. |
ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions
Stellt die Orchestrierungsoptionen für ein Projektziel für fragende Antworten dar.
Name | Typ | Beschreibung |
---|---|---|
questionAnsweringOrchestration |
Conversational |
Projektdetails zur Fragebeantwortung. |
targetProjectKind |
string:
Question |
Die Art des Ziels, das im Orchestrierungsflow verwendet wird. |
ConversationalAnalysisAuthoringExportedUtteranceEntityLabel
Stellt eine Entitätsbezeichnung für eine Äußerung dar.
Name | Typ | Beschreibung |
---|---|---|
category |
string |
Die Kategorie der Entitätsbezeichnung. |
length |
integer |
Länge für den Entitätstext. |
offset |
integer |
Startposition für den Entitätstext. |
ConversationalAnalysisAuthoringOrchestrationExportedIntent
Stellt eine exportierte Absicht für ein Orchestrierungsprojekt dar.
Name | Typ | Beschreibung |
---|---|---|
category |
string |
Die Absichtskategorie. |
orchestration | ConversationalAnalysisAuthoringExportedOrchestrationOptions: |
Gibt das Verhalten dieser Absicht im Orchestrierungsflow an. |
ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets
Stellt die Ressourcen eines Orchestrierungsprojekts dar.
Name | Typ | Beschreibung |
---|---|---|
intents |
Conversational |
Stellt die Absichten des Projekts dar. |
projectKind |
string:
Orchestration |
Der Projekttyp, der die Ressourcen enthält. |
utterances |
Conversational |
Stellt die Äußerungen des Projekts dar. |
ConversationalAnalysisAuthoringOrchestrationExportedUtterance
Stellt eine Äußerung eines Orchestrierungsprojekts dar.
Name | Typ | Beschreibung |
---|---|---|
dataset |
string |
Das Dataset für diese Äußerung. Zulässige Werte sind "Train" und "Test". |
intent |
string |
Die Absicht der Äußerung. |
language |
string |
Stellt die Sprache der Äußerung dar. Dies ist BCP-47-Darstellung einer Sprache. Verwenden Sie beispielsweise "en" für Englisch, "en-gb" für Englisch (UK), "es" für Spanisch usw. |
text |
string |
Der Äußerungstext. |
ConversationalAnalysisAuthoringProjectSettings
Stellt die Einstellungen dar, die zum Definieren des Projektverhaltens verwendet werden.
Name | Typ | Beschreibung |
---|---|---|
confidenceThreshold |
number |
Der Schwellenwert der Absicht mit der höchsten Vertrauenswürdigkeit, bei der die Vorhersage automatisch in "Keine" geändert wird. Der Wert des Schwellenwerts sollte zwischen 0 und 1 einschließlich liegen. |
Error
Das Fehlerobjekt.
Name | Typ | Beschreibung |
---|---|---|
code |
Einer der vom Server definierten 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 für Menschen lesbare Darstellung des Fehlers. |
target |
string |
Das Ziel des Fehlers. |
ErrorCode
Für Menschen 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. |
ExportedProjectFormat
Das Format der zu verwendenden exportierten Projektdatei.
Name | Typ | Beschreibung |
---|---|---|
Conversation |
string |
Gibt das Format für ein Konversationsprojekt an. |
Luis |
string |
Gibt das Format für eine Anwendung an, die aus LUIS exportiert wurde. |
InnerErrorCode
Für Menschen 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 |
Einer der vom Server definierten 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. |
ProjectKind
Stellt die Projektart dar.
Name | Typ | Beschreibung |
---|---|---|
Conversation |
string |
Ein Projekt zum Erstellen natürlicher Sprache in Apps, Bots und IoT-Geräte. |
Orchestration |
string |
Ein Projekt zum Verbinden und Orchestrieren von Unterhaltungen, benutzerdefinierten Fragen und LUIS-Projekten in einem einzigen Projekt. |
StringIndexType
Gibt die Methode an, die zum Interpretieren von Zeichenfolgenoffsets verwendet wird. Weitere Informationen finden Sie unter https://aka.ms/text-analytics-offsets.
Name | Typ | Beschreibung |
---|---|---|
Utf16CodeUnit |
string |
Die Offset- und Längenwerte entsprechen UTF-16-Codeeinheiten. Verwenden Sie diese Option, wenn Ihre Anwendung in einer Sprache geschrieben ist, die Unicode unterstützt, z. B. Java, JavaScript. |