Ingestion Job Runs - List

Tjänst:

Azure AI Services

API-version:

2024-05-01-preview

Listor körningarna av det angivna jobb-ID:t.

GET {endpoint}/openai/ingestion/jobs/{job-id}/runs?api-version=2024-05-01-preview

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string url	Cognitive Services-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-kontonamn).
job-id	path	True	string	Jobbets ID.
api-version	query	True	string	Den begärda API-versionen.

Begärandehuvud

Name	Obligatorisk	Typ	Description
api-key	True	string	Ange din Azure OpenAI-kontonyckel för Cognitive Services här.
mgmt-user-token		string	Den token som används för att komma åt arbetsytan (behövs endast för användarberäkningsjobb).

Svar

Name	Typ	Description
200 OK	IngestionJobRunList	Klart
Other Status Codes	ErrorResponse	Ett fel inträffade.

Säkerhet

api-key

Ange din Azure OpenAI-kontonyckel för Cognitive Services här.

Typ: apiKey
I: header

Exempel

List ingestion job runs

Exempelbegäran

HTTP

GET {endpoint}/openai/ingestion/jobs/{job-id}/runs?api-version=2024-05-01-preview

Exempelsvar

Statuskod:

200

{
  "value": [
    {
      "jobId": "ingestion-job",
      "runId": "f375b912-331c-4fc5-8e9f-2d7205e3e036",
      "status": "Succeeded"
    },
    {
      "jobId": "ingestion-job",
      "runId": "07f2d192-add7-4202-a2e3-858c2577f4fd",
      "status": "Failed"
    },
    {
      "jobId": "ingestion-job",
      "runId": "5ef7a436-1147-4cbb-82e0-3d502bcc6a7b",
      "status": "Running"
    }
  ]
}

Definitioner

Name	Description
Error	Fel
ErrorCode	Felkod
ErrorResponse	ErrorResponse
IngestionError	IngestionError
IngestionJobProgress	IngestionJobProgress
IngestionJobRun	IngestionJobRun
IngestionJobRunList	IngestionJobRunList
IngestionJobStageProgress	IngestionJobStageProgress
InnerError	InnerError
InnerErrorCode	InnerErrorCode
OperationState	OperationState

Error

Fel

Name	Typ	Description
code	ErrorCode	Felkod Felkoder som definieras i Microsoft REST-riktlinjerna (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
details	Error[]	Felinformationen om den är tillgänglig.
innererror	InnerError	InnerError Inre fel enligt definitionen i Microsoft REST-riktlinjerna (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
message	string	Meddelandet om det här felet.
target	string	Platsen där felet inträffade om det var tillgängligt.

ErrorCode

Felkod

Name	Typ	Description
conflict	string	Den begärda åtgärden står i konflikt med det aktuella resurstillståndet.
contentFilter	string	Bildgenereringen misslyckades till följd av vårt säkerhetssystem.
fileImportFailed	string	Det gick inte att importera filen.
forbidden	string	Åtgärden är förbjuden för den aktuella användaren/API-nyckeln.
internalFailure	string	Internt fel. Försök igen.
invalidPayload	string	Begärandedata är ogiltiga för den här åtgärden.
itemDoesAlreadyExist	string	Objektet finns redan.
jsonlValidationFailed	string	Verifieringen av jsonl-data misslyckades.
notFound	string	Det går inte att hitta resursen.
quotaExceeded	string	Kvoten har överskridits.
serviceUnavailable	string	Tjänsten är inte tillgänglig för närvarande.
tooManyRequests	string	För många begäranden. Försök igen senare.
unauthorized	string	Den aktuella användar-/API-nyckeln har inte behörighet för åtgärden.
unexpectedEntityState	string	Det går inte att utföra åtgärden i den aktuella resursens tillstånd.

ErrorResponse

ErrorResponse

Name	Typ	Description
error	Error	Fel Felinnehåll enligt definitionen i Microsoft REST-riktlinjerna (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

IngestionError

IngestionError

Name	Typ	Description
innerErrors	string[]
message	string

IngestionJobProgress

IngestionJobProgress

Name	Typ	Description
stageProgress	IngestionJobStageProgress[]	IngestionJobStageProgress

IngestionJobRun

IngestionJobRun

Name	Typ	Description
error	IngestionError	IngestionError Information om inmatningsfelet
jobId	string
progress	IngestionJobProgress	IngestionJobProgress
runId	string
status	OperationState	OperationState Tillståndet för ett jobb eller objekt.
warnings	string[]

IngestionJobRunList

IngestionJobRunList

Name	Typ	Description
nextLink	string	Länken till nästa sida.
value	IngestionJobRun[]	Listan över objekt.

IngestionJobStageProgress

IngestionJobStageProgress

Name	Typ	Description
name	string
processedItems	integer
state	OperationState	OperationState Tillståndet för ett jobb eller objekt.
subStageProgress	IngestionJobStageProgress[]	IngestionJobStageProgress
totalItems	integer

InnerError

InnerError

Name	Typ	Description
code	InnerErrorCode	InnerErrorCode Inre felkoder enligt definitionen i Microsoft REST-riktlinjerna (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
innererror	InnerError	InnerError Inre fel enligt definitionen i Microsoft REST-riktlinjerna (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

InnerErrorCode

InnerErrorCode

Name	Typ	Description
invalidPayload	string	Begärandedata är ogiltiga för den här åtgärden.

OperationState

OperationState

Name	Typ	Description
failed	string	Åtgärden har slutfört bearbetningen med ett fel och kan inte användas ytterligare.
notRunning	string	Åtgärden har ännu inte placerats i kö för att bearbetas i framtiden.
running	string	Åtgärden har börjat bearbetas.
succeeded	string	Åtgärden har bearbetats och är klar för förbrukning.