Ingestion Jobs - Create

Referencia

Service:: Cognitive Services - Azure OpenAI

API Version:: 2023-10-01-preview

Inicia un trabajo para ingerir datos en un índice de Azure Search que se usará como origen de datos para las finalizaciones. El estado del trabajo de ingesta se conservará durante 48 horas después de su finalización y se eliminará después.

PUT {endpoint}/openai/extensions/on-your-data/ingestion-jobs/{jobId}?api-version=2023-10-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).
jobId	path	True	string	Identificador del trabajo de ingesta.
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.
searchServiceEndpoint	True	string	Punto de conexión al recurso del servicio de búsqueda donde se crearán los recursos de ingesta.
searchServiceAdminKey		string	La clave de administrador del recurso del servicio de búsqueda si la identidad administrada no está configurada.
storageConnectionString	True	string	El cadena de conexión a la cuenta de Blob Storage que hospeda los datos que se ingerirán.
storageContainer	True	string	Nombre del contenedor que hospeda los datos que se van a ingerir.
embeddingEndpoint		string	El punto de conexión del modelo de incrustaciones que se va a usar para insertar cálculos si está habilitado.
embeddingKey		string	Clave que se va a usar para acceder al modelo de incrustaciones si está habilitada y si la identidad administrada no está configurada.
storageEndpoint		string	El punto de conexión de Blob Storage que hospeda los datos que se van a ingerir. Necesario para el formato ResourceId de storageConnectionString.
embeddingDeploymentName		string	Nombre de la implementación de inserción del recurso de Azure OpenAI actual que se va a usar para acceder al modelo de incrustaciones.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
dataRefreshIntervalInMinutes	True	integer
chunkSize		integer	Este número define el número máximo de tokens en cada fragmento generado por el flujo de ingesta.
completionAction		IngestionJobCompletionAction	IngestionJobCompletionAction Acción que se va a realizar al finalizar el trabajo de ingesta.
id		string
progress		IngestionJobProgress	IngestaJobProgress
warnings		string[]

Respuestas

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

Seguridad

api-key

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

Type: apiKey
In: header

Ejemplos

Starting an ingestion job.

Sample Request

HTTP

PUT https://aoairesource.openai.azure.com/openai/extensions/on-your-data/ingestion-jobs/test?api-version=2023-10-01-preview






{
  "dataRefreshIntervalInMinutes": 60,
  "completionAction": "cleanUpAssets"
}

Sample Response

Status code:: 200

{
  "id": "test",
  "dataRefreshIntervalInMinutes": 60,
  "completionAction": "cleanUpAssets",
  "status": "notRunning",
  "warnings": [],
  "progress": {
    "stageProgress": [
      {
        "name": "Preprocessing",
        "totalItems": 0,
        "processedItems": 0
      },
      {
        "name": "Indexing",
        "totalItems": 0,
        "processedItems": 0
      }
    ]
  }
}

Definiciones

Nombre	Description
Error	Error
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
IngestionJob	IngestionJob
IngestionJobCompletionAction	IngestionJobCompletionAction
IngestionJobProgress	IngestaJobProgress
InnerError	InnerError
InnerErrorCode	InnerErrorCode
OperationState	OperationState
StageProgress

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).

IngestionJob

Nombre	Tipo	Valor predeterminado	Description
chunkSize	integer	1024	Este número define el número máximo de tokens en cada fragmento generado por el flujo de ingesta.
completionAction	IngestionJobCompletionAction		IngestionJobCompletionAction Acción que se va a realizar al finalizar el trabajo de ingesta.
dataRefreshIntervalInMinutes	integer
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).
id	string
progress	IngestionJobProgress		IngestaJobProgress
status	OperationState		OperationState Estado de un trabajo o elemento.
warnings	string[]

IngestionJobCompletionAction

Nombre	Tipo	Description
cleanUpAssets	string	Limpiará los recursos intermedios creados durante el proceso de ingesta.
keepAllAssets	string	No limpiará ninguno de los recursos intermedios creados durante el proceso de ingesta.

IngestionJobProgress

IngestaJobProgress

Nombre	Tipo	Description
stageProgress	StageProgress[]

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.

StageProgress

Nombre	Tipo	Description
name	string
processedItems	integer
totalItems	integer

Share via