@cotofe/service-of-litellm/dist/apis/BatchApi.d.ts

OpenAPI client for @cotofe/service-of-litellm

/**
 * Platform
 * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 *
 * The version of the OpenAPI document: 1.0.0
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import * as runtime from '../runtime';
export interface BatchApiCancelBatchBatchesBatchIdCancelPostRequest {
    batchId: string;
    provider?: string | null;
}
export interface BatchApiCancelBatchProviderV1BatchesBatchIdCancelPostRequest {
    batchId: string;
    provider: string | null;
}
export interface BatchApiCancelBatchV1BatchesBatchIdCancelPostRequest {
    batchId: string;
    provider?: string | null;
}
export interface BatchApiCreateBatchBatchesPostRequest {
    provider?: string | null;
}
export interface BatchApiCreateBatchProviderV1BatchesPostRequest {
    provider: string | null;
}
export interface BatchApiCreateBatchV1BatchesPostRequest {
    provider?: string | null;
}
export interface BatchApiListBatchesBatchesGetRequest {
    provider?: string | null;
    limit?: number | null;
    after?: string | null;
}
export interface BatchApiListBatchesProviderV1BatchesGetRequest {
    provider: string | null;
    limit?: number | null;
    after?: string | null;
}
export interface BatchApiListBatchesV1BatchesGetRequest {
    provider?: string | null;
    limit?: number | null;
    after?: string | null;
}
export interface BatchApiRetrieveBatchBatchesBatchIdGetRequest {
    batchId: string;
    provider?: string | null;
}
export interface BatchApiRetrieveBatchProviderV1BatchesBatchIdGetRequest {
    provider: string | null;
    batchId: string;
}
export interface BatchApiRetrieveBatchV1BatchesBatchIdGetRequest {
    batchId: string;
    provider?: string | null;
}
/**
 *
 */
