Freigeben über

Conversational Analysis Authoring - Import

  • Referenz
Dienst:
Azure AI Services
API-Version:
2023-04-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=2023-04-01
Mit optionalen Parametern: 
POST {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/:import?api-version=2023-04-01&format={format}

URI-Parameter

Name In Erforderlich Typ Beschreibung
Endpoint
 path True

string

projectName
 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.
format
 query

ExportedProjectFormat

Das Format der zu verwendenden exportierten Projektdatei.

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:

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

ErrorResponse

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

Successful Import Project

Beispielanforderung

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": []
      }
    ]
  }
}

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=2023-04-01

Definitionen

Name Beschreibung
CompositionSetting
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.
ConversationalAnalysisAuthoringExportedEntityRegex

Stellt eine regex-Komponente einer Entität dar.
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
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.
OrchestrationTargetProjectKind
ProjectKind
StringIndexType

CompositionSetting

Name Typ Beschreibung
combineComponents

string

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

string

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

string

Wenn zwei oder mehr Komponenten im Text gefunden und sich überlappen, wird die Komponente mit dem längsten Zeichensatz zurückgegeben.
separateComponents

string

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

ConversationalAnalysisAuthoringExportedEntityRegex

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

Name Typ Beschreibung
category

string

Die Absichtskategorie.

ConversationalAnalysisAuthoringConversationExportedProjectAssets

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

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

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

Definiert die Orchestrierungsdetails für ein Unterhaltungsprojektziel.

Name Typ Beschreibung
deploymentName

string

Der Name der zielbezogenen Bereitstellung.
projectName

string

Der Name des Zielprojekts.

ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions

Stellt die Orchestrierungsoptionen für ein Unterhaltungsprojektziel dar.

Name Typ Beschreibung
conversationOrchestration

ConversationalAnalysisAuthoringExportedConversationOrchestration

Die Zieldetails des Unterhaltungsprojekts.
targetProjectKind string:

Conversation

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

ConversationalAnalysisAuthoringExportedEntityRegex

Stellt eine regex-Komponente einer Entität dar.

Name Typ Beschreibung
expressions

ConversationalAnalysisAuthoringExportedEntityRegexExpression[]

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

string

Der Schlüssel des regex-Ausdrucks.
regexPattern

string

Das regex-Muster.

ConversationalAnalysisAuthoringExportedEntitySublist

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

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

ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions

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

Name Typ Beschreibung
luisOrchestration

ConversationalAnalysisAuthoringExportedLuisOrchestration

Die Zieldetails der LUIS-Anwendung.
targetProjectKind string:

Luis

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 Zeichenfolgenversatzen verwendet wird. Weitere Informationen finden Sie unter https://aka.ms/text-analytics-offsets.

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration

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

Name Typ Beschreibung
projectName

string

Der Name des Zielprojekts.

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions

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

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

ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets

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

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

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 einschließlich 1 liegen.

Error

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

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

OrchestrationTargetProjectKind

Name Typ Beschreibung
Conversation

string

Luis

string

QuestionAnswering

string

ProjectKind

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 Fragenantworten und LUIS-Projekten in einem einzigen Projekt.

StringIndexType

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 wird, die Unicode unterstützt, z. B. JavaScript.