Conversational Analysis Authoring - Import

Riferimento

Servizio:: Azure AI Services

Versione API:: 2023-04-01

Attiva un processo per importare un progetto. Se esiste già un progetto con lo stesso nome, i dati del progetto vengono sostituiti.

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

Con parametri facoltativi:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
Endpoint	path	True	string
projectName	path	True	string	Nome del progetto da utilizzare.
api-version	query	True	string	Versione dell'API da usare per questa operazione.
format	query		ExportedProjectFormat	Formato del file di progetto esportato da utilizzare.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
metadata	True	ConversationalAnalysisAuthoringCreateProjectOptions	Rappresenta i metadati del progetto.
projectFileVersion	True	string	Versione del file esportato.
stringIndexType	True	StringIndexType	Specifica il metodo utilizzato per interpretare gli offset di stringa. Per altre informazioni, vedere https://aka.ms/text-analytics-offsets.
assets		ConversationalAnalysisAuthoringExportedProjectAssets: ConversationalAnalysisAuthoringConversationExportedProjectAssets ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets	Rappresenta gli asset del progetto.

Risposte

Nome	Tipo	Descrizione
202 Accepted		La richiesta è stata accettata per l'elaborazione, ma l'elaborazione non è ancora stata completata. Intestazioni Operation-Location: string
Other Status Codes	ErrorResponse	Risposta di errore imprevista.

Nome

Tipo

Descrizione

202 Accepted

La richiesta è stata accettata per l'elaborazione, ma l'elaborazione non è ancora stata completata.

Intestazioni

Operation-Location: string

Other Status Codes

ErrorResponse

Risposta di errore imprevista.

Sicurezza

Ocp-Apim-Subscription-Key

Tipo: apiKey
In: header

OAuth2Auth

Tipo: oauth2
Flow: accessCode
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize
URL token: https://login.microsoftonline.com/common/oauth2/token

Ambiti

Nome	Descrizione
https://cognitiveservices.azure.com/.default

Esempio

Successful Import Project

Esempio di richiesta

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

Risposta di esempio

Codice di stato:: 202

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

Definizioni

Nome	Descrizione
CompositionSetting
ConversationalAnalysisAuthoringConversationExportedEntity	Rappresenta un'entità con i relativi componenti.
ConversationalAnalysisAuthoringConversationExportedIntent	Rappresenta una finalità esportata di un progetto di conversazione.
ConversationalAnalysisAuthoringConversationExportedProjectAssets	Rappresenta gli asset esportati di un progetto di conversazione.
ConversationalAnalysisAuthoringConversationExportedUtterance	Rappresenta un'espressione esportata per un progetto di conversazione.
ConversationalAnalysisAuthoringCreateProjectOptions	Rappresenta le opzioni utilizzate per creare o aggiornare un progetto.
ConversationalAnalysisAuthoringExportedConversationOrchestration	Definisce i dettagli dell'orchestrazione per una destinazione di progetto conversazionale.
ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions	Rappresenta le opzioni di orchestrazione per una destinazione di progetto conversazionale.
ConversationalAnalysisAuthoringExportedEntityList	Rappresenta un componente elenco di un'entità.
ConversationalAnalysisAuthoringExportedEntityListSynonym	Rappresenta un elenco di sinonimi all'interno di un componente elenco
ConversationalAnalysisAuthoringExportedEntityRegex	Rappresenta un componente regex di un'entità.
ConversationalAnalysisAuthoringExportedEntityRegexExpression	Rappresenta un'espressione regex all'interno di un componente regex. Questa espressione segue la sintassi regex .NET. Per riferimento, vedere qui: https://video2.skills-academy.com/dotnet/standard/base-types/regular-expressions
ConversationalAnalysisAuthoringExportedEntitySublist	Rappresenta un sotto-elenco all'interno di un componente elenco.
ConversationalAnalysisAuthoringExportedLuisOrchestration	Definisce i dettagli dell'orchestrazione per una destinazione dell'applicazione LUIS.
ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions	Rappresenta le opzioni di orchestrazione per una destinazione dell'applicazione LUIS.
ConversationalAnalysisAuthoringExportedPrebuiltEntity	Rappresenta un componente entità predefinito esportato
ConversationalAnalysisAuthoringExportedProject	Rappresenta un progetto esportato.
ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration	Definisce i dettagli dell'orchestrazione per una destinazione del progetto Di risposta alle domande.
ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions	Rappresenta le opzioni di orchestrazione per una destinazione del progetto Di risposta alle domande.
ConversationalAnalysisAuthoringExportedUtteranceEntityLabel	Rappresenta un'etichetta di entità per un'espressione.
ConversationalAnalysisAuthoringOrchestrationExportedIntent	Rappresenta una finalità esportata per un progetto di orchestrazione.
ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets	Rappresenta gli asset di un progetto di orchestrazione.
ConversationalAnalysisAuthoringOrchestrationExportedUtterance	Rappresenta un'espressione di un progetto di orchestrazione.
ConversationalAnalysisAuthoringProjectSettings	Rappresenta le impostazioni utilizzate per definire il comportamento del progetto.
Error	Oggetto error.
ErrorCode	Codice di errore leggibile.
ErrorResponse	Risposta di errore.
ExportedProjectFormat	Formato del file di progetto esportato da utilizzare.
InnerErrorCode	Codice di errore leggibile.
InnerErrorModel	Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API Microsoft One , https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
OrchestrationTargetProjectKind
ProjectKind
StringIndexType

