Question Answering Projects - Create Project

Hizmet:

Azure AI Services

API Sürümü:

2023-04-01

Proje oluşturma veya güncelleştirme.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
Endpoint	path	True	string (uri)	Desteklenen Bilişsel Hizmetler uç noktası (örneğin, https://< resource-name.api.cognitiveservices.azure.com>).
projectName	path	True	string maxLength: 100 pattern: ^(?=[a-zA-Z0-9])[a-zA-Z0-9-]{0,98}[a-zA-Z0-9]$	Projenin adı.
api-version	query	True	string minLength: 1	Bu işlem için kullanılacak API sürümü.

İstek Gövdesi

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	Projeler arasında birden çok dil için etkinleştirilen veya etkinleştirilmeyen kaynak.
settings	ProjectSettings	Project'in yapılandırılabilir ayarları.

Yanıtlar

Name	Tür	Description
200 OK	QuestionAnsweringProjectMetadata	İstek başarılı oldu.
201 Created	QuestionAnsweringProjectMetadata	İstek başarılı oldu ve sonuç olarak yeni bir kaynak oluşturuldu.
Other Status Codes	ErrorResponse	Beklenmeyen bir hata yanıtı. Üst Bilgiler x-ms-error-code: string

Güvenlik

Ocp-Apim-Subscription-Key

Tür: apiKey
İçinde: header

OAuth2Auth

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name	Description
https://cognitiveservices.azure.com/.default

Örnekler

Successful query

Örnek isteği

HTTP

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

{
  "description": "proj1 is a test project.",
  "multilingualResource": true,
  "settings": {
    "defaultAnswer": "No good match found for your question in the Knowledgebase."
  },
  "language": "en"
}

Örnek yanıt

Durum kodu:

200

{
  "description": "proj1 is a test project.",
  "createdDateTime": "2021-05-01T15:13:22Z",
  "lastDeployedDateTime": "2021-05-01T15:13:22Z",
  "lastModifiedDateTime": "2021-05-01T15:13:22Z",
  "multilingualResource": true,
  "projectName": "proj1",
  "settings": {
    "defaultAnswer": "No good match found for your question in the Knowledgebase."
  },
  "language": "en"
}

Durum kodu:

201

{
  "description": "proj1 is a test project.",
  "createdDateTime": "2021-05-01T15:13:22Z",
  "lastDeployedDateTime": "2021-05-01T15:13:22Z",
  "lastModifiedDateTime": "2021-05-01T15:13:22Z",
  "multilingualResource": true,
  "projectName": "proj1",
  "settings": {
    "defaultAnswer": "No good match found for your question in the Knowledgebase."
  },
  "language": "en"
}

Tanımlar

Name	Description
Error	Hata nesnesi.
ErrorCode	İnsan tarafından okunabilen hata kodu.
ErrorResponse	Hata yanıtı.
InnerErrorCode	İnsan tarafından okunabilen 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	Project'in yapılandırılabilir ayarları.
QuestionAnsweringProjectMetadata	Projeyi temsil eder.
QuestionAnsweringProjectMetadataCreateOrUpdate	Projeyi temsil eder.

Error

Object

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 hatalar hakkında bir dizi ayrıntı.
innererror	InnerErrorModel	Hatayla ilgili geçerli nesneden daha belirli bilgiler içeren bir nesne.
message	string	Hatanın insan tarafından okunabilir bir gösterimi.
target	string	Hatanın hedefi.

ErrorCode

Listeleme

İnsan tarafından okunabilen hata kodu.

Değer	Description
InvalidRequest	Geçersiz istek hatası
InvalidArgument	Geçersiz bağımsız değişken hatası
Unauthorized	Yetkisiz erişim hatası
Forbidden	Yasak erişim hatası
NotFound	Bulunamadı hatası
ProjectNotFound	Proje bulunamadı hatası
OperationNotFound	İşlem bulunamadı hatası
AzureCognitiveSearchNotFound	Azure Bilişsel Arama bulunamadı hatası
AzureCognitiveSearchIndexNotFound	Azure Bilişsel Arama dizini bulunamadı hatası
TooManyRequests	Çok fazla istek hatası
AzureCognitiveSearchThrottling	Azure Bilişsel Arama azaltma hatası
AzureCognitiveSearchIndexLimitReached	Azure Bilişsel Arama dizin sınırına ulaşıldı hatası
InternalServerError	İç sunucu hatası
ServiceUnavailable	Hizmet kullanılamıyor hatası
Timeout	Zaman aşımı hatası
QuotaExceeded	Kota aşıldı hatası
Conflict	Çakışma hatası
Warning	Uyarı hatası

ErrorResponse

Object

Hata yanıtı.

Name	Tür	Description
error	Error	Hata nesnesi.

InnerErrorCode

Listeleme

İnsan tarafından okunabilen hata kodu.

Değer	Description
InvalidRequest	Geçersiz istek hatası
InvalidParameterValue	Geçersiz parametre değeri hatası
KnowledgeBaseNotFound	Bilgi bankası bulunamadı hatası
AzureCognitiveSearchNotFound	Azure Bilişsel Arama bulunamadı hatası
AzureCognitiveSearchThrottling	Azure Bilişsel Arama azaltma hatası
ExtractionFailure	Ayıklama hatası
InvalidRequestBodyFormat	Geçersiz istek gövdesi biçimi hatası
EmptyRequest	Boş istek hatası
MissingInputDocuments	Eksik giriş belgeleri hatası
InvalidDocument	Geçersiz belge hatası
ModelVersionIncorrect	Model sürümü yanlış hatası
InvalidDocumentBatch	Geçersiz belge toplu iş hatası
UnsupportedLanguageCode	Desteklenmeyen dil kodu hatası
InvalidCountryHint	Geçersiz ülke ipucu hatası

InnerErrorModel

Object

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 mesajı.
target	string	Hata hedefi.

ProjectSettings

Object

Project'in yapılandırılabilir ayarları.

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

QuestionAnsweringProjectMetadata

Object

Projeyi temsil eder.

Name	Tür	Description
createdDateTime	string (date-time)	Proje oluşturma tarih-saati.
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.
lastDeployedDateTime	string (date-time)	Projenin son dağıtım tarih-saatini temsil eder.
lastModifiedDateTime	string (date-time)	Projenin son değiştirme tarihi-saatini temsil eder.
multilingualResource	boolean	Projeler arasında birden çok dil için etkinleştirilen veya etkinleştirilmeyen kaynak.
projectName	string maxLength: 100 pattern: ^(?=[a-zA-Z0-9])[a-zA-Z0-9-]{0,98}[a-zA-Z0-9]$	Projenin adı.
settings	ProjectSettings	Project'in yapılandırılabilir ayarları.

QuestionAnsweringProjectMetadataCreateOrUpdate

Object

Projeyi temsil eder.

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	Projeler arasında birden çok dil için etkinleştirilen veya etkinleştirilmeyen kaynak.
settings	ProjectSettings	Project'in yapılandırılabilir ayarları.