Conversational Analysis Authoring - Import

Service:

Azure AI Services

API-versie:

2023-04-01

Hiermee wordt een taak geactiveerd om een project te importeren. Als er al een project met dezelfde naam bestaat, worden de gegevens van dat project vervangen.

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

Met optionele parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
Endpoint	path	True	string
projectName	path	True	string	De naam van het te gebruiken project.
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.
format	query		ExportedProjectFormat	De indeling van het geëxporteerde projectbestand dat moet worden gebruikt.

Aanvraagbody

Name	Vereist	Type	Description
metadata	True	ConversationalAnalysisAuthoringCreateProjectOptions	Vertegenwoordigt de projectmetagegevens.
projectFileVersion	True	string	De versie van het geëxporteerde bestand.
stringIndexType	True	StringIndexType	Hiermee geeft u de methode op die wordt gebruikt om tekenreeksverschuivingen te interpreteren. Zie https://aka.ms/text-analytics-offsetsvoor meer informatie.
assets		ConversationalAnalysisAuthoringExportedProjectAssets: ConversationalAnalysisAuthoringConversationExportedProjectAssets ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets	Vertegenwoordigt de projectactiva.

Antwoorden

Name	Type	Description
202 Accepted		De aanvraag is geaccepteerd voor verwerking, maar de verwerking is nog niet voltooid. Kopteksten Operation-Location: string
Other Status Codes	ErrorResponse	Een onverwachte foutreactie.

Beveiliging

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Stroom: accessCode
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize
Token-URL: https://login.microsoftonline.com/common/oauth2/token

Bereiken

Name	Description
https://cognitiveservices.azure.com/.default

Voorbeelden

Successful Import Project

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:

202

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

Definities

Name	Description
CompositionSetting
ConversationalAnalysisAuthoringConversationExportedEntity	Vertegenwoordigt een entiteit met de bijbehorende onderdelen.
ConversationalAnalysisAuthoringConversationExportedIntent	Vertegenwoordigt een geëxporteerde intentie van een gespreksproject.
ConversationalAnalysisAuthoringConversationExportedProjectAssets	Vertegenwoordigt de geëxporteerde assets van een gespreksproject.
ConversationalAnalysisAuthoringConversationExportedUtterance	Vertegenwoordigt een geëxporteerde uiting voor een gespreksproject.
ConversationalAnalysisAuthoringCreateProjectOptions	Vertegenwoordigt de opties die worden gebruikt om een project te maken of bij te werken.
ConversationalAnalysisAuthoringExportedConversationOrchestration	Hiermee definieert u de indelingsdetails voor een Conversational-projectdoel.
ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions	Vertegenwoordigt de indelingsopties voor een Conversational-projectdoel.
ConversationalAnalysisAuthoringExportedEntityList	Vertegenwoordigt een lijstonderdeel van een entiteit.
ConversationalAnalysisAuthoringExportedEntityListSynonym	Vertegenwoordigt een lijst met synoniemen in een lijstonderdeel
ConversationalAnalysisAuthoringExportedEntityRegex	Vertegenwoordigt een regex-onderdeel van een entiteit.
ConversationalAnalysisAuthoringExportedEntityRegexExpression	Vertegenwoordigt een regex-expressie in een regex-onderdeel. Deze expressie volgt de .NET regex-syntaxis. Controleer hier ter referentie: https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions
ConversationalAnalysisAuthoringExportedEntitySublist	Vertegenwoordigt een sublijst in een lijstonderdeel.
ConversationalAnalysisAuthoringExportedLuisOrchestration	Hiermee definieert u de indelingsdetails voor een LUIS-toepassingsdoel.
ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions	Vertegenwoordigt de indelingsopties voor een LUIS-toepassingsdoel.
ConversationalAnalysisAuthoringExportedPrebuiltEntity	Vertegenwoordigt een geëxporteerd vooraf gedefinieerd entiteitsonderdeel
ConversationalAnalysisAuthoringExportedProject	Vertegenwoordigt een geëxporteerd project.
ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration	Definieert de indelingsdetails voor een vraagantwoordprojectdoel.
ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions	Vertegenwoordigt de indelingsopties voor een vraagantwoordprojectdoel.
ConversationalAnalysisAuthoringExportedUtteranceEntityLabel	Vertegenwoordigt een entiteitslabel voor een utterance.
ConversationalAnalysisAuthoringOrchestrationExportedIntent	Vertegenwoordigt een geëxporteerde intentie voor een indelingsproject.
ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets	Vertegenwoordigt de assets van een indelingsproject.
ConversationalAnalysisAuthoringOrchestrationExportedUtterance	Vertegenwoordigt een uiting van een indelingsproject.
ConversationalAnalysisAuthoringProjectSettings	Vertegenwoordigt de instellingen die worden gebruikt om het projectgedrag te definiëren.
Error	Het foutobject.
ErrorCode	Leesbare foutcode.
ErrorResponse	Foutreactie.
ExportedProjectFormat	De indeling van het geëxporteerde projectbestand dat moet worden gebruikt.
InnerErrorCode	Leesbare foutcode.
InnerErrorModel	Een object met meer specifieke 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.
OrchestrationTargetProjectKind
ProjectKind
StringIndexType

