Freigeben über

Conversational Analysis Authoring - Import

  • Referenz
Dienst:
Azure AI Services
API-Version:
2022-05-01

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=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

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 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.

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

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 Zu befolgende Verhalten, wenn sich die Komponenten der Entität miteinander überlappen.
ConversationalAnalysisAuthoringConversationExportedEntity

Stellt eine Entität mit ihren Komponenten dar.
ConversationalAnalysisAuthoringConversationExportedIntent

Stellt eine exportierte Absicht eines Konversationsprojekts dar.
ConversationalAnalysisAuthoringConversationExportedProjectAssets

Stellt die exportierten Ressourcen eines Konversationsprojekts dar.
ConversationalAnalysisAuthoringConversationExportedUtterance

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

Stellt die Optionen dar, die zum Erstellen oder Aktualisieren eines Projekts verwendet werden.
ConversationalAnalysisAuthoringExportedConversationOrchestration

Definiert die Orchestrierungsdetails für ein Conversational-Projektziel.
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 fragende Antworten.
ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions

Stellt die Orchestrierungsoptionen für ein Projektziel für fragende Antworten 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 Objekte 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 Richtlinien der Microsoft One-API: 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 Zeichenfolgenoffsets verwendet wird. Weitere Informationen finden Sie unter https://aka.ms/text-analytics-offsets.

CompositionSetting

Das Zu befolgende Verhalten, 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 überschneiden, werden die Spannen der Komponenten in 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 überschneiden, 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

CompositionSetting

Das Zu befolgende Verhalten, wenn sich die Komponenten der Entität miteinander überlappen.
list

ConversationalAnalysisAuthoringExportedEntityList

Die Listenkomponente der Entität.
prebuilts

ConversationalAnalysisAuthoringExportedPrebuiltEntity[]

Die vordefinierten Entitätskomponenten.

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

ConversationalAnalysisAuthoringConversationExportedEntity[]

Die im Projekt definierten Entitäten.
intents

ConversationalAnalysisAuthoringConversationExportedIntent[]

Die im Projekt definierten Absichten.
projectKind string:

Conversation

Der Typ des Projekts, das die Ressourcen enthält.
utterances

ConversationalAnalysisAuthoringConversationExportedUtterance[]

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

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 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 die 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

ProjectKind

Stellt die Projektart dar.
projectName

string

Der neue Projektname.
settings

ConversationalAnalysisAuthoringProjectSettings

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 Unterhaltungsprojektziel dar.

Name Typ Beschreibung
conversationOrchestration

ConversationalAnalysisAuthoringExportedConversationOrchestration

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

ConversationalAnalysisAuthoringExportedEntitySublist[]

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.

ConversationalAnalysisAuthoringExportedEntitySublist

Stellt eine Unterliste innerhalb einer Listenkomponente dar.

Name Typ Beschreibung
listKey

string

Der Schlüssel der Unterliste.
synonyms

ConversationalAnalysisAuthoringExportedEntityListSynonym[]

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

ConversationalAnalysisAuthoringExportedLuisOrchestration

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

ConversationalAnalysisAuthoringCreateProjectOptions

Stellt die Projektmetadaten dar.
projectFileVersion

string

Die Version der exportierten Datei.
stringIndexType

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

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration

Projektdetails zur Fragebeantwortung.
targetProjectKind string:

QuestionAnswering

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 Objekte eines Orchestrierungsprojekts dar.

Name Typ Beschreibung
intents

ConversationalAnalysisAuthoringOrchestrationExportedIntent[]

Stellt die Absichten des Projekts dar.
projectKind string:

Orchestration

Der Typ des Projekts, das die Ressourcen enthält.
utterances

ConversationalAnalysisAuthoringOrchestrationExportedUtterance[]

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 die 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 Zuverlässigkeit, an der die Vorhersage automatisch in "Keine" geändert wird.

Error

Das Fehlerobjekt.

Name Typ Beschreibung
code

ErrorCode

Einer von einem serverdefiniertem Satz 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

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

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

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 Richtlinien der Microsoft One-API: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name Typ Beschreibung
code

InnerErrorCode

Einer von einem serverdefiniertem Satz 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

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 Konversations-, 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 und JavaScript.