CompositionSetting

Nome	Tipo	Descrizione
combineComponents	string	Quando due o più componenti si trovano nel testo e si sovrappongono, gli intervalli dei componenti vengono uniti in un unico intervallo che li combina tutti.
requireExactOverlap	string	Per restituire l'entità, tutti i componenti devono sovrapporsi esattamente agli stessi caratteri del testo. Se uno dei componenti definiti non corrisponde o è previsto, l'entità non restituirà.
returnLongestOverlap	string	Quando due o più componenti si trovano nel testo e si sovrappongono, viene restituito il componente con il set di caratteri più lungo.
separateComponents	string	La corrispondenza o la stima di ogni componente viene restituita come istanza separata dell'entità.

ConversationalAnalysisAuthoringConversationExportedEntity

Rappresenta un'entità con i relativi componenti.

Nome	Tipo	Descrizione
category	string	Categoria dell'entità.
compositionSetting	CompositionSetting	Comportamento da seguire quando i componenti dell'entità si sovrappongono tra loro.
list	ConversationalAnalysisAuthoringExportedEntityList	Componente elenco dell'entità.
prebuilts	ConversationalAnalysisAuthoringExportedPrebuiltEntity[]	Componenti delle entità predefinite.
regex	ConversationalAnalysisAuthoringExportedEntityRegex	Componente regex dell'entità.
requiredComponents	string[]	Componenti necessari. I valori consentiti sono 'learned', 'list', 'prebuilts' e 'regex'.

ConversationalAnalysisAuthoringConversationExportedIntent

Rappresenta una finalità esportata di un progetto di conversazione.

Nome	Tipo	Descrizione
category	string	Categoria di finalità.

ConversationalAnalysisAuthoringConversationExportedProjectAssets

Rappresenta gli asset esportati di un progetto di conversazione.

Nome	Tipo	Descrizione
entities	ConversationalAnalysisAuthoringConversationExportedEntity[]	Entità definite nel progetto.
intents	ConversationalAnalysisAuthoringConversationExportedIntent[]	Finalità definite nel progetto.
projectKind	string: Conversation	Tipo di progetto contenente gli asset.
utterances	ConversationalAnalysisAuthoringConversationExportedUtterance[]	Espressioni definite nel progetto.

ConversationalAnalysisAuthoringConversationExportedUtterance

Rappresenta un'espressione esportata per un progetto di conversazione.