CompositionSetting

Name	Type	Description
combineComponents	string	Wanneer er twee of meer onderdelen in de tekst worden gevonden en elkaar overlappen, worden de spanen van de onderdelen samengevoegd in één spanspan waarin ze allemaal worden gecombineerd.
requireExactOverlap	string	Alle onderdelen moeten exact dezelfde tekens in de tekst overlappen om de entiteit te retourneren. Als een van de gedefinieerde onderdelen niet overeenkomt met of voorspeld is, wordt de entiteit niet geretourneerd.
returnLongestOverlap	string	Wanneer twee of meer onderdelen in de tekst worden gevonden en overlappen, wordt het onderdeel met de langste set tekens geretourneerd.
separateComponents	string	De overeenkomst of voorspelling van elk onderdeel wordt geretourneerd als een afzonderlijk exemplaar van de entiteit.

ConversationalAnalysisAuthoringConversationExportedEntity

Vertegenwoordigt een entiteit met de bijbehorende onderdelen.

Name	Type	Description
category	string	De categorie van de entiteit.
compositionSetting	CompositionSetting	Het gedrag dat moet worden gevolgd wanneer de onderdelen van de entiteit elkaar overlappen.
list	ConversationalAnalysisAuthoringExportedEntityList	Het lijstonderdeel van de entiteit.
prebuilts	ConversationalAnalysisAuthoringExportedPrebuiltEntity[]	De vooraf gemaakte entiteitenonderdelen.
regex	ConversationalAnalysisAuthoringExportedEntityRegex	Het regex-onderdeel van de entiteit.
requiredComponents	string[]	De vereiste onderdelen. Toegestane waarden zijn 'learned', 'list', 'prebuilts' en 'regex'.

ConversationalAnalysisAuthoringConversationExportedIntent

Vertegenwoordigt een geëxporteerde intentie van een gespreksproject.

Name	Type	Description
category	string	De intentiecategorie.

ConversationalAnalysisAuthoringConversationExportedProjectAssets

Vertegenwoordigt de geëxporteerde assets van een gespreksproject.

Name	Type	Description
entities	ConversationalAnalysisAuthoringConversationExportedEntity[]	De entiteiten die in het project zijn gedefinieerd.
intents	ConversationalAnalysisAuthoringConversationExportedIntent[]	De intenties die in het project zijn gedefinieerd.
projectKind	string: Conversation	Het type project dat de assets bevat.
utterances	ConversationalAnalysisAuthoringConversationExportedUtterance[]	De uitingen die in het project zijn gedefinieerd.

ConversationalAnalysisAuthoringConversationExportedUtterance

Vertegenwoordigt een geëxporteerde uiting voor een gespreksproject.

Name	Type	Description
dataset	string	De gegevensset voor deze utterance. Toegestane waarden zijn 'Trainen' en 'Testen'.
entities	ConversationalAnalysisAuthoringExportedUtteranceEntityLabel[]	Vertegenwoordigt de entiteitslabels van de utterance.
intent	string	De intentie van de uiting.
language	string	Vertegenwoordigt de taal van de uiting. Dit is BCP-47-weergave van een taal. Gebruik bijvoorbeeld "en" voor Engels, "en-gb" voor Engels (VK), "es" voor Spaans, enzovoort.
text	string	De uitingstekst.

ConversationalAnalysisAuthoringCreateProjectOptions

