ai.z.openapi.service.batches

Interface BatchService

All Known Implementing Classes:

BatchServiceImpl

public interface BatchService

Batch service interface

Method Summary

Modifier and Type	Method and Description
BatchResponse	cancelBatch(BatchRequest request) Cancels a batch request.
BatchResponse	cancelBatch(String batchId) Cancels a batch request by ID.
BatchResponse	createBatch(BatchCreateParams batchCreateParams) Creates a batch request.
QueryBatchResponse	listBatches(QueryBatchRequest queryBatchRequest) Lists all batches.
BatchResponse	retrieveBatch(BatchRequest request) Retrieves a specific batch.
BatchResponse	retrieveBatch(String batchId) Retrieves a specific batch by ID.

Method Detail

createBatch

BatchResponse createBatch(BatchCreateParams batchCreateParams)

Creates a batch request.

Parameters:

batchCreateParams - the batch creation parameters

Returns:

BatchResponse containing the created batch details

retrieveBatch

BatchResponse retrieveBatch(BatchRequest request)

Retrieves a specific batch.

Parameters:

request - the batch request containing the batch ID

Returns:

BatchResponse containing the batch details

retrieveBatch

BatchResponse retrieveBatch(String batchId)

Retrieves a specific batch by ID.

Parameters:

batchId - the ID of the batch to retrieve

Returns:

BatchResponse containing the batch details

listBatches

QueryBatchResponse listBatches(QueryBatchRequest queryBatchRequest)

Lists all batches.

Parameters:

queryBatchRequest - the query parameters for listing batches

Returns:

QueryBatchResponse containing the list of batches

cancelBatch

BatchResponse cancelBatch(BatchRequest request)

Cancels a batch request.

Parameters:

request - the batch request containing the batch ID

Returns:

BatchResponse containing the cancellation result

cancelBatch

BatchResponse cancelBatch(String batchId)

Cancels a batch request by ID.

Parameters:

batchId - the ID of the batch to cancel

Returns:

BatchResponse containing the cancellation result