Partager via


Conversational Analysis Authoring - Import

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=2023-04-01
POST {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/:import?format={format}&api-version=2023-04-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

Nom du projet à utiliser.

api-version
query True

string

Version d’API client.

format
query

ExportedProjectFormat

Format du fichier projet exporté à utiliser.

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:

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.

Sécurité

AADToken

Il s’agit des flux OAuth2 Azure Active Directory . Lorsqu’il est associé au contrôle d’accès en fonction du rôle Azure, il peut être utilisé pour contrôler l’accès à Azure Maps API REST. Les contrôles d’accès en fonction du rôle Azure sont utilisés pour désigner l’accès à un ou plusieurs Azure Maps compte de ressource ou sous-ressources. Tout utilisateur, groupe ou principal de service peut se voir accorder l’accès via un rôle intégré ou un rôle personnalisé composé d’une ou plusieurs autorisations pour Azure Maps API REST.

Pour implémenter des scénarios, nous vous recommandons d’afficher les concepts d’authentification. En résumé, cette définition de sécurité fournit une solution pour modéliser des applications via des objets capables de contrôler l’accès sur des API et des étendues spécifiques.

Notes

  • Cette définition de sécurité nécessite l’utilisation de l’en-tête x-ms-client-id pour indiquer à quelle ressource Azure Maps l’application demande l’accès. Vous pouvez l’acquérir à partir de l’API de gestion maps.

est Authorization URL spécifique au cloud public Azure instance. Les clouds souverains ont des URL d’autorisation uniques et des configurations Azure Active Directory. * Le contrôle d’accès en fonction du rôle Azure est configuré à partir du plan de gestion Azure via Portail Azure, PowerShell, CLI, kits SDK Azure ou API REST. * L’utilisation du Kit de développement logiciel (SDK) web Azure Maps permet une configuration basée sur la configuration d’une application pour plusieurs cas d’usage.

  • Actuellement, Azure Active Directory v1.0 ou v2.0 prend en charge les comptes professionnels, scolaires et invités, mais ne prend pas en charge les comptes personnels.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

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

Ocp-Apim-Subscription-Key

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

Type: apiKey
Dans: header

Exemples

Successful Import Project

Exemple de requête

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

Exemple de réponse

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

Définitions

Nom Description
CompositionSetting

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

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 d’orchestration d’une cible de projet conversationnel.

ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions

Représente les options d’orchestration pour 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

ConversationalAnalysisAuthoringExportedEntityRegex

Représente un composant regex d’une entité.

ConversationalAnalysisAuthoringExportedEntityRegexExpression

Représente une expression regex à l’intérieur d’un composant regex. Cette expression suit la syntaxe regex .NET. Pour référence, case activée ici :https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions

ConversationalAnalysisAuthoringExportedEntitySublist

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

ConversationalAnalysisAuthoringExportedLuisOrchestration

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

ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions

Représente les options d’orchestration pour 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 d’orchestration d’une cible de projet de réponses aux questions.

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions

Représente les options d’orchestration d’une cible de projet de réponses 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 error.

ErrorCode

Code d’erreur lisible par l’utilisateur.

ErrorResponse

Réponse d’erreur.

ExportedProjectFormat

Format du fichier projet exporté à utiliser.

InnerErrorCode

Code d’erreur lisible par l’utilisateur.

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

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

Nom Type Description
combineComponents

string

Lorsque deux ou plusieurs composants se trouvent dans le texte et se chevauchent, les étendues des composants sont fusionnées en une seule étendue combinant tous les composants.

requireExactOverlap

string

Tous les composants doivent se chevaucher exactement au niveau des mêmes caractères dans le texte pour que l’entité soit retournée. Si l’un des composants définis n’est pas mis en correspondance ou prédit, l’entité n’est pas retournée.

returnLongestOverlap

string

Lorsque plusieurs composants sont trouvés dans le texte et se chevauchent, le composant avec l’ensemble de caractères le plus long est retourné.

separateComponents

string

La correspondance ou la prédiction de chaque composant est retournée en tant qu’instance distincte de l’entité.

ConversationalAnalysisAuthoringConversationExportedEntity

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.

list

ConversationalAnalysisAuthoringExportedEntityList

Composant de liste de l’entité.

prebuilts

ConversationalAnalysisAuthoringExportedPrebuiltEntity[]

Composants d’entités prédéfinies.

regex

ConversationalAnalysisAuthoringExportedEntityRegex

Composant regex de l’entité.

requiredComponents

string[]

Composants requis. Les valeurs autorisées sont « learned », « list », « prebuilts » et « regex ».

ConversationalAnalysisAuthoringConversationExportedIntent

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

Nom Type Description
category

string

Catégorie d’intention.

ConversationalAnalysisAuthoringConversationExportedProjectAssets

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

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 de l’énoncé.

ConversationalAnalysisAuthoringCreateProjectOptions

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 doit être utilisé pour plusieurs langues ou non.

projectKind

ProjectKind

Représente le type de projet.

projectName

string

Nom du nouveau projet.

settings

ConversationalAnalysisAuthoringProjectSettings

Paramètres du projet.

ConversationalAnalysisAuthoringExportedConversationOrchestration

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

Nom Type Description
deploymentName

string

Nom du déploiement ciblé.

projectName

string

Nom du projet ciblé.

ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions

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

Nom Type Description
conversationOrchestration

ConversationalAnalysisAuthoringExportedConversationOrchestration

Détails de la cible du projet conversationnel.

targetProjectKind string:

Conversation

Type de cible utilisé dans le flux d’orchestration.

ConversationalAnalysisAuthoringExportedEntityList

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

Nom Type Description
sublists

ConversationalAnalysisAuthoringExportedEntitySublist[]

Sous-listes du composant de liste.

ConversationalAnalysisAuthoringExportedEntityListSynonym

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

ConversationalAnalysisAuthoringExportedEntityRegex

Représente un composant regex d’une entité.

Nom Type Description
expressions

ConversationalAnalysisAuthoringExportedEntityRegexExpression[]

Expressions regex du composant regex. Ces expressions suivent la syntaxe regex .NET. Pour référence, case activée ici :https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions

ConversationalAnalysisAuthoringExportedEntityRegexExpression

Représente une expression regex à l’intérieur d’un composant regex. Cette expression suit la syntaxe regex .NET. Pour référence, case activée ici :https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions

Nom Type Description
language

string

Représente la langue de l’expression regex. 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.

regexKey

string

Clé de l’expression regex.

regexPattern

string

Modèle regex.

ConversationalAnalysisAuthoringExportedEntitySublist

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[]

Expressions de qui correspondent à la sous-liste.

ConversationalAnalysisAuthoringExportedLuisOrchestration

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

Nom Type Description
appId

string

ID d’application LUIS.

appVersion

string

ID de version ciblée.

slotName

string

Nom de l’emplacement ciblé.

ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions

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

Nom Type Description
luisOrchestration

ConversationalAnalysisAuthoringExportedLuisOrchestration

Détails de la cible de l’application LUIS.

targetProjectKind string:

Luis

Type de cible utilisé dans le flux d’orchestration.

ConversationalAnalysisAuthoringExportedPrebuiltEntity

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

Nom Type Description
category

string

Catégorie d’entité prédéfinie.

ConversationalAnalysisAuthoringExportedProject

Représente un projet exporté.

Nom Type Description
assets ConversationalAnalysisAuthoringExportedProjectAssets:

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

Définit les détails d’orchestration d’une cible de projet de réponses aux questions.

Nom Type Description
projectName

string

Nom du projet cible.

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions

Représente les options d’orchestration d’une cible de projet de réponses aux questions.

Nom Type Description
questionAnsweringOrchestration

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration

Détails du projet De réponse aux questions.

targetProjectKind string:

QuestionAnswering

Type de cible utilisé dans le flux d’orchestration.

ConversationalAnalysisAuthoringExportedUtteranceEntityLabel

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

Nom Type Description
category

string

Catégorie de l’étiquette d’entité.

length

integer

Longueur du texte de l’entité.

offset

integer

Position de début du texte de l’entité.

ConversationalAnalysisAuthoringOrchestrationExportedIntent

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

Nom Type Description
category

string

Catégorie d’intention.

orchestration ConversationalAnalysisAuthoringExportedOrchestrationOptions:

Spécifie le comportement de cette intention dans le flux d’orchestration.

ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets

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

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 de l’énoncé.

ConversationalAnalysisAuthoringProjectSettings

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

Nom Type Description
confidenceThreshold

number

Seuil de l’intention avec le niveau de confiance le plus élevé, auquel la prédiction sera automatiquement remplacée par « Aucun ». La valeur du seuil doit être comprise entre 0 et 1 inclus.

Error

Objet error.

Nom Type Description
code

ErrorCode

Un des ensembles de codes d’erreur définis par le serveur.

details

Error[]

Tableau de détails sur les 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 de l’erreur.

target

string

Cible de l’erreur.

ErrorCode

Code d’erreur lisible par l’utilisateur.

Nom 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

Réponse d’erreur.

Nom Type Description
error

Error

Objet error.

ExportedProjectFormat

Format du fichier projet exporté à utiliser.

Nom Type Description
Conversation

string

Spécifie le format d’un projet conversationnel.

Luis

string

Spécifie le format d’une application qui a été exportée à partir de LUIS.

InnerErrorCode

Code d’erreur lisible par l’utilisateur.

Nom 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

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 des ensembles 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

Représente le type de projet.

Nom Type Description
Conversation

string

Un projet pour créer un langage naturel dans des applications, des bots et des appareils IoT.

Orchestration

string

Un projet pour connecter et orchestrer des projets Conversation, Réponses aux questions personnalisées et LUIS dans un seul 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.

Nom Type Description
Utf16CodeUnit

string

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