Conversational Analysis Authoring - Import
Wyzwala zadanie importowania projektu. Jeśli projekt o tej samej nazwie już istnieje, dane tego projektu zostaną zastąpione.
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 identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
Endpoint
|
path | True |
string |
Obsługiwany punkt końcowy usług Cognitive Services (np. https://.api.cognitiveservices.azure.com). |
project
|
path | True |
string |
Nazwa projektu do użycia. |
api-version
|
query | True |
string |
Wersja interfejsu API klienta. |
format
|
query |
Format wyeksportowanego pliku projektu do użycia. |
Treść żądania
Nazwa | Wymagane | Typ | Opis |
---|---|---|---|
metadata | True |
Reprezentuje metadane projektu. |
|
projectFileVersion | True |
string |
Wersja wyeksportowanego pliku. |
stringIndexType | True |
Określa metodę używaną do interpretowania przesunięcia ciągów. Aby uzyskać dodatkowe informacje, zobacz https://aka.ms/text-analytics-offsets. |
|
assets | ConversationalAnalysisAuthoringExportedProjectAssets: |
Reprezentuje zasoby projektu. |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
202 Accepted |
Wyniki pomyślnego wywołania z nagłówkiem Operation-Location służącym do sprawdzania stanu zadania. Headers operation-location: string |
|
Other Status Codes |
Odpowiedź na błąd. |
Zabezpieczenia
AADToken
Są to przepływy protokołu OAuth2 usługi Azure Active Directory . W połączeniu z kontrolą dostępu opartą na rolach platformy Azure może służyć do kontrolowania dostępu do interfejsów API REST Azure Maps. Mechanizmy kontroli dostępu opartej na rolach platformy Azure służą do wyznaczania dostępu do co najmniej jednego konta zasobów Azure Maps lub zasobów podrzędnych. Każdy użytkownik, grupa lub jednostka usługi może mieć dostęp za pośrednictwem wbudowanej roli lub roli niestandardowej składającej się z co najmniej jednego uprawnienia do Azure Maps interfejsów API REST.
Aby zaimplementować scenariusze, zalecamy wyświetlenie pojęć dotyczących uwierzytelniania. Podsumowując, ta definicja zabezpieczeń udostępnia rozwiązanie do modelowania aplikacji za pośrednictwem obiektów, które mogą kontrolować dostęp do określonych interfejsów API i zakresów.
Uwagi
- Ta definicja zabezpieczeń wymaga użycia nagłówka
x-ms-client-id
, aby wskazać, do którego zasobu Azure Maps aplikacja żąda dostępu. Można to uzyskać za pomocą interfejsu API zarządzania mapami.
Element Authorization URL
jest specyficzny dla wystąpienia chmury publicznej platformy Azure. Suwerenne chmury mają unikatowe adresy URL autoryzacji i konfiguracje usługi Azure Active Directory.
* Kontrola dostępu oparta na rolach platformy Azure jest konfigurowana z płaszczyzny zarządzania platformy Azure za pośrednictwem Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsów API REST.
* Użycie zestawu AZURE MAPS Web SDK umożliwia konfigurację opartą na konfiguracji aplikacji w wielu przypadkach użycia.
- Obecnie usługa Azure Active Directory w wersji 1.0 lub 2.0 obsługuje konta służbowe, szkolne i gości, ale nie obsługują kont osobistych.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nazwa | Opis |
---|---|
https://cognitiveservices.azure.com/.default | https://cognitiveservices.azure.com/.default |
Ocp-Apim-Subscription-Key
Klucz subskrypcji zasobu usługi językowej.
Type:
apiKey
In:
header
Przykłady
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
Definicje
Nazwa | Opis |
---|---|
Composition |
Zachowanie, które ma być przestrzegane, gdy składniki jednostki nakładają się na siebie nawzajem. |
Conversational |
Reprezentuje jednostkę ze swoimi składnikami. |
Conversational |
Reprezentuje wyeksportowaną intencję projektu konwersacyjnego. |
Conversational |
Reprezentuje wyeksportowane zasoby projektu konwersacyjnego. |
Conversational |
Reprezentuje wyeksportowaną wypowiedź dla projektu konwersacyjnego. |
Conversational |
Reprezentuje opcje używane do tworzenia lub aktualizowania projektu. |
Conversational |
Definiuje szczegóły aranżacji obiektu docelowego projektu konwersacyjnego. |
Conversational |
Reprezentuje opcje aranżacji obiektu docelowego projektu konwersacyjnego. |
Conversational |
Reprezentuje składnik listy jednostki. |
Conversational |
Reprezentuje listę synonimów wewnątrz składnika listy |
Conversational |
Reprezentuje składnik regex jednostki. |
Conversational |
Reprezentuje wyrażenie wyrażenia regularnego wewnątrz składnika regex. To wyrażenie jest zgodne ze składnią regex platformy .NET. Aby uzyskać informacje, sprawdź tutaj: https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions |
Conversational |
Reprezentuje listę podrzędną wewnątrz składnika listy. |
Conversational |
Definiuje szczegóły aranżacji obiektu docelowego aplikacji usługi LUIS. |
Conversational |
Reprezentuje opcje orkiestracji dla obiektu docelowego aplikacji usługi LUIS. |
Conversational |
Reprezentuje wyeksportowany wstępnie utworzony składnik jednostki |
Conversational |
Reprezentuje wyeksportowany projekt. |
Conversational |
Definiuje szczegóły aranżacji obiektu docelowego projektu odpowiedzi na pytania. |
Conversational |
Reprezentuje opcje aranżacji obiektu docelowego projektu odpowiedzi na pytania. |
Conversational |
Reprezentuje etykietę jednostki dla wypowiedzi. |
Conversational |
Reprezentuje wyeksportowaną intencję projektu aranżacji. |
Conversational |
Reprezentuje zasoby projektu aranżacji. |
Conversational |
Reprezentuje wypowiedź projektu aranżacji. |
Conversational |
Reprezentuje ustawienia używane do definiowania zachowania projektu. |
Error |
Obiekt błędu. |
Error |
Kod błędu czytelny dla człowieka. |
Error |
Odpowiedź na błąd. |
Exported |
Format wyeksportowanego pliku projektu do użycia. |
Inner |
Kod błędu czytelny dla człowieka. |
Inner |
Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi interfejsu API usługi Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. |
Project |
Reprezentuje rodzaj projektu. |
String |
Określa metodę używaną do interpretowania przesunięcia ciągów. Aby uzyskać dodatkowe informacje, zobacz https://aka.ms/text-analytics-offsets. |
CompositionSetting
Zachowanie, które ma być przestrzegane, gdy składniki jednostki nakładają się na siebie nawzajem.
Nazwa | Typ | Opis |
---|---|---|
combineComponents |
string |
Gdy w tekście znajduje się co najmniej dwa składniki i nakładają się na siebie, zakresy składników są scalane ze sobą w jeden zakres łączący wszystkie z nich. |
requireExactOverlap |
string |
Wszystkie składniki muszą nakładać się na dokładnie te same znaki w tekście, aby jednostka zwróciła. Jeśli jeden ze zdefiniowanych składników nie jest zgodny lub przewidywany, jednostka nie zostanie zwrócona. |
returnLongestOverlap |
string |
Gdy w tekście znajduje się co najmniej dwa składniki i nakładają się na siebie, zwracany jest składnik z najdłuższym zestawem znaków. |
separateComponents |
string |
Dopasowanie lub przewidywanie każdego składnika jest zwracane jako oddzielne wystąpienie jednostki. |
ConversationalAnalysisAuthoringConversationExportedEntity
Reprezentuje jednostkę ze swoimi składnikami.
Nazwa | Typ | Opis |
---|---|---|
category |
string |
Kategoria jednostki. |
compositionSetting |
Zachowanie, które ma być przestrzegane, gdy składniki jednostki nakładają się na siebie nawzajem. |
|
list |
Składnik listy jednostki. |
|
prebuilts |
Wstępnie utworzone składniki jednostek. |
|
regex |
Składnik regex jednostki. |
|
requiredComponents |
string[] |
Wymagane składniki. Dozwolone wartości to "poznane", "list", "wstępnie utworzone" i "regex". |
ConversationalAnalysisAuthoringConversationExportedIntent
Reprezentuje wyeksportowaną intencję projektu konwersacyjnego.
Nazwa | Typ | Opis |
---|---|---|
category |
string |
Kategoria intencji. |
ConversationalAnalysisAuthoringConversationExportedProjectAssets
Reprezentuje wyeksportowane zasoby projektu konwersacyjnego.
Nazwa | Typ | Opis |
---|---|---|
entities |
Jednostki zdefiniowane w projekcie. |
|
intents |
Intencje zdefiniowane w projekcie. |
|
projectKind |
string:
Conversation |
Typ projektu zawierającego zasoby. |
utterances |
Conversational |
Wypowiedzi zdefiniowane w projekcie. |
ConversationalAnalysisAuthoringConversationExportedUtterance
Reprezentuje wyeksportowaną wypowiedź dla projektu konwersacyjnego.
Nazwa | Typ | Opis |
---|---|---|
dataset |
string |
Zestaw danych dla tej wypowiedzi. Dozwolone wartości to "Train" (Trenowanie) i "Test". |
entities |
Conversational |
Reprezentuje etykiety jednostek wypowiedzi. |
intent |
string |
Intencja wypowiedzi. |
language |
string |
Reprezentuje język wypowiedzi. Jest to reprezentacja języka BCP-47. Na przykład użyj ciągu "en" dla języka angielskiego, "en-gb" dla języka angielskiego (Wielka Brytania), "es" dla języka hiszpańskiego itp. |
text |
string |
Tekst wypowiedzi. |
ConversationalAnalysisAuthoringCreateProjectOptions
Reprezentuje opcje używane do tworzenia lub aktualizowania projektu.
Nazwa | Typ | Opis |
---|---|---|
description |
string |
Opis projektu. |
language |
string |
Język projektu. Jest to reprezentacja języka BCP-47. Na przykład użyj ciągu "en" dla języka angielskiego, "en-gb" dla języka angielskiego (Wielka Brytania), "es" dla języka hiszpańskiego itp. |
multilingual |
boolean |
Czy projekt będzie używany w wielu językach, czy nie. |
projectKind |
Reprezentuje rodzaj projektu. |
|
projectName |
string |
Nowa nazwa projektu. |
settings |
Ustawienia projektu. |
ConversationalAnalysisAuthoringExportedConversationOrchestration
Definiuje szczegóły aranżacji obiektu docelowego projektu konwersacyjnego.
Nazwa | Typ | Opis |
---|---|---|
deploymentName |
string |
Nazwa wdrożenia docelowego. |
projectName |
string |
Nazwa projektu docelowego. |
ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions
Reprezentuje opcje aranżacji obiektu docelowego projektu konwersacyjnego.
Nazwa | Typ | Opis |
---|---|---|
conversationOrchestration |
Conversational |
Szczegóły obiektu docelowego projektu konwersacji. |
targetProjectKind |
string:
Conversation |
Rodzaj obiektu docelowego używanego w przepływie aranżacji. |
ConversationalAnalysisAuthoringExportedEntityList
Reprezentuje składnik listy jednostki.
Nazwa | Typ | Opis |
---|---|---|
sublists |
Pod listami składnika listy. |
ConversationalAnalysisAuthoringExportedEntityListSynonym
Reprezentuje listę synonimów wewnątrz składnika listy
Nazwa | Typ | Opis |
---|---|---|
language |
string |
Reprezentuje język synonimów. Jest to reprezentacja języka BCP-47. Na przykład użyj ciągu "en" dla języka angielskiego, "en-gb" dla języka angielskiego (Wielka Brytania), "es" dla języka hiszpańskiego itp. |
values |
string[] |
Lista synonimów. |
ConversationalAnalysisAuthoringExportedEntityRegex
Reprezentuje składnik regex jednostki.
Nazwa | Typ | Opis |
---|---|---|
expressions |
Conversational |
Wyrażenia regularne składnika regex. Te wyrażenia są zgodne ze składnią regex platformy .NET. Aby uzyskać informacje, sprawdź tutaj: https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions |
ConversationalAnalysisAuthoringExportedEntityRegexExpression
Reprezentuje wyrażenie wyrażenia regularnego wewnątrz składnika regex. To wyrażenie jest zgodne ze składnią regex platformy .NET. Aby uzyskać informacje, sprawdź tutaj: https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions
Nazwa | Typ | Opis |
---|---|---|
language |
string |
Reprezentuje język wyrażenia regularnego. Jest to reprezentacja języka BCP-47. Na przykład użyj ciągu "en" dla języka angielskiego, "en-gb" dla języka angielskiego (Wielka Brytania), "es" dla języka hiszpańskiego itp. |
regexKey |
string |
Klucz wyrażenia regularnego. |
regexPattern |
string |
Wzorzec regex. |
ConversationalAnalysisAuthoringExportedEntitySublist
Reprezentuje listę podrzędną wewnątrz składnika listy.
Nazwa | Typ | Opis |
---|---|---|
listKey |
string |
Klucz listy podrzędnej. |
synonyms |
Frazy, które odpowiadają pod liście. |
ConversationalAnalysisAuthoringExportedLuisOrchestration
Definiuje szczegóły aranżacji obiektu docelowego aplikacji usługi LUIS.
Nazwa | Typ | Opis |
---|---|---|
appId |
string |
Identyfikator aplikacji usługi LUIS. |
appVersion |
string |
Identyfikator wersji docelowej. |
slotName |
string |
Nazwa miejsca docelowego. |
ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions
Reprezentuje opcje orkiestracji dla obiektu docelowego aplikacji usługi LUIS.
Nazwa | Typ | Opis |
---|---|---|
luisOrchestration |
Szczegóły docelowej aplikacji usługi LUIS. |
|
targetProjectKind |
string:
Luis |
Rodzaj obiektu docelowego używanego w przepływie aranżacji. |
ConversationalAnalysisAuthoringExportedPrebuiltEntity
Reprezentuje wyeksportowany wstępnie utworzony składnik jednostki
Nazwa | Typ | Opis |
---|---|---|
category |
string |
Wstępnie utworzona kategoria jednostki. |
ConversationalAnalysisAuthoringExportedProject
Reprezentuje wyeksportowany projekt.
Nazwa | Typ | Opis |
---|---|---|
assets | ConversationalAnalysisAuthoringExportedProjectAssets: |
Reprezentuje zasoby projektu. |
metadata |
Reprezentuje metadane projektu. |
|
projectFileVersion |
string |
Wersja wyeksportowanego pliku. |
stringIndexType |
Określa metodę używaną do interpretowania przesunięcia ciągów. Aby uzyskać dodatkowe informacje, zobacz https://aka.ms/text-analytics-offsets. |
ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration
Definiuje szczegóły aranżacji obiektu docelowego projektu odpowiedzi na pytania.
Nazwa | Typ | Opis |
---|---|---|
projectName |
string |
Nazwa projektu docelowego. |
ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions
Reprezentuje opcje aranżacji obiektu docelowego projektu odpowiedzi na pytania.
Nazwa | Typ | Opis |
---|---|---|
questionAnsweringOrchestration |
Conversational |
Szczegóły projektu odpowiedzi na pytania. |
targetProjectKind |
string:
Question |
Rodzaj obiektu docelowego używanego w przepływie aranżacji. |
ConversationalAnalysisAuthoringExportedUtteranceEntityLabel
Reprezentuje etykietę jednostki dla wypowiedzi.
Nazwa | Typ | Opis |
---|---|---|
category |
string |
Kategoria etykiety jednostki. |
length |
integer |
Długość tekstu jednostki. |
offset |
integer |
Pozycja początkowa dla tekstu jednostki. |
ConversationalAnalysisAuthoringOrchestrationExportedIntent
Reprezentuje wyeksportowaną intencję projektu aranżacji.
Nazwa | Typ | Opis |
---|---|---|
category |
string |
Kategoria intencji. |
orchestration | ConversationalAnalysisAuthoringExportedOrchestrationOptions: |
Określa zachowanie tej intencji w przepływie aranżacji. |
ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets
Reprezentuje zasoby projektu aranżacji.
Nazwa | Typ | Opis |
---|---|---|
intents |
Conversational |
Reprezentuje intencje projektu. |
projectKind |
string:
Orchestration |
Typ projektu zawierającego zasoby. |
utterances |
Conversational |
Reprezentuje wypowiedzi projektu. |
ConversationalAnalysisAuthoringOrchestrationExportedUtterance
Reprezentuje wypowiedź projektu aranżacji.
Nazwa | Typ | Opis |
---|---|---|
dataset |
string |
Zestaw danych dla tej wypowiedzi. Dozwolone wartości to "Train" (Trenowanie) i "Test". |
intent |
string |
Intencja wypowiedzi. |
language |
string |
Reprezentuje język wypowiedzi. Jest to reprezentacja języka BCP-47. Na przykład użyj ciągu "en" dla języka angielskiego, "en-gb" dla języka angielskiego (Wielka Brytania), "es" dla języka hiszpańskiego itp. |
text |
string |
Tekst wypowiedzi. |
ConversationalAnalysisAuthoringProjectSettings
Reprezentuje ustawienia używane do definiowania zachowania projektu.
Nazwa | Typ | Opis |
---|---|---|
confidenceThreshold |
number |
Próg intencji z największą ufnością, przy której przewidywanie zostanie automatycznie zmienione na "Brak". Wartość progu powinna należeć do przedziału od 0 do 1 włącznie. |
Error
Obiekt błędu.
Nazwa | Typ | Opis |
---|---|---|
code |
Jeden z zdefiniowanych przez serwer zestaw kodów błędów. |
|
details |
Error[] |
Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu. |
innererror |
Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie. |
|
message |
string |
Czytelna dla człowieka reprezentacja błędu. |
target |
string |
Element docelowy błędu. |
ErrorCode
Kod błędu czytelny dla człowieka.
Nazwa | Typ | Opis |
---|---|---|
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
Odpowiedź na błąd.
Nazwa | Typ | Opis |
---|---|---|
error |
Obiekt błędu. |
ExportedProjectFormat
Format wyeksportowanego pliku projektu do użycia.
Nazwa | Typ | Opis |
---|---|---|
Conversation |
string |
Określa format projektu konwersacyjnego. |
Luis |
string |
Określa format aplikacji wyeksportowanej z usługi LUIS. |
InnerErrorCode
Kod błędu czytelny dla człowieka.
Nazwa | Typ | Opis |
---|---|---|
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
Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi interfejsu API usługi Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
Nazwa | Typ | Opis |
---|---|---|
code |
Jeden z zdefiniowanych przez serwer zestaw kodów błędów. |
|
details |
object |
Szczegóły błędu. |
innererror |
Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie. |
|
message |
string |
Komunikat o błędzie. |
target |
string |
Błąd docelowy. |
ProjectKind
Reprezentuje rodzaj projektu.
Nazwa | Typ | Opis |
---|---|---|
Conversation |
string |
Projekt tworzenia języka naturalnego w aplikacjach, botach i urządzeniach IoT. |
Orchestration |
string |
Projekt umożliwiający łączenie i organizowanie konwersacji, niestandardowe odpowiedzi na pytania i projekty usługi LUIS w jednym projekcie. |
StringIndexType
Określa metodę używaną do interpretowania przesunięcia ciągów. Aby uzyskać dodatkowe informacje, zobacz https://aka.ms/text-analytics-offsets.
Nazwa | Typ | Opis |
---|---|---|
Utf16CodeUnit |
string |
Wartości przesunięcia i długości odpowiadają jednostkom kodu UTF-16. Użyj tej opcji, jeśli aplikacja jest napisana w języku obsługującym kod Unicode, na przykład JavaScript. |