Nome	Tipo	Descrizione
dataset	string	Set di dati per questa espressione. I valori consentiti sono 'Train' e 'Test'.
entities	ConversationalAnalysisAuthoringExportedUtteranceEntityLabel[]	Rappresenta le etichette di entità dell'espressione.
intent	string	Finalità dell'espressione.
language	string	Rappresenta la lingua dell'espressione. Si tratta della rappresentazione BCP-47 di una lingua. Ad esempio, usare "en" per l'inglese, "en-gb" per l'inglese (Regno Unito), "es" per lo spagnolo e così via.
text	string	Testo dell'espressione.

ConversationalAnalysisAuthoringCreateProjectOptions

Rappresenta le opzioni utilizzate per creare o aggiornare un progetto.

Nome	Tipo	Descrizione
description	string	Descrizione del progetto.
language	string	Linguaggio del progetto. Si tratta della rappresentazione BCP-47 di una lingua. Ad esempio, usare "en" per l'inglese, "en-gb" per l'inglese (Regno Unito), "es" per lo spagnolo e così via.
multilingual	boolean	Indica se il progetto verrà usato o meno per più lingue.
projectKind	ProjectKind	Rappresenta il tipo di progetto.
projectName	string	Nome del nuovo progetto.
settings	ConversationalAnalysisAuthoringProjectSettings	Impostazioni del progetto.

ConversationalAnalysisAuthoringExportedConversationOrchestration

Definisce i dettagli dell'orchestrazione per una destinazione di progetto conversazionale.

Nome	Tipo	Descrizione
deploymentName	string	Nome della distribuzione di destinazione.
projectName	string	Nome del progetto di destinazione.

ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions

Rappresenta le opzioni di orchestrazione per una destinazione di progetto conversazionale.

Nome	Tipo	Descrizione
conversationOrchestration	ConversationalAnalysisAuthoringExportedConversationOrchestration	Dettagli della destinazione del progetto conversazionale.
targetProjectKind	string: Conversation

ConversationalAnalysisAuthoringExportedEntityList

Rappresenta un componente elenco di un'entità.

Nome	Tipo	Descrizione
sublists	ConversationalAnalysisAuthoringExportedEntitySublist[]	Elenchi secondari del componente elenco.

ConversationalAnalysisAuthoringExportedEntityListSynonym

Rappresenta un elenco di sinonimi all'interno di un componente elenco

Nome	Tipo	Descrizione
language	string	Rappresenta la lingua dei sinonimi. Si tratta della rappresentazione BCP-47 di una lingua. Ad esempio, usare "en" per l'inglese, "en-gb" per l'inglese (Regno Unito), "es" per lo spagnolo e così via.
values	string[]	Elenco di sinonimi.

ConversationalAnalysisAuthoringExportedEntityRegex

Rappresenta un componente regex di un'entità.

Nome	Tipo	Descrizione
expressions	ConversationalAnalysisAuthoringExportedEntityRegexExpression[]	Espressioni regex del componente regex. Queste espressioni seguono la sintassi regex .NET. Per riferimento, vedere qui: https://video2.skills-academy.com/dotnet/standard/base-types/regular-expressions

ConversationalAnalysisAuthoringExportedEntityRegexExpression

Rappresenta un'espressione regex all'interno di un componente regex. Questa espressione segue la sintassi regex .NET. Per riferimento, vedere qui: https://video2.skills-academy.com/dotnet/standard/base-types/regular-expressions

Nome	Tipo	Descrizione
language	string	Rappresenta la lingua dell'espressione regex. Si tratta della rappresentazione BCP-47 di una lingua. Ad esempio, usare "en" per l'inglese, "en-gb" per l'inglese (Regno Unito), "es" per lo spagnolo e così via.
regexKey	string	Chiave dell'espressione regex.
regexPattern	string	Modello regex.

ConversationalAnalysisAuthoringExportedEntitySublist

Rappresenta un sotto-elenco all'interno di un componente elenco.

