Aracılığıyla paylaş


Question Answering Projects - Get Update Qnas Status

Soru-Cevap güncelleştirme işinin durumunu alır.

GET {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}/qnas/jobs/{jobId}?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).

jobId
path True

string

İş Kimliği.

projectName
path True

string

Kullanılacak projenin adı.

api-version
query True

string

İstemci API sürümü.

Yanıtlar

Name Tür Description
200 OK

JobState

Soru-Cevap iş durumunu güncelleştirin.

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

GET {Endpoint}/language/authoring/query-knowledgebases/projects/proj1/qnas/jobs/job1?api-version=2023-04-01

Örnek yanıt

{
  "errors": [],
  "createdDateTime": "2021-05-01T17:21:14Z",
  "expirationDateTime": "2021-05-01T17:21:14Z",
  "jobId": "635c2741-15c4-4c2c-9f78-bfd30b6b2a4a",
  "lastUpdatedDateTime": "2021-05-01T17:21:14Z",
  "status": "succeeded"
}

Tanımlar

Name Description
Error

Hata nesnesi.

ErrorCode

İnsan tarafından okunabilir hata kodu.

ErrorResponse

Hata yanıtı.

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.

JobState

İş durumu, iş meta verilerini ve hataları temsil eder.

jobStatus

İş Durumu.

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.

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.

JobState

İş durumu, iş meta verilerini ve hataları temsil eder.

Name Tür Description
createdDateTime

string

errors

Error[]

Hata nesnesi.

expirationDateTime

string

jobId

string

lastUpdatedDateTime

string

status

jobStatus

İş Durumu.

jobStatus

İş Durumu.

Name Tür Description
cancelled

string

cancelling

string

failed

string

notStarted

string

partiallyCompleted

string

running

string

succeeded

string