Conversational Analysis Authoring - Import
Projeyi içeri aktarmak için bir işi tetikler. Aynı ada sahip bir proje zaten varsa, o projenin verileri değiştirilir.
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 Parametreleri
Name | İçinde | Gerekli | Tür | Description |
---|---|---|---|---|
Endpoint
|
path | True |
string |
Desteklenen Bilişsel Hizmetler uç noktası (ör. https://.api.cognitiveservices.azure.com). |
project
|
path | True |
string |
Kullanılacak projenin adı. |
api-version
|
query | True |
string |
İstemci API sürümü. |
format
|
query |
Kullanılacak dışarı aktarılan proje dosyasının biçimi. |
İstek Gövdesi
Name | Gerekli | Tür | Description |
---|---|---|---|
metadata | True |
Proje meta verilerini temsil eder. |
|
projectFileVersion | True |
string |
Dışarı aktarılan dosyanın sürümü. |
stringIndexType | True |
Dize uzaklıklarını yorumlamak için kullanılan yöntemi belirtir. Ek bilgi için bkz https://aka.ms/text-analytics-offsets. . |
|
assets | ConversationalAnalysisAuthoringExportedProjectAssets: |
Proje varlıklarını temsil eder. |
Yanıtlar
Name | Tür | Description |
---|---|---|
202 Accepted |
Başarılı bir çağrı, işin durumunu denetlemek için kullanılan bir Operation-Location üst bilgisi ile sonuçlanır. Üst Bilgiler operation-location: string |
|
Other Status Codes |
Hata yanıtı. |
Güvenlik
AADToken
Bunlar Azure Active Directory OAuth2 Akışlarıdır. Azure rol tabanlı erişim denetimiyle eşleştirildiğinde, Azure Haritalar REST API'lerine erişimi denetlemek için kullanılabilir. Azure rol tabanlı erişim denetimleri, bir veya daha fazla Azure Haritalar kaynak hesabına veya alt kaynağa erişim tanımlamak için kullanılır. Tüm kullanıcılara, gruplara veya hizmet sorumlularına yerleşik bir rol veya Azure Haritalar REST API'leri için bir veya daha fazla izinden oluşan özel bir rol aracılığıyla erişim verilebilir.
Senaryoları uygulamak için kimlik doğrulama kavramlarını görüntülemenizi öneririz. Özetle, bu güvenlik tanımı belirli API'ler ve kapsamlar üzerinde erişim denetimi yapabilen nesneler aracılığıyla uygulamaları modellemek için bir çözüm sağlar.
Notlar
- Bu güvenlik tanımı, uygulamanın erişim istediği Azure Haritalar kaynağı belirtmek için üst bilgi kullanımını
x-ms-client-id
gerektirir. Bu, Haritalar yönetim API'sinden alınabilir.
Authorization URL
, Azure genel bulut örneğine özgüdür. Bağımsız bulutların benzersiz Yetkilendirme URL'leri ve Azure Active Directory yapılandırmaları vardır.
* Azure rol tabanlı erişim denetimi azure yönetim düzleminden Azure portal, PowerShell, CLI, Azure SDK'ları veya REST API'leri aracılığıyla yapılandırılır.
* Azure Haritalar Web SDK'sının kullanımı, bir uygulamanın birden çok kullanım örneği için yapılandırma tabanlı kurulumuna olanak tanır.
- Şu anda Azure Active Directory v1.0 veya v2.0 , İş, Okul ve Konuklar'ı destekler ancak Kişisel hesapları desteklemez.
Tür:
oauth2
Akış:
implicit
Yetkilendirme URL’si:
https://login.microsoftonline.com/common/oauth2/authorize
Kapsamlar
Name | Description |
---|---|
https://cognitiveservices.azure.com/.default | https://cognitiveservices.azure.com/.default |
Ocp-Apim-Subscription-Key
Dil hizmeti kaynağı için abonelik anahtarı.
Tür:
apiKey
İçinde:
header
Örnekler
Successful Import Project
Örnek isteği
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": []
}
]
}
}
Örnek yanıt
operation-location: {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/import/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-01
Tanımlar
Name | Description |
---|---|
Composition |
Varlığın bileşenleri birbiriyle çakıştığında izleyebileceğiniz davranış. |
Conversational |
Bileşenleriyle bir varlığı temsil eder. |
Conversational |
Konuşma projesinin dışarı aktarılan amacını temsil eder. |
Conversational |
Konuşma projesinin dışarı aktarılan varlıklarını temsil eder. |
Conversational |
Konuşma projesi için dışarı aktarılan bir konuşmayı temsil eder. |
Conversational |
Proje oluşturmak veya güncelleştirmek için kullanılan seçenekleri temsil eder. |
Conversational |
Konuşma projesi hedefi için düzenleme ayrıntılarını tanımlar. |
Conversational |
Konuşma projesi hedefi için düzenleme seçeneklerini temsil eder. |
Conversational |
Bir varlığın liste bileşenini temsil eder. |
Conversational |
Liste bileşeni içindeki eş anlamlılar listesini temsil eder |
Conversational |
Bir varlığın regex bileşenini temsil eder. |
Conversational |
Bir regex bileşeni içindeki bir regex ifadesini temsil eder. Bu ifade .NET regex söz dizimini izler. Başvuru için buraya bakın: https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions |
Conversational |
Liste bileşeni içindeki bir alt listeyi temsil eder. |
Conversational |
LUIS uygulama hedefi için düzenleme ayrıntılarını tanımlar. |
Conversational |
LUIS uygulama hedefi için düzenleme seçeneklerini temsil eder. |
Conversational |
Dışarı aktarılan önceden oluşturulmuş varlık bileşenini temsil eder |
Conversational |
Dışarı aktarılan bir projeyi temsil eder. |
Conversational |
Soru Yanıtlama proje hedefi için düzenleme ayrıntılarını tanımlar. |
Conversational |
Soru Yanıtlama proje hedefi için düzenleme seçeneklerini temsil eder. |
Conversational |
Konuşma için bir varlık etiketini temsil eder. |
Conversational |
Düzenleme projesi için dışarı aktarılan amacı temsil eder. |
Conversational |
Düzenleme projesinin varlıklarını temsil eder. |
Conversational |
Düzenleme projesinin konuşmalarını temsil eder. |
Conversational |
Proje davranışını tanımlamak için kullanılan ayarları temsil eder. |
Error |
Hata nesnesi. |
Error |
İnsan tarafından okunabilir hata kodu. |
Error |
Hata yanıtı. |
Exported |
Kullanılacak dışarı aktarılan proje dosyasının biçimi. |
Inner |
İnsan tarafından okunabilir hata kodu. |
Inner |
Hata hakkında daha ayrıntılı bilgi içeren bir nesne. Microsoft One API yönergelerine göre - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. |
Project |
Proje türünü temsil eder. |
String |
Dize uzaklıklarını yorumlamak için kullanılan yöntemi belirtir. Ek bilgi için bkz https://aka.ms/text-analytics-offsets. . |
CompositionSetting
Varlığın bileşenleri birbiriyle çakıştığında izleyebileceğiniz davranış.
Name | Tür | Description |
---|---|---|
combineComponents |
string |
Metinde iki veya daha fazla bileşen bulunduğunda ve örtüştüğünde, bileşenlerin yayılma alanları bir araya getirilerek tümü birleştirilir. |
requireExactOverlap |
string |
Varlığın döndürülmesi için tüm bileşenlerin metindeki tam olarak aynı karakterlerle çakışması gerekir. Tanımlanan bileşenlerden biri eşleştirilmediyse veya tahmin edilmediyse varlık döndürülmeyecektir. |
returnLongestOverlap |
string |
Metinde iki veya daha fazla bileşen bulunduğunda ve örtüştüğünde, en uzun karakter kümesine sahip bileşen döndürülür. |
separateComponents |
string |
Her bileşenin eşleşmesi veya tahmini, varlığın ayrı bir örneği olarak döndürülür. |
ConversationalAnalysisAuthoringConversationExportedEntity
Bileşenleriyle bir varlığı temsil eder.
Name | Tür | Description |
---|---|---|
category |
string |
Varlığın kategorisi. |
compositionSetting |
Varlığın bileşenleri birbiriyle çakıştığında izleyebileceğiniz davranış. |
|
list |
Varlığın liste bileşeni. |
|
prebuilts |
Önceden oluşturulmuş varlıklar bileşenleri. |
|
regex |
Varlığın regex bileşeni. |
|
requiredComponents |
string[] |
Gerekli bileşenler. İzin verilen değerler 'learned', 'list', 'prebuilts' ve 'regex' değerleridir. |
ConversationalAnalysisAuthoringConversationExportedIntent
Konuşma projesinin dışarı aktarılan amacını temsil eder.
Name | Tür | Description |
---|---|---|
category |
string |
Amaç kategorisi. |
ConversationalAnalysisAuthoringConversationExportedProjectAssets
Konuşma projesinin dışarı aktarılan varlıklarını temsil eder.
Name | Tür | Description |
---|---|---|
entities |
Projede tanımlanan varlıklar. |
|
intents |
Projede tanımlanan amaçlar. |
|
projectKind |
string:
Conversation |
Varlıkları içeren proje türü. |
utterances |
Conversational |
Projede tanımlanan konuşmalar. |
ConversationalAnalysisAuthoringConversationExportedUtterance
Konuşma projesi için dışarı aktarılan bir konuşmayı temsil eder.
Name | Tür | Description |
---|---|---|
dataset |
string |
Bu konuşmanın veri kümesi. İzin verilen değerler 'Train' ve 'Test' değerleridir. |
entities |
Conversational |
İfadenin varlık etiketlerini temsil eder. |
intent |
string |
Konuşmanın amacı. |
language |
string |
Konuşmanın dilini temsil eder. Bu, bir dilin BCP-47 gösterimidir. Örneğin, İngilizce için "en", İngilizce (Birleşik Krallık) için "en-gb", İspanyolca için "es" vb. kullanın. |
text |
string |
Konuşma metni. |
ConversationalAnalysisAuthoringCreateProjectOptions
Proje oluşturmak veya güncelleştirmek için kullanılan seçenekleri temsil eder.
Name | Tür | Description |
---|---|---|
description |
string |
Proje açıklaması. |
language |
string |
Proje dili. Bu, bir dilin BCP-47 gösterimidir. Örneğin, İngilizce için "en", İngilizce (Birleşik Krallık) için "en-gb", İspanyolca için "es" vb. kullanın. |
multilingual |
boolean |
Projenin birden çok dil için kullanılıp kullanılmayacağı. |
projectKind |
Proje türünü temsil eder. |
|
projectName |
string |
Yeni proje adı. |
settings |
Proje ayarları. |
ConversationalAnalysisAuthoringExportedConversationOrchestration
Konuşma projesi hedefi için düzenleme ayrıntılarını tanımlar.
Name | Tür | Description |
---|---|---|
deploymentName |
string |
Hedeflenen dağıtımın adı. |
projectName |
string |
Hedeflenen projenin adı. |
ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions
Konuşma projesi hedefi için düzenleme seçeneklerini temsil eder.
Name | Tür | Description |
---|---|---|
conversationOrchestration |
Conversational |
Konuşma projesinin hedef ayrıntıları. |
targetProjectKind |
string:
Conversation |
Düzenleme akışında kullanılan hedefin türü. |
ConversationalAnalysisAuthoringExportedEntityList
Bir varlığın liste bileşenini temsil eder.
Name | Tür | Description |
---|---|---|
sublists |
Liste bileşeninin alt listeleri. |
ConversationalAnalysisAuthoringExportedEntityListSynonym
Liste bileşeni içindeki eş anlamlılar listesini temsil eder
Name | Tür | Description |
---|---|---|
language |
string |
Eş anlamlıların dilini temsil eder. Bu, bir dilin BCP-47 gösterimidir. Örneğin, İngilizce için "en", İngilizce (Birleşik Krallık) için "en-gb", İspanyolca için "es" vb. kullanın. |
values |
string[] |
Eş anlamlılar listesi. |
ConversationalAnalysisAuthoringExportedEntityRegex
Bir varlığın regex bileşenini temsil eder.
Name | Tür | Description |
---|---|---|
expressions |
Conversational |
Regex bileşeninin regex ifadeleri. Bu ifadeler .NET regex söz dizimini izler. Başvuru için buraya bakın: https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions |
ConversationalAnalysisAuthoringExportedEntityRegexExpression
Bir regex bileşeni içindeki bir regex ifadesini temsil eder. Bu ifade .NET regex söz dizimini izler. Başvuru için buraya bakın: https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions
Name | Tür | Description |
---|---|---|
language |
string |
Regex ifadesinin dilini temsil eder. Bu, bir dilin BCP-47 gösterimidir. Örneğin, İngilizce için "en", İngilizce (Birleşik Krallık) için "en-gb", İspanyolca için "es" vb. kullanın. |
regexKey |
string |
Regex ifadesinin anahtarı. |
regexPattern |
string |
Regex deseni. |
ConversationalAnalysisAuthoringExportedEntitySublist
Liste bileşeni içindeki bir alt listeyi temsil eder.
Name | Tür | Description |
---|---|---|
listKey |
string |
Alt listenin anahtarı. |
synonyms |
Bunun tümcecikleri alt listeye karşılık gelir. |
ConversationalAnalysisAuthoringExportedLuisOrchestration
LUIS uygulama hedefi için düzenleme ayrıntılarını tanımlar.
Name | Tür | Description |
---|---|---|
appId |
string |
LUIS uygulama kimliği. |
appVersion |
string |
Hedeflenen sürüm kimliği. |
slotName |
string |
Hedeflenen yuva adı. |
ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions
LUIS uygulama hedefi için düzenleme seçeneklerini temsil eder.
Name | Tür | Description |
---|---|---|
luisOrchestration |
LUIS uygulaması hedef ayrıntıları. |
|
targetProjectKind |
string:
Luis |
Düzenleme akışında kullanılan hedefin türü. |
ConversationalAnalysisAuthoringExportedPrebuiltEntity
Dışarı aktarılan önceden oluşturulmuş varlık bileşenini temsil eder
Name | Tür | Description |
---|---|---|
category |
string |
Önceden oluşturulmuş varlık kategorisi. |
ConversationalAnalysisAuthoringExportedProject
Dışarı aktarılan bir projeyi temsil eder.
Name | Tür | Description |
---|---|---|
assets | ConversationalAnalysisAuthoringExportedProjectAssets: |
Proje varlıklarını temsil eder. |
metadata |
Proje meta verilerini temsil eder. |
|
projectFileVersion |
string |
Dışarı aktarılan dosyanın sürümü. |
stringIndexType |
Dize uzaklıklarını yorumlamak için kullanılan yöntemi belirtir. Ek bilgi için bkz https://aka.ms/text-analytics-offsets. . |
ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration
Soru Yanıtlama proje hedefi için düzenleme ayrıntılarını tanımlar.
Name | Tür | Description |
---|---|---|
projectName |
string |
Hedef projenin adı. |
ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions
Soru Yanıtlama proje hedefi için düzenleme seçeneklerini temsil eder.
Name | Tür | Description |
---|---|---|
questionAnsweringOrchestration |
Conversational |
Soru Yanıtlama projesi ayrıntıları. |
targetProjectKind |
string:
Question |
Düzenleme akışında kullanılan hedefin türü. |
ConversationalAnalysisAuthoringExportedUtteranceEntityLabel
Konuşma için bir varlık etiketini temsil eder.
Name | Tür | Description |
---|---|---|
category |
string |
Varlık etiketinin kategorisi. |
length |
integer |
Varlık metninin uzunluğu. |
offset |
integer |
Varlık metni için başlangıç konumu. |
ConversationalAnalysisAuthoringOrchestrationExportedIntent
Düzenleme projesi için dışarı aktarılan amacı temsil eder.
Name | Tür | Description |
---|---|---|
category |
string |
Amaç kategorisi. |
orchestration | ConversationalAnalysisAuthoringExportedOrchestrationOptions: |
Bu amacın düzenleme akışındaki davranışını belirtir. |
ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets
Düzenleme projesinin varlıklarını temsil eder.
Name | Tür | Description |
---|---|---|
intents |
Conversational |
Projenin amaçlarını temsil eder. |
projectKind |
string:
Orchestration |
Varlıkları içeren proje türü. |
utterances |
Conversational |
Projenin konuşmalarını temsil eder. |
ConversationalAnalysisAuthoringOrchestrationExportedUtterance
Düzenleme projesinin konuşmalarını temsil eder.
Name | Tür | Description |
---|---|---|
dataset |
string |
Bu konuşmanın veri kümesi. İzin verilen değerler 'Train' ve 'Test' değerleridir. |
intent |
string |
Konuşmanın amacı. |
language |
string |
Konuşmanın dilini temsil eder. Bu, bir dilin BCP-47 gösterimidir. Örneğin, İngilizce için "en", İngilizce (Birleşik Krallık) için "en-gb", İspanyolca için "es" vb. kullanın. |
text |
string |
Konuşma metni. |
ConversationalAnalysisAuthoringProjectSettings
Proje davranışını tanımlamak için kullanılan ayarları temsil eder.
Name | Tür | Description |
---|---|---|
confidenceThreshold |
number |
Tahminin otomatik olarak "Yok" olarak değiştirileceği, en yüksek güvene sahip amacın eşiği. Eşik değeri 0 ile 1 (dahil) arasında olmalıdır. |
Error
Hata nesnesi.
Name | Tür | Description |
---|---|---|
code |
Sunucu tanımlı hata kodları kümesinden biri. |
|
details |
Error[] |
Bu bildirilen hataya yol açan belirli hatalarla ilgili ayrıntılar dizisi. |
innererror |
Hatayla ilgili geçerli nesneden daha özel bilgiler içeren bir nesne. |
|
message |
string |
Hatanın insan tarafından okunabilen bir gösterimi. |
target |
string |
Hatanın hedefi. |
ErrorCode
İnsan tarafından okunabilir hata kodu.
Name | Tür | 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
Hata yanıtı.
Name | Tür | Description |
---|---|---|
error |
Hata nesnesi. |
ExportedProjectFormat
Kullanılacak dışarı aktarılan proje dosyasının biçimi.
Name | Tür | Description |
---|---|---|
Conversation |
string |
Konuşma projesinin biçimini belirtir. |
Luis |
string |
LUIS'ten dışarı aktarılan bir uygulamanın biçimini belirtir. |
InnerErrorCode
İnsan tarafından okunabilir hata kodu.
Name | Tür | 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
Hata hakkında daha ayrıntılı bilgi içeren bir nesne. Microsoft One API yönergelerine göre - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
Name | Tür | Description |
---|---|---|
code |
Sunucu tanımlı hata kodları kümesinden biri. |
|
details |
object |
Hata ayrıntıları. |
innererror |
Hatayla ilgili geçerli nesneden daha özel bilgiler içeren bir nesne. |
|
message |
string |
Hata iletisi. |
target |
string |
Hata hedefi. |
ProjectKind
Proje türünü temsil eder.
Name | Tür | Description |
---|---|---|
Conversation |
string |
Uygulamalar, botlar ve IoT cihazlarına doğal dil oluşturma projesi. |
Orchestration |
string |
Konuşma, Özel soru yanıtlama ve LUIS projelerini tek bir projede birbirine bağlayıp düzenlemeye yönelik bir proje. |
StringIndexType
Dize uzaklıklarını yorumlamak için kullanılan yöntemi belirtir. Ek bilgi için bkz https://aka.ms/text-analytics-offsets. .
Name | Tür | Description |
---|---|---|
Utf16CodeUnit |
string |
Uzaklık ve uzunluk değerleri UTF-16 kod birimlerine karşılık gelir. Uygulamanız Java, JavaScript gibi Unicode'u destekleyen bir dilde yazılmışsa bu seçeneği kullanın. |