Conversational Analysis Authoring - Import
Memicu pekerjaan untuk mengimpor proyek. Jika sebuah proyek dengan nama yang sama sudah ada, data proyek tersebut diganti.
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
Parameter URI
Nama | Dalam | Diperlukan | Jenis | Deskripsi |
---|---|---|---|---|
Endpoint
|
path | True |
string |
Titik akhir Cognitive Services yang didukung (misalnya, https://.api.cognitiveservices.azure.com). |
project
|
path | True |
string |
Nama proyek yang akan digunakan. |
api-version
|
query | True |
string |
Versi API klien. |
format
|
query |
Format file proyek yang diekspor untuk digunakan. |
Isi Permintaan
Nama | Diperlukan | Jenis | Deskripsi |
---|---|---|---|
metadata | True |
Mewakili metadata proyek. |
|
projectFileVersion | True |
string |
Versi file yang diekspor. |
stringIndexType | True |
Menentukan metode yang digunakan untuk menginterpretasikan offset string. Untuk informasi tambahan lihat https://aka.ms/text-analytics-offsets. |
|
assets | ConversationalAnalysisAuthoringExportedProjectAssets: |
Mewakili aset proyek. |
Respons
Nama | Jenis | Deskripsi |
---|---|---|
202 Accepted |
Hasil call yang sukses dengan header Operasi-Lokasi yang digunakan untuk memeriksa status pekerjaan. Headers operation-location: string |
|
Other Status Codes |
Respons kesalahan. |
Keamanan
AADToken
Ini adalah Alur OAuth2 Azure Active Directory . Saat dipasangkan dengan kontrol akses berbasis peran Azure, kontrol akses tersebut dapat digunakan untuk mengontrol akses ke Azure Maps REST API. Kontrol akses berbasis peran Azure digunakan untuk menunjuk akses ke satu atau beberapa akun sumber daya atau sub-sumber daya Azure Maps. Setiap pengguna, grup, atau perwakilan layanan dapat diberikan akses melalui peran bawaan atau peran kustom yang terdiri dari satu atau beberapa izin untuk Azure Maps REST API.
Untuk menerapkan skenario, sebaiknya lihat konsep autentikasi. Singkatnya, definisi keamanan ini menyediakan solusi untuk pemodelan aplikasi melalui objek yang mampu mengontrol akses pada API dan cakupan tertentu.
Catatan
- Definisi keamanan ini memerlukan penggunaan
x-ms-client-id
header untuk menunjukkan sumber daya Azure Maps mana yang meminta akses aplikasi. Ini dapat diperoleh dari API manajemen Maps.
Authorization URL
khusus untuk instans cloud publik Azure. Sovereign cloud memiliki URL Otorisasi yang unik dan konfigurasi direktori Azure Active.
* Kontrol akses berbasis peran Azure dikonfigurasi dari bidang manajemen Azure melalui portal Azure, PowerShell, CLI, Azure SDK, atau REST API.
* Penggunaan Azure Maps Web SDK memungkinkan penyiapan berbasis konfigurasi aplikasi untuk beberapa kasus penggunaan.
- Saat ini, Azure Active Directory v1.0 atau v2.0 mendukung Kantor, Sekolah, dan Tamu tetapi tidak mendukung akun Pribadi.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nama | Deskripsi |
---|---|
https://cognitiveservices.azure.com/.default | https://cognitiveservices.azure.com/.default |
Ocp-Apim-Subscription-Key
Kunci langganan untuk sumber daya layanan Bahasa.
Type:
apiKey
In:
header
Contoh
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
Definisi
Nama | Deskripsi |
---|---|
Composition |
Perilaku yang harus diikuti ketika komponen entitas tumpang tindih satu sama lain. |
Conversational |
Mewakili entitas dengan komponennya. |
Conversational |
Mewakili niat yang diekspor dari proyek percakapan. |
Conversational |
Mewakili aset yang diekspor dari proyek percakapan. |
Conversational |
Mewakili ucapan yang diekspor untuk proyek percakapan. |
Conversational |
Mewakili opsi yang digunakan untuk membuat atau memperbarui proyek. |
Conversational |
Menentukan detail orkestrasi untuk target proyek Percakapan. |
Conversational |
Mewakili opsi orkestrasi untuk target proyek Percakapan. |
Conversational |
Mewakili komponen daftar entitas. |
Conversational |
Mewakili daftar sinonim di dalam komponen daftar |
Conversational |
Mewakili komponen regex entitas. |
Conversational |
Mewakili ekspresi regex di dalam komponen regex. Ekspresi ini mengikuti sintaks regex .NET. Untuk referensi, lihat di sini: https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions |
Conversational |
Mewakili sub-daftar di dalam komponen daftar. |
Conversational |
Menentukan detail orkestrasi untuk target aplikasi LUIS. |
Conversational |
Mewakili opsi orkestrasi untuk target aplikasi LUIS. |
Conversational |
Mewakili komponen entitas bawaan yang diekspor |
Conversational |
Mewakili proyek yang diekspor. |
Conversational |
Menentukan detail orkestrasi untuk target proyek Tanya Jawab. |
Conversational |
Mewakili opsi orkestrasi untuk target proyek Jawaban atas Pertanyaan. |
Conversational |
Mewakili label entitas untuk ucapan. |
Conversational |
Mewakili niat yang diekspor untuk proyek orkestrasi. |
Conversational |
Mewakili aset proyek orkestrasi. |
Conversational |
Mewakili ucapan proyek orkestrasi. |
Conversational |
Mewakili pengaturan yang digunakan untuk menentukan perilaku proyek. |
Error |
Objek kesalahan. |
Error |
Kode kesalahan yang dapat dibaca manusia. |
Error |
Respons kesalahan. |
Exported |
Format file proyek yang diekspor untuk digunakan. |
Inner |
Kode kesalahan yang dapat dibaca manusia. |
Inner |
Objek yang berisi informasi yang lebih spesifik tentang kesalahan tersebut. Sesuai panduan Microsoft One API - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. |
Project |
Mewakili jenis proyek. |
String |
Menentukan metode yang digunakan untuk menginterpretasikan offset string. Untuk informasi tambahan lihat https://aka.ms/text-analytics-offsets. |
CompositionSetting
Perilaku yang harus diikuti ketika komponen entitas tumpang tindih satu sama lain.
Nama | Jenis | Deskripsi |
---|---|---|
combineComponents |
string |
Ketika dua komponen atau lebih ditemukan dalam teks dan tumpang tindih, rentang komponen digabungkan bersama-sama menjadi satu rentang yang menggabungkan semuanya. |
requireExactOverlap |
string |
Semua komponen harus tumpang tindih pada karakter yang sama persis dalam teks agar entitas dapat dikembalikan. Jika salah satu komponen yang ditentukan tidak dicocokkan atau diprediksi, entitas tidak akan kembali. |
returnLongestOverlap |
string |
Ketika dua komponen atau lebih ditemukan dalam teks dan tumpang tindih, komponen dengan sekumpulan karakter terpanjang dikembalikan. |
separateComponents |
string |
Kecocokan atau prediksi setiap komponen ditampilkan sebagai instans terpisah dari entitas. |
ConversationalAnalysisAuthoringConversationExportedEntity
Mewakili entitas dengan komponennya.
Nama | Jenis | Deskripsi |
---|---|---|
category |
string |
Kategori entitas. |
compositionSetting |
Perilaku yang harus diikuti ketika komponen entitas tumpang tindih satu sama lain. |
|
list |
Komponen daftar entitas. |
|
prebuilts |
Komponen entitas bawaan. |
|
regex |
Komponen regex entitas. |
|
requiredComponents |
string[] |
Komponen yang diperlukan. Nilai yang diizinkan adalah 'learned', 'list', 'prebuilts' dan 'regex'. |
ConversationalAnalysisAuthoringConversationExportedIntent
Mewakili niat yang diekspor dari proyek percakapan.
Nama | Jenis | Deskripsi |
---|---|---|
category |
string |
Kategori niat. |
ConversationalAnalysisAuthoringConversationExportedProjectAssets
Mewakili aset yang diekspor dari proyek percakapan.
Nama | Jenis | Deskripsi |
---|---|---|
entities |
Entitas yang ditentukan dalam proyek. |
|
intents |
Niat yang ditentukan dalam proyek. |
|
projectKind |
string:
Conversation |
Jenis proyek yang berisi aset. |
utterances |
Conversational |
Ucapan yang didefinisikan dalam proyek. |
ConversationalAnalysisAuthoringConversationExportedUtterance
Mewakili ucapan yang diekspor untuk proyek percakapan.
Nama | Jenis | Deskripsi |
---|---|---|
dataset |
string |
Himpunan data untuk ucapan ini. Nilai yang diizinkan adalah 'Latih' dan 'Uji'. |
entities |
Conversational |
Mewakili label entitas ucapan. |
intent |
string |
Niat ungkapan. |
language |
string |
Mewakili bahasa ucapan. Ini adalah representasi BCP-47 dari sebuah bahasa. Misalnya, gunakan "en" untuk bahasa Inggris, "en-gb" untuk bahasa Inggris (Inggris), "es" untuk bahasa Spanyol dll. |
text |
string |
Teks ucapan. |
ConversationalAnalysisAuthoringCreateProjectOptions
Mewakili opsi yang digunakan untuk membuat atau memperbarui proyek.
Nama | Jenis | Deskripsi |
---|---|---|
description |
string |
Deskripsi proyek. |
language |
string |
Bahasa proyek. Ini adalah representasi BCP-47 dari sebuah bahasa. Misalnya, gunakan "en" untuk bahasa Inggris, "en-gb" untuk bahasa Inggris (Inggris), "es" untuk bahasa Spanyol dll. |
multilingual |
boolean |
Apakah proyek akan digunakan untuk beberapa bahasa atau tidak. |
projectKind |
Mewakili jenis proyek. |
|
projectName |
string |
Nama proyek baru. |
settings |
Pengaturan proyek. |
ConversationalAnalysisAuthoringExportedConversationOrchestration
Menentukan detail orkestrasi untuk target proyek Percakapan.
Nama | Jenis | Deskripsi |
---|---|---|
deploymentName |
string |
Nama penyebaran yang ditargetkan. |
projectName |
string |
Nama proyek yang ditargetkan. |
ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions
Mewakili opsi orkestrasi untuk target proyek Percakapan.
Nama | Jenis | Deskripsi |
---|---|---|
conversationOrchestration |
Conversational |
Detail target proyek percakapan. |
targetProjectKind |
string:
Conversation |
Jenis target yang digunakan dalam aliran orkestrasi. |
ConversationalAnalysisAuthoringExportedEntityList
Mewakili komponen daftar entitas.
Nama | Jenis | Deskripsi |
---|---|---|
sublists |
Sub-daftar komponen daftar. |
ConversationalAnalysisAuthoringExportedEntityListSynonym
Mewakili daftar sinonim di dalam komponen daftar
Nama | Jenis | Deskripsi |
---|---|---|
language |
string |
Mewakili bahasa sinonim. Ini adalah representasi BCP-47 dari sebuah bahasa. Misalnya, gunakan "en" untuk bahasa Inggris, "en-gb" untuk bahasa Inggris (Inggris), "es" untuk bahasa Spanyol dll. |
values |
string[] |
Daftar sinonim. |
ConversationalAnalysisAuthoringExportedEntityRegex
Mewakili komponen regex entitas.
Nama | Jenis | Deskripsi |
---|---|---|
expressions |
Conversational |
Ekspresi regex komponen regex. Ekspresi ini mengikuti sintaks regex .NET. Untuk referensi, lihat di sini: https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions |
ConversationalAnalysisAuthoringExportedEntityRegexExpression
Mewakili ekspresi regex di dalam komponen regex. Ekspresi ini mengikuti sintaks regex .NET. Untuk referensi, lihat di sini: https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions
Nama | Jenis | Deskripsi |
---|---|---|
language |
string |
Mewakili bahasa ekspresi regex. Ini adalah representasi BCP-47 dari sebuah bahasa. Misalnya, gunakan "en" untuk bahasa Inggris, "en-gb" untuk bahasa Inggris (Inggris), "es" untuk bahasa Spanyol dll. |
regexKey |
string |
Kunci ekspresi regex. |
regexPattern |
string |
Pola regex. |
ConversationalAnalysisAuthoringExportedEntitySublist
Mewakili sub-daftar di dalam komponen daftar.
Nama | Jenis | Deskripsi |
---|---|---|
listKey |
string |
Kunci sub-daftar. |
synonyms |
Frasa yang sesuai dengan sub-daftar. |
ConversationalAnalysisAuthoringExportedLuisOrchestration
Menentukan detail orkestrasi untuk target aplikasi LUIS.
Nama | Jenis | Deskripsi |
---|---|---|
appId |
string |
ID aplikasi LUIS. |
appVersion |
string |
Id versi yang ditargetkan. |
slotName |
string |
Nama slot yang ditargetkan. |
ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions
Mewakili opsi orkestrasi untuk target aplikasi LUIS.
Nama | Jenis | Deskripsi |
---|---|---|
luisOrchestration |
Detail target aplikasi LUIS. |
|
targetProjectKind |
string:
Luis |
Jenis target yang digunakan dalam aliran orkestrasi. |
ConversationalAnalysisAuthoringExportedPrebuiltEntity
Mewakili komponen entitas bawaan yang diekspor
Nama | Jenis | Deskripsi |
---|---|---|
category |
string |
Kategori entitas bawaan. |
ConversationalAnalysisAuthoringExportedProject
Mewakili proyek yang diekspor.
Nama | Jenis | Deskripsi |
---|---|---|
assets | ConversationalAnalysisAuthoringExportedProjectAssets: |
Mewakili aset proyek. |
metadata |
Mewakili metadata proyek. |
|
projectFileVersion |
string |
Versi file yang diekspor. |
stringIndexType |
Menentukan metode yang digunakan untuk menginterpretasikan offset string. Untuk informasi tambahan lihat https://aka.ms/text-analytics-offsets. |
ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration
Menentukan detail orkestrasi untuk target proyek Tanya Jawab.
Nama | Jenis | Deskripsi |
---|---|---|
projectName |
string |
Nama proyek target. |
ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions
Mewakili opsi orkestrasi untuk target proyek Jawaban atas Pertanyaan.
Nama | Jenis | Deskripsi |
---|---|---|
questionAnsweringOrchestration |
Conversational |
Detail proyek Jawaban atas Pertanyaan. |
targetProjectKind |
string:
Question |
Jenis target yang digunakan dalam aliran orkestrasi. |
ConversationalAnalysisAuthoringExportedUtteranceEntityLabel
Mewakili label entitas untuk ucapan.
Nama | Jenis | Deskripsi |
---|---|---|
category |
string |
Kategori label entitas. |
length |
integer |
Panjang untuk teks entitas. |
offset |
integer |
Posisi mulai untuk teks entitas. |
ConversationalAnalysisAuthoringOrchestrationExportedIntent
Mewakili niat yang diekspor untuk proyek orkestrasi.
Nama | Jenis | Deskripsi |
---|---|---|
category |
string |
Kategori niat. |
orchestration | ConversationalAnalysisAuthoringExportedOrchestrationOptions: |
Menentukan perilaku niat ini dalam alur orkestrasi. |
ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets
Mewakili aset proyek orkestrasi.
Nama | Jenis | Deskripsi |
---|---|---|
intents |
Conversational |
Mewakili niat proyek. |
projectKind |
string:
Orchestration |
Jenis proyek yang berisi aset. |
utterances |
Conversational |
Mewakili ucapan proyek. |
ConversationalAnalysisAuthoringOrchestrationExportedUtterance
Mewakili ucapan proyek orkestrasi.
Nama | Jenis | Deskripsi |
---|---|---|
dataset |
string |
Himpunan data untuk ucapan ini. Nilai yang diizinkan adalah 'Latih' dan 'Uji'. |
intent |
string |
Niat ungkapan. |
language |
string |
Mewakili bahasa ucapan. Ini adalah representasi BCP-47 dari sebuah bahasa. Misalnya, gunakan "en" untuk bahasa Inggris, "en-gb" untuk bahasa Inggris (Inggris), "es" untuk bahasa Spanyol dll. |
text |
string |
Teks ucapan. |
ConversationalAnalysisAuthoringProjectSettings
Mewakili pengaturan yang digunakan untuk menentukan perilaku proyek.
Nama | Jenis | Deskripsi |
---|---|---|
confidenceThreshold |
number |
Ambang niat dengan keyakinan tertinggi, di mana prediksi akan secara otomatis diubah menjadi "Tidak Ada". Nilai ambang harus antara 0 dan 1 inklusif. |
Error
Objek kesalahan.
Nama | Jenis | Deskripsi |
---|---|---|
code |
Salah satu set kode kesalahan yang ditentukan server. |
|
details |
Error[] |
Array detail tentang kesalahan tertentu yang menyebabkan kesalahan yang dilaporkan ini. |
innererror |
Objek yang berisi informasi yang lebih spesifik daripada objek saat ini tentang kesalahan. |
|
message |
string |
Representasi kesalahan yang dapat dibaca manusia. |
target |
string |
Target kesalahan. |
ErrorCode
Kode kesalahan yang dapat dibaca manusia.
Nama | Jenis | Deskripsi |
---|---|---|
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
Respons kesalahan.
Nama | Jenis | Deskripsi |
---|---|---|
error |
Objek kesalahan. |
ExportedProjectFormat
Format file proyek yang diekspor untuk digunakan.
Nama | Jenis | Deskripsi |
---|---|---|
Conversation |
string |
Menentukan format untuk proyek percakapan. |
Luis |
string |
Menentukan format untuk aplikasi yang diekspor dari LUIS. |
InnerErrorCode
Kode kesalahan yang dapat dibaca manusia.
Nama | Jenis | Deskripsi |
---|---|---|
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
Objek yang berisi informasi yang lebih spesifik tentang kesalahan tersebut. Sesuai panduan Microsoft One API - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
Nama | Jenis | Deskripsi |
---|---|---|
code |
Salah satu set kode kesalahan yang ditentukan server. |
|
details |
object |
Detail kesalahan. |
innererror |
Objek yang berisi informasi yang lebih spesifik daripada objek saat ini tentang kesalahan. |
|
message |
string |
Pesan kesalahan. |
target |
string |
Target kesalahan. |
ProjectKind
Mewakili jenis proyek.
Nama | Jenis | Deskripsi |
---|---|---|
Conversation |
string |
Proyek untuk membangun bahasa alami ke dalam aplikasi, bot, dan perangkat IoT. |
Orchestration |
string |
Proyek untuk menyambungkan dan mengatur Percakapan, Jawaban atas pertanyaan kustom, dan proyek LUIS bersama-sama dalam satu proyek tunggal. |
StringIndexType
Menentukan metode yang digunakan untuk menginterpretasikan offset string. Untuk informasi tambahan lihat https://aka.ms/text-analytics-offsets.
Nama | Jenis | Deskripsi |
---|---|---|
Utf16CodeUnit |
string |
Nilai offset dan panjang akan sesuai dengan unit kode UTF-16. Gunakan opsi ini jika aplikasi Anda ditulis dalam bahasa yang mendukung Unicode, misalnya Java, JavaScript. |