Conversational Analysis Authoring - Import

Projekt importálásához aktivál egy feladatot. Ha már létezik ilyen nevű projekt, a program lecseréli a projekt adatait.

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

URI-paraméterek

Name In Kötelező Típus Description
Endpoint
path True

string

Támogatott Cognitive Services-végpont (pl. https://.api.cognitiveservices.azure.com).

projectName
path True

string

A használni kívánt projekt neve.

api-version
query True

string

Ügyfél API-verziója.

format
query

ExportedProjectFormat

A használni kívánt exportált projektfájl formátuma.

Kérelem törzse

Name Kötelező Típus Description
metadata True

ConversationalAnalysisAuthoringCreateProjectOptions

A projekt metaadatait jelöli.

projectFileVersion True

string

Az exportált fájl verziója.

stringIndexType True

StringIndexType

A sztringeltolások értelmezéséhez használt metódust adja meg. További információ: https://aka.ms/text-analytics-offsets.

assets ConversationalAnalysisAuthoringExportedProjectAssets:

A projekteszközöket jelöli.

Válaszok

Name Típus Description
202 Accepted

A sikeres hívás eredménye egy Operation-Location fejléccel, amely a feladat állapotának ellenőrzésére szolgál.

Headers

operation-location: string

Other Status Codes

ErrorResponse

Hibaválasz.

Biztonság

AADToken

Ezek az Azure Active Directory OAuth2-folyamatok . Az Azure-beli szerepköralapú hozzáférés-vezérléssel párosítva Azure Maps REST API-khoz való hozzáférés vezérlésére használható. Az Azure szerepköralapú hozzáférés-vezérlése egy vagy több Azure Maps erőforrásfiókhoz vagy alerőforráshoz való hozzáférés kijelölésére szolgál. Bármely felhasználó, csoport vagy szolgáltatásnév hozzáférést kaphat egy beépített szerepkörrel vagy egy vagy több rest API-Azure Maps ra vonatkozó engedélyből álló egyéni szerepkörrel.

A forgatókönyvek implementálásához javasoljuk, hogy tekintse meg a hitelesítési fogalmakat. Összefoglalva, ez a biztonsági definíció megoldást nyújt az alkalmazás(ok) adott API-k és hatókörök hozzáférés-vezérlésére képes objektumokon keresztüli modellezésére.

Jegyzetek

  • Ez a biztonsági definíció megköveteli a fejléc használatát annak x-ms-client-id jelzéséhez, hogy melyik Azure Maps erőforráshoz kér hozzáférést az alkalmazás. Ez a Maps management API-ból szerezhető be.

A Authorization URL az Azure nyilvános felhőpéldányára vonatkozik. A szuverén felhők egyedi engedélyezési URL-címekkel és Azure Active Directory-konfigurációkkal rendelkeznek. * Az Azure szerepköralapú hozzáférés-vezérlése az Azure felügyeleti síkjáról van konfigurálva Azure Portal, PowerShell, CLI, Azure SDK-k vagy REST API-k használatával. * A Azure Maps Web SDK használata lehetővé teszi az alkalmazások konfigurációalapú beállítását több használati esetben.

  • Az Azure Active Directory 1.0-s vagy 2.0-s verziója jelenleg a munkahelyi, iskolai és vendégfelhasználói fiókokat támogatja, de nem támogatja a személyes fiókokat.

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

Egy nyelvi szolgáltatási erőforrás előfizetői kulcsa.

Type: apiKey
In: header

Példák

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

Definíciók

Name Description
CompositionSetting

A követendő viselkedés, ha az entitás összetevői átfedésben vannak egymással.

ConversationalAnalysisAuthoringConversationExportedEntity

Egy entitást jelöl annak összetevőivel.

ConversationalAnalysisAuthoringConversationExportedIntent

Egy beszélgetési projekt exportált szándékát jelöli.

ConversationalAnalysisAuthoringConversationExportedProjectAssets

Egy beszélgetési projekt exportált eszközeit jelöli.

ConversationalAnalysisAuthoringConversationExportedUtterance

Beszélgetési projekt exportált beszédelemét jelöli.

ConversationalAnalysisAuthoringCreateProjectOptions

A projekt létrehozásához vagy frissítéséhez használt beállításokat jelöli.

ConversationalAnalysisAuthoringExportedConversationOrchestration

Meghatározza a beszélgetési projekt céljának vezénylési részleteit.

ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions

Egy beszélgetési projekt céljának vezénylési beállításait jelöli.

ConversationalAnalysisAuthoringExportedEntityList

Egy entitás listaösszetevőjét jelöli.

ConversationalAnalysisAuthoringExportedEntityListSynonym

Egy listaösszetevő szinonimáinak listáját jelöli

ConversationalAnalysisAuthoringExportedEntityRegex

Egy entitás regex összetevőjét jelöli.

ConversationalAnalysisAuthoringExportedEntityRegexExpression

Regex-összetevőn belüli regex kifejezést jelöl. Ez a kifejezés a .NET reguláris szintaxisát követi. Referenciaként tekintse meg az alábbiakat: https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions

ConversationalAnalysisAuthoringExportedEntitySublist

Egy listaösszetevőn belüli allistát jelöl.

ConversationalAnalysisAuthoringExportedLuisOrchestration

Meghatározza a LUIS-alkalmazás céljának vezénylési részleteit.

ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions

A LUIS-alkalmazáscél vezénylési lehetőségeit jelöli.

ConversationalAnalysisAuthoringExportedPrebuiltEntity

Exportált előre összeállított entitásösszetevőt jelöl

ConversationalAnalysisAuthoringExportedProject

Exportált projektet jelöl.

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration

Meghatározza a kérdés-válasz projekt céljának vezénylési részleteit.

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions

A kérdés-válasz projekt célcsoportjának vezénylési lehetőségeit jelöli.

ConversationalAnalysisAuthoringExportedUtteranceEntityLabel

Egy kimondott szöveg entitáscímkéjét jelöli.

ConversationalAnalysisAuthoringOrchestrationExportedIntent

Vezénylési projekt exportált szándékát jelöli.

ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets

Egy vezénylési projekt eszközeit jelöli.

ConversationalAnalysisAuthoringOrchestrationExportedUtterance

Egy vezénylési projekt kimondott szövegét jelöli.

ConversationalAnalysisAuthoringProjectSettings

A projekt viselkedésének meghatározásához használt beállításokat jelöli.

Error

A hibaobjektum.

ErrorCode

Emberi olvasásra alkalmas hibakód.

ErrorResponse

Hibaválasz.

ExportedProjectFormat

A használni kívánt exportált projektfájl formátuma.

InnerErrorCode

Emberi olvasásra alkalmas hibakód.

InnerErrorModel

Egy objektum, amely részletesebb információkat tartalmaz a hibáról. A Microsoft One API irányelvei szerint – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

ProjectKind

A projekttípust jelöli.

StringIndexType

Megadja a sztringeltolások értelmezéséhez használt metódust. További információ: https://aka.ms/text-analytics-offsets.

CompositionSetting

A követendő viselkedés, ha az entitás összetevői átfedésben vannak egymással.

Name Típus Description
combineComponents

string

Ha két vagy több összetevő található a szövegben, és átfedésben van, az összetevők spanjai egybeolvadnak egy egyesítéssel, amelyek mindegyiket kombinálja.

requireExactOverlap

string

Az entitás visszaadásához az összes összetevőnek pontosan ugyanazokkal a karakterekkel kell átfedésben lennie a szövegben. Ha az egyik definiált összetevő nincs megfeleltetve vagy előre jelezve, az entitás nem fog visszatérni.

returnLongestOverlap

string

Ha két vagy több összetevő található a szövegben, és átfedésben van, a rendszer a leghosszabb karakterkészlettel rendelkező összetevőt adja vissza.

separateComponents

string

Minden összetevő egyezését vagy előrejelzését a rendszer az entitás külön példányaként adja vissza.

ConversationalAnalysisAuthoringConversationExportedEntity

Egy entitást jelöl annak összetevőivel.

Name Típus Description
category

string

Az entitás kategóriája.

compositionSetting

CompositionSetting

A követendő viselkedés, ha az entitás összetevői átfedésben vannak egymással.

list

ConversationalAnalysisAuthoringExportedEntityList

Az entitás listaösszetevője.

prebuilts

ConversationalAnalysisAuthoringExportedPrebuiltEntity[]

Az előre összeállított entitások összetevői.

regex

ConversationalAnalysisAuthoringExportedEntityRegex

Az entitás regex összetevője.

requiredComponents

string[]

A szükséges összetevők. Az engedélyezett értékek a következők: "learned", "list", "prebuilts" és "regex".

ConversationalAnalysisAuthoringConversationExportedIntent

Egy beszélgetési projekt exportált szándékát jelöli.

Name Típus Description
category

string

A szándékkategória.

ConversationalAnalysisAuthoringConversationExportedProjectAssets

Egy beszélgetési projekt exportált eszközeit jelöli.

Name Típus Description
entities

ConversationalAnalysisAuthoringConversationExportedEntity[]

A projektben definiált entitások.

intents

ConversationalAnalysisAuthoringConversationExportedIntent[]

A projektben definiált szándékok.

projectKind string:

Conversation

Az eszközöket tartalmazó projekt típusa.

utterances

ConversationalAnalysisAuthoringConversationExportedUtterance[]

A projektben definiált kimondott szövegek.

ConversationalAnalysisAuthoringConversationExportedUtterance

Beszélgetési projekt exportált beszédelemét jelöli.

Name Típus Description
dataset

string

A kimondott szöveg adatkészlete. Az engedélyezett értékek a "Betanítása" és a "Teszt".

entities

ConversationalAnalysisAuthoringExportedUtteranceEntityLabel[]

A kimondott szöveg entitásfeliratait jelöli.

intent

string

A kimondott szöveg szándéka.

language

string

A kimondott szöveg nyelvét jelöli. Ez egy nyelv BCP-47-es reprezentációja. Használja például az "en" szót angolra, az "en-gb" szót angolra (UK), "es" spanyolra stb.

text

string

A kimondott szöveg.

ConversationalAnalysisAuthoringCreateProjectOptions

A projekt létrehozásához vagy frissítéséhez használt beállításokat jelöli.

Name Típus Description
description

string

A projekt leírása.

language

string

A projekt nyelve. Ez egy nyelv BCP-47-es reprezentációja. Használja például az "en" szót angolra, az "en-gb" szót angolra (UK), "es" spanyolra stb.

multilingual

boolean

Azt jelzi, hogy a projekt több nyelvhez is használható-e.

projectKind

ProjectKind

A projekttípust jelöli.

projectName

string

Az új projekt neve.

settings

ConversationalAnalysisAuthoringProjectSettings

A projekt beállításai.

ConversationalAnalysisAuthoringExportedConversationOrchestration

Meghatározza a beszélgetési projekt céljának vezénylési részleteit.

Name Típus Description
deploymentName

string

A célzott üzemelő példány neve.

projectName

string

A megcélzott projekt neve.

ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions

Egy beszélgetési projekt céljának vezénylési beállításait jelöli.

Name Típus Description
conversationOrchestration

ConversationalAnalysisAuthoringExportedConversationOrchestration

A beszélgetési projekt céladatai.

targetProjectKind string:

Conversation

A vezénylési folyamatban használt cél típusa.

ConversationalAnalysisAuthoringExportedEntityList

Egy entitás listaösszetevőjét jelöli.

Name Típus Description
sublists

ConversationalAnalysisAuthoringExportedEntitySublist[]

A listaösszetevő allistái.

ConversationalAnalysisAuthoringExportedEntityListSynonym

Egy listaösszetevő szinonimáinak listáját jelöli

Name Típus Description
language

string

A szinonimák nyelvét jelöli. Ez egy nyelv BCP-47-es reprezentációja. Használhatja például az "en" szót az angolhoz, az "en-gb" szót az angolhoz (UK), az "es" szót a spanyolhoz stb.

values

string[]

A szinonimák listája.

ConversationalAnalysisAuthoringExportedEntityRegex

Egy entitás regex összetevőjét jelöli.

Name Típus Description
expressions

ConversationalAnalysisAuthoringExportedEntityRegexExpression[]

A regex összetevő regex-kifejezései. Ezek a kifejezések a .NET regex szintaxisát követik. Referenciaként tekintse meg a következőt: https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions

ConversationalAnalysisAuthoringExportedEntityRegexExpression

Regex-összetevőn belüli regex kifejezést jelöl. Ez a kifejezés a .NET reguláris szintaxisát követi. Referenciaként tekintse meg az alábbiakat: https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions

Name Típus Description
language

string

A regex kifejezés nyelvét jelöli. Ez egy nyelv BCP-47-es reprezentációja. Használhatja például az "en" szót az angolhoz, az "en-gb" szót az angolhoz (UK), az "es" szót a spanyolhoz stb.

regexKey

string

A regex kifejezés kulcsa.

regexPattern

string

A reguláris minta.

ConversationalAnalysisAuthoringExportedEntitySublist

Egy listaösszetevőn belüli allistát jelöl.

Name Típus Description
listKey

string

Az allista kulcsa.

synonyms

ConversationalAnalysisAuthoringExportedEntityListSynonym[]

Az allistának megfelelő kifejezések.

ConversationalAnalysisAuthoringExportedLuisOrchestration

Meghatározza a LUIS-alkalmazás céljának vezénylési részleteit.

Name Típus Description
appId

string

A LUIS-alkalmazás azonosítója.

appVersion

string

A megcélzott verzióazonosító.

slotName

string

A célhely neve.

ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions

A LUIS-alkalmazáscél vezénylési lehetőségeit jelöli.

Name Típus Description
luisOrchestration

ConversationalAnalysisAuthoringExportedLuisOrchestration

A LUIS-alkalmazás céladatai.

targetProjectKind string:

Luis

A vezénylési folyamatban használt cél típusa.

ConversationalAnalysisAuthoringExportedPrebuiltEntity

Exportált előre összeállított entitásösszetevőt jelöl

Name Típus Description
category

string

Az előre összeállított entitáskategória.

ConversationalAnalysisAuthoringExportedProject

Exportált projektet jelöl.

Name Típus Description
assets ConversationalAnalysisAuthoringExportedProjectAssets:

A projektegységeket jelöli.

metadata

ConversationalAnalysisAuthoringCreateProjectOptions

A projekt metaadatait jelöli.

projectFileVersion

string

Az exportált fájl verziója.

stringIndexType

StringIndexType

Megadja a sztringeltolások értelmezéséhez használt metódust. További információ: https://aka.ms/text-analytics-offsets.

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration

Meghatározza a kérdés-válasz projekt céljának vezénylési részleteit.

Name Típus Description
projectName

string

A célprojekt neve.

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions

A kérdés-válasz projekt célcsoportjának vezénylési lehetőségeit jelöli.

Name Típus Description
questionAnsweringOrchestration

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration

A Kérdés megválaszolása projekt részletei.

targetProjectKind string:

QuestionAnswering

A vezénylési folyamatban használt cél típusa.

ConversationalAnalysisAuthoringExportedUtteranceEntityLabel

Egy kimondott szöveg entitáscímkéjét jelöli.

Name Típus Description
category

string

Az entitáscímke kategóriája.

length

integer

Az entitás szövegének hossza.

offset

integer

Az entitás szövegének kezdőpozíciója.

ConversationalAnalysisAuthoringOrchestrationExportedIntent

Vezénylési projekt exportált szándékát jelöli.

Name Típus Description
category

string

A szándékkategória.

orchestration ConversationalAnalysisAuthoringExportedOrchestrationOptions:

Meghatározza ennek a szándéknak a viselkedését a vezénylési folyamatban.

ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets

Egy vezénylési projekt eszközeit jelöli.

Name Típus Description
intents

ConversationalAnalysisAuthoringOrchestrationExportedIntent[]

A projekt szándékait jelöli.

projectKind string:

Orchestration

Az eszközöket tartalmazó projekt típusa.

utterances

ConversationalAnalysisAuthoringOrchestrationExportedUtterance[]

A projekt beszédelemeit jelöli.

ConversationalAnalysisAuthoringOrchestrationExportedUtterance

Egy vezénylési projekt kimondott szövegét jelöli.

Name Típus Description
dataset

string

A kimondott szöveg adatkészlete. Az engedélyezett értékek a "Betanítása" és a "Teszt".

intent

string

A kimondott szöveg szándéka.

language

string

A kimondott szöveg nyelvét jelöli. Ez egy nyelv BCP-47-es reprezentációja. Használja például az "en" szót angolra, az "en-gb" szót angolra (UK), "es" spanyolra stb.

text

string

A kimondott szöveg.

ConversationalAnalysisAuthoringProjectSettings

A projekt viselkedésének meghatározásához használt beállításokat jelöli.

Name Típus Description
confidenceThreshold

number

A legnagyobb megbízhatósággal rendelkező szándék küszöbértéke, amelynél az előrejelzés automatikusan "Nincs" értékre változik. A küszöbérték értéke 0 és 1 közötti lehet.

Error

A hibaobjektum.

Name Típus Description
code

ErrorCode

A kiszolgáló által definiált hibakódok egyike.

details

Error[]

A jelentett hibához vezető konkrét hibák részleteinek tömbje.

innererror

InnerErrorModel

Egy objektum, amely az aktuális objektumnál pontosabb információkat tartalmaz a hibáról.

message

string

A hiba emberi olvasásra alkalmas ábrázolása.

target

string

A hiba célja.

ErrorCode

Emberi olvasásra alkalmas hibakód.

Name Típus 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

Hibaválasz.

Name Típus Description
error

Error

A hibaobjektum.

ExportedProjectFormat

A használni kívánt exportált projektfájl formátuma.

Name Típus Description
Conversation

string

Megadja egy beszélgetési projekt formátumát.

Luis

string

Meghatározza a LUIS-ból exportált alkalmazás formátumát.

InnerErrorCode

Emberi olvasásra alkalmas hibakód.

Name Típus 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

Egy objektum, amely részletesebb információkat tartalmaz a hibáról. A Microsoft One API irányelvei szerint – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name Típus Description
code

InnerErrorCode

A kiszolgáló által definiált hibakódok egyike.

details

object

Hiba részletei.

innererror

InnerErrorModel

Egy objektum, amely az aktuális objektumnál pontosabb információkat tartalmaz a hibáról.

message

string

Hibaüzenet.

target

string

Hibacél.

ProjectKind

A projekttípust jelöli.

Name Típus Description
Conversation

string

Egy projekt, amely természetes nyelvet fejleszt alkalmazásokba, robotokba és IoT-eszközökbe.

Orchestration

string

Egy projekt, amely egyetlen projektben csatlakoztatja és vezényeli a beszélgetéseket, az egyéni kérdések megválaszolását és a LUIS-projekteket.

StringIndexType

Megadja a sztringeltolások értelmezéséhez használt metódust. További információ: https://aka.ms/text-analytics-offsets.

Name Típus Description
Utf16CodeUnit

string

Az eltolás és a hosszértékek UTF-16 kódegységeknek felelnek meg. Akkor használja ezt a lehetőséget, ha az alkalmazás Unicode-ot támogató nyelven van megírva, például Java, JavaScript.