Conversational Analysis Authoring - Import

Riferimento

Servizio:: Azure AI Services

Versione API:: 2022-05-01

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

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

Con parametri facoltativi:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
Endpoint	path	True	string	Endpoint servizi cognitivi supportati (ad esempio, https://.api.cognitiveservices.azure.com).
projectName	path	True	string	Nome del progetto da usare.
api-version	query	True	string	Versione API client.
format	query		ExportedProjectFormat	Formato del file di progetto esportato da usare.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
Ocp-Apim-Subscription-Key	True	string	Chiave di sottoscrizione per una risorsa del servizio lingua.

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 usato per interpretare gli offset di stringa. Per ulteriori informazioni, vedere https://aka.ms/text-analytics-offsets.
assets		ConversationalAnalysisAuthoringExportedProjectAssets: ConversationalAnalysisAuthoringConversationExportedProjectAssets ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets	Rappresenta gli asset del progetto.

Risposte

Nome	Tipo	Descrizione
202 Accepted		Risultati di una chiamata con esito positivo con un'intestazione Operation-Location utilizzata per controllare lo stato del processo. Intestazioni operation-location: string
Other Status Codes	ErrorResponse	Risposta di errore.

Nome

Tipo

Descrizione

202 Accepted

Risultati di una chiamata con esito positivo con un'intestazione Operation-Location utilizzata per controllare lo stato del processo.

Intestazioni

operation-location: string

Other Status Codes

ErrorResponse

Risposta di errore.

Sicurezza

Ocp-Apim-Subscription-Key

Chiave di sottoscrizione per una risorsa del servizio lingua.

Tipo: apiKey
In: header

Esempio

Successful Import Project

Esempio di richiesta

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

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

Definizioni

Nome	Descrizione
CompositionSetting	Comportamento da seguire quando i componenti dell'entità si sovrappongono tra loro.
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 usate per creare o aggiornare un progetto.
ConversationalAnalysisAuthoringExportedConversationOrchestration	Definisce i dettagli dell'orchestrazione per una destinazione del progetto Conversational.
ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions	Rappresenta le opzioni di orchestrazione per una destinazione del progetto conversational.
ConversationalAnalysisAuthoringExportedEntityList	Rappresenta un componente elenco di un'entità.
ConversationalAnalysisAuthoringExportedEntityListSynonym	Rappresenta un elenco di sinonimi all'interno di un componente elenco
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 di entità predefinita 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 usate per definire il comportamento del progetto.
Error	Oggetto error.
ErrorCode	Codice di errore leggibile dall'utente.
ErrorResponse	Risposta di errore.
ExportedProjectFormat	Formato del file di progetto esportato da usare.
InnerErrorCode	Codice di errore leggibile dall'utente.
InnerErrorModel	Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida per l'API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ProjectKind	Rappresenta il tipo di progetto.
StringIndexType	Specifica il metodo usato per interpretare gli offset di stringa. Per ulteriori informazioni, vedere https://aka.ms/text-analytics-offsets.

CompositionSetting

Comportamento da seguire quando i componenti dell'entità si sovrappongono tra loro.

Nome	Tipo	Descrizione
combineComponents	string	Quando si trovano due o più componenti nel testo e si sovrappongono, gli intervalli dei componenti vengono uniti in un unico intervallo che li combina tutti.
requireExactOverlap	string	Tutti i componenti devono sovrapporsi allo stesso carattere nel testo per restituire l'entità. Se uno dei componenti definiti non corrisponde o previsto, l'entità non restituirà.
returnLongestOverlap	string	Quando si trovano due o più componenti nel testo e si sovrappongono, viene restituito il componente con il set di caratteri più lungo.
separateComponents	string	Ogni corrispondenza o 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.

ConversationalAnalysisAuthoringConversationExportedIntent

Rappresenta una finalità esportata di un progetto di conversazione.

Nome	Tipo	Descrizione
category	string	Categoria finalità.

ConversationalAnalysisAuthoringConversationExportedProjectAssets

Rappresenta gli asset esportati di un progetto di conversazione.

Nome	Tipo	Descrizione
entities	ConversationalAnalysisAuthoringConversationExportedEntity[]	Le 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 inglese, "en-gb" per inglese (UK), "es" per spagnolo e così via.
text	string	Testo dell'espressione.

ConversationalAnalysisAuthoringCreateProjectOptions

Rappresenta le opzioni usate per creare o aggiornare un progetto.

Nome	Tipo	Descrizione
description	string	Descrizione del progetto.
language	string	Lingua del progetto. Si tratta della rappresentazione BCP-47 di una lingua. Ad esempio, usare "en" per inglese, "en-gb" per inglese (UK), "es" per spagnolo e così via.
multilingual	boolean	Indipendentemente dal fatto che il progetto venga usato per più lingue o meno.
projectKind	ProjectKind	Rappresenta il tipo di progetto.
projectName	string	Nuovo nome del progetto.
settings	ConversationalAnalysisAuthoringProjectSettings	Impostazioni del progetto.

ConversationalAnalysisAuthoringExportedConversationOrchestration

Definisce i dettagli dell'orchestrazione per una destinazione del progetto Conversational.

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 del progetto conversational.

Nome	Tipo	Descrizione
conversationOrchestration	ConversationalAnalysisAuthoringExportedConversationOrchestration	Dettagli della destinazione del progetto conversazionale.
targetProjectKind	string: Conversation	Tipo di destinazione utilizzato nel flusso di orchestrazione.

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 inglese, "en-gb" per inglese (UK), "es" per spagnolo e così via.
values	string[]	Elenco di sinonimi.

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	Tipo di destinazione utilizzato nel flusso di orchestrazione.

ConversationalAnalysisAuthoringExportedPrebuiltEntity

Rappresenta un componente di entità predefinita 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 usato per interpretare gli offset di stringa. Per ulteriori 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	Tipo di destinazione utilizzato nel flusso di orchestrazione.

ConversationalAnalysisAuthoringExportedUtteranceEntityLabel

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

Nome	Tipo	Descrizione
category	string	Categoria dell'etichetta di 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 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 inglese, "en-gb" per inglese (UK), "es" per spagnolo e così via.
text	string	Testo dell'espressione.

ConversationalAnalysisAuthoringProjectSettings

Rappresenta le impostazioni usate per definire il comportamento del progetto.

Nome	Tipo	Descrizione
confidenceThreshold	number	Soglia della finalità con la massima attendibilità, in cui la stima verrà modificata automaticamente in "Nessuno".

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 dall'utente.

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

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 dall'utente.

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 per l'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 degli errori.
innererror	InnerErrorModel	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message	string	Messaggio di errore.
target	string	Destinazione errore.

ProjectKind

Rappresenta il tipo di progetto.

Nome	Tipo	Descrizione
Conversation	string	Progetto per creare linguaggio naturale in app, bot e dispositivi IoT.
Orchestration	string	Progetto per connettere e orchestrare conversazione, risposte personalizzate alle domande e progetti LUIS insieme in un singolo progetto.

StringIndexType

Specifica il metodo usato per interpretare gli offset di stringa. Per ulteriori informazioni, vedere https://aka.ms/text-analytics-offsets.

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

Condividi tramite

Conversational Analysis Authoring - Import

Parametri dell'URI

Intestazione della richiesta

Corpo della richiesta

Risposte

Sicurezza

Ocp-Apim-Subscription-Key

Esempio

Successful Import Project

Esempio di richiesta

Risposta di esempio

Definizioni

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

Risorse aggiuntive