Question Answering Projects - Get Delete Status
Hiermee haalt u de status van een Project-verwijdertaak op.
GET {Endpoint}/language/authoring/query-knowledgebases/projects/deletion-jobs/{jobId}?api-version=2023-04-01
URI-parameters
| Name | In | Vereist | Type | Description |
|---|---|---|---|---|
|
Endpoint
|
path | True |
string (uri) |
Ondersteund Cognitive Services-eindpunt (bijvoorbeeld https://< resource-name.api.cognitiveservices.azure.com>). |
|
job
|
path | True |
string |
De functie-ID. |
|
api-version
|
query | True |
string minLength: 1 |
De API-versie die voor deze bewerking moet worden gebruikt. |
Antwoorden
| Name | Type | Description |
|---|---|---|
| 200 OK |
De aanvraag is voltooid. |
|
| Other Status Codes |
Een onverwachte foutreactie. Kopteksten x-ms-error-code: string |
Beveiliging
Ocp-Apim-Subscription-Key
Type:
apiKey
In:
header
OAuth2Auth
Type:
oauth2
Stroom:
implicit
Autorisatie-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiken
| Name | Description |
|---|---|
| https://cognitiveservices.azure.com/.default |
Voorbeelden
Successful query
Voorbeeldaanvraag
GET {Endpoint}/language/authoring/query-knowledgebases/projects/deletion-jobs/job1?api-version=2023-04-01
Voorbeeldrespons
{
"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"
}
Definities
| Name | Description |
|---|---|
|
Azure. |
Het foutobject. |
|
Azure. |
Een object met meer specifieke informatie over de fout. Volgens de Azure REST API-richtlijnen - . https://aka.ms/AzureRestApiGuidelines#handling-errors |
| Error |
Het foutobject. |
|
Error |
Leesbare foutcode. |
|
Error |
Foutreactie. |
|
Inner |
Leesbare foutcode. |
|
Inner |
Een object met meer specifieke informatie over de fout. Volgens de richtlijnen voor Microsoft One-API- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. |
|
job |
Status van de baan. |
|
Question |
Vertegenwoordigt de status van een projectverwijderingstaak. |
Azure.Core.Foundations.Error
Het foutobject.
| Name | Type | Description |
|---|---|---|
| code |
string |
Een van een door de server gedefinieerde set foutcodes. |
| details |
Een matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout. |
|
| innererror |
Een object met meer specifieke informatie dan het huidige object over de fout. |
|
| message |
string |
Een leesbare weergave van de fout. |
| target |
string |
Het doel van de fout. |
Azure.Core.Foundations.InnerError
Een object met meer specifieke informatie over de fout. Volgens de Azure REST API-richtlijnen - . https://aka.ms/AzureRestApiGuidelines#handling-errors
| Name | Type | Description |
|---|---|---|
| code |
string |
Een van een door de server gedefinieerde set foutcodes. |
| innererror |
Interne fout. |
Error
Het foutobject.
| Name | Type | Description |
|---|---|---|
| code |
Een van een door de server gedefinieerde set foutcodes. |
|
| details |
Error[] |
Een matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout. |
| innererror |
Een object met meer specifieke informatie dan het huidige object over de fout. |
|
| message |
string |
Een leesbare weergave van de fout. |
| target |
string |
Het doel van de fout. |
ErrorCode
Leesbare foutcode.
| Waarde | Description |
|---|---|
| InvalidRequest |
Ongeldige aanvraagfout |
| InvalidArgument |
Ongeldig argumentfout |
| Unauthorized |
Fout bij onbevoegde toegang |
| Forbidden |
Fout bij verboden toegang |
| NotFound |
Fout niet gevonden |
| ProjectNotFound |
De fout Project is niet gevonden |
| OperationNotFound |
Fout bij bewerking niet gevonden |
| AzureCognitiveSearchNotFound |
Fout met Azure Cognitive Search is niet gevonden |
| AzureCognitiveSearchIndexNotFound |
Fout bij azure Cognitive Search-index is niet gevonden |
| TooManyRequests |
Fout bij te veel aanvragen |
| AzureCognitiveSearchThrottling |
Beperkingsfout in Azure Cognitive Search |
| AzureCognitiveSearchIndexLimitReached |
Azure Cognitive Search-indexlimiet bereikt fout |
| InternalServerError |
Interne serverfout |
| ServiceUnavailable |
Fout over niet-beschikbaar service |
| Timeout |
Time-outfout |
| QuotaExceeded |
Fout over overschreden quotum |
| Conflict |
Conflict fout |
| Warning |
Waarschuwingsfout |
ErrorResponse
Foutreactie.
| Name | Type | Description |
|---|---|---|
| error |
Het foutobject. |
InnerErrorCode
Leesbare foutcode.
| Waarde | Description |
|---|---|
| InvalidRequest |
Ongeldige aanvraagfout |
| InvalidParameterValue |
Fout met ongeldige parameterwaarde |
| KnowledgeBaseNotFound |
Fout in Knowledge Base is niet gevonden |
| AzureCognitiveSearchNotFound |
Fout met Azure Cognitive Search is niet gevonden |
| AzureCognitiveSearchThrottling |
Beperkingsfout in Azure Cognitive Search |
| ExtractionFailure |
Fout bij extractiefout |
| InvalidRequestBodyFormat |
Fout bij ongeldige indeling van aanvraagtekst |
| EmptyRequest |
Fout bij lege aanvraag |
| MissingInputDocuments |
Fout bij ontbrekende invoerdocumenten |
| InvalidDocument |
Ongeldige documentfout |
| ModelVersionIncorrect |
Fout bij onjuiste modelversie |
| InvalidDocumentBatch |
Ongeldige documentbatchfout |
| UnsupportedLanguageCode |
Fout met niet-ondersteunde taalcode |
| InvalidCountryHint |
Fout met ongeldige landhint |
InnerErrorModel
Een object met meer specifieke informatie over de fout. Volgens de richtlijnen voor Microsoft One-API- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
| Name | Type | Description |
|---|---|---|
| code |
Een van een door de server gedefinieerde set foutcodes. |
|
| details |
object |
Foutdetails. |
| innererror |
Een object met meer specifieke informatie dan het huidige object over de fout. |
|
| message |
string |
Foutmelding. |
| target |
string |
Foutdoel. |
jobStatus
Status van de baan.
| Waarde | Description |
|---|---|
| notStarted | |
| running | |
| succeeded | |
| failed | |
| cancelled | |
| cancelling | |
| partiallyCompleted |
QuestionAnsweringAuthoringProjectDeletionJobState
Vertegenwoordigt de status van een projectverwijderingstaak.
| Name | Type | Description |
|---|---|---|
| createdDateTime |
string (date-time) |
De aanmaakdatum en -tijd van de taak. |
| errors |
De fouten die zijn opgetreden tijdens het uitvoeren van de taak. |
|
| expirationDateTime |
string (date-time) |
De vervaldatum en tijd van de taak. |
| jobId |
string |
De functie-ID. |
| lastUpdatedDateTime |
string (date-time) |
De laatste datum waarop de taak is bijgewerkt. |
| status |
Status van de baan. |