Question Answering Projects - Import

Başvuru

Hizmet:: Cognitive Services - Language

API Sürümü:: 2023-04-01

Proje varlıklarını içeri aktar.

POST {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}/:import?api-version=2023-04-01

İsteğe bağlı parametrelerle:

POST {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}/:import?api-version=2023-04-01&format={format}&assetKind={assetKind}

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
Endpoint	path	True	string	Desteklenen Bilişsel Hizmetler uç noktası (ör. https://.api.cognitiveservices.azure.com).
projectName	path	True	string	Kullanılacak projenin adı.
api-version	query	True	string	İstemci API sürümü.
assetKind	query		string	Projenin varlığı türü.
format	query		format	Bilgi bankası İçeri veya Dışarı Aktarma biçimi.

İstek Gövdesi

Name	Tür	Description
assets	Assets	Bu projenin tüm varlıkları.
fileUri	string	Veri Dosyası URI'lerini içeri aktar.
metadata	CreateProjectOptions	Projeyi oluşturmak için gereken parametreler.

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	ErrorResponse	Hata yanıtı.

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

ErrorResponse

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ğına erişimi tanımlamak için kullanılır. Herhangi bir kullanıcı, grup veya hizmet sorumlusuna yerleşik bir rol veya REST API'lerini Azure Haritalar 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ı modellemeye yönelik bir çözüm sağlar.

Notlar

Bu güvenlik tanımı, uygulamanın erişim isteğinde x-ms-client-id bulunduğu Azure Haritalar kaynağı belirtmek için üst bilginin kullanılmasını gerektirir. Bu, Haritalar yönetim API'sinden edinilebilir.

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 portal, PowerShell, CLI, Azure SDK'ları veya REST API'leri aracılığıyla Azure yönetim düzleminden 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 query

Örnek isteği

HTTP

POST {Endpoint}/language/authoring/query-knowledgebases/projects/proj1/:import?api-version=2023-04-01

{
  "assets": {
    "synonyms": [
      {
        "alterations": [
          "wa",
          "washington",
          "washington state"
        ]
      },
      {
        "alterations": [
          "U.S",
          "usa",
          "united states of america"
        ]
      }
    ],
    "qnas": [
      {
        "lastUpdatedDateTime": "2021-05-01T17:21:14Z",
        "id": 1,
        "answer": "ans1",
        "source": "source1",
        "questions": [
          "question 1.1",
          "question 1.2"
        ],
        "metadata": {
          "k1": "v1",
          "k2": "v2"
        },
        "dialog": {
          "isContextOnly": false,
          "prompts": [
            {
              "displayOrder": 1,
              "qnaId": 2,
              "displayText": "prompt 1.1"
            }
          ]
        }
      },
      {
        "lastUpdatedDateTime": "2021-05-01T17:21:14Z",
        "id": 2,
        "answer": "ans2",
        "source": "source2",
        "questions": [
          "question 2.1",
          "question 2.2"
        ]
      }
    ]
  }
}

Örnek yanıt

Durum kodu:: 202

Operation-Location: https:///language/authoring/query-knowledgebases/projects/proj1/import/jobs/job1?api-version=2023-04-01

Tanımlar

Name	Description
Assets	Bu projenin tüm varlıkları.
CreateProjectOptions	Projeyi oluşturmak için gereken parametreler.
Error	Hata nesnesi.
ErrorCode	İnsan tarafından okunabilir hata kodu.
ErrorResponse	Hata yanıtı.
format	Bilgi bankası İçeri veya Dışarı Aktarma biçimi.
ImportJobOptions	İçeri aktarılması gereken proje varlıkları.
ImportQnaRecord	Soru-Cevap Kaydını İçeri Aktar.
InnerErrorCode	İnsan tarafından okunabilir hata kodu.
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.
ProjectSettings	Projenin yapılandırılabilir ayarları.
QnaDialog	Soru-Cevap Kaydı ile ilişkili iletişim kutusu.
QnaPrompt	Bir yanıt iste.
QnaRecord	Soru-Cevap kaydı.
SuggestedQuestion	Etkin Öğrenme özelliği tarafından önerilen soru.
SuggestedQuestionsCluster	Active Learning ile ilgili önerilen sorular küme ayrıntıları.
WordAlterations	Sözcük değişiklikleri koleksiyonu.

Assets

Bu projenin tüm varlıkları.

Name	Tür	Description
qnas	ImportQnaRecord[]	İçeri aktarılacağınız Soru-Cevap kayıtlarının listesi.
synonyms	WordAlterations[]	Eş anlamlılar koleksiyonu.

CreateProjectOptions

Projeyi oluşturmak için gereken parametreler.

Name	Tür	Description
description	string	Projenin açıklaması.
language	string	Metin kayıtlarının dili. Bu, bir dilin BCP-47 gösterimidir. Örneğin, İngilizce için "en" kullanın; İspanyolca vb için "es" Ayarlanmadıysa, varsayılan olarak İngilizce için "en" kullanın.
multilingualResource	boolean	Aynı kaynak için farklı dillerde bilgi bankaları oluşturmayı etkinleştirmek için true olarak ayarlayın.
settings	ProjectSettings	Projenin yapılandırılabilir ayarları.

Error

Hata nesnesi.

Name	Tür	Description
code	ErrorCode	Sunucu tanımlı hata kodları kümesinden biri.
details	Error[]	Bu bildirilen hataya yol açan belirli hatalarla ilgili bir dizi ayrıntı.
innererror	InnerErrorModel	Hatayla ilgili geçerli nesneden daha belirli bilgiler içeren bir nesne.
message	string	Hatanın insanlar tarafından okunabilir 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	Error	Hata nesnesi.

format

Bilgi bankası İçeri veya Dışarı Aktarma biçimi.

Name	Tür	Description
excel	string	Tsv biçimindeki tüm varlıklar ve meta veriler dahil olmak üzere bilgi bankası çoğaltmayı dışarı veya içeri aktarın.
json	string	Soru-Cevap varlıklarını JSON biçiminde dışarı veya içeri aktarın.
tsv	string	Excel biçimindeki tüm varlıklar ve meta veriler dahil olmak üzere bilgi bankası çoğaltmayı dışarı veya içeri aktarın.

ImportJobOptions

İçeri aktarılması gereken proje varlıkları.

Name	Tür	Description
assets	Assets	Bu projenin tüm varlıkları.
fileUri	string	Veri Dosyası URI'lerini içeri aktar.
metadata	CreateProjectOptions	Projeyi oluşturmak için gereken parametreler.

ImportQnaRecord

Soru-Cevap Kaydını İçeri Aktar.

Name	Tür	Description
activeLearningSuggestions	SuggestedQuestionsCluster[]	Soru-Cevap için Etkin Öğrenme önerilerinin listesi.
answer	string	Yanıt metni.
dialog	QnaDialog	Soru-Cevap bağlamı.
id	integer	Soru-Cevap için benzersiz kimlik.
lastUpdatedDateTime	string	Soru-Cevap'ın son güncelleştirildiği tarih-saat.
metadata	object	Yanıtla ilişkili meta veriler; soru yanıtlarını kategorilere ayırmak veya filtrelemek için kullanışlıdır.
questions	string[]	Yanıtla ilişkili soruların listesi.
source	string	Soru-Cevap'ın dizine alındığı kaynak; örneğin. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs
sourceDisplayName	string	Kaynağın kolay adı.

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	InnerErrorCode	Sunucu tanımlı hata kodları kümesinden biri.
details	object	Hata ayrıntıları.
innererror	InnerErrorModel	Hatayla ilgili geçerli nesneden daha belirli bilgiler içeren bir nesne.
message	string	Hata iletisi.
target	string	Hata hedefi.

ProjectSettings

Projenin yapılandırılabilir ayarları.

Name	Tür	Description
defaultAnswer	string	bilgi bankası iyi eşleşme bulunmadığında varsayılan Yanıt yanıtı.

QnaDialog

Soru-Cevap Kaydı ile ilişkili iletişim kutusu.

Name	Tür	Description
isContextOnly	boolean	Bir istemin yalnızca önceki bir soruyla ilgili olup olmadığını işaretlemek için. Doğruysa, bağlamı olmayan sorgular için yanıt olarak bu Soru-Cevap'ı eklemeyin; aksi takdirde bağlamı yoksayar ve yanıtlarda bu Soru-Cevap'ı içerir.
prompts	QnaPrompt[]	Yanıtla ilişkili istemlerin listesi.

QnaPrompt

Bir yanıt iste.

Name	Tür	Description
displayOrder	integer	İstem dizini. İstemleri sıralamak için kullanılır.
displayText	string	İzleme sorusu istemini temsil etmek için görüntülenen metin.
qna	QnaRecord	Soru-Cevap kaydı. Soru-Cevap veya Soru-Cevap kaydının bir İstemde mevcut olması gerekir.
qnaId	integer	soru işaretine karşılık gelen Soru-Cevap kimliği.

QnaRecord

Soru-Cevap kaydı.

Name	Tür	Description
activeLearningSuggestions	SuggestedQuestionsCluster[]	Soru-Cevap için Etkin Öğrenme önerilerinin listesi.
answer	string	Yanıt metni.
dialog	QnaDialog	Soru-Cevap bağlamı.
id	integer	Soru-Cevap için benzersiz kimlik.
metadata	object	Yanıtla ilişkili meta veriler; soru yanıtlarını kategorilere ayırmak veya filtrelemek için kullanışlıdır.
questions	string[]	Yanıtla ilişkili soruların listesi.
source	string	Soru-Cevap'ın dizine alındığı kaynak; örneğin. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs

SuggestedQuestion

Etkin Öğrenme özelliği tarafından önerilen soru.

Name	Tür	Description
autoSuggestedCount	integer	Sorunun Active Learning algoritması tarafından otomatik olarak önerildiği sayıdır.
question	string	Etkin Öğrenme özelliği tarafından önerilen soru.
userSuggestedCount	integer	Sorunun kullanıcı tarafından açıkça önerildiği sayıdır.

SuggestedQuestionsCluster

Active Learning ile ilgili önerilen sorular küme ayrıntıları.

Name	Tür	Description
clusterHead	string	Active Learning kümeleme algoritması tarafından önerilen sorular kümesinin başı olarak seçilen soru.
suggestedQuestions	SuggestedQuestion[]	Soru-Cevap için önerilen tüm soruların listesi.

WordAlterations

Sözcük değişiklikleri koleksiyonu.

Name	Tür	Description
alterations	string[]	Sözcük değişiklikleri koleksiyonu.

Aracılığıyla paylaş

Question Answering Projects - Import

URI Parametreleri

İstek Gövdesi

Yanıtlar

Güvenlik

AADToken

Notlar

Kapsamlar

Ocp-Apim-Subscription-Key

Örnekler

Successful query

Örnek isteği

Örnek yanıt

Tanımlar

Assets

CreateProjectOptions

Error

ErrorCode

ErrorResponse

format

ImportJobOptions

ImportQnaRecord

InnerErrorCode

InnerErrorModel

ProjectSettings

QnaDialog

QnaPrompt

QnaRecord

SuggestedQuestion

SuggestedQuestionsCluster

WordAlterations

Ek kaynaklar