Conversational Analysis Authoring - Import

Referenz

Dienst:: Azure AI Services

API-Version:: 2022-05-01

Löst einen Auftrag aus, um ein Projekt zu importieren. Wenn bereits ein Projekt mit demselben Namen vorhanden ist, werden die Daten dieses Projekts ersetzt.

POST {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/:import?api-version=2022-05-01

Mit optionalen Parametern:

POST {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/:import?format={format}&api-version=2022-05-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
Endpoint	path	True	string	Unterstützter Cognitive Services-Endpunkt (z. B. https://.api.cognitiveservices.azure.com).
projectName	path	True	string maxLength: 100	Der Name des zu verwendenden Projekts.
api-version	query	True	string	Client-API-Version.
format	query		ExportedProjectFormat	Das Format der zu verwendenden exportierten Projektdatei.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Ocp-Apim-Subscription-Key	True	string	Ein Abonnementschlüssel für eine Sprachdienstressource.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
metadata	True	ConversationalAnalysisAuthoringCreateProjectOptions	Stellt die Projektmetadaten dar.
projectFileVersion	True	string	Die Version der exportierten Datei.
stringIndexType	True	StringIndexType	Gibt die Methode an, die zum Interpretieren von Zeichenfolgenversatzen verwendet wird. Weitere Informationen finden Sie unter https://aka.ms/text-analytics-offsets.
assets		ConversationalAnalysisAuthoringExportedProjectAssets: ConversationalAnalysisAuthoringConversationExportedProjectAssets ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets	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. Header operation-location: string
Other Status Codes	ErrorResponse	Fehlerantwort.

Name

Typ

Beschreibung

202 Accepted

Ein erfolgreicher Aufruf enthält einen Operation-Location-Header, mit dem der Auftragsstatus überprüft wird.

Header

operation-location: string

Other Status Codes

ErrorResponse

Fehlerantwort.

Sicherheit

Ocp-Apim-Subscription-Key

Ein Abonnementschlüssel für eine Sprachdienstressource.

Typ: apiKey
In: header

Beispiele

Successful Import Project

Beispielanforderung

HTTP

POST {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/:import?api-version=2022-05-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"
      }
    ],
    "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": []
      }
    ]
  }
}

Beispiel für eine Antwort

Statuscode:: 202

