Conversational Analysis Authoring - Import

Referentie

Service:: Azure AI Services

API-versie:: 2022-05-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=2022-05-01

Met optionele parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
Endpoint	path	True	string	Ondersteund Cognitive Services-eindpunt (bijvoorbeeld https://.api.cognitiveservices.azure.com).
projectName	path	True	string	De naam van het project dat moet worden gebruikt.
api-version	query	True	string	Client-API-versie.
format	query		ExportedProjectFormat	De indeling van het geëxporteerde projectbestand dat moet worden gebruikt.

Aanvraagkoptekst

Name	Vereist	Type	Description
Ocp-Apim-Subscription-Key	True	string	Een abonnementssleutel voor een taalserviceresource.

Aanvraagbody

Name	Vereist	Type	Description
metadata	True	ConversationalAnalysisAuthoringCreateProjectOptions	Vertegenwoordigt de metagegevens van het project.
projectFileVersion	True	string	De versie van het geëxporteerde bestand.
stringIndexType	True	StringIndexType	Hiermee geeft u de methode die wordt gebruikt voor het interpreteren van tekenreeks offsets. Zie voor meer informatie https://aka.ms/text-analytics-offsets.
assets		ConversationalAnalysisAuthoringExportedProjectAssets: ConversationalAnalysisAuthoringConversationExportedProjectAssets ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets	Vertegenwoordigt de projectassets.

Antwoorden

Name	Type	Description
202 Accepted		Een geslaagde aanroep resulteert in een Operation-Location header die wordt gebruikt om de status van de taak te controleren. Kopteksten operation-location: string
Other Status Codes	ErrorResponse	Foutreactie.

Name

Type

Description

202 Accepted

Een geslaagde aanroep resulteert in een Operation-Location header die wordt gebruikt om de status van de taak te controleren.

Kopteksten

operation-location: string

Other Status Codes

ErrorResponse

Foutreactie.

Beveiliging

Ocp-Apim-Subscription-Key

Een abonnementssleutel voor een taalserviceresource.

Type: apiKey
In: header

Voorbeelden

Successful Import Project

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:: 202

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

Definities

Name	Description
CompositionSetting	Het gedrag dat moet worden gevolgd wanneer de onderdelen van de entiteit elkaar overlappen.
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	Definieert de indelingsdetails voor een gespreksprojectdoel.
ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions	Vertegenwoordigt de indelingsopties voor een gespreksprojectdoel.
ConversationalAnalysisAuthoringExportedEntityList	Vertegenwoordigt een lijstonderdeel van een entiteit.
ConversationalAnalysisAuthoringExportedEntityListSynonym	Vertegenwoordigt een lijst met synoniemen in een lijstonderdeel
ConversationalAnalysisAuthoringExportedEntitySublist	Vertegenwoordigt een sublijst in een lijstonderdeel.
ConversationalAnalysisAuthoringExportedLuisOrchestration	Definieert de indelingsdetails voor een LUIS-toepassingsdoel.
ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions	Vertegenwoordigt de indelingsopties voor een LUIS-toepassingsdoel.
ConversationalAnalysisAuthoringExportedPrebuiltEntity	Vertegenwoordigt een geëxporteerd vooraf samengesteld entiteitsonderdeel
ConversationalAnalysisAuthoringExportedProject	Vertegenwoordigt een geëxporteerd project.
ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration	Definieert de indelingsdetails voor een projectdoel voor het beantwoorden van vragen.
ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions	Vertegenwoordigt de indelingsopties voor een projectdoel voor het beantwoorden van vragen.
ConversationalAnalysisAuthoringExportedUtteranceEntityLabel	Vertegenwoordigt een entiteitslabel voor een uiting.
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 gedrag van het project te definiëren.
Error	Het foutobject.
ErrorCode	Door mensen leesbare foutcode.
ErrorResponse	Foutreactie.
ExportedProjectFormat	De indeling van het geëxporteerde projectbestand dat moet worden gebruikt.
InnerErrorCode	Door mensen leesbare foutcode.
InnerErrorModel	Een object met specifiekere 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.
ProjectKind	Vertegenwoordigt het soort project.
StringIndexType	Hiermee geeft u de methode op die wordt gebruikt voor het interpreteren van tekenreeks offsets. Zie voor meer informatie https://aka.ms/text-analytics-offsets.

CompositionSetting

Het gedrag dat moet worden gevolgd wanneer de onderdelen van de entiteit elkaar overlappen.

Name	Type	Description
combineComponents	string	Wanneer er twee of meer onderdelen in de tekst worden gevonden en elkaar overlappen, worden de spanten van de onderdelen samengevoegd tot één span waarin ze allemaal worden gecombineerd.
requireExactOverlap	string	Alle onderdelen moeten elkaar overlappen met exact dezelfde tekens in de tekst om de entiteit te retourneren. Als een van de gedefinieerde onderdelen niet overeenkomt of wordt voorspeld, retourneert de entiteit niet.
returnLongestOverlap	string	Wanneer er twee of meer onderdelen in de tekst worden gevonden en elkaar 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 samengestelde entiteitenonderdelen.

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 activa bevat.
utterances	ConversationalAnalysisAuthoringConversationExportedUtterance[]	De utterances die in het project zijn gedefinieerd.

ConversationalAnalysisAuthoringConversationExportedUtterance

Vertegenwoordigt een geëxporteerde uiting voor een gespreksproject.

Name	Type	Description
dataset	string	De gegevensset voor deze uiting. 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 voor meerdere talen wordt gebruikt of niet.
projectKind	ProjectKind	Vertegenwoordigt het soort project.
projectName	string	De nieuwe projectnaam.
settings	ConversationalAnalysisAuthoringProjectSettings	De projectinstellingen.

ConversationalAnalysisAuthoringExportedConversationOrchestration

Definieert de indelingsdetails voor een gespreksprojectdoel.

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

ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions

Vertegenwoordigt de indelingsopties voor een gespreksprojectdoel.

Name	Type	Description
conversationOrchestration	ConversationalAnalysisAuthoringExportedConversationOrchestration	De doelgegevens van het gespreksproject.
targetProjectKind	string: Conversation	Het type doel dat wordt gebruikt in de indelingsstroom.

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

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

Definieert 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	Het type doel dat wordt gebruikt in de indelingsstroom.

ConversationalAnalysisAuthoringExportedPrebuiltEntity

Vertegenwoordigt een geëxporteerd vooraf samengesteld 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 projectassets.
metadata	ConversationalAnalysisAuthoringCreateProjectOptions	Vertegenwoordigt de metagegevens van het project.
projectFileVersion	string	De versie van het geëxporteerde bestand.
stringIndexType	StringIndexType	Hiermee geeft u de methode op die wordt gebruikt voor het interpreteren van tekenreeks offsets. Zie voor meer informatie https://aka.ms/text-analytics-offsets.

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration

Definieert de indelingsdetails voor een projectdoel voor het beantwoorden van vragen.

Name	Type	Description
projectName	string	De naam van het doelproject.

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions

Vertegenwoordigt de indelingsopties voor een projectdoel voor het beantwoorden van vragen.

Name	Type	Description
questionAnsweringOrchestration	ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration	De details van het project Vraag beantwoorden.
targetProjectKind	string: QuestionAnswering	Het type doel dat wordt gebruikt in de indelingsstroom.

ConversationalAnalysisAuthoringExportedUtteranceEntityLabel

Vertegenwoordigt een entiteitslabel voor een uiting.

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

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 activa 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 uiting. 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 gedrag van het project te definiëren.

Name	Type	Description
confidenceThreshold	number	De drempelwaarde van de intentie met de hoogste betrouwbaarheid, waarbij de voorspelling automatisch wordt gewijzigd in 'Geen'.

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 tot deze gerapporteerde fout hebben geleid.
innererror	InnerErrorModel	Een object met specifiekere informatie dan het huidige object over de fout.
message	string	Een door mensen leesbare weergave van de fout.
target	string	Het doel van de fout.

ErrorCode

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

InnerErrorCode

Door mensen 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 specifiekere 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 specifiekere informatie dan het huidige object over de fout.
message	string	Foutbericht.
target	string	Foutdoel.

ProjectKind

Vertegenwoordigt het soort project.

Name	Type	Description
Conversation	string	Een project om natuurlijke taal in te bouwen in apps, bots en IoT-apparaten.
Orchestration	string	Een project om gesprekken, aangepaste vraagantwoorden en LUIS-projecten te verbinden en te organiseren in één project.

StringIndexType

Hiermee geeft u de methode op die wordt gebruikt voor het interpreteren van tekenreeks offsets. Zie voor meer informatie https://aka.ms/text-analytics-offsets.

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

Delen via

Conversational Analysis Authoring - Import

URI-parameters

Aanvraagkoptekst

Aanvraagbody

Antwoorden

Beveiliging

Ocp-Apim-Subscription-Key

Voorbeelden

Successful Import Project

Voorbeeldaanvraag

Voorbeeldrespons

Definities

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

Aanvullende resources