Vertegenwoordigt de opties die worden gebruikt om een project te maken of bij te werken.

Name	Type	Description
description	string	De projectbeschrijving.
language	string	De projecttaal. Dit is BCP-47-weergave van een taal. Gebruik bijvoorbeeld "en" voor Engels, "en-gb" voor Engels (VK), "es" voor Spaans, enzovoort.
multilingual	boolean	Of het project nu wordt gebruikt voor meerdere talen of niet.
projectKind	ProjectKind	Vertegenwoordigt het projecttype.
projectName	string	De naam van het nieuwe project.
settings	ConversationalAnalysisAuthoringProjectSettings	De projectinstellingen.

ConversationalAnalysisAuthoringExportedConversationOrchestration

Hiermee definieert u de indelingsdetails voor een Conversational-projectdoel.

Name	Type	Description
deploymentName	string	De naam van de doelimplementatie.
projectName	string	De naam van het doelproject.

ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions

Vertegenwoordigt de indelingsopties voor een Conversational-projectdoel.

Name	Type	Description
conversationOrchestration	ConversationalAnalysisAuthoringExportedConversationOrchestration	De details van het conversationele projectdoel.
targetProjectKind	string: Conversation

ConversationalAnalysisAuthoringExportedEntityList

Vertegenwoordigt een lijstonderdeel van een entiteit.

Name	Type	Description
sublists	ConversationalAnalysisAuthoringExportedEntitySublist[]	De sublijsten van het lijstonderdeel.

ConversationalAnalysisAuthoringExportedEntityListSynonym

Vertegenwoordigt een lijst met synoniemen in een lijstonderdeel

Name	Type	Description
language	string	Vertegenwoordigt de taal van de synoniemen. Dit is BCP-47-weergave van een taal. Gebruik bijvoorbeeld "en" voor Engels, "en-gb" voor Engels (VK), "es" voor Spaans, enzovoort.
values	string[]	De lijst met synoniemen.

ConversationalAnalysisAuthoringExportedEntityRegex

Vertegenwoordigt een regex-onderdeel van een entiteit.

Name	Type	Description
expressions	ConversationalAnalysisAuthoringExportedEntityRegexExpression[]	De regex-expressies van het regex-onderdeel. Deze expressies volgen de .NET regex-syntaxis. Controleer hier ter referentie: https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions

ConversationalAnalysisAuthoringExportedEntityRegexExpression

Vertegenwoordigt een regex-expressie in een regex-onderdeel. Deze expressie volgt de .NET regex-syntaxis. Controleer hier ter referentie: https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions

Name	Type	Description
language	string	Vertegenwoordigt de taal van de regex-expressie. Dit is BCP-47-weergave van een taal. Gebruik bijvoorbeeld "en" voor Engels, "en-gb" voor Engels (VK), "es" voor Spaans, enzovoort.
regexKey	string	De sleutel van de regex-expressie.
regexPattern	string	Het regex-patroon.

ConversationalAnalysisAuthoringExportedEntitySublist

Vertegenwoordigt een sublijst in een lijstonderdeel.

Name	Type	Description
listKey	string	De sleutel van de sublijst.
synonyms	ConversationalAnalysisAuthoringExportedEntityListSynonym[]	De zinnen daarvan komen overeen met de sublijst.

ConversationalAnalysisAuthoringExportedLuisOrchestration

Hiermee definieert u de indelingsdetails voor een LUIS-toepassingsdoel.

Name	Type	Description
appId	string	De LUIS-toepassings-id.
appVersion	string	De doelversie-id.
slotName	string	De naam van de doelsite.

ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions

Vertegenwoordigt de indelingsopties voor een LUIS-toepassingsdoel.

Name	Type	Description
luisOrchestration	ConversationalAnalysisAuthoringExportedLuisOrchestration	De doelgegevens van de LUIS-toepassing.
targetProjectKind	string: Luis

ConversationalAnalysisAuthoringExportedPrebuiltEntity

Vertegenwoordigt een geëxporteerd vooraf gedefinieerd entiteitsonderdeel

Name	Type	Description
category	string	De vooraf gedefinieerde entiteitscategorie.

ConversationalAnalysisAuthoringExportedProject

Vertegenwoordigt een geëxporteerd project.

