Dela via

Conversational Analysis Authoring - Import

  • Referens
Tjänst:
Azure AI Services
API-version:
2022-05-01

Utlöser ett jobb för att importera ett projekt. Om det redan finns ett projekt med samma namn ersätts data för projektet.

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

URI-parametrar

Name I Obligatorisk Typ Description
Endpoint
 path True

string

Cognitive Services-slutpunkt som stöds (t.ex. https://.api.cognitiveservices.azure.com).
projectName
 path True

string

maxLength: 100

Namnet på projektet som ska användas.
api-version
 query True

string

Klient-API-version.
format
 query

ExportedProjectFormat

Formatet för den exporterade projektfilen som ska användas.

Begärandehuvud

Name Obligatorisk Typ Description
Ocp-Apim-Subscription-Key True

string

En prenumerationsnyckel för en språktjänstresurs.

Begärandetext

Name Obligatorisk Typ Description
metadata True

ConversationalAnalysisAuthoringCreateProjectOptions

Representerar projektets metadata.
projectFileVersion True

string

Versionen av den exporterade filen.
stringIndexType True

StringIndexType

Anger den metod som används för att tolka strängförskjutningar. Mer information finns i https://aka.ms/text-analytics-offsets.
assets ConversationalAnalysisAuthoringExportedProjectAssets:

Representerar projekttillgångarna.

Svar

Name Typ Description
202 Accepted

Ett lyckat anrop resulterar i ett Operation-Location-huvud som används för att kontrollera jobbets status.

Sidhuvuden

operation-location: string
Other Status Codes

ErrorResponse

Felsvar.

Säkerhet

Ocp-Apim-Subscription-Key

En prenumerationsnyckel för en språktjänstresurs.

Typ: apiKey
I: header

Exempel

Successful Import Project

Exempelbegäran

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

Exempelsvar

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

Definitioner

Name Description
CompositionSetting

Beteendet att följa när entitetens komponenter överlappar varandra.
ConversationalAnalysisAuthoringConversationExportedEntity

Representerar en entitet med dess komponenter.
ConversationalAnalysisAuthoringConversationExportedIntent

Representerar en exporterad avsikt för ett konversationsprojekt.
ConversationalAnalysisAuthoringConversationExportedProjectAssets

Representerar de exporterade tillgångarna i ett konversationsprojekt.
ConversationalAnalysisAuthoringConversationExportedUtterance

Representerar ett exporterat yttrande för ett konversationsprojekt.
ConversationalAnalysisAuthoringCreateProjectOptions

Representerar de alternativ som används för att skapa eller uppdatera ett projekt.
ConversationalAnalysisAuthoringExportedConversationOrchestration

Definierar orkestreringsinformationen för ett projektmål för konversationer.
ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions

Representerar orkestreringsalternativen för ett projektmål för konversationer.
ConversationalAnalysisAuthoringExportedEntityList

Representerar en listkomponent i en entitet.
ConversationalAnalysisAuthoringExportedEntityListSynonym

Representerar en lista över synonymer i en listkomponent
ConversationalAnalysisAuthoringExportedEntitySublist

Representerar en underlista i en listkomponent.
ConversationalAnalysisAuthoringExportedLuisOrchestration

Definierar orkestreringsinformationen för ett LUIS-programmål.
ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions

Representerar orkestreringsalternativen för ett LUIS-programmål.
ConversationalAnalysisAuthoringExportedPrebuiltEntity

Representerar en exporterad fördefinierad entitetskomponent
ConversationalAnalysisAuthoringExportedProject

Representerar ett exporterat projekt.
ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration

Definierar orkestreringsinformationen för ett projektmål för frågesvar.
ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions

Representerar orkestreringsalternativen för ett projektmål för frågesvar.
ConversationalAnalysisAuthoringExportedUtteranceEntityLabel

Representerar en entitetsetikett för ett yttrande.
ConversationalAnalysisAuthoringOrchestrationExportedIntent

Representerar en exporterad avsikt för ett orkestreringsprojekt.
ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets

Representerar tillgångarna i ett orkestreringsprojekt.
ConversationalAnalysisAuthoringOrchestrationExportedUtterance

Representerar ett yttrande från ett orkestreringsprojekt.
ConversationalAnalysisAuthoringProjectSettings

Representerar de inställningar som används för att definiera projektbeteendet.
Error

Felobjektet.
ErrorCode

Felkod som kan läsas av människor.
ErrorResponse

Felsvar.
ExportedProjectFormat

Formatet för den exporterade projektfilen som ska användas.
InnerErrorCode

Felkod som kan läsas av människor.
InnerErrorModel

Ett objekt som innehåller mer specifik information om felet. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ProjectKind

Representerar projekttypen.
StringIndexType

Anger den metod som används för att tolka strängförskjutningar. Mer information finns i https://aka.ms/text-analytics-offsets.

CompositionSetting

Uppräkning

Beteendet att följa när entitetens komponenter överlappar varandra.

Värde Description
combineComponents

När två eller flera komponenter hittas i texten och överlappar varandra sammanfogas komponenternas spännvidd till ett intervall som kombinerar dem alla.
requireExactOverlap

Alla komponenter måste överlappa exakt samma tecken i texten för att entiteten ska returneras. Om en av de definierade komponenterna inte matchas eller förutsägs returnerar inte entiteten.
returnLongestOverlap

När två eller flera komponenter hittas i texten och överlappar varandra returneras komponenten med den längsta uppsättningen tecken.
separateComponents

Varje komponents matchning eller förutsägelse returneras som en separat instans av entiteten.

ConversationalAnalysisAuthoringConversationExportedEntity

Objekt

Representerar en entitet med dess komponenter.

Name Typ Description
category

string

Kategorin för entiteten.
compositionSetting

CompositionSetting

Beteendet att följa när entitetens komponenter överlappar varandra.
list

ConversationalAnalysisAuthoringExportedEntityList

Entitetens listkomponent.
prebuilts

ConversationalAnalysisAuthoringExportedPrebuiltEntity[]

De fördefinierade komponenterna för entiteter.

ConversationalAnalysisAuthoringConversationExportedIntent

Objekt

Representerar en exporterad avsikt för ett konversationsprojekt.

Name Typ Description
category

string

Avsiktskategorin.

ConversationalAnalysisAuthoringConversationExportedProjectAssets

Objekt

Representerar de exporterade tillgångarna i ett konversationsprojekt.

Name Typ Description
entities

ConversationalAnalysisAuthoringConversationExportedEntity[]

Entiteterna som definierats i projektet.
intents

ConversationalAnalysisAuthoringConversationExportedIntent[]

De avsikter som definierats i projektet.
projectKind string:

Conversation

Typen av projekt som innehåller tillgångarna.
utterances

ConversationalAnalysisAuthoringConversationExportedUtterance[]

De yttranden som definierats i projektet.

ConversationalAnalysisAuthoringConversationExportedUtterance

Objekt

Representerar ett exporterat yttrande för ett konversationsprojekt.

Name Typ Description
dataset

string

Datauppsättningen för det här yttrandet. Tillåtna värden är "Train" och "Test".
entities

ConversationalAnalysisAuthoringExportedUtteranceEntityLabel[]

Representerar entitetsetiketterna för yttrandet.
intent

string

Avsikten med yttrandet.
language

string

Representerar yttrandets språk. Det här är BCP-47-representation av ett språk. Använd till exempel "en" för engelska, "en-gb" för engelska (Storbritannien), "es" för spanska osv.
text

string

Yttrandetexten.

ConversationalAnalysisAuthoringCreateProjectOptions

Objekt

Representerar de alternativ som används för att skapa eller uppdatera ett projekt.

Name Typ Description
description

string

Projektbeskrivningen.
language

string

Projektspråket. Det här är BCP-47-representation av ett språk. Använd till exempel "en" för engelska, "en-gb" för engelska (Storbritannien), "es" för spanska osv.
multilingual

boolean

Om projektet skulle användas för flera språk eller inte.
projectKind

ProjectKind

Representerar projekttypen.
projectName

string

Det nya projektnamnet.
settings

ConversationalAnalysisAuthoringProjectSettings

Projektinställningarna.

ConversationalAnalysisAuthoringExportedConversationOrchestration

Objekt

Definierar orkestreringsinformationen för ett projektmål för konversationer.

Name Typ Description
deploymentName

string

Namnet på den riktade distributionen.
projectName

string

Namnet på målprojektet.

ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions

Objekt

Representerar orkestreringsalternativen för ett projektmål för konversationer.

Name Typ Description
conversationOrchestration

ConversationalAnalysisAuthoringExportedConversationOrchestration

Målinformation för konversationsprojekt.
targetProjectKind string:

Conversation

Den typ av mål som används i orkestreringsflödet.

ConversationalAnalysisAuthoringExportedEntityList

Objekt

Representerar en listkomponent i en entitet.

Name Typ Description
sublists

ConversationalAnalysisAuthoringExportedEntitySublist[]

Underlistorna för listkomponenten.

ConversationalAnalysisAuthoringExportedEntityListSynonym

Objekt

Representerar en lista över synonymer i en listkomponent

Name Typ Description
language

string

Representerar synonymernas språk. Det här är BCP-47-representation av ett språk. Använd till exempel "en" för engelska, "en-gb" för engelska (Storbritannien), "es" för spanska osv.
values

string[]

Listan över synonymer.

ConversationalAnalysisAuthoringExportedEntitySublist

Objekt

Representerar en underlista i en listkomponent.

Name Typ Description
listKey

string

Nyckeln i underlistan.
synonyms

ConversationalAnalysisAuthoringExportedEntityListSynonym[]

Fraserna i det motsvarar underlistan.

ConversationalAnalysisAuthoringExportedLuisOrchestration

Objekt

Definierar orkestreringsinformationen för ett LUIS-programmål.

Name Typ Description
appId

string (uuid)

LUIS-program-ID: t.
appVersion

string

Målversions-ID:t.
slotName

string

Målfackets namn.

ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions

Objekt

Representerar orkestreringsalternativen för ett LUIS-programmål.

Name Typ Description
luisOrchestration

ConversationalAnalysisAuthoringExportedLuisOrchestration

Information om LUIS-programmets mål.
targetProjectKind string:

Luis

Den typ av mål som används i orkestreringsflödet.

ConversationalAnalysisAuthoringExportedPrebuiltEntity

Objekt

Representerar en exporterad fördefinierad entitetskomponent

Name Typ Description
category

string

Den fördefinierade entitetskategorin.

ConversationalAnalysisAuthoringExportedProject

Objekt

Representerar ett exporterat projekt.

Name Typ Description
assets ConversationalAnalysisAuthoringExportedProjectAssets:

Representerar projekttillgångarna.
metadata

ConversationalAnalysisAuthoringCreateProjectOptions

Representerar projektets metadata.
projectFileVersion

string

Versionen av den exporterade filen.
stringIndexType

StringIndexType

Anger den metod som används för att tolka strängförskjutningar. Mer information finns i https://aka.ms/text-analytics-offsets.

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration

Objekt

Definierar orkestreringsinformationen för ett projektmål för frågesvar.

Name Typ Description
projectName

string

Namnet på målprojektet.

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions

Objekt

Representerar orkestreringsalternativen för ett projektmål för frågesvar.

Name Typ Description
questionAnsweringOrchestration

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration

Projektinformation om frågesvar.
targetProjectKind string:

QuestionAnswering

Den typ av mål som används i orkestreringsflödet.

ConversationalAnalysisAuthoringExportedUtteranceEntityLabel

Objekt

Representerar en entitetsetikett för ett yttrande.

Name Typ Description
category

string

Kategorin för entitetsetiketten.
length

integer (int32)

Längd för entitetstexten.
offset

integer (int32)

Startposition för entitetstexten.

ConversationalAnalysisAuthoringOrchestrationExportedIntent

Objekt

Representerar en exporterad avsikt för ett orkestreringsprojekt.

Name Typ Description
category

string

Avsiktskategorin.
orchestration ConversationalAnalysisAuthoringExportedOrchestrationOptions:

Anger beteendet för den här avsikten i orkestreringsflödet.

ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets

Objekt

Representerar tillgångarna i ett orkestreringsprojekt.

Name Typ Description
intents

ConversationalAnalysisAuthoringOrchestrationExportedIntent[]

Representerar projektets avsikter.
projectKind string:

Orchestration

Typen av projekt som innehåller tillgångarna.
utterances

ConversationalAnalysisAuthoringOrchestrationExportedUtterance[]

Representerar projektets yttranden.

ConversationalAnalysisAuthoringOrchestrationExportedUtterance

Objekt

Representerar ett yttrande från ett orkestreringsprojekt.

Name Typ Description
dataset

string

Datauppsättningen för det här yttrandet. Tillåtna värden är "Train" och "Test".
intent

string

Avsikten med yttrandet.
language

string

Representerar yttrandets språk. Det här är BCP-47-representation av ett språk. Använd till exempel "en" för engelska, "en-gb" för engelska (Storbritannien), "es" för spanska osv.
text

string

Yttrandetexten.

ConversationalAnalysisAuthoringProjectSettings

Objekt

Representerar de inställningar som används för att definiera projektbeteendet.

Name Typ Description
confidenceThreshold

number (float)

Tröskelvärdet för avsikten med högsta konfidens, där förutsägelsen automatiskt ändras till "Ingen".

Error

Objekt

Felobjektet.

Name Typ Description
code

ErrorCode

En av en serverdefinierad uppsättning felkoder.
details

Error[]

En matris med information om specifika fel som ledde till det rapporterade felet.
innererror

InnerErrorModel

Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message

string

En mänsklig läsbar representation av felet.
target

string

Målet för felet.

ErrorCode

Uppräkning

Felkod som kan läsas av människor.

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

ErrorResponse

Objekt

Felsvar.

Name Typ Description
error

Error

Felobjektet.

ExportedProjectFormat

Uppräkning

Formatet för den exporterade projektfilen som ska användas.

Värde Description
Conversation

Anger formatet för ett konversationsprojekt.
Luis

Anger formatet för ett program som exporterades från LUIS.

InnerErrorCode

Uppräkning

Felkod som kan läsas av människor.

Värde Description
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
EmptyRequest
ExtractionFailure
InvalidCountryHint
InvalidDocument
InvalidDocumentBatch
InvalidParameterValue
InvalidRequest
InvalidRequestBodyFormat
KnowledgeBaseNotFound
MissingInputDocuments
ModelVersionIncorrect
UnsupportedLanguageCode

InnerErrorModel

Objekt

Ett objekt som innehåller mer specifik information om felet. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name Typ Description
code

InnerErrorCode

En av en serverdefinierad uppsättning felkoder.
details

object

Felinformation.
innererror

InnerErrorModel

Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message

string

Felmeddelande.
target

string

Felmål.

ProjectKind

Uppräkning

Representerar projekttypen.

Värde Description
Conversation

Ett projekt för att skapa naturligt språk i appar, robotar och IoT-enheter.
Orchestration

Ett projekt för att ansluta och orkestrera konversation, anpassad fråga som svarar och LUIS-projekt tillsammans i ett enda projekt.

StringIndexType

Uppräkning

Anger den metod som används för att tolka strängförskjutningar. Mer information finns i https://aka.ms/text-analytics-offsets.

Värde Description
Utf16CodeUnit

Förskjutnings- och längdvärdena motsvarar UTF-16-kodenheter. Använd det här alternativet om ditt program är skrivet på ett språk som stöder Unicode, till exempel Java, JavaScript.