Conversational Analysis Authoring - Import

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

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

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 rozhraní API klienta.

format
query

ExportedProjectFormat

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

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:

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.

Headers

operation-location: string

Other Status Codes

ErrorResponse

Chybová odpověď.

Zabezpečení

AADToken

Toto jsou toky Azure Active Directory OAuth2 . Při spárování s řízením přístupu na základě role v Azure se dá použít k řízení přístupu k Azure Maps rozhraní REST API. Řízení přístupu na základě role v Azure slouží k určení přístupu k jednomu nebo několika Azure Maps účtu prostředku nebo dílčím prostředkům. Každému uživateli, skupině nebo instančnímu objektu je možné udělit přístup prostřednictvím předdefinované role nebo vlastní role složené z jednoho nebo více oprávnění k Azure Maps rozhraní REST API.

Pokud chcete implementovat scénáře, doporučujeme zobrazit si koncepty ověřování. Souhrnně řečeno, tato definice zabezpečení poskytuje řešení pro modelování aplikací prostřednictvím objektů schopných řízení přístupu pro konkrétní rozhraní API a obory.

Poznámky

  • Tato definice zabezpečení vyžaduje použití hlavičky x-ms-client-id k označení Azure Maps prostředku, ke kterému aplikace žádá o přístup. Můžete ho získat z rozhraní MAPS MANAGEMENT API.

Je Authorization URL specifický pro instanci veřejného cloudu Azure. Suverénní cloudy mají jedinečné autorizační adresy URL a konfigurace Azure Active Directory. * Řízení přístupu na základě role v Azure se konfiguruje z roviny správy Azure prostřednictvím Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API. * Použití sady AZURE MAPS Web SDK umožňuje nastavení aplikace na základě konfigurace pro více případů použití.

  • Azure Active Directory verze 1.0 nebo 2.0 v současné době podporuje pracovní, školní a hosta, ale nepodporuje osobní účty.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Ocp-Apim-Subscription-Key

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

Type: apiKey
In: header

Příklady

Successful Import Project

Sample Request

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

Sample Response

operation-location: {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/import/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-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 v komponentě seznamu.

ConversationalAnalysisAuthoringExportedEntityRegex

Představuje komponentu regex entity.

ConversationalAnalysisAuthoringExportedEntityRegexExpression

Představuje výraz regulárního výrazu uvnitř komponenty regex. Tento výraz se řídí syntaxí regulárního výrazu .NET. Referenční informace najdete tady: https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions

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í použitá k definování chování projektu.

Error

Objekt chyby.

ErrorCode

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

ErrorResponse

Odpověď na chybu.

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 vzájemně překrývají.

Name Typ Description
combineComponents

string

Pokud jsou v textu nalezeny dvě nebo více komponent a překrývají se, jsou rozsahy součástí sloučeny do jednoho rozsahu, který kombinuje všechny z nich.

requireExactOverlap

string

Aby se entita vrátila, musí se všechny komponenty překrývat přesně ve stejných znaménách v textu. Pokud se některá z definovaných komponent neshoduje nebo predikuje, entita se nevrátí.

returnLongestOverlap

string

Pokud jsou v textu nalezeny dvě nebo více komponent a překrývají se, vrátí se komponenta s nejdelší sadou znaků.

separateComponents

string

Shoda nebo predikce 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 vzájemně překrývají.

list

ConversationalAnalysisAuthoringExportedEntityList

Komponenta seznamu entity.

prebuilts

ConversationalAnalysisAuthoringExportedPrebuiltEntity[]

Předem připravené komponenty entit.

regex

ConversationalAnalysisAuthoringExportedEntityRegex

Komponenta regex entity.

requiredComponents

string[]

Požadované komponenty. Povolené hodnoty jsou "learned", "list", "prebuilts" a "regex".

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. Použijte například "en" pro angličtinu, "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. Použijte například "en" pro angličtinu, "en-gb" pro angličtinu (UK), "es" pro španělštinu atd.

multilingual

boolean

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

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

Typ cíle použitý v toku orchestrace.

ConversationalAnalysisAuthoringExportedEntityList

Představuje součást seznamu entity.

Name Typ Description
sublists

ConversationalAnalysisAuthoringExportedEntitySublist[]

Dílčí seznamy komponenty seznamu.

ConversationalAnalysisAuthoringExportedEntityListSynonym

Představuje seznam synonym v komponentě seznamu.

Name Typ Description
language

string

Představuje jazyk synonym. 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.

values

string[]

Seznam synonym.

ConversationalAnalysisAuthoringExportedEntityRegex

Představuje komponentu regex entity.

Name Typ Description
expressions

ConversationalAnalysisAuthoringExportedEntityRegexExpression[]

Výrazy regex komponenty regex. Tyto výrazy se řídí syntaxí regex .NET. Referenční informace najdete tady: https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions

ConversationalAnalysisAuthoringExportedEntityRegexExpression

Představuje výraz regulárního výrazu uvnitř komponenty regex. Tento výraz se řídí syntaxí regulárního výrazu .NET. Referenční informace najdete tady: https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions

Name Typ Description
language

string

Představuje jazyk výrazu regulárního výrazu. 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.

regexKey

string

Klíč výrazu regulárního výrazu.

regexPattern

string

Vzor regulárního výrazu.

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

Typ cíle použitý v toku orchestrace.

ConversationalAnalysisAuthoringExportedPrebuiltEntity

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

Name Typ Description
category

string

Předem připravená kategorie entit.

ConversationalAnalysisAuthoringExportedProject

Představuje exportovaný projekt.

Name Typ Description
assets ConversationalAnalysisAuthoringExportedProjectAssets:

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

Typ cíle použitý 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:

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. Použijte například "en" pro angličtinu, "en-gb" pro angličtinu (UK), "es" pro španělštinu atd.

text

string

Text promluvy.

ConversationalAnalysisAuthoringProjectSettings

Představuje nastavení použitá 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ý". Hodnota prahové hodnoty by měla být mezi 0 a 1 včetně.

Error

Objekt chyby.

Name Typ Description
code

ErrorCode

Jeden ze serverem definované sady 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 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

Odpověď na chybu.

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é sady kódů chyb.

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 pro vytvoření přirozeného jazyka do aplikací, robotů a zařízení IoT.

Orchestration

string

Projekt pro propojení a orchestraci konverzací, vlastních odpovědí na otázky a projektů 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 Java nebo JavaScript.