Name	Type	Description
assets	ConversationalAnalysisAuthoringExportedProjectAssets: ConversationalAnalysisAuthoringConversationExportedProjectAssets ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets	Vertegenwoordigt de projectactiva.
metadata	ConversationalAnalysisAuthoringCreateProjectOptions	Vertegenwoordigt de projectmetagegevens.
projectFileVersion	string	De versie van het geëxporteerde bestand.
stringIndexType	StringIndexType	Hiermee geeft u de methode op die wordt gebruikt om tekenreeksverschuivingen te interpreteren. Zie https://aka.ms/text-analytics-offsetsvoor meer informatie.

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration

Definieert de indelingsdetails voor een vraagantwoordprojectdoel.

Name	Type	Description
projectName	string	De naam van het doelproject.

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions

Vertegenwoordigt de indelingsopties voor een vraagantwoordprojectdoel.

Name	Type	Description
questionAnsweringOrchestration	ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration	De details van het vraagantwoordproject.
targetProjectKind	string: QuestionAnswering

ConversationalAnalysisAuthoringExportedUtteranceEntityLabel

Vertegenwoordigt een entiteitslabel voor een utterance.

Name	Type	Description
category	string	De categorie van het entiteitslabel.
length	integer	Lengte voor de entiteitstekst.
offset	integer	Beginpositie voor de entiteitstekst.

ConversationalAnalysisAuthoringOrchestrationExportedIntent

Vertegenwoordigt een geëxporteerde intentie voor een indelingsproject.

Name	Type	Description
category	string	De intentiecategorie.
orchestration	ConversationalAnalysisAuthoringExportedOrchestrationOptions: ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions	Hiermee geeft u het gedrag van deze intentie in de indelingsstroom.

ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets

Vertegenwoordigt de assets van een indelingsproject.

Name	Type	Description
intents	ConversationalAnalysisAuthoringOrchestrationExportedIntent[]	Vertegenwoordigt de intenties van het project.
projectKind	string: Orchestration	Het type project dat de assets bevat.
utterances	ConversationalAnalysisAuthoringOrchestrationExportedUtterance[]	Vertegenwoordigt de uitingen van het project.

ConversationalAnalysisAuthoringOrchestrationExportedUtterance

Vertegenwoordigt een uiting van een indelingsproject.

Name	Type	Description
dataset	string	De gegevensset voor deze utterance. Toegestane waarden zijn 'Trainen' en 'Testen'.
intent	string	De intentie van de uiting.
language	string	Vertegenwoordigt de taal van de uiting. Dit is BCP-47-weergave van een taal. Gebruik bijvoorbeeld "en" voor Engels, "en-gb" voor Engels (VK), "es" voor Spaans, enzovoort.
text	string	De uitingstekst.

ConversationalAnalysisAuthoringProjectSettings

Vertegenwoordigt de instellingen die worden gebruikt om het projectgedrag te definiëren.

Name	Type	Description
confidenceThreshold	number	De drempelwaarde van de intentie met het hoogste vertrouwen, waarbij de voorspelling automatisch wordt gewijzigd in 'Geen'. De waarde van de drempelwaarde moet tussen 0 en 1 liggen.

Error

Het foutobject.

Name	Type	Description
code	ErrorCode	Een van een door de server gedefinieerde set foutcodes.
details	Error[]	Een matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout.
innererror	InnerErrorModel	Een object met meer specifieke informatie dan het huidige object over de fout.
message	string	Een leesbare weergave van de fout.
target	string	Het doel van de fout.

ErrorCode

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	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.
Luis	string	Hiermee geeft u de indeling op voor een toepassing die is geëxporteerd uit LUIS.

InnerErrorCode

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 meer specifieke 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	InnerErrorCode	Een van een door de server gedefinieerde set foutcodes.
details	object	Foutdetails.
innererror	InnerErrorModel	Een object met meer specifieke informatie dan het huidige object over de fout.
message	string	Foutmelding.
target	string	Foutdoel.

OrchestrationTargetProjectKind

Name	Type	Description
Conversation	string
Luis	string
QuestionAnswering	string

ProjectKind

Name	Type	Description
Conversation	string	Een project voor het bouwen van natuurlijke taal in apps, bots en IoT-apparaten.
Orchestration	string	Een project voor het verbinden en organiseren van gesprekken, aangepaste vragen beantwoorden en LUIS-projecten samen in één project.

StringIndexType

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