operation-location: {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/import/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2022-05-01

Definitionen

Name	Beschreibung
CompositionSetting	Das Verhalten, das befolgt werden soll, wenn sich die Komponenten der Entität miteinander überlappen.
ConversationalAnalysisAuthoringConversationExportedEntity	Stellt eine Entität mit ihren Komponenten dar.
ConversationalAnalysisAuthoringConversationExportedIntent	Stellt eine exportierte Absicht eines Unterhaltungsprojekts dar.
ConversationalAnalysisAuthoringConversationExportedProjectAssets	Stellt die exportierten Objekte eines Unterhaltungsprojekts dar.
ConversationalAnalysisAuthoringConversationExportedUtterance	Stellt eine exportierte Äußerung für ein Unterhaltungsprojekt dar.
ConversationalAnalysisAuthoringCreateProjectOptions	Stellt die Optionen dar, die zum Erstellen oder Aktualisieren eines Projekts verwendet werden.
ConversationalAnalysisAuthoringExportedConversationOrchestration	Definiert die Orchestrierungsdetails für ein Unterhaltungsprojektziel.
ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions	Stellt die Orchestrierungsoptionen für ein Unterhaltungsprojektziel dar.
ConversationalAnalysisAuthoringExportedEntityList	Stellt eine Listenkomponente einer Entität dar.
ConversationalAnalysisAuthoringExportedEntityListSynonym	Stellt eine Liste von Synonymen innerhalb einer Listenkomponente dar.
ConversationalAnalysisAuthoringExportedEntitySublist	Stellt eine Unterliste innerhalb einer Listenkomponente dar.
ConversationalAnalysisAuthoringExportedLuisOrchestration	Definiert die Orchestrierungsdetails für ein LUIS-Anwendungsziel.
ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions	Stellt die Orchestrierungsoptionen für ein LUIS-Anwendungsziel dar.
ConversationalAnalysisAuthoringExportedPrebuiltEntity	Stellt eine exportierte vordefinierte Entitätskomponente dar.
ConversationalAnalysisAuthoringExportedProject	Stellt ein exportiertes Projekt dar.
ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration	Definiert die Orchestrierungsdetails für ein Projektziel für die Frageantwort.
ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions	Stellt die Orchestrierungsoptionen für ein Projektziel für die Frageantwort dar.
ConversationalAnalysisAuthoringExportedUtteranceEntityLabel	Stellt eine Entitätsbezeichnung für eine Äußerung dar.
ConversationalAnalysisAuthoringOrchestrationExportedIntent	Stellt eine exportierte Absicht für ein Orchestrierungsprojekt dar.
ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets	Stellt die Ressourcen eines Orchestrierungsprojekts dar.
ConversationalAnalysisAuthoringOrchestrationExportedUtterance	Stellt eine Äußerung eines Orchestrierungsprojekts dar.
ConversationalAnalysisAuthoringProjectSettings	Stellt die Einstellungen dar, die zum Definieren des Projektverhaltens verwendet werden.
Error	Das Fehlerobjekt.
ErrorCode	Lesbarer Fehlercode.
ErrorResponse	Fehlerantwort.
ExportedProjectFormat	Das Format der zu verwendenden exportierten Projektdatei.
InnerErrorCode	Lesbarer Fehlercode.
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.
ProjectKind	Stellt die Projektart dar.
StringIndexType	Gibt die Methode an, die zum Interpretieren von Zeichenfolgenversatzen verwendet wird. Weitere Informationen finden Sie unter https://aka.ms/text-analytics-offsets.

CompositionSetting

Enumeration

Das Verhalten, das befolgt werden soll, wenn sich die Komponenten der Entität miteinander überlappen.

Wert	Beschreibung
combineComponents	Wenn zwei oder mehr Komponenten im Text gefunden werden und sich überlappen, werden die Spannweiten der Komponenten in einer Spanne zusammengeführt, die alle zusammenfasst.
requireExactOverlap	Alle Komponenten müssen exakt dieselben Zeichen im Text überlappen, damit die Entität zurückgegeben wird. Wenn eine der definierten Komponenten nicht übereinstimmt oder vorhergesagt wird, wird die Entität nicht zurückgegeben.
returnLongestOverlap	Wenn zwei oder mehr Komponenten im Text gefunden und sich überlappen, wird die Komponente mit dem längsten Zeichensatz zurückgegeben.
separateComponents	Jede Komponente wird als separate Instanz der Entität zurückgegeben.

ConversationalAnalysisAuthoringConversationExportedEntity

Objekt

Stellt eine Entität mit ihren Komponenten dar.

Name	Typ	Beschreibung
category	string	Die Kategorie der Entität.
compositionSetting	CompositionSetting	Das Verhalten, das befolgt werden soll, wenn sich die Komponenten der Entität miteinander überlappen.
list	ConversationalAnalysisAuthoringExportedEntityList	Die Listenkomponente der Entität.
prebuilts	ConversationalAnalysisAuthoringExportedPrebuiltEntity[]	Die vordefinierten Entitätskomponenten.

ConversationalAnalysisAuthoringConversationExportedIntent

Objekt

Stellt eine exportierte Absicht eines Unterhaltungsprojekts dar.

Name	Typ	Beschreibung
category	string	Die Absichtskategorie.

ConversationalAnalysisAuthoringConversationExportedProjectAssets

Objekt

Stellt die exportierten Objekte eines Unterhaltungsprojekts dar.

Name	Typ	Beschreibung
entities	ConversationalAnalysisAuthoringConversationExportedEntity[]	Die im Projekt definierten Entitäten.
intents	ConversationalAnalysisAuthoringConversationExportedIntent[]	Die im Projekt definierten Absichten.
projectKind	string: Conversation	Der Projekttyp, der die Ressourcen enthält.
utterances	ConversationalAnalysisAuthoringConversationExportedUtterance[]	Die im Projekt definierten Äußerungen.

ConversationalAnalysisAuthoringConversationExportedUtterance

Objekt

Stellt eine exportierte Äußerung für ein Unterhaltungsprojekt dar.

Name	Typ	Beschreibung
dataset	string	Das Dataset für diese Äußerung. Zulässige Werte sind "Train" und "Test".
entities	ConversationalAnalysisAuthoringExportedUtteranceEntityLabel[]	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 die BCP-47-Darstellung einer Sprache. Verwenden Sie z. B. "en" für Englisch, "en-gb" für Englisch (UK), "es" für Spanisch usw.
text	string	Der Text der Äußerung.

ConversationalAnalysisAuthoringCreateProjectOptions

Objekt

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 die BCP-47-Darstellung einer Sprache. Verwenden Sie z. B. "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	ProjectKind	Stellt die Projektart dar.
projectName	string	Der neue Projektname.
settings	ConversationalAnalysisAuthoringProjectSettings	Die Projekteinstellungen.

ConversationalAnalysisAuthoringExportedConversationOrchestration

Objekt

Definiert die Orchestrierungsdetails für ein Unterhaltungsprojektziel.

Name	Typ	Beschreibung
deploymentName	string	Der Name der zielbezogenen Bereitstellung.
projectName	string	Der Name des Zielprojekts.

ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions

Objekt

Stellt die Orchestrierungsoptionen für ein Unterhaltungsprojektziel dar.

Name	Typ	Beschreibung
conversationOrchestration	ConversationalAnalysisAuthoringExportedConversationOrchestration	Die Zieldetails des Unterhaltungsprojekts.
targetProjectKind	string: Conversation	Die Art des Ziels, das im Orchestrierungsfluss verwendet wird.

ConversationalAnalysisAuthoringExportedEntityList

Objekt

Stellt eine Listenkomponente einer Entität dar.

Name	Typ	Beschreibung
sublists	ConversationalAnalysisAuthoringExportedEntitySublist[]	Die Unterlisten der Listenkomponente.

ConversationalAnalysisAuthoringExportedEntityListSynonym

Objekt

Stellt eine Liste von Synonymen innerhalb einer Listenkomponente dar.

Name	Typ	Beschreibung
language	string	Stellt die Sprache der Synonyme dar. Dies ist die BCP-47-Darstellung einer Sprache. Verwenden Sie z. B. "en" für Englisch, "en-gb" für Englisch (UK), "es" für Spanisch usw.
values	string[]	Die Liste der Synonyme.

ConversationalAnalysisAuthoringExportedEntitySublist

Objekt

Stellt eine Unterliste innerhalb einer Listenkomponente dar.

Name	Typ	Beschreibung
listKey	string	Der Schlüssel der Unterliste.
synonyms	ConversationalAnalysisAuthoringExportedEntityListSynonym[]	Die Ausdrücke, die der Unterliste entsprechen.

ConversationalAnalysisAuthoringExportedLuisOrchestration

Objekt

Definiert die Orchestrierungsdetails für ein LUIS-Anwendungsziel.

Name	Typ	Beschreibung
appId	string (uuid)	Die LUIS-Anwendungs-ID.
appVersion	string	Die Zielversions-ID.
slotName	string	Der Name des Zielplatzes.

ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions

Objekt

Stellt die Orchestrierungsoptionen für ein LUIS-Anwendungsziel dar.

Name	Typ	Beschreibung
luisOrchestration	ConversationalAnalysisAuthoringExportedLuisOrchestration	Die Zieldetails der LUIS-Anwendung.
targetProjectKind	string: Luis	Die Art des Ziels, das im Orchestrierungsfluss verwendet wird.

ConversationalAnalysisAuthoringExportedPrebuiltEntity

Objekt

Stellt eine exportierte vordefinierte Entitätskomponente dar.

Name	Typ	Beschreibung
category	string	Die vordefinierte Entitätskategorie.

ConversationalAnalysisAuthoringExportedProject

Objekt

Stellt ein exportiertes Projekt dar.

Name	Typ	Beschreibung
assets	ConversationalAnalysisAuthoringExportedProjectAssets: ConversationalAnalysisAuthoringConversationExportedProjectAssets ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets	Stellt die Projektressourcen dar.
metadata	ConversationalAnalysisAuthoringCreateProjectOptions	Stellt die Projektmetadaten dar.
projectFileVersion	string	Die Version der exportierten Datei.
stringIndexType	StringIndexType	Gibt die Methode an, die zum Interpretieren von Zeichenfolgenversatzen verwendet wird. Weitere Informationen finden Sie unter https://aka.ms/text-analytics-offsets.

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration

Objekt

Definiert die Orchestrierungsdetails für ein Projektziel für die Frageantwort.

Name	Typ	Beschreibung
projectName	string	Der Name des Zielprojekts.

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions

Objekt

Stellt die Orchestrierungsoptionen für ein Projektziel für die Frageantwort dar.

Name	Typ	Beschreibung
questionAnsweringOrchestration	ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration	Die Projektdetails für die Frageantwort.
targetProjectKind	string: QuestionAnswering	Die Art des Ziels, das im Orchestrierungsfluss verwendet wird.

ConversationalAnalysisAuthoringExportedUtteranceEntityLabel

Objekt

Stellt eine Entitätsbezeichnung für eine Äußerung dar.

Name	Typ	Beschreibung
category	string	Die Kategorie der Entitätsbezeichnung.
length	integer (int32)	Länge für den Entitätstext.
offset	integer (int32)	Startposition für den Entitätstext.

ConversationalAnalysisAuthoringOrchestrationExportedIntent

Objekt

Stellt eine exportierte Absicht für ein Orchestrierungsprojekt dar.

Name	Typ	Beschreibung
category	string	Die Absichtskategorie.
orchestration	ConversationalAnalysisAuthoringExportedOrchestrationOptions: ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions	Gibt das Verhalten dieser Absicht im Orchestrierungsfluss an.

ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets

Objekt

Stellt die Ressourcen eines Orchestrierungsprojekts dar.

Name	Typ	Beschreibung
intents	ConversationalAnalysisAuthoringOrchestrationExportedIntent[]	Stellt die Absichten des Projekts dar.
projectKind	string: Orchestration	Der Projekttyp, der die Ressourcen enthält.
utterances	ConversationalAnalysisAuthoringOrchestrationExportedUtterance[]	Stellt die Äußerungen des Projekts dar.

ConversationalAnalysisAuthoringOrchestrationExportedUtterance

Objekt

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 die BCP-47-Darstellung einer Sprache. Verwenden Sie z. B. "en" für Englisch, "en-gb" für Englisch (UK), "es" für Spanisch usw.
text	string	Der Text der Äußerung.

ConversationalAnalysisAuthoringProjectSettings

Objekt

Stellt die Einstellungen dar, die zum Definieren des Projektverhaltens verwendet werden.

Name	Typ	Beschreibung
confidenceThreshold	number (float)	Der Schwellenwert der Absicht mit der höchsten Vertrauenswürdigkeit, bei der die Vorhersage automatisch in "Keine" geändert wird.

Error

Objekt

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	ErrorCode	Eine serverdefinierte Gruppe von Fehlercodes.
details	Error[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror	InnerErrorModel	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

Enumeration

Lesbarer Fehlercode.

Wert	Beschreibung
AzureCognitiveSearchIndexLimitReached
AzureCognitiveSearchIndexNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
Conflict
Forbidden
InternalServerError
InvalidArgument
InvalidRequest
NotFound
OperationNotFound
ProjectNotFound
QuotaExceeded
ServiceUnavailable
Timeout
TooManyRequests
Unauthorized
Warning

ErrorResponse

Objekt

Fehlerantwort.

Name	Typ	Beschreibung
error	Error	Das Fehlerobjekt.

ExportedProjectFormat

Enumeration

Das Format der zu verwendenden exportierten Projektdatei.

Wert	Beschreibung
Conversation	Gibt das Format für ein Unterhaltungsprojekt an.
Luis	Gibt das Format für eine Anwendung an, die aus LUIS exportiert wurde.

InnerErrorCode

Enumeration

Lesbarer Fehlercode.

Wert	Beschreibung
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
EmptyRequest
ExtractionFailure
InvalidCountryHint
InvalidDocument
InvalidDocumentBatch
InvalidParameterValue
InvalidRequest
InvalidRequestBodyFormat
KnowledgeBaseNotFound
MissingInputDocuments
ModelVersionIncorrect
UnsupportedLanguageCode

InnerErrorModel

Objekt

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	InnerErrorCode	Eine serverdefinierte Gruppe von Fehlercodes.
details	object	Fehlerdetails.
innererror	InnerErrorModel	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Fehlermeldung.
target	string	Fehlerziel.

ProjectKind

Enumeration

Stellt die Projektart dar.

Wert	Beschreibung
Conversation	Ein Projekt zum Erstellen natürlicher Sprache in Apps, Bots und IoT-Geräte.
Orchestration	Ein Projekt zum Verbinden und Orchestrieren von Unterhaltungen, benutzerdefinierten Fragenantworten und LUIS-Projekten in einem einzigen Projekt.

StringIndexType

Enumeration

Gibt die Methode an, die zum Interpretieren von Zeichenfolgenversatzen verwendet wird. Weitere Informationen finden Sie unter https://aka.ms/text-analytics-offsets.

Wert	Beschreibung
Utf16CodeUnit	Die Offset- und Längenwerte entsprechen UTF-16-Codeeinheiten. Verwenden Sie diese Option, wenn Ihre Anwendung in einer Sprache geschrieben wird, die Unicode unterstützt, z. B. JavaScript.

Freigeben über

Conversational Analysis Authoring - Import

URI-Parameter

Anforderungsheader

Anforderungstext

Antworten

Sicherheit

Ocp-Apim-Subscription-Key

Beispiele

Successful Import Project

Beispielanforderung

Beispiel für eine Antwort

Definitionen

CompositionSetting

ConversationalAnalysisAuthoringConversationExportedEntity

ConversationalAnalysisAuthoringConversationExportedIntent

ConversationalAnalysisAuthoringConversationExportedProjectAssets

ConversationalAnalysisAuthoringConversationExportedUtterance

ConversationalAnalysisAuthoringCreateProjectOptions

ConversationalAnalysisAuthoringExportedConversationOrchestration

ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions

ConversationalAnalysisAuthoringExportedEntityList

ConversationalAnalysisAuthoringExportedEntityListSynonym

ConversationalAnalysisAuthoringExportedEntitySublist

ConversationalAnalysisAuthoringExportedLuisOrchestration

ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions

ConversationalAnalysisAuthoringExportedPrebuiltEntity

ConversationalAnalysisAuthoringExportedProject

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions

ConversationalAnalysisAuthoringExportedUtteranceEntityLabel

ConversationalAnalysisAuthoringOrchestrationExportedIntent

ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets

ConversationalAnalysisAuthoringOrchestrationExportedUtterance

ConversationalAnalysisAuthoringProjectSettings

Error

ErrorCode

ErrorResponse

ExportedProjectFormat

InnerErrorCode

InnerErrorModel

ProjectKind

StringIndexType

Zusätzliche Ressourcen