Conversational Analysis Authoring - Import

Reference

Služba:: Azure AI Services

Verze rozhraní API:: 2022-05-01

Aktivuje úlohu pro import projektu. Pokud projekt se stejným názvem již existuje, nahradí se data tohoto projektu.

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

S volitelnými parametry:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
Endpoint	path	True	string	Podporovaný koncový bod služeb Cognitive Services (např. https://.api.cognitiveservices.azure.com).
projectName	path	True	string	Název projektu, který se má použít.
api-version	query	True	string	Verze klientského rozhraní API
format	query		ExportedProjectFormat	Formát exportovaného souboru projektu, který se má použít.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
Ocp-Apim-Subscription-Key	True	string	Klíč předplatného pro prostředek služby language.

Text požadavku

Name	Vyžadováno	Typ	Description
metadata	True	ConversationalAnalysisAuthoringCreateProjectOptions	Představuje metadata projektu.
projectFileVersion	True	string	Verze exportovaného souboru.
stringIndexType	True	StringIndexType	Určuje metodu použitou k interpretaci posunů řetězců. Další informace najdete v tématu https://aka.ms/text-analytics-offsets.
assets		ConversationalAnalysisAuthoringExportedProjectAssets: ConversationalAnalysisAuthoringConversationExportedProjectAssets ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets	Představuje prostředky projektu.

Odpovědi

Name	Typ	Description
202 Accepted		Výsledky úspěšného volání s hlavičkou Operation-Location, která slouží ke kontrole stavu úlohy. Hlavičky operation-location: string
Other Status Codes	ErrorResponse	Odpověď na chybu.

Name

Typ

Description

202 Accepted

Výsledky úspěšného volání s hlavičkou Operation-Location, která slouží ke kontrole stavu úlohy.

Hlavičky

operation-location: string

Other Status Codes

ErrorResponse

Odpověď na chybu.

Zabezpečení

Ocp-Apim-Subscription-Key

Klíč předplatného pro prostředek služby language.

Typ: apiKey
V: header

Příklady

Successful Import Project

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 202

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

Definice

Name	Description
CompositionSetting	Chování, které se má sledovat, když se komponenty entity překrývají.
ConversationalAnalysisAuthoringConversationExportedEntity	Představuje entitu s jejími komponentami.
ConversationalAnalysisAuthoringConversationExportedIntent	Představuje exportovaný záměr konverzačního projektu.
ConversationalAnalysisAuthoringConversationExportedProjectAssets	Představuje exportované prostředky konverzačního projektu.
ConversationalAnalysisAuthoringConversationExportedUtterance	Představuje exportovanou promluvu pro konverzační projekt.
ConversationalAnalysisAuthoringCreateProjectOptions	Představuje možnosti použité k vytvoření nebo aktualizaci projektu.
ConversationalAnalysisAuthoringExportedConversationOrchestration	Definuje podrobnosti orchestrace pro cíl konverzačního projektu.
ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions	Představuje možnosti orchestrace pro cíl konverzačního projektu.
ConversationalAnalysisAuthoringExportedEntityList	Představuje komponentu seznamu entity.
ConversationalAnalysisAuthoringExportedEntityListSynonym	Představuje seznam synonym v komponentě seznamu.
ConversationalAnalysisAuthoringExportedEntitySublist	Představuje dílčí seznam uvnitř součásti seznamu.
ConversationalAnalysisAuthoringExportedLuisOrchestration	Definuje podrobnosti orchestrace pro cíl aplikace LUIS.
ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions	Představuje možnosti orchestrace pro cíl aplikace LUIS.
ConversationalAnalysisAuthoringExportedPrebuiltEntity	Představuje exportovanou předem připravenou komponentu entity.
ConversationalAnalysisAuthoringExportedProject	Představuje exportovaný projekt.
ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration	Definuje podrobnosti orchestrace pro cíl projektu odpovídání na otázky.
ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions	Představuje možnosti orchestrace pro cíl projektu odpovídání na otázky.
ConversationalAnalysisAuthoringExportedUtteranceEntityLabel	Představuje popisek entity pro promluvu.
ConversationalAnalysisAuthoringOrchestrationExportedIntent	Představuje exportovaný záměr pro projekt orchestrace.
ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets	Představuje prostředky projektu orchestrace.
ConversationalAnalysisAuthoringOrchestrationExportedUtterance	Představuje promluvu projektu orchestrace.
ConversationalAnalysisAuthoringProjectSettings	Představuje nastavení sloužící k definování chování projektu.
Error	Objekt chyby.
ErrorCode	Kód chyby čitelný pro člověka.
ErrorResponse	Chybová odpověď.
ExportedProjectFormat	Formát exportovaného souboru projektu, který se má použít.
InnerErrorCode	Kód chyby čitelný pro člověka.
InnerErrorModel	Objekt obsahující konkrétnější informace o chybě. Podle pokynů k rozhraní MICROSOFT One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ProjectKind	Představuje druh projektu.
StringIndexType	Určuje metodu použitou k interpretaci posunů řetězců. Další informace najdete v tématu https://aka.ms/text-analytics-offsets.

CompositionSetting

Chování, které se má sledovat, když se komponenty entity překrývají.

Name	Typ	Description
combineComponents	string	Pokud se v textu najdou dvě nebo více komponent a překrývají se, spany komponent se sloučí do jednoho rozsahu, který je zkombinuje všechny.
requireExactOverlap	string	Aby se entita vrátila, musí se všechny komponenty v textu překrývat přesně stejnými znaky. Pokud se některá z definovaných komponent neshoduje nebo není predikována, entita se nevrátí.
returnLongestOverlap	string	Pokud jsou v textu nalezeny dvě nebo více součástí a překrývají se, vrátí se komponenta s nejdelší sadou znaků.
separateComponents	string	Shoda nebo předpověď každé komponenty se vrátí jako samostatná instance entity.

ConversationalAnalysisAuthoringConversationExportedEntity

Představuje entitu s jejími komponentami.

Name	Typ	Description
category	string	Kategorie entity.
compositionSetting	CompositionSetting	Chování, které se má sledovat, když se komponenty entity překrývají.
list	ConversationalAnalysisAuthoringExportedEntityList	Komponenta seznamu entity.
prebuilts	ConversationalAnalysisAuthoringExportedPrebuiltEntity[]	Předem připravené komponenty entit.

ConversationalAnalysisAuthoringConversationExportedIntent

Představuje exportovaný záměr konverzačního projektu.

Name	Typ	Description
category	string	Kategorie záměru.

ConversationalAnalysisAuthoringConversationExportedProjectAssets

Představuje exportované prostředky konverzačního projektu.

Name	Typ	Description
entities	ConversationalAnalysisAuthoringConversationExportedEntity[]	Entity definované v projektu
intents	ConversationalAnalysisAuthoringConversationExportedIntent[]	Záměry definované v projektu
projectKind	string: Conversation	Typ projektu, který obsahuje prostředky.
utterances	ConversationalAnalysisAuthoringConversationExportedUtterance[]	Promluvy definované v projektu

ConversationalAnalysisAuthoringConversationExportedUtterance

Představuje exportovanou promluvu pro konverzační projekt.

Name	Typ	Description
dataset	string	Datová sada pro tuto promluvu. Povolené hodnoty jsou Train a Test.
entities	ConversationalAnalysisAuthoringExportedUtteranceEntityLabel[]	Představuje popisky entit promluvy.
intent	string	Záměr promluvy.
language	string	Představuje jazyk promluvy. Toto je reprezentace jazyka BCP-47. Například pro angličtinu použijte "en", "en-gb" pro angličtinu (UK), "es" pro španělštinu atd.
text	string	Text promluvy.

ConversationalAnalysisAuthoringCreateProjectOptions

Představuje možnosti použité k vytvoření nebo aktualizaci projektu.

Name	Typ	Description
description	string	Popis projektu.
language	string	Jazyk projektu. Toto je reprezentace jazyka BCP-47. Například pro angličtinu použijte "en", "en-gb" pro angličtinu (UK), "es" pro španělštinu atd.
multilingual	boolean	Určuje, jestli se projekt bude používat pro více jazyků nebo ne.
projectKind	ProjectKind	Představuje druh projektu.
projectName	string	Název nového projektu.
settings	ConversationalAnalysisAuthoringProjectSettings	Nastavení projektu.

ConversationalAnalysisAuthoringExportedConversationOrchestration

Definuje podrobnosti orchestrace pro cíl konverzačního projektu.

Name	Typ	Description
deploymentName	string	Název cílového nasazení.
projectName	string	Název cílového projektu.

ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions

Představuje možnosti orchestrace pro cíl konverzačního projektu.

Name	Typ	Description
conversationOrchestration	ConversationalAnalysisAuthoringExportedConversationOrchestration	Podrobnosti o cíli konverzačního projektu
targetProjectKind	string: Conversation	Druh cíle použitého v toku orchestrace.

ConversationalAnalysisAuthoringExportedEntityList

Představuje komponentu seznamu entity.

Name	Typ	Description
sublists	ConversationalAnalysisAuthoringExportedEntitySublist[]	Dílčí seznamy součásti seznamu.

ConversationalAnalysisAuthoringExportedEntityListSynonym

Představuje seznam synonym v komponentě seznamu.

Name	Typ	Description
language	string	Představuje jazyk synonym. Toto je reprezentace jazyka BCP-47. Použijte například "en" pro angličtinu, "en-gb" pro angličtinu (UK), "es" pro španělštinu atd.
values	string[]	Seznam synonym.

ConversationalAnalysisAuthoringExportedEntitySublist

Představuje dílčí seznam uvnitř součásti seznamu.

Name	Typ	Description
listKey	string	Klíč dílčího seznamu.
synonyms	ConversationalAnalysisAuthoringExportedEntityListSynonym[]	Fráze, které odpovídají dílčímu seznamu.

ConversationalAnalysisAuthoringExportedLuisOrchestration

Definuje podrobnosti orchestrace pro cíl aplikace LUIS.

Name	Typ	Description
appId	string	ID aplikace LUIS.
appVersion	string	ID cílové verze
slotName	string	Název cílového slotu.

ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions

Představuje možnosti orchestrace pro cíl aplikace LUIS.

Name	Typ	Description
luisOrchestration	ConversationalAnalysisAuthoringExportedLuisOrchestration	Podrobnosti o cíli aplikace LUIS
targetProjectKind	string: Luis	Druh cíle použitého v toku orchestrace.

ConversationalAnalysisAuthoringExportedPrebuiltEntity

Představuje exportovanou předem připravenou komponentu entity.

Name	Typ	Description
category	string	Předem připravená kategorie entity.

ConversationalAnalysisAuthoringExportedProject

Představuje exportovaný projekt.

Name	Typ	Description
assets	ConversationalAnalysisAuthoringExportedProjectAssets: ConversationalAnalysisAuthoringConversationExportedProjectAssets ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets	Představuje prostředky projektu.
metadata	ConversationalAnalysisAuthoringCreateProjectOptions	Představuje metadata projektu.
projectFileVersion	string	Verze exportovaného souboru.
stringIndexType	StringIndexType	Určuje metodu použitou k interpretaci posunů řetězců. Další informace najdete v tématu https://aka.ms/text-analytics-offsets.

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration

Definuje podrobnosti orchestrace pro cíl projektu odpovídání na otázky.

Name	Typ	Description
projectName	string	Název cílového projektu.

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions

Představuje možnosti orchestrace pro cíl projektu odpovídání na otázky.

Name	Typ	Description
questionAnsweringOrchestration	ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration	Podrobnosti projektu Odpovídání na otázky
targetProjectKind	string: QuestionAnswering	Druh cíle použitého v toku orchestrace.

ConversationalAnalysisAuthoringExportedUtteranceEntityLabel

Představuje popisek entity pro promluvu.

Name	Typ	Description
category	string	Kategorie popisku entity.
length	integer	Délka textu entity
offset	integer	Počáteční pozice textu entity

ConversationalAnalysisAuthoringOrchestrationExportedIntent

Představuje exportovaný záměr pro projekt orchestrace.

Name	Typ	Description
category	string	Kategorie záměru.
orchestration	ConversationalAnalysisAuthoringExportedOrchestrationOptions: ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions	Určuje chování tohoto záměru v toku orchestrace.

ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets

Představuje prostředky projektu orchestrace.

Name	Typ	Description
intents	ConversationalAnalysisAuthoringOrchestrationExportedIntent[]	Představuje záměry projektu.
projectKind	string: Orchestration	Typ projektu, který obsahuje prostředky.
utterances	ConversationalAnalysisAuthoringOrchestrationExportedUtterance[]	Představuje promluvy projektu.

ConversationalAnalysisAuthoringOrchestrationExportedUtterance

Představuje promluvu projektu orchestrace.

Name	Typ	Description
dataset	string	Datová sada pro tuto promluvu. Povolené hodnoty jsou Train a Test.
intent	string	Záměr promluvy.
language	string	Představuje jazyk promluvy. Toto je reprezentace jazyka BCP-47. Například pro angličtinu použijte "en", "en-gb" pro angličtinu (UK), "es" pro španělštinu atd.
text	string	Text promluvy.

ConversationalAnalysisAuthoringProjectSettings

Představuje nastavení sloužící k definování chování projektu.

Name	Typ	Description
confidenceThreshold	number	Prahová hodnota záměru s nejvyšší spolehlivostí, při které se předpověď automaticky změní na "Žádná".

Error

Objekt chyby.

Name	Typ	Description
code	ErrorCode	Jeden ze serverem definovaných chybových kódů.
details	Error[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
innererror	InnerErrorModel	Objekt obsahující konkrétnější informace o chybě než aktuální objekt.
message	string	Lidsky čitelná reprezentace chyby.
target	string	Cíl chyby.

ErrorCode

Kód chyby čitelný pro člověka.

Name	Typ	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

Chybová odpověď.

Name	Typ	Description
error	Error	Objekt chyby.

ExportedProjectFormat

Formát exportovaného souboru projektu, který se má použít.

Name	Typ	Description
Conversation	string	Určuje formát konverzačního projektu.
Luis	string	Určuje formát aplikace, která byla exportována ze služby LUIS.

InnerErrorCode

Kód chyby čitelný pro člověka.

Name	Typ	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

Objekt obsahující konkrétnější informace o chybě. Podle pokynů k rozhraní MICROSOFT One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Description
code	InnerErrorCode	Jeden ze serverem definovaných chybových kódů.
details	object	Podrobnosti o chybě.
innererror	InnerErrorModel	Objekt obsahující konkrétnější informace o chybě než aktuální objekt.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ProjectKind

Představuje druh projektu.

Name	Typ	Description
Conversation	string	Projekt, který do aplikací, robotů a zařízení IoT zabuduje přirozený jazyk.
Orchestration	string	Projekt pro propojení a orchestraci projektů Konverzace, Vlastní odpovídání na otázky a LUIS v jednom projektu.

StringIndexType

Určuje metodu použitou k interpretaci posunů řetězců. Další informace najdete v tématu https://aka.ms/text-analytics-offsets.

Name	Typ	Description
Utf16CodeUnit	string	Hodnoty posunu a délky budou odpovídat jednotkám kódu UTF-16. Tuto možnost použijte, pokud je vaše aplikace napsaná v jazyce, který podporuje Kódování Unicode, například v Javě nebo JavaScriptu.

Sdílet prostřednictvím

Conversational Analysis Authoring - Import

Parametry identifikátoru URI

Hlavička požadavku

Text požadavku

Odpovědi

Zabezpečení

Ocp-Apim-Subscription-Key

Příklady

Successful Import Project

Ukázkový požadavek

Ukázková odpověď

Definice

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

Další materiály