Conversational Analysis Authoring - Import
Utlöser ett jobb för att importera ett projekt. Om det redan finns ett projekt med samma namn ersätts data för det projektet.
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-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
Endpoint
|
path | True |
string |
Cognitive Services-slutpunkt som stöds (t.ex. https://.api.cognitiveservices.azure.com). |
project
|
path | True |
string |
Namnet på det projekt som ska användas. |
api-version
|
query | True |
string |
Klient-API-version. |
format
|
query |
Formatet för den exporterade projektfilen som ska användas. |
Begärandetext
Name | Obligatorisk | Typ | Description |
---|---|---|---|
metadata | True |
Representerar projektets metadata. |
|
projectFileVersion | True |
string |
Den exporterade filens version. |
stringIndexType | True |
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. Headers operation-location: string |
|
Other Status Codes |
Felsvar. |
Säkerhet
AADToken
Det här är Azure Active Directory OAuth2-flöden . När den är kopplad till rollbaserad åtkomstkontroll i Azure kan den användas för att styra åtkomsten till Azure Maps REST-API:er. Rollbaserade åtkomstkontroller i Azure används för att ange åtkomst till en eller flera Azure Maps resurskonto eller underresurser. Alla användare, grupper eller tjänstens huvudnamn kan beviljas åtkomst via en inbyggd roll eller en anpassad roll som består av en eller flera behörigheter för att Azure Maps REST-API:er.
För att implementera scenarier rekommenderar vi att du visar autentiseringsbegrepp. Sammanfattningsvis tillhandahåller den här säkerhetsdefinitionen en lösning för modellering av program via objekt som kan få åtkomstkontroll för specifika API:er och omfång.
Kommentarer
- Den här säkerhetsdefinitionen
x-ms-client-id
kräver att huvudet används för att ange vilken Azure Maps resurs som programmet begär åtkomst till. Detta kan hämtas från Maps Management-API:et.
Authorization URL
är specifikt för den offentliga Azure-molninstansen. Nationella moln har unika auktoriserings-URL:er och Azure Active Directory-konfigurationer.
* Den rollbaserade Azure-åtkomstkontrollen konfigureras från Azure-hanteringsplanet via Azure Portal, PowerShell, CLI, Azure SDK:er eller REST-API:er.
* Användning av Azure Maps Web SDK möjliggör konfigurationsbaserad konfiguration av ett program för flera användningsfall.
- För närvarande har Azure Active Directory v1.0 eller v2.0 stöd för arbete, skola och gäster, men har inte stöd för personliga konton.
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
En prenumerationsnyckel för en språktjänstresurs.
Type:
apiKey
In:
header
Exempel
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
Definitioner
Name | Description |
---|---|
Composition |
Beteendet att följa när entitetens komponenter överlappar varandra. |
Conversational |
Representerar en entitet med dess komponenter. |
Conversational |
Representerar en exporterad avsikt för ett konversationsprojekt. |
Conversational |
Representerar de exporterade tillgångarna i ett konversationsprojekt. |
Conversational |
Representerar ett exporterat yttrande för ett konversationsprojekt. |
Conversational |
Representerar de alternativ som används för att skapa eller uppdatera ett projekt. |
Conversational |
Definierar orkestreringsinformationen för ett projektmål för konversation. |
Conversational |
Representerar orkestreringsalternativen för ett projektmål för konversation. |
Conversational |
Representerar en listkomponent i en entitet. |
Conversational |
Representerar en lista över synonymer i en listkomponent |
Conversational |
Representerar en regex-komponent i en entitet. |
Conversational |
Representerar ett regex-uttryck i en regex-komponent. Det här uttrycket följer .NET regex-syntaxen. Referens finns här: https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions |
Conversational |
Representerar en underlista i en listkomponent. |
Conversational |
Definierar orkestreringsinformationen för ett LUIS-programmål. |
Conversational |
Representerar orkestreringsalternativen för ett LUIS-programmål. |
Conversational |
Representerar en exporterad fördefinierad entitetskomponent |
Conversational |
Representerar ett exporterat projekt. |
Conversational |
Definierar orkestreringsinformationen för ett projektmål för frågesvar. |
Conversational |
Representerar orkestreringsalternativen för ett projektmål för frågesvar. |
Conversational |
Representerar en entitetsetikett för ett yttrande. |
Conversational |
Representerar en exporterad avsikt för ett orkestreringsprojekt. |
Conversational |
Representerar tillgångarna i ett orkestreringsprojekt. |
Conversational |
Representerar ett yttrande från ett orkestreringsprojekt. |
Conversational |
Representerar de inställningar som används för att definiera projektbeteendet. |
Error |
Felobjektet. |
Error |
Felkod som kan läsas av människor. |
Error |
Felsvar. |
Exported |
Formatet för den exporterade projektfilen som ska användas. |
Inner |
Felkod som kan läsas av människor. |
Inner |
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. |
Project |
Representerar projekttypen. |
String |
Anger den metod som används för att tolka strängförskjutningar. Mer information finns i https://aka.ms/text-analytics-offsets. |
CompositionSetting
Beteendet att följa när entitetens komponenter överlappar varandra.
Name | Typ | Description |
---|---|---|
combineComponents |
string |
När två eller flera komponenter hittas i texten och överlappar sammanslås komponenternas spännvidd i ett spann som kombinerar dem alla. |
requireExactOverlap |
string |
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 |
string |
När två eller flera komponenter hittas i texten och överlappar returneras komponenten med den längsta uppsättningen tecken. |
separateComponents |
string |
Varje komponents matchning eller förutsägelse returneras som en separat instans av entiteten. |
ConversationalAnalysisAuthoringConversationExportedEntity
Representerar en entitet med dess komponenter.
Name | Typ | Description |
---|---|---|
category |
string |
Kategorin för entiteten. |
compositionSetting |
Beteendet att följa när entitetens komponenter överlappar varandra. |
|
list |
Listkomponenten för entiteten. |
|
prebuilts |
De fördefinierade komponenterna för entiteter. |
|
regex |
Regex-komponenten för entiteten. |
|
requiredComponents |
string[] |
Nödvändiga komponenter. Tillåtna värden är "learned", "list", "prebuilts" och "regex". |
ConversationalAnalysisAuthoringConversationExportedIntent
Representerar en exporterad avsikt för ett konversationsprojekt.
Name | Typ | Description |
---|---|---|
category |
string |
Avsiktskategorin. |
ConversationalAnalysisAuthoringConversationExportedProjectAssets
Representerar de exporterade tillgångarna i ett konversationsprojekt.
Name | Typ | Description |
---|---|---|
entities |
Entiteterna som definierats i projektet. |
|
intents |
Avsikterna som definierats i projektet. |
|
projectKind |
string:
Conversation |
Typen av projekt som innehåller tillgångarna. |
utterances |
Conversational |
De yttranden som definierats i projektet. |
ConversationalAnalysisAuthoringConversationExportedUtterance
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 "Träna" och "Test". |
entities |
Conversational |
Representerar entitetsetiketterna för yttrandet. |
intent |
string |
Avsikten med yttrandet. |
language |
string |
Representerar yttrandets språk. Detta ä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
Representerar de alternativ som används för att skapa eller uppdatera ett projekt.
Name | Typ | Description |
---|---|---|
description |
string |
Projektbeskrivningen. |
language |
string |
Projektspråket. Detta ä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 |
Representerar projekttypen. |
|
projectName |
string |
Det nya projektnamnet. |
settings |
Projektinställningarna. |
ConversationalAnalysisAuthoringExportedConversationOrchestration
Definierar orkestreringsinformationen för ett projektmål för konversation.
Name | Typ | Description |
---|---|---|
deploymentName |
string |
Namnet på den riktade distributionen. |
projectName |
string |
Namnet på målprojektet. |
ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions
Representerar orkestreringsalternativen för ett projektmål för konversation.
Name | Typ | Description |
---|---|---|
conversationOrchestration |
Conversational |
Målinformation för konversationsprojektet. |
targetProjectKind |
string:
Conversation |
Den typ av mål som används i orkestreringsflödet. |
ConversationalAnalysisAuthoringExportedEntityList
Representerar en listkomponent i en entitet.
Name | Typ | Description |
---|---|---|
sublists |
Underlistorna för listkomponenten. |
ConversationalAnalysisAuthoringExportedEntityListSynonym
Representerar en lista över synonymer i en listkomponent
Name | Typ | Description |
---|---|---|
language |
string |
Representerar synonymernas språk. Detta ä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. |
ConversationalAnalysisAuthoringExportedEntityRegex
Representerar en regex-komponent i en entitet.
Name | Typ | Description |
---|---|---|
expressions |
Conversational |
Regex-uttrycken för regex-komponenten. Dessa uttryck följer .NET regex-syntaxen. Referens finns här: https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions |
ConversationalAnalysisAuthoringExportedEntityRegexExpression
Representerar ett regex-uttryck i en regex-komponent. Det här uttrycket följer .NET regex-syntaxen. Referens finns här: https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions
Name | Typ | Description |
---|---|---|
language |
string |
Representerar språket i regex-uttrycket. Detta ä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. |
regexKey |
string |
Nyckeln för regex-uttrycket. |
regexPattern |
string |
Regex-mönstret. |
ConversationalAnalysisAuthoringExportedEntitySublist
Representerar en underlista i en listkomponent.
Name | Typ | Description |
---|---|---|
listKey |
string |
Nyckeln för underlistan. |
synonyms |
Fraserna i som motsvarar underlistan. |
ConversationalAnalysisAuthoringExportedLuisOrchestration
Definierar orkestreringsinformationen för ett LUIS-programmål.
Name | Typ | Description |
---|---|---|
appId |
string |
LUIS-program-ID. |
appVersion |
string |
Målversions-ID:t. |
slotName |
string |
Målplatsens namn. |
ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions
Representerar orkestreringsalternativen för ett LUIS-programmål.
Name | Typ | Description |
---|---|---|
luisOrchestration |
Information om LUIS-programmets mål. |
|
targetProjectKind |
string:
Luis |
Den typ av mål som används i orkestreringsflödet. |
ConversationalAnalysisAuthoringExportedPrebuiltEntity
Representerar en exporterad fördefinierad entitetskomponent
Name | Typ | Description |
---|---|---|
category |
string |
Den fördefinierade entitetskategorin. |
ConversationalAnalysisAuthoringExportedProject
Representerar ett exporterat projekt.
Name | Typ | Description |
---|---|---|
assets | ConversationalAnalysisAuthoringExportedProjectAssets: |
Representerar projekttillgångarna. |
metadata |
Representerar projektets metadata. |
|
projectFileVersion |
string |
Den exporterade filens version. |
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
Definierar orkestreringsinformationen för ett projektmål för frågesvar.
Name | Typ | Description |
---|---|---|
projectName |
string |
Namnet på målprojektet. |
ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions
Representerar orkestreringsalternativen för ett projektmål för frågesvar.
Name | Typ | Description |
---|---|---|
questionAnsweringOrchestration |
Conversational |
Information om frågesvarsprojektet. |
targetProjectKind |
string:
Question |
Den typ av mål som används i orkestreringsflödet. |
ConversationalAnalysisAuthoringExportedUtteranceEntityLabel
Representerar en entitetsetikett för ett yttrande.
Name | Typ | Description |
---|---|---|
category |
string |
Kategorin för entitetsetiketten. |
length |
integer |
Entitetstextens längd. |
offset |
integer |
Startposition för entitetstexten. |
ConversationalAnalysisAuthoringOrchestrationExportedIntent
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
Representerar tillgångarna i ett orkestreringsprojekt.
Name | Typ | Description |
---|---|---|
intents |
Conversational |
Representerar projektets avsikter. |
projectKind |
string:
Orchestration |
Typen av projekt som innehåller tillgångarna. |
utterances |
Conversational |
Representerar projektets yttranden. |
ConversationalAnalysisAuthoringOrchestrationExportedUtterance
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 "Träna" och "Test". |
intent |
string |
Avsikten med yttrandet. |
language |
string |
Representerar yttrandets språk. Detta ä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
Representerar de inställningar som används för att definiera projektbeteendet.
Name | Typ | Description |
---|---|---|
confidenceThreshold |
number |
Tröskelvärdet för avsikten med högsta konfidens, där förutsägelsen automatiskt ändras till "Ingen". Värdet för tröskelvärdet ska vara mellan 0 och 1 inklusive. |
Error
Felobjektet.
Name | Typ | Description |
---|---|---|
code |
En av en serverdefinierad uppsättning felkoder. |
|
details |
Error[] |
En matris med information om specifika fel som ledde till det rapporterade felet. |
innererror |
Ett objekt som innehåller mer specifik information än det aktuella objektet om felet. |
|
message |
string |
En läsbar återgivning av felet. |
target |
string |
Målet för felet. |
ErrorCode
Felkod som kan läsas av människor.
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
Felsvar.
Name | Typ | Description |
---|---|---|
error |
Felobjektet. |
ExportedProjectFormat
Formatet för den exporterade projektfilen som ska användas.
Name | Typ | Description |
---|---|---|
Conversation |
string |
Anger formatet för ett konversationsprojekt. |
Luis |
string |
Anger formatet för ett program som exporterades från LUIS. |
InnerErrorCode
Felkod som kan läsas av människor.
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
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 |
En av en serverdefinierad uppsättning felkoder. |
|
details |
object |
Felinformation. |
innererror |
Ett objekt som innehåller mer specifik information än det aktuella objektet om felet. |
|
message |
string |
Felmeddelande. |
target |
string |
Felmål. |
ProjectKind
Representerar projekttypen.
Name | Typ | Description |
---|---|---|
Conversation |
string |
Ett projekt för att skapa naturligt språk i appar, robotar och IoT-enheter. |
Orchestration |
string |
Ett projekt för att ansluta och samordna konversations-, anpassade frågesvars- och LUIS-projekt i ett enda projekt. |
StringIndexType
Anger den metod som används för att tolka strängförskjutningar. Mer information finns i https://aka.ms/text-analytics-offsets.
Name | Typ | Description |
---|---|---|
Utf16CodeUnit |
string |
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. |