Nome	Tipo	Descrizione
listKey	string	Chiave dell'elenco secondario.
synonyms	ConversationalAnalysisAuthoringExportedEntityListSynonym[]	Frasi di che corrispondono all'elenco secondario.

ConversationalAnalysisAuthoringExportedLuisOrchestration

Definisce i dettagli dell'orchestrazione per una destinazione dell'applicazione LUIS.

Nome	Tipo	Descrizione
appId	string	ID applicazione LUIS.
appVersion	string	ID versione di destinazione.
slotName	string	Nome dello slot di destinazione.

ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions

Rappresenta le opzioni di orchestrazione per una destinazione dell'applicazione LUIS.

Nome	Tipo	Descrizione
luisOrchestration	ConversationalAnalysisAuthoringExportedLuisOrchestration	Dettagli della destinazione dell'applicazione LUIS.
targetProjectKind	string: Luis

ConversationalAnalysisAuthoringExportedPrebuiltEntity

Rappresenta un componente entità predefinito esportato

Nome	Tipo	Descrizione
category	string	Categoria di entità predefinita.

ConversationalAnalysisAuthoringExportedProject

Rappresenta un progetto esportato.

Nome	Tipo	Descrizione
assets	ConversationalAnalysisAuthoringExportedProjectAssets: ConversationalAnalysisAuthoringConversationExportedProjectAssets ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets	Rappresenta gli asset del progetto.
metadata	ConversationalAnalysisAuthoringCreateProjectOptions	Rappresenta i metadati del progetto.
projectFileVersion	string	Versione del file esportato.
stringIndexType	StringIndexType	Specifica il metodo utilizzato per interpretare gli offset di stringa. Per altre informazioni, vedere https://aka.ms/text-analytics-offsets.

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration

Definisce i dettagli dell'orchestrazione per una destinazione del progetto Di risposta alle domande.

Nome	Tipo	Descrizione
projectName	string	Nome del progetto di destinazione.

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions

Rappresenta le opzioni di orchestrazione per una destinazione del progetto Di risposta alle domande.

Nome	Tipo	Descrizione
questionAnsweringOrchestration	ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration	Dettagli del progetto Di risposta alle domande.
targetProjectKind	string: QuestionAnswering

ConversationalAnalysisAuthoringExportedUtteranceEntityLabel

Rappresenta un'etichetta di entità per un'espressione.

Nome	Tipo	Descrizione
category	string	Categoria dell'etichetta dell'entità.
length	integer	Lunghezza per il testo dell'entità.
offset	integer	Posizione iniziale per il testo dell'entità.

ConversationalAnalysisAuthoringOrchestrationExportedIntent

Rappresenta una finalità esportata per un progetto di orchestrazione.

Nome	Tipo	Descrizione
category	string	Categoria di finalità.
orchestration	ConversationalAnalysisAuthoringExportedOrchestrationOptions: ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions	Specifica il comportamento di questa finalità nel flusso di orchestrazione.

ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets

Rappresenta gli asset di un progetto di orchestrazione.

Nome	Tipo	Descrizione
intents	ConversationalAnalysisAuthoringOrchestrationExportedIntent[]	Rappresenta le finalità del progetto.
projectKind	string: Orchestration	Tipo di progetto contenente gli asset.
utterances	ConversationalAnalysisAuthoringOrchestrationExportedUtterance[]	Rappresenta le espressioni del progetto.

ConversationalAnalysisAuthoringOrchestrationExportedUtterance

Rappresenta un'espressione di un progetto di orchestrazione.

Nome	Tipo	Descrizione
dataset	string	Set di dati per questa espressione. I valori consentiti sono 'Train' e 'Test'.
intent	string	Finalità dell'espressione.
language	string	Rappresenta la lingua dell'espressione. Si tratta della rappresentazione BCP-47 di una lingua. Ad esempio, usare "en" per l'inglese, "en-gb" per l'inglese (Regno Unito), "es" per lo spagnolo e così via.
text	string	Testo dell'espressione.

ConversationalAnalysisAuthoringProjectSettings

