Question Answering Projects - Get Delete Status

Dienst:

Azure AI Services

API-Version:

2023-04-01

Ruft den Status eines Projektlöschauftrags ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
Endpoint	path	True	string (uri)	Unterstützter Cognitive Services-Endpunkt (z. B. https://.api.cognitiveservices.azure.com).
jobId	path	True	string	Die Auftrags-ID.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	QuestionAnsweringAuthoringProjectDeletionJobState	Die Anforderung ist erfolgreich.
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort. Header x-ms-error-code: string

Sicherheit

Ocp-Apim-Subscription-Key

Typ: apiKey
In: header

OAuth2Auth

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

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

Beispiele

Successful query

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:

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"
}

Definitionen

Name	Beschreibung
Azure.Core.Foundations.Error	Das Fehlerobjekt.
Azure.Core.Foundations.InnerError	Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien – https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
Error	Das Fehlerobjekt.
ErrorCode	Lesbarer Fehlercode.
ErrorResponse	Fehlerantwort.
InnerErrorCode	Lesbarer Fehlercode.
InnerErrorModel	Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
jobStatus	Auftragsstatus.
QuestionAnsweringAuthoringProjectDeletionJobState	Stellt den Status eines Projektlöschauftrags dar.

Azure.Core.Foundations.Error

Objekt

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe von Fehlercodes.
details	Azure.Core.Foundations.Error[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror	Azure.Core.Foundations.InnerError	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Eine lesbare Darstellung des Fehlers.
target	string	Das Ziel des Fehlers.

Azure.Core.Foundations.InnerError

Objekt

Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien – https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe von Fehlercodes.
innererror	Azure.Core.Foundations.InnerError	Innerer Fehler.

Error

Objekt

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	ErrorCode	Eine serverdefinierte Gruppe von Fehlercodes.
details	Error[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror	InnerErrorModel	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Eine lesbare Darstellung des Fehlers.
target	string	Das Ziel des Fehlers.

ErrorCode

Enumeration

Lesbarer Fehlercode.

Wert	Beschreibung
AzureCognitiveSearchIndexLimitReached	Azure Cognitive Search Index limit reached error
AzureCognitiveSearchIndexNotFound	Der Azure Cognitive Search-Index wurde nicht gefunden
AzureCognitiveSearchNotFound	Fehler bei Azure Cognitive Search nicht gefunden
AzureCognitiveSearchThrottling	Fehler bei der Drosselung von Azure Cognitive Search
Conflict	Konfliktfehler
Forbidden	Fehler beim unzulässigen Zugriff
InternalServerError	Interner Serverfehler
InvalidArgument	Ungültiger Argumentfehler
InvalidRequest	Ungültiger Anforderungsfehler
NotFound	Fehler nicht gefunden
OperationNotFound	Fehler beim Vorgang nicht gefunden
ProjectNotFound	Fehler beim Fehler "Projekt nicht gefunden"
QuotaExceeded	Fehler "Kontingent überschritten"
ServiceUnavailable	Fehler "Dienst nicht verfügbar"
Timeout	Timeout-Fehler
TooManyRequests	Fehler bei zu vielen Anforderungen
Unauthorized	Fehler beim nicht autorisierten Zugriff
Warning	Warnungsfehler

ErrorResponse

Objekt

Fehlerantwort.

Name	Typ	Beschreibung
error	Error	Das Fehlerobjekt.

InnerErrorCode

Enumeration

Lesbarer Fehlercode.

Wert	Beschreibung
AzureCognitiveSearchNotFound	Fehler bei Azure Cognitive Search nicht gefunden
AzureCognitiveSearchThrottling	Fehler bei der Drosselung von Azure Cognitive Search
EmptyRequest	Fehler "Leere Anforderung"
ExtractionFailure	Fehler bei Extraktionsfehlern
InvalidCountryHint	Ungültiger Fehler im Landhinweis
InvalidDocument	Ungültiger Dokumentfehler
InvalidDocumentBatch	Ungültiger Dokumentbatchfehler
InvalidParameterValue	Ungültiger Parameterwertfehler
InvalidRequest	Ungültiger Anforderungsfehler
InvalidRequestBodyFormat	Ungültiger Fehler beim Anforderungstextformat
KnowledgeBaseNotFound	Fehler in der Knowledge Base nicht gefunden
MissingInputDocuments	Fehler bei fehlenden Eingabedokumenten
ModelVersionIncorrect	Fehler bei der Modellversion
UnsupportedLanguageCode	Fehler beim nicht unterstützten Sprachcode

InnerErrorModel

Objekt

Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Beschreibung
code	InnerErrorCode	Eine serverdefinierte Gruppe von Fehlercodes.
details	object	Fehlerdetails.
innererror	InnerErrorModel	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Fehlermeldung.
target	string	Fehlerziel.

jobStatus

Enumeration

Auftragsstatus.

Wert	Beschreibung
cancelled
cancelling
failed
notStarted
partiallyCompleted
running
succeeded

QuestionAnsweringAuthoringProjectDeletionJobState

Objekt

Stellt den Status eines Projektlöschauftrags dar.

Name	Typ	Beschreibung
createdDateTime	string (date-time)	Das Erstellungsdatum des Auftrags.
errors	Azure.Core.Foundations.Error[]	Fehler beim Ausführen des Auftrags.
expirationDateTime	string (date-time)	Die Ablaufzeit des Auftrags.
jobId	string	Die Auftrags-ID.
lastUpdatedDateTime	string (date-time)	Das letzte Datum, zu dem der Auftrag aktualisiert wurde.
status	jobStatus	Auftragsstatus.