export declare class BatchApi extends runtime.BaseAPI {
    /**
     * Cancel a batch. This is the equivalent of POST https://api.openai.com/v1/batches/{batch_id}/cancel  Supports Identical Params as: https://platform.openai.com/docs/api-reference/batch/cancel  Example Curl ``` curl http://localhost:4000/v1/batches/batch_abc123/cancel         -H \"Authorization: Bearer sk-1234\"         -H \"Content-Type: application/json\"         -X POST  ```
     * Cancel Batch
     */
    cancelBatchBatchesBatchIdCancelPostRaw(requestParameters: BatchApiCancelBatchBatchesBatchIdCancelPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
    /**
     * Cancel a batch. This is the equivalent of POST https://api.openai.com/v1/batches/{batch_id}/cancel  Supports Identical Params as: https://platform.openai.com/docs/api-reference/batch/cancel  Example Curl ``` curl http://localhost:4000/v1/batches/batch_abc123/cancel         -H \"Authorization: Bearer sk-1234\"         -H \"Content-Type: application/json\"         -X POST  ```
     * Cancel Batch
     */
    cancelBatchBatchesBatchIdCancelPost(requestParameters: BatchApiCancelBatchBatchesBatchIdCancelPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
    /**
     * Cancel a batch. This is the equivalent of POST https://api.openai.com/v1/batches/{batch_id}/cancel  Supports Identical Params as: https://platform.openai.com/docs/api-reference/batch/cancel  Example Curl ``` curl http://localhost:4000/v1/batches/batch_abc123/cancel         -H \"Authorization: Bearer sk-1234\"         -H \"Content-Type: application/json\"         -X POST  ```
     * Cancel Batch
     */
    cancelBatchProviderV1BatchesBatchIdCancelPostRaw(requestParameters: BatchApiCancelBatchProviderV1BatchesBatchIdCancelPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
    /**
     * Cancel a batch. This is the equivalent of POST https://api.openai.com/v1/batches/{batch_id}/cancel  Supports Identical Params as: https://platform.openai.com/docs/api-reference/batch/cancel  Example Curl ``` curl http://localhost:4000/v1/batches/batch_abc123/cancel         -H \"Authorization: Bearer sk-1234\"         -H \"Content-Type: application/json\"         -X POST  ```
     * Cancel Batch
     */
    cancelBatchProviderV1BatchesBatchIdCancelPost(requestParameters: BatchApiCancelBatchProviderV1BatchesBatchIdCancelPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
    /**
     * Cancel a batch. This is the equivalent of POST https://api.openai.com/v1/batches/{batch_id}/cancel  Supports Identical Params as: https://platform.openai.com/docs/api-reference/batch/cancel  Example Curl ``` curl http://localhost:4000/v1/batches/batch_abc123/cancel         -H \"Authorization: Bearer sk-1234\"         -H \"Content-Type: application/json\"         -X POST  ```
     * Cancel Batch
     */
    cancelBatchV1BatchesBatchIdCancelPostRaw(requestParameters: BatchApiCancelBatchV1BatchesBatchIdCancelPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
    /**
     * Cancel a batch. This is the equivalent of POST https://api.openai.com/v1/batches/{batch_id}/cancel  Supports Identical Params as: https://platform.openai.com/docs/api-reference/batch/cancel  Example Curl ``` curl http://localhost:4000/v1/batches/batch_abc123/cancel         -H \"Authorization: Bearer sk-1234\"         -H \"Content-Type: application/json\"         -X POST  ```
     * Cancel Batch
     */
    cancelBatchV1BatchesBatchIdCancelPost(requestParameters: BatchApiCancelBatchV1BatchesBatchIdCancelPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
    /**
     * Create large batches of API requests for asynchronous processing. This is the equivalent of POST https://api.openai.com/v1/batch Supports Identical Params as: https://platform.openai.com/docs/api-reference/batch  Example Curl ``` curl http://localhost:4000/v1/batches         -H \"Authorization: Bearer sk-1234\"         -H \"Content-Type: application/json\"         -d \'{         \"input_file_id\": \"file-abc123\",         \"endpoint\": \"/v1/chat/completions\",         \"completion_window\": \"24h\" }\' ```
     * Create Batch
     */
    createBatchBatchesPostRaw(requestParameters: BatchApiCreateBatchBatchesPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
    /**
     * Create large batches of API requests for asynchronous processing. This is the equivalent of POST https://api.openai.com/v1/batch Supports Identical Params as: https://platform.openai.com/docs/api-reference/batch  Example Curl ``` curl http://localhost:4000/v1/batches         -H \"Authorization: Bearer sk-1234\"         -H \"Content-Type: application/json\"         -d \'{         \"input_file_id\": \"file-abc123\",         \"endpoint\": \"/v1/chat/completions\",         \"completion_window\": \"24h\" }\' ```
     * Create Batch
     */
    createBatchBatchesPost(requestParameters?: BatchApiCreateBatchBatchesPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
    /**
     * Create large batches of API requests for asynchronous processing. This is the equivalent of POST https://api.openai.com/v1/batch Supports Identical Params as: https://platform.openai.com/docs/api-reference/batch  Example Curl ``` curl http://localhost:4000/v1/batches         -H \"Authorization: Bearer sk-1234\"         -H \"Content-Type: application/json\"         -d \'{         \"input_file_id\": \"file-abc123\",         \"endpoint\": \"/v1/chat/completions\",         \"completion_window\": \"24h\" }\' ```
     * Create Batch
     */
    createBatchProviderV1BatchesPostRaw(requestParameters: BatchApiCreateBatchProviderV1BatchesPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
    /**
     * Create large batches of API requests for asynchronous processing. This is the equivalent of POST https://api.openai.com/v1/batch Supports Identical Params as: https://platform.openai.com/docs/api-reference/batch  Example Curl ``` curl http://localhost:4000/v1/batches         -H \"Authorization: Bearer sk-1234\"         -H \"Content-Type: application/json\"         -d \'{         \"input_file_id\": \"file-abc123\",         \"endpoint\": \"/v1/chat/completions\",         \"completion_window\": \"24h\" }\' ```
     * Create Batch
     */
    createBatchProviderV1BatchesPost(requestParameters: BatchApiCreateBatchProviderV1BatchesPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
    /**
     * Create large batches of API requests for asynchronous processing. This is the equivalent of POST https://api.openai.com/v1/batch Supports Identical Params as: https://platform.openai.com/docs/api-reference/batch  Example Curl ``` curl http://localhost:4000/v1/batches         -H \"Authorization: Bearer sk-1234\"         -H \"Content-Type: application/json\"         -d \'{         \"input_file_id\": \"file-abc123\",         \"endpoint\": \"/v1/chat/completions\",         \"completion_window\": \"24h\" }\' ```
     * Create Batch
     */
    createBatchV1BatchesPostRaw(requestParameters: BatchApiCreateBatchV1BatchesPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
    /**
     * Create large batches of API requests for asynchronous processing. This is the equivalent of POST https://api.openai.com/v1/batch Supports Identical Params as: https://platform.openai.com/docs/api-reference/batch  Example Curl ``` curl http://localhost:4000/v1/batches         -H \"Authorization: Bearer sk-1234\"         -H \"Content-Type: application/json\"         -d \'{         \"input_file_id\": \"file-abc123\",         \"endpoint\": \"/v1/chat/completions\",         \"completion_window\": \"24h\" }\' ```
     * Create Batch
     */
    createBatchV1BatchesPost(requestParameters?: BatchApiCreateBatchV1BatchesPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
    /**
     * Lists  This is the equivalent of GET https://api.openai.com/v1/batches/ Supports Identical Params as: https://platform.openai.com/docs/api-reference/batch/list  Example Curl ``` curl http://localhost:4000/v1/batches?limit=2     -H \"Authorization: Bearer sk-1234\"     -H \"Content-Type: application/json\"  ```
     * List Batches
     */
    listBatchesBatchesGetRaw(requestParameters: BatchApiListBatchesBatchesGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
    /**
     * Lists  This is the equivalent of GET https://api.openai.com/v1/batches/ Supports Identical Params as: https://platform.openai.com/docs/api-reference/batch/list  Example Curl ``` curl http://localhost:4000/v1/batches?limit=2     -H \"Authorization: Bearer sk-1234\"     -H \"Content-Type: application/json\"  ```
     * List Batches
     */
    listBatchesBatchesGet(requestParameters?: BatchApiListBatchesBatchesGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
    /**
     * Lists  This is the equivalent of GET https://api.openai.com/v1/batches/ Supports Identical Params as: https://platform.openai.com/docs/api-reference/batch/list  Example Curl ``` curl http://localhost:4000/v1/batches?limit=2     -H \"Authorization: Bearer sk-1234\"     -H \"Content-Type: application/json\"  ```
     * List Batches
     */
    listBatchesProviderV1BatchesGetRaw(requestParameters: BatchApiListBatchesProviderV1BatchesGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
    /**
     * Lists  This is the equivalent of GET https://api.openai.com/v1/batches/ Supports Identical Params as: https://platform.openai.com/docs/api-reference/batch/list  Example Curl ``` curl http://localhost:4000/v1/batches?limit=2     -H \"Authorization: Bearer sk-1234\"     -H \"Content-Type: application/json\"  ```
     * List Batches
     */
    listBatchesProviderV1BatchesGet(requestParameters: BatchApiListBatchesProviderV1BatchesGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
    /**
     * Lists  This is the equivalent of GET https://api.openai.com/v1/batches/ Supports Identical Params as: https://platform.openai.com/docs/api-reference/batch/list  Example Curl ``` curl http://localhost:4000/v1/batches?limit=2     -H \"Authorization: Bearer sk-1234\"     -H \"Content-Type: application/json\"  ```
     * List Batches
     */
    listBatchesV1BatchesGetRaw(requestParameters: BatchApiListBatchesV1BatchesGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
    /**
     * Lists  This is the equivalent of GET https://api.openai.com/v1/batches/ Supports Identical Params as: https://platform.openai.com/docs/api-reference/batch/list  Example Curl ``` curl http://localhost:4000/v1/batches?limit=2     -H \"Authorization: Bearer sk-1234\"     -H \"Content-Type: application/json\"  ```
     * List Batches
     */
    listBatchesV1BatchesGet(requestParameters?: BatchApiListBatchesV1BatchesGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
    /**
     * Retrieves a batch. This is the equivalent of GET https://api.openai.com/v1/batches/{batch_id} Supports Identical Params as: https://platform.openai.com/docs/api-reference/batch/retrieve  Example Curl ``` curl http://localhost:4000/v1/batches/batch_abc123     -H \"Authorization: Bearer sk-1234\"     -H \"Content-Type: application/json\"  ```
     * Retrieve Batch
     */
    retrieveBatchBatchesBatchIdGetRaw(requestParameters: BatchApiRetrieveBatchBatchesBatchIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
    /**
     * Retrieves a batch. This is the equivalent of GET https://api.openai.com/v1/batches/{batch_id} Supports Identical Params as: https://platform.openai.com/docs/api-reference/batch/retrieve  Example Curl ``` curl http://localhost:4000/v1/batches/batch_abc123     -H \"Authorization: Bearer sk-1234\"     -H \"Content-Type: application/json\"  ```
     * Retrieve Batch
     */
    retrieveBatchBatchesBatchIdGet(requestParameters: BatchApiRetrieveBatchBatchesBatchIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
    /**
     * Retrieves a batch. This is the equivalent of GET https://api.openai.com/v1/batches/{batch_id} Supports Identical Params as: https://platform.openai.com/docs/api-reference/batch/retrieve  Example Curl ``` curl http://localhost:4000/v1/batches/batch_abc123     -H \"Authorization: Bearer sk-1234\"     -H \"Content-Type: application/json\"  ```
     * Retrieve Batch
     */
    retrieveBatchProviderV1BatchesBatchIdGetRaw(requestParameters: BatchApiRetrieveBatchProviderV1BatchesBatchIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
    /**
     * Retrieves a batch. This is the equivalent of GET https://api.openai.com/v1/batches/{batch_id} Supports Identical Params as: https://platform.openai.com/docs/api-reference/batch/retrieve  Example Curl ``` curl http://localhost:4000/v1/batches/batch_abc123     -H \"Authorization: Bearer sk-1234\"     -H \"Content-Type: application/json\"  ```
     * Retrieve Batch
     */
    retrieveBatchProviderV1BatchesBatchIdGet(requestParameters: BatchApiRetrieveBatchProviderV1BatchesBatchIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
    /**
     * Retrieves a batch. This is the equivalent of GET https://api.openai.com/v1/batches/{batch_id} Supports Identical Params as: https://platform.openai.com/docs/api-reference/batch/retrieve  Example Curl ``` curl http://localhost:4000/v1/batches/batch_abc123     -H \"Authorization: Bearer sk-1234\"     -H \"Content-Type: application/json\"  ```
     * Retrieve Batch
     */
    retrieveBatchV1BatchesBatchIdGetRaw(requestParameters: BatchApiRetrieveBatchV1BatchesBatchIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
    /**
     * Retrieves a batch. This is the equivalent of GET https://api.openai.com/v1/batches/{batch_id} Supports Identical Params as: https://platform.openai.com/docs/api-reference/batch/retrieve  Example Curl ``` curl http://localhost:4000/v1/batches/batch_abc123     -H \"Authorization: Bearer sk-1234\"     -H \"Content-Type: application/json\"  ```
     * Retrieve Batch
     */
    retrieveBatchV1BatchesBatchIdGet(requestParameters: BatchApiRetrieveBatchV1BatchesBatchIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
}