Question Answering Projects - Get Delete Status

Szolgáltatás:: Azure AI Services

API-verzió:: 2023-04-01

Lekéri a Project törlési feladatának állapotát.

GET {Endpoint}/language/authoring/query-knowledgebases/projects/deletion-jobs/{jobId}?api-version=2023-04-01

URI-paraméterek

Name	In	Kötelező	Típus	Description
Endpoint	path	True	string (uri)	Támogatott Cognitive Services végpont (például https:// resource-name.api.cognitiveservices.azure.com<>).
jobId	path	True	string	A feladat azonosítója.
api-version	query	True	string minLength: 1	A művelethez használandó API-verzió.

Válaszok

Name	Típus	Description
200 OK	QuestionAnsweringAuthoringProjectDeletionJobState	A kérés sikeres volt.
Other Status Codes	ErrorResponse	Váratlan hibaválasz. Fejlécek x-ms-error-code: string

Name

Típus

Description

200 OK

QuestionAnsweringAuthoringProjectDeletionJobState

A kérés sikeres volt.

Other Status Codes

ErrorResponse

Váratlan hibaválasz.

Fejlécek

x-ms-error-code: string

Biztonság

Ocp-Apim-Subscription-Key

Típus: apiKey
In: header

OAuth2Auth

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

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

Példák

Successful query

Mintakérelem

HTTP

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

Mintaválasz

Állapotkód:: 200

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

Definíciók

Name	Description
Azure.Core.Foundations.Error	A hibaobjektum.
Azure.Core.Foundations.InnerError	Egy objektum, amely részletesebb információkat tartalmaz a hibáról. Az Azure REST API irányelvei szerint – https://aka.ms/AzureRestApiGuidelines#handling-errors.
Error	A hibaobjektum.
ErrorCode	Ember által olvasható hibakód.
ErrorResponse	Hibaválasz.
InnerErrorCode	Ember által olvasható hibakód.
InnerErrorModel	Egy objektum, amely részletesebb információkat tartalmaz a hibáról. A Microsoft One API irányelvei szerint – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
jobStatus	Munkakör állapota.
QuestionAnsweringAuthoringProjectDeletionJobState	A projekttörlési feladat állapotát jelöli.

Azure.Core.Foundations.Error

Tárgy

A hibaobjektum.

Name	Típus	Description
code	string	A kiszolgáló által definiált hibakódok egyike.
details	Azure.Core.Foundations.Error[]	A jelentett hibához vezető konkrét hibák részleteinek tömbje.
innererror	Azure.Core.Foundations.InnerError	Egy objektum, amely az aktuális objektumnál pontosabb információt tartalmaz a hibáról.
message	string	A hiba ember által olvasható ábrázolása.
target	string	A hiba célja.

Azure.Core.Foundations.InnerError

Tárgy

Egy objektum, amely részletesebb információkat tartalmaz a hibáról. Az Azure REST API irányelvei szerint – https://aka.ms/AzureRestApiGuidelines#handling-errors.

Name	Típus	Description
code	string	A kiszolgáló által definiált hibakódok egyike.
innererror	Azure.Core.Foundations.InnerError	Belső hiba.

Error

Tárgy

A hibaobjektum.

Name	Típus	Description
code	ErrorCode	A kiszolgáló által definiált hibakódok egyike.
details	Error[]	A jelentett hibához vezető konkrét hibák részleteinek tömbje.
innererror	InnerErrorModel	Egy objektum, amely az aktuális objektumnál pontosabb információt tartalmaz a hibáról.
message	string	A hiba ember által olvasható ábrázolása.
target	string	A hiba célja.

ErrorCode

Felsorolás

Ember által olvasható hibakód.

Érték	Description
InvalidRequest	Érvénytelen kérelemhiba
InvalidArgument	Érvénytelen argumentumhiba
Unauthorized	Jogosulatlan hozzáférési hiba
Forbidden	Tiltott hozzáférési hiba
NotFound	Nem található hiba
ProjectNotFound	A project nem található hiba
OperationNotFound	A művelet nem található hiba
AzureCognitiveSearchNotFound	Az Azure Cognitive Search nem található hiba
AzureCognitiveSearchIndexNotFound	Az Azure Cognitive Search-index nem található hiba
TooManyRequests	Túl sok kéréshiba
AzureCognitiveSearchThrottling	Azure Cognitive Search szabályozási hiba
AzureCognitiveSearchIndexLimitReached	Az Azure Cognitive Search indexkorlátja elérte a hibát
InternalServerError	Belső kiszolgálóhiba
ServiceUnavailable	A szolgáltatás nem érhető el
Timeout	Időtúllépési hiba
QuotaExceeded	Kvóta túllépése hiba
Conflict	Ütközési hiba
Warning	Figyelmeztetési hiba

ErrorResponse

Tárgy

Hibaválasz.

Name	Típus	Description
error	Error	A hibaobjektum.

InnerErrorCode

Felsorolás

Ember által olvasható hibakód.

Érték	Description
InvalidRequest	Érvénytelen kérelemhiba
InvalidParameterValue	Érvénytelen paraméterérték-hiba
KnowledgeBaseNotFound	A tudásbázis nem található hiba
AzureCognitiveSearchNotFound	Az Azure Cognitive Search nem található hiba
AzureCognitiveSearchThrottling	Azure Cognitive Search szabályozási hiba
ExtractionFailure	Kinyerési hiba
InvalidRequestBodyFormat	Érvénytelen kérelemtörzsformátum-hiba
EmptyRequest	Üres kérelemhiba
MissingInputDocuments	Hiányzó bemeneti dokumentumok hibája
InvalidDocument	Érvénytelen dokumentumhiba
ModelVersionIncorrect	A modell verziója helytelen
InvalidDocumentBatch	Érvénytelen dokumentumköteg-hiba
UnsupportedLanguageCode	Nem támogatott nyelvi kódhiba
InvalidCountryHint	Érvénytelen országmutató-hiba

InnerErrorModel

Tárgy

Egy objektum, amely részletesebb információkat tartalmaz a hibáról. A Microsoft One API irányelvei szerint – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Típus	Description
code	InnerErrorCode	A kiszolgáló által definiált hibakódok egyike.
details	object	Hiba részletei.
innererror	InnerErrorModel	Egy objektum, amely az aktuális objektumnál pontosabb információt tartalmaz a hibáról.
message	string	Hibaüzenet.
target	string	Hibacél.

jobStatus

Felsorolás

Munkakör állapota.

Érték	Description
notStarted
running
succeeded
failed
cancelled
cancelling
partiallyCompleted

QuestionAnsweringAuthoringProjectDeletionJobState

Tárgy

A projekttörlési feladat állapotát jelöli.

Name	Típus	Description
createdDateTime	string (date-time)	A feladat létrehozásának dátuma, időpontja.
errors	Azure.Core.Foundations.Error[]	A feladat végrehajtása során felmerült hibák.
expirationDateTime	string (date-time)	A feladat lejárati dátuma, az idő.
jobId	string	A feladat azonosítója.
lastUpdatedDateTime	string (date-time)	A feladat frissítésének utolsó dátuma.
status	jobStatus	Munkakör állapota.