Rappresenta le impostazioni utilizzate per definire il comportamento del progetto.

Nome	Tipo	Descrizione
confidenceThreshold	number	Soglia della finalità con maggiore attendibilità, in cui la stima verrà automaticamente modificata in "Nessuno". Il valore della soglia deve essere compreso tra 0 e 1 inclusi.

Error

Oggetto error.

Nome	Tipo	Descrizione
code	ErrorCode	Uno di un set definito dal server di codici di errore.
details	Error[]	Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato.
innererror	InnerErrorModel	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message	string	Rappresentazione leggibile dell'errore.
target	string	Destinazione dell'errore.

ErrorCode

Codice di errore leggibile.

Nome	Tipo	Descrizione
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

Risposta di errore.

Nome	Tipo	Descrizione
error	Error	Oggetto error.

ExportedProjectFormat

Formato del file di progetto esportato da utilizzare.

Nome	Tipo	Descrizione
Conversation	string	Specifica il formato per un progetto di conversazione.
Luis	string	Specifica il formato per un'applicazione esportata da LUIS.

InnerErrorCode

Codice di errore leggibile.

Nome	Tipo	Descrizione
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

Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API Microsoft One , https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nome	Tipo	Descrizione
code	InnerErrorCode	Uno di un set definito dal server di codici di errore.
details	object	Dettagli errore.
innererror	InnerErrorModel	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message	string	Messaggio di errore.
target	string	Destinazione errore.

OrchestrationTargetProjectKind

Nome	Tipo	Descrizione
Conversation	string
Luis	string
QuestionAnswering	string

ProjectKind

Nome	Tipo	Descrizione
Conversation	string	Progetto per compilare il linguaggio naturale in app, bot e dispositivi IoT.
Orchestration	string	Un progetto per connettere e orchestrare conversazioni, risposte alle domande personalizzate e progetti LUIS insieme in un unico progetto.

StringIndexType

Nome	Tipo	Descrizione
Utf16CodeUnit	string	I valori di offset e lunghezza corrispondono alle unità di codice UTF-16. Usare questa opzione se l'applicazione viene scritta in un linguaggio che supporta Unicode, ad esempio JavaScript.

Condividi tramite

Conversational Analysis Authoring - Import

Parametri dell'URI

Corpo della richiesta

Risposte

Sicurezza

Ocp-Apim-Subscription-Key

OAuth2Auth

Ambiti

Esempio

Successful Import Project

Esempio di richiesta

Risposta di esempio

Definizioni

CompositionSetting

ConversationalAnalysisAuthoringConversationExportedEntity

ConversationalAnalysisAuthoringConversationExportedIntent

ConversationalAnalysisAuthoringConversationExportedProjectAssets

ConversationalAnalysisAuthoringConversationExportedUtterance

ConversationalAnalysisAuthoringCreateProjectOptions

ConversationalAnalysisAuthoringExportedConversationOrchestration

ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions

ConversationalAnalysisAuthoringExportedEntityList

ConversationalAnalysisAuthoringExportedEntityListSynonym

ConversationalAnalysisAuthoringExportedEntityRegex

ConversationalAnalysisAuthoringExportedEntityRegexExpression

ConversationalAnalysisAuthoringExportedEntitySublist

ConversationalAnalysisAuthoringExportedLuisOrchestration

ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions

ConversationalAnalysisAuthoringExportedPrebuiltEntity

ConversationalAnalysisAuthoringExportedProject

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions

ConversationalAnalysisAuthoringExportedUtteranceEntityLabel

ConversationalAnalysisAuthoringOrchestrationExportedIntent

ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets

ConversationalAnalysisAuthoringOrchestrationExportedUtterance

ConversationalAnalysisAuthoringProjectSettings

Error

ErrorCode

ErrorResponse

ExportedProjectFormat

InnerErrorCode

InnerErrorModel

OrchestrationTargetProjectKind

ProjectKind

StringIndexType

Risorse aggiuntive