Ingestion Job Runs - Get

Referencia

Servicio:: Azure AI Services

Versión de la API:: 2024-05-01-preview

Obtiene los detalles del identificador de ejecución especificado como parte del identificador de trabajo especificado.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string url	Puntos de conexión de Cognitive Services admitidos (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre de la cuenta de Azure OpenAI).
job-id	path	True	string	Identificador del trabajo.
run-id	path	True	string	Identificador de la ejecución.
api-version	query	True	string	La versión de API solicitada.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
api-key	True	string	Proporcione aquí la clave de cuenta de Azure OpenAI de Cognitive Services.
mgmt-user-token		string	Token que se usa para acceder al área de trabajo (solo es necesario para trabajos de proceso de usuario).

Respuestas

Nombre	Tipo	Description
200 OK	IngestionJobRun	Correcto
Other Status Codes	ErrorResponse	Se produjo un error.

Seguridad

api-key

Proporcione aquí la clave de cuenta de Azure OpenAI de Cognitive Services.

Tipo: apiKey
En: header

Ejemplos

Get ingestion job runs

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 200

{
  "jobId": "ingestion-job",
  "runId": "5ef7a436-1147-4cbb-82e0-3d502bcc6a7b",
  "status": "Running",
  "progress": {
    "stageProgress": [
      {
        "name": "Preprocessing",
        "totalItems": 14,
        "processedItems": 0,
        "state": "notRunning"
      },
      {
        "name": "Indexing",
        "state": "notRunning"
      }
    ]
  }
}

Definiciones

Nombre	Description
Error	Error
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
IngestionError	IngestionError
IngestionJobProgress	IngestaJobProgress
IngestionJobRun	IngestionJobRun
IngestionJobStageProgress	IngestionJobStageProgress
InnerError	InnerError
InnerErrorCode	InnerErrorCode
OperationState	OperationState

Error

Nombre	Tipo	Description
code	ErrorCode	ErrorCode Códigos de error tal y como se definen en las directrices de REST de Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
details	Error[]	Detalles del error si está disponible.
innererror	InnerError	InnerError Error interno tal como se define en las directrices rest de Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
message	string	Mensaje de este error.
target	string	Ubicación donde se produjo el error si está disponible.

ErrorCode

Nombre	Tipo	Description
conflict	string	La operación solicitada entra en conflicto con el estado de recurso actual.
contentFilter	string	Se produjo un error en la generación de imágenes como resultado de nuestro sistema de seguridad.
fileImportFailed	string	Error en la importación del archivo.
forbidden	string	La operación está prohibida para la clave de usuario o API actual.
internalFailure	string	Error interno. Inténtelo de nuevo.
invalidPayload	string	Los datos de solicitud no son válidos para esta operación.
itemDoesAlreadyExist	string	El elemento ya existe.
jsonlValidationFailed	string	Error en la validación de datos jsonl.
notFound	string	No se encuentra el recurso.
quotaExceeded	string	Cuota superada.
serviceUnavailable	string	El servicio no está disponible actualmente.
tooManyRequests	string	Demasiadas solicitudes. Inténtelo de nuevo más tarde.
unauthorized	string	La clave de usuario o API actual no está autorizada para la operación.
unexpectedEntityState	string	La operación no se puede ejecutar en el estado del recurso actual.

ErrorResponse

Nombre	Tipo	Description
error	Error	Error Contenido de error tal y como se define en las directrices de REST de Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

IngestionError

Nombre	Tipo	Description
innerErrors	string[]
message	string

IngestionJobProgress

IngestaJobProgress

Nombre	Tipo	Description
stageProgress	IngestionJobStageProgress[]	IngestionJobStageProgress

IngestionJobRun

Nombre	Tipo	Description
error	IngestionError	IngestionError Detalles del error de ingesta
jobId	string
progress	IngestionJobProgress	IngestaJobProgress
runId	string
status	OperationState	OperationState Estado de un trabajo o elemento.
warnings	string[]

IngestionJobStageProgress

Nombre	Tipo	Description
name	string
processedItems	integer
state	OperationState	OperationState Estado de un trabajo o elemento.
subStageProgress	IngestionJobStageProgress[]	IngestionJobStageProgress
totalItems	integer

InnerError

Nombre	Tipo	Description
code	InnerErrorCode	InnerErrorCode Códigos de error internos, tal como se define en las directrices de REST de Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
innererror	InnerError	InnerError Error interno tal como se define en las directrices rest de Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

InnerErrorCode

Nombre	Tipo	Description
invalidPayload	string	Los datos de solicitud no son válidos para esta operación.

OperationState

Nombre	Tipo	Description
failed	string	La operación ha completado el procesamiento con un error y no se puede consumir más.
notRunning	string	La operación aún no está en cola para procesarse en el futuro.
running	string	La operación se ha iniciado para procesarse.
succeeded	string	La operación se ha procesado correctamente y está lista para su consumo.

Compartir a través de