Conversational Analysis Authoring - Import

Référence

Service:: Azure AI Services

Version d'API:: 2022-05-01

Déclenche un travail pour importer un projet. Si un projet portant le même nom existe déjà, les données de ce projet sont remplacées.

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

Avec des paramètres facultatifs:

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
Endpoint	path	True	string	Point de terminaison Cognitive Services pris en charge (par exemple, https://.api.cognitiveservices.azure.com).
projectName	path	True	string maxLength: 100	Nom du projet à utiliser.
api-version	query	True	string	Version de l’API cliente.
format	query		ExportedProjectFormat	Format du fichier projet exporté à utiliser.

En-tête de la demande

Nom	Obligatoire	Type	Description
Ocp-Apim-Subscription-Key	True	string	Clé d’abonnement pour une ressource de service de langage.

Corps de la demande

Nom	Obligatoire	Type	Description
metadata	True	ConversationalAnalysisAuthoringCreateProjectOptions	Représente les métadonnées du projet.
projectFileVersion	True	string	Version du fichier exporté.
stringIndexType	True	StringIndexType	Spécifie la méthode utilisée pour interpréter les décalages de chaîne. Pour plus d’informations, consultez https://aka.ms/text-analytics-offsets.
assets		ConversationalAnalysisAuthoringExportedProjectAssets: ConversationalAnalysisAuthoringConversationExportedProjectAssets ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets	Représente les ressources du projet.

Réponses

Nom	Type	Description
202 Accepted		Un appel réussi donne un en-tête Operation-Location utilisé pour vérifier l’état du travail. En-têtes operation-location: string
Other Status Codes	ErrorResponse	Réponse d’erreur.

Nom

Type

Description

202 Accepted

Un appel réussi donne un en-tête Operation-Location utilisé pour vérifier l’état du travail.

En-têtes

operation-location: string

Other Status Codes

ErrorResponse

Réponse d’erreur.

Sécurité

Ocp-Apim-Subscription-Key

Clé d’abonnement pour une ressource de service de langage.

Type: apiKey
Dans: header

Exemples

Successful Import Project

Exemple de requête

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

Exemple de réponse

Code d’état:: 202

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

Définitions

Nom	Description
CompositionSetting	Comportement à suivre lorsque les composants de l’entité se chevauchent les uns avec les autres.
ConversationalAnalysisAuthoringConversationExportedEntity	Représente une entité avec ses composants.
ConversationalAnalysisAuthoringConversationExportedIntent	Représente une intention exportée d’un projet conversationnel.
ConversationalAnalysisAuthoringConversationExportedProjectAssets	Représente les ressources exportées d’un projet conversationnel.
ConversationalAnalysisAuthoringConversationExportedUtterance	Représente un énoncé exporté pour un projet conversationnel.
ConversationalAnalysisAuthoringCreateProjectOptions	Représente les options utilisées pour créer ou mettre à jour un projet.
ConversationalAnalysisAuthoringExportedConversationOrchestration	Définit les détails de l’orchestration d’une cible de projet conversationnel.
ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions	Représente les options d’orchestration d’une cible de projet conversationnel.
ConversationalAnalysisAuthoringExportedEntityList	Représente un composant de liste d’une entité.
ConversationalAnalysisAuthoringExportedEntityListSynonym	Représente une liste de synonymes à l’intérieur d’un composant de liste
ConversationalAnalysisAuthoringExportedEntitySublist	Représente une sous-liste à l’intérieur d’un composant de liste.
ConversationalAnalysisAuthoringExportedLuisOrchestration	Définit les détails de l’orchestration pour une cible d’application LUIS.
ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions	Représente les options d’orchestration d’une cible d’application LUIS.
ConversationalAnalysisAuthoringExportedPrebuiltEntity	Représente un composant d’entité prédéfini exporté
ConversationalAnalysisAuthoringExportedProject	Représente un projet exporté.
ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration	Définit les détails de l’orchestration d’une cible de projet Réponse aux questions.
ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions	Représente les options d’orchestration d’une cible de projet Réponse aux questions.
ConversationalAnalysisAuthoringExportedUtteranceEntityLabel	Représente une étiquette d’entité pour un énoncé.
ConversationalAnalysisAuthoringOrchestrationExportedIntent	Représente une intention exportée pour un projet d’orchestration.
ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets	Représente les ressources d’un projet d’orchestration.
ConversationalAnalysisAuthoringOrchestrationExportedUtterance	Représente un énoncé d’un projet d’orchestration.
ConversationalAnalysisAuthoringProjectSettings	Représente les paramètres utilisés pour définir le comportement du projet.
Error	Objet d’erreur.
ErrorCode	Code d’erreur lisible par l’homme.
ErrorResponse	Réponse d’erreur.
ExportedProjectFormat	Format du fichier projet exporté à utiliser.
InnerErrorCode	Code d’erreur lisible par l’homme.
InnerErrorModel	Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux instructions de l’API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ProjectKind	Représente le type de projet.
StringIndexType	Spécifie la méthode utilisée pour interpréter les décalages de chaîne. Pour plus d’informations, consultez https://aka.ms/text-analytics-offsets.

CompositionSetting

Énumération

Comportement à suivre lorsque les composants de l’entité se chevauchent les uns avec les autres.

Valeur	Description
combineComponents	Lorsque deux composants ou plus sont trouvés dans le texte et se chevauchent, les étendues des composants sont fusionnées en une seule étendue combinant toutes ces étendues.
requireExactOverlap	Tous les composants doivent chevaucher exactement les mêmes caractères dans le texte de l’entité à retourner. Si l’un des composants définis n’est pas mis en correspondance ou prédit, l’entité ne retourne pas.
returnLongestOverlap	Lorsque deux composants ou plus sont trouvés dans le texte et se chevauchent, le composant avec le jeu de caractères le plus long est retourné.
separateComponents	La correspondance ou la prédiction de chaque composant est retournée en tant qu’instance distincte de l’entité.

ConversationalAnalysisAuthoringConversationExportedEntity

Object

Représente une entité avec ses composants.

Nom	Type	Description
category	string	Catégorie de l’entité.
compositionSetting	CompositionSetting	Comportement à suivre lorsque les composants de l’entité se chevauchent les uns avec les autres.
list	ConversationalAnalysisAuthoringExportedEntityList	Composant de liste de l’entité.
prebuilts	ConversationalAnalysisAuthoringExportedPrebuiltEntity[]	Composants d’entités prédéfinies.

ConversationalAnalysisAuthoringConversationExportedIntent

Object

Représente une intention exportée d’un projet conversationnel.

Nom	Type	Description
category	string	Catégorie d’intention.

ConversationalAnalysisAuthoringConversationExportedProjectAssets

Object

Représente les ressources exportées d’un projet conversationnel.

Nom	Type	Description
entities	ConversationalAnalysisAuthoringConversationExportedEntity[]	Entités définies dans le projet.
intents	ConversationalAnalysisAuthoringConversationExportedIntent[]	Intentions définies dans le projet.
projectKind	string: Conversation	Type de projet contenant les ressources.
utterances	ConversationalAnalysisAuthoringConversationExportedUtterance[]	Énoncés définis dans le projet.

ConversationalAnalysisAuthoringConversationExportedUtterance

Object

Représente un énoncé exporté pour un projet conversationnel.

Nom	Type	Description
dataset	string	Jeu de données pour cet énoncé. Les valeurs autorisées sont « Train » et « Test ».
entities	ConversationalAnalysisAuthoringExportedUtteranceEntityLabel[]	Représente les étiquettes d’entité de l’énoncé.
intent	string	Intention de l’énoncé.
language	string	Représente la langue de l’énoncé. Il s’agit de la représentation BCP-47 d’une langue. Par exemple, utilisez « en » pour l’anglais, «en-gb» pour l’anglais (Royaume-Uni), « es » pour l’espagnol, etc.
text	string	Texte d’énoncé.

ConversationalAnalysisAuthoringCreateProjectOptions

Object

Représente les options utilisées pour créer ou mettre à jour un projet.

Nom	Type	Description
description	string	Description du projet.
language	string	Langue du projet. Il s’agit de la représentation BCP-47 d’une langue. Par exemple, utilisez « en » pour l’anglais, «en-gb» pour l’anglais (Royaume-Uni), « es » pour l’espagnol, etc.
multilingual	boolean	Indique si le projet serait utilisé pour plusieurs langues ou non.
projectKind	ProjectKind	Représente le type de projet.
projectName	string	Nouveau nom du projet.
settings	ConversationalAnalysisAuthoringProjectSettings	Paramètres du projet.

ConversationalAnalysisAuthoringExportedConversationOrchestration

Object

Définit les détails de l’orchestration d’une cible de projet conversationnel.

Nom	Type	Description
deploymentName	string	Nom du déploiement ciblé.
projectName	string	Nom du projet ciblé.

ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions

Object

Représente les options d’orchestration d’une cible de projet conversationnel.

Nom	Type	Description
conversationOrchestration	ConversationalAnalysisAuthoringExportedConversationOrchestration	Détails de la cible du projet conversationnel.
targetProjectKind	string: Conversation	Type de la cible utilisée dans le flux d’orchestration.

ConversationalAnalysisAuthoringExportedEntityList

Object

Représente un composant de liste d’une entité.

Nom	Type	Description
sublists	ConversationalAnalysisAuthoringExportedEntitySublist[]	Sous-listes du composant de liste.

ConversationalAnalysisAuthoringExportedEntityListSynonym

Object

Représente une liste de synonymes à l’intérieur d’un composant de liste

Nom	Type	Description
language	string	Représente la langue des synonymes. Il s’agit de la représentation BCP-47 d’une langue. Par exemple, utilisez « en » pour l’anglais, «en-gb» pour l’anglais (Royaume-Uni), « es » pour l’espagnol, etc.
values	string[]	Liste des synonymes.

ConversationalAnalysisAuthoringExportedEntitySublist

Object

Représente une sous-liste à l’intérieur d’un composant de liste.

Nom	Type	Description
listKey	string	Clé de la sous-liste.
synonyms	ConversationalAnalysisAuthoringExportedEntityListSynonym[]	Les expressions de ce qui correspondent à la sous-liste.

ConversationalAnalysisAuthoringExportedLuisOrchestration

Object

Définit les détails de l’orchestration pour une cible d’application LUIS.

Nom	Type	Description
appId	string (uuid)	ID d’application LUIS.
appVersion	string	ID de version ciblé.
slotName	string	Nom de l’emplacement ciblé.

ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions

Object

Représente les options d’orchestration d’une cible d’application LUIS.

Nom	Type	Description
luisOrchestration	ConversationalAnalysisAuthoringExportedLuisOrchestration	Détails de la cible de l’application LUIS.
targetProjectKind	string: Luis	Type de la cible utilisée dans le flux d’orchestration.

ConversationalAnalysisAuthoringExportedPrebuiltEntity

Object

Représente un composant d’entité prédéfini exporté

Nom	Type	Description
category	string	Catégorie d’entité prédéfinie.

ConversationalAnalysisAuthoringExportedProject

Object

Représente un projet exporté.

Nom	Type	Description
assets	ConversationalAnalysisAuthoringExportedProjectAssets: ConversationalAnalysisAuthoringConversationExportedProjectAssets ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets	Représente les ressources du projet.
metadata	ConversationalAnalysisAuthoringCreateProjectOptions	Représente les métadonnées du projet.
projectFileVersion	string	Version du fichier exporté.
stringIndexType	StringIndexType	Spécifie la méthode utilisée pour interpréter les décalages de chaîne. Pour plus d’informations, consultez https://aka.ms/text-analytics-offsets.

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration

Object

Définit les détails de l’orchestration d’une cible de projet Réponse aux questions.

Nom	Type	Description
projectName	string	Nom du projet cible.

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions

Object

Représente les options d’orchestration d’une cible de projet Réponse aux questions.

Nom	Type	Description
questionAnsweringOrchestration	ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration	Détails du projet Réponse aux questions.
targetProjectKind	string: QuestionAnswering	Type de la cible utilisée dans le flux d’orchestration.

ConversationalAnalysisAuthoringExportedUtteranceEntityLabel

Object

Représente une étiquette d’entité pour un énoncé.

Nom	Type	Description
category	string	Catégorie de l’étiquette d’entité.
length	integer (int32)	Longueur du texte de l’entité.
offset	integer (int32)	Position de début du texte de l’entité.

ConversationalAnalysisAuthoringOrchestrationExportedIntent

Object

Représente une intention exportée pour un projet d’orchestration.

Nom	Type	Description
category	string	Catégorie d’intention.
orchestration	ConversationalAnalysisAuthoringExportedOrchestrationOptions: ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions	Spécifie le comportement de cette intention dans le flux d’orchestration.

ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets

Object

Représente les ressources d’un projet d’orchestration.

Nom	Type	Description
intents	ConversationalAnalysisAuthoringOrchestrationExportedIntent[]	Représente les intentions du projet.
projectKind	string: Orchestration	Type de projet contenant les ressources.
utterances	ConversationalAnalysisAuthoringOrchestrationExportedUtterance[]	Représente les énoncés du projet.

ConversationalAnalysisAuthoringOrchestrationExportedUtterance

Object

Représente un énoncé d’un projet d’orchestration.

Nom	Type	Description
dataset	string	Jeu de données pour cet énoncé. Les valeurs autorisées sont « Train » et « Test ».
intent	string	Intention de l’énoncé.
language	string	Représente la langue de l’énoncé. Il s’agit de la représentation BCP-47 d’une langue. Par exemple, utilisez « en » pour l’anglais, «en-gb» pour l’anglais (Royaume-Uni), « es » pour l’espagnol, etc.
text	string	Texte d’énoncé.

ConversationalAnalysisAuthoringProjectSettings

Object

Représente les paramètres utilisés pour définir le comportement du projet.

Nom	Type	Description
confidenceThreshold	number (float)	Seuil de l’intention avec la confiance la plus élevée, auquel la prédiction sera automatiquement remplacée par « Aucun ».

Error

Object

Objet d’erreur.

Nom	Type	Description
code	ErrorCode	Un ensemble de codes d’erreur définis par le serveur.
details	Error[]	Tableau de détails sur des erreurs spécifiques qui ont conduit à cette erreur signalée.
innererror	InnerErrorModel	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.
message	string	Représentation lisible par l’homme de l’erreur.
target	string	Cible de l’erreur.

ErrorCode

Énumération

Code d’erreur lisible par l’homme.

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

ErrorResponse

Object

Réponse d’erreur.

Nom	Type	Description
error	Error	Objet d’erreur.

ExportedProjectFormat

Énumération

Format du fichier projet exporté à utiliser.

Valeur	Description
Conversation	Spécifie le format d’un projet conversationnel.
Luis	Spécifie le format d’une application exportée à partir de LUIS.

InnerErrorCode

Énumération

Code d’erreur lisible par l’homme.

Valeur	Description
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
EmptyRequest
ExtractionFailure
InvalidCountryHint
InvalidDocument
InvalidDocumentBatch
InvalidParameterValue
InvalidRequest
InvalidRequestBodyFormat
KnowledgeBaseNotFound
MissingInputDocuments
ModelVersionIncorrect
UnsupportedLanguageCode

InnerErrorModel

Object

Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux instructions de l’API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nom	Type	Description
code	InnerErrorCode	Un ensemble de codes d’erreur définis par le serveur.
details	object	Détails de l’erreur.
innererror	InnerErrorModel	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.
message	string	Message d'erreur.
target	string	Cible d’erreur.

ProjectKind

Énumération

Représente le type de projet.

Valeur	Description
Conversation	Projet de création d’un langage naturel dans des applications, des bots et des appareils IoT.
Orchestration	Un projet pour connecter et orchestrer conversation, réponses aux questions personnalisées et projets LUIS ensemble dans un seul projet.

StringIndexType

Énumération

Spécifie la méthode utilisée pour interpréter les décalages de chaîne. Pour plus d’informations, consultez https://aka.ms/text-analytics-offsets.

Valeur	Description
Utf16CodeUnit	Les valeurs de décalage et de longueur correspondent aux unités de code UTF-16. Utilisez cette option si votre application est écrite dans un langage qui prend en charge Unicode, par exemple JavaScript.

Partager via

Conversational Analysis Authoring - Import

Paramètres URI

En-tête de la demande

Corps de la demande

Réponses

Sécurité

Ocp-Apim-Subscription-Key

Exemples

Successful Import Project

Exemple de requête

Exemple de réponse

Définitions

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