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 maxLength: 100	Název projektu, který se má použít.
api-version	query	True	string	Verze rozhraní API klienta.
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 jazyka.

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 sloužící ke kontrole stavu úlohy. Hlavičky operation-location: string
Other Status Codes	ErrorResponse	Chybová odpověď.

Name

Typ

Description

202 Accepted

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

Hlavičky

operation-location: string

Other Status Codes

ErrorResponse

Chybová odpověď.

Zabezpečení

Ocp-Apim-Subscription-Key

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

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 vzájemně 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 součást seznamu entity.
ConversationalAnalysisAuthoringExportedEntityListSynonym	Představuje seznam synonym uvnitř součásti 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ědi na otázky.
ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions	Představuje možnosti orchestrace pro cíl projektu odpovědi 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í použitá k definování chování projektu.
Error	Objekt chyby.
ErrorCode	Kód chyby čitelné člověkem
ErrorResponse	Chybová odpověď.
ExportedProjectFormat	Formát exportovaného souboru projektu, který se má použít.
InnerErrorCode	Kód chyby čitelné člověkem
InnerErrorModel	Objekt obsahující konkrétnější informace o chybě. Podle pokynů k rozhraní API Microsoft One – 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

Výčet

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

Hodnota	Description
combineComponents	Pokud jsou v textu nalezeny dvě nebo více součástí a překrývají se, jejich rozsahy se sloučí do jednoho rozsahu, který zkombinuje všechny.
requireExactOverlap	Všechny komponenty se musí překrývat přesně stejnými znaky v textu, aby se entita vrátila. Pokud se některá z definovaných komponent neshoduje ani nepřepovídá, entita se nevrátí.
returnLongestOverlap	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	Shoda nebo predikce každé komponenty se vrátí jako samostatná instance entity.

ConversationalAnalysisAuthoringConversationExportedEntity

Objekt

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 vzájemně překrývají.
list	ConversationalAnalysisAuthoringExportedEntityList	Součást seznamu entity.
prebuilts	ConversationalAnalysisAuthoringExportedPrebuiltEntity[]	Předem připravené komponenty entit.

ConversationalAnalysisAuthoringConversationExportedIntent

Objekt

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

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

ConversationalAnalysisAuthoringConversationExportedProjectAssets

Objekt

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 obsahující prostředky.
utterances	ConversationalAnalysisAuthoringConversationExportedUtterance[]	Promluvy definované v projektu.

ConversationalAnalysisAuthoringConversationExportedUtterance

Objekt

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 použijte "en" pro angličtinu, "en-gb" pro angličtinu (UK), "es" pro španělštinu atd.
text	string	Text promluvy.

ConversationalAnalysisAuthoringCreateProjectOptions

Objekt

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 použijte "en" pro angličtinu, "en-gb" pro angličtinu (UK), "es" pro španělštinu atd.
multilingual	boolean	Bez ohledu na to, jestli se projekt použije pro více jazyků, nebo ne.
projectKind	ProjectKind	Představuje druh projektu.
projectName	string	Název nového projektu.
settings	ConversationalAnalysisAuthoringProjectSettings	Nastavení projektu.

ConversationalAnalysisAuthoringExportedConversationOrchestration

Objekt

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

Objekt

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ý v toku orchestrace.

ConversationalAnalysisAuthoringExportedEntityList

Objekt

Představuje součást seznamu entity.

Name	Typ	Description
sublists	ConversationalAnalysisAuthoringExportedEntitySublist[]	Podsestavy součásti seznamu.

ConversationalAnalysisAuthoringExportedEntityListSynonym

Objekt

Představuje seznam synonym uvnitř součásti seznamu.

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

ConversationalAnalysisAuthoringExportedEntitySublist

Objekt

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

Name	Typ	Description
listKey	string	Klíč podsítě.
synonyms	ConversationalAnalysisAuthoringExportedEntityListSynonym[]	Fráze, které odpovídají podsestavě.

ConversationalAnalysisAuthoringExportedLuisOrchestration

Objekt

Definuje podrobnosti orchestrace pro cíl aplikace LUIS.

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

ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions

Objekt

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ý v toku orchestrace.

ConversationalAnalysisAuthoringExportedPrebuiltEntity

Objekt

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

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

ConversationalAnalysisAuthoringExportedProject

Objekt

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

Objekt

Definuje podrobnosti orchestrace pro cíl projektu odpovědi na otázky.

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

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions

Objekt

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

Name	Typ	Description
questionAnsweringOrchestration	ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration	Podrobnosti o projektu odpovědi na otázky.
targetProjectKind	string: QuestionAnswering	Druh cíle použitý v toku orchestrace.

ConversationalAnalysisAuthoringExportedUtteranceEntityLabel

Objekt

Představuje popisek entity pro promluvu.

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

ConversationalAnalysisAuthoringOrchestrationExportedIntent

Objekt

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

Objekt

Představuje prostředky projektu orchestrace.

Name	Typ	Description
intents	ConversationalAnalysisAuthoringOrchestrationExportedIntent[]	Představuje záměry projektu.
projectKind	string: Orchestration	Typ projektu obsahující prostředky.
utterances	ConversationalAnalysisAuthoringOrchestrationExportedUtterance[]	Představuje promluvy projektu.

ConversationalAnalysisAuthoringOrchestrationExportedUtterance

Objekt

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 použijte "en" pro angličtinu, "en-gb" pro angličtinu (UK), "es" pro španělštinu atd.
text	string	Text promluvy.

ConversationalAnalysisAuthoringProjectSettings

Objekt

Představuje nastavení použitá k definování chování projektu.

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

Error

Objekt

Objekt chyby.

Name	Typ	Description
code	ErrorCode	Jedna ze serverově definovaných kódů chyb.
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, než je aktuální objekt o chybě.
message	string	Čitelné znázornění chyby člověkem.
target	string	Cíl chyby.

ErrorCode

Výčet

Kód chyby čitelné člověkem

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

ErrorResponse

Objekt

Chybová odpověď.

Name	Typ	Description
error	Error	Objekt chyby.

ExportedProjectFormat

Výčet

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

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

InnerErrorCode

Výčet

Kód chyby čitelné člověkem

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

InnerErrorModel

Objekt

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

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

ProjectKind

Výčet

Představuje druh projektu.

Hodnota	Description
Conversation	Projekt pro sestavení přirozeného jazyka do aplikací, robotů a zařízení IoT
Orchestration	Projekt pro propojení a orchestraci konverzací, vlastních odpovědí na otázky a projektů LUIS v jednom projektu.

StringIndexType

Výčet

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

Hodnota	Description
Utf16CodeUnit	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 Unicode, například JavaScript.

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