Update Batch Completion

Changed on
post/v2/batch-completions/{batch_completion_id}

Request

  • The document declares no server URL.
  • Auth
    • HTTP basic
    • or OAuth 2
      Password
      Token URL: token

Path parameters

batch_completion_idstring required

Request body

job_idstring required

ID of the batch completions job

prioritystring nullable

Priority of the batch inference job. Default to None.

Response

Successful Response

job_idstring required
input_data_pathstring nullable

Path to the input file. The input file should be a JSON file of type List[CreateBatchCompletionsRequestContent].

output_data_pathstring required

Path to the output file. The output file will be a JSON file of type List[CompletionOutput].

prioritystring nullable

Priority of the batch inference job. Default to None.

status'queued' | 'running' | 'completed' | 'failed' | 'cancelled' | 'unknown' required
created_atstring required
expires_atstring required
completed_atstring nullable required
metadataobject nullable required
successboolean required

Whether the update was successful

Example response

{
  "model_config": {
    "model": "mixtral-8x7b-instruct"
  }
}

Changes

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status