UNPKG

@cotofe/service-of-litellm

Version:

OpenAPI client for @cotofe/service-of-litellm

487 lines (486 loc) 25 kB
/** * 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. */ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) { function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); } return new (P || (P = Promise))(function (resolve, reject) { function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } } function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } } function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); } step((generator = generator.apply(thisArg, _arguments || [])).next()); }); }; import * as runtime from '../runtime'; /** * */ export class LitellmApi extends runtime.BaseAPI { /** * Create new pass-through endpoint * Create Pass Through Endpoints */ createPassThroughEndpointsConfigPassThroughEndpointPostRaw(requestParameters, initOverrides) { return __awaiter(this, void 0, void 0, function* () { const queryParameters = {}; const headerParameters = {}; headerParameters['Content-Type'] = 'application/json'; if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = yield token('bearer', []); if (tokenString) { headerParameters.Authorization = `Bearer ${tokenString}`; } } const response = yield this.request({ path: `/config/pass_through_endpoint`, method: 'POST', headers: headerParameters, query: queryParameters, body: requestParameters.passThroughGenericEndpoint, }, initOverrides); if (this.isJsonMime(response.headers.get('content-type'))) { return new runtime.JSONApiResponse(response); } else { return new runtime.TextApiResponse(response); } }); } /** * Create new pass-through endpoint * Create Pass Through Endpoints */ createPassThroughEndpointsConfigPassThroughEndpointPost() { return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) { const response = yield this.createPassThroughEndpointsConfigPassThroughEndpointPostRaw(requestParameters, initOverrides); return yield response.value(); }); } /** * Delete a pass-through endpoint Returns - the deleted endpoint * Delete Pass Through Endpoints */ deletePassThroughEndpointsConfigPassThroughEndpointDeleteRaw(requestParameters, initOverrides) { return __awaiter(this, void 0, void 0, function* () { if (requestParameters.endpointId == null) { throw new runtime.RequiredError('endpointId', 'Required parameter "endpointId" was null or undefined when calling deletePassThroughEndpointsConfigPassThroughEndpointDelete().'); } const queryParameters = {}; if (requestParameters.endpointId != null) { queryParameters.endpoint_id = requestParameters.endpointId; } const headerParameters = {}; if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = yield token('bearer', []); if (tokenString) { headerParameters.Authorization = `Bearer ${tokenString}`; } } const response = yield this.request({ path: `/config/pass_through_endpoint`, method: 'DELETE', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response); }); } /** * Delete a pass-through endpoint Returns - the deleted endpoint * Delete Pass Through Endpoints */ deletePassThroughEndpointsConfigPassThroughEndpointDelete(requestParameters, initOverrides) { return __awaiter(this, void 0, void 0, function* () { const response = yield this.deletePassThroughEndpointsConfigPassThroughEndpointDeleteRaw(requestParameters, initOverrides); return yield response.value(); }); } /** * GET configured pass through endpoint. If no endpoint_id given, return all configured endpoints. * Get Pass Through Endpoints */ getPassThroughEndpointsConfigPassThroughEndpointGetRaw(requestParameters, initOverrides) { return __awaiter(this, void 0, void 0, function* () { const queryParameters = {}; if (requestParameters.endpointId != null) { queryParameters.endpoint_id = requestParameters.endpointId; } const headerParameters = {}; if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = yield token('bearer', []); if (tokenString) { headerParameters.Authorization = `Bearer ${tokenString}`; } } const response = yield this.request({ path: `/config/pass_through_endpoint`, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response); }); } /** * GET configured pass through endpoint. If no endpoint_id given, return all configured endpoints. * Get Pass Through Endpoints */ getPassThroughEndpointsConfigPassThroughEndpointGet() { return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) { const response = yield this.getPassThroughEndpointsConfigPassThroughEndpointGetRaw(requestParameters, initOverrides); return yield response.value(); }); } /** * Get a list of available routes in the FastAPI application. * Get Routes */ getRoutesRoutesGetRaw(initOverrides) { return __awaiter(this, void 0, void 0, function* () { const queryParameters = {}; const headerParameters = {}; if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = yield token('bearer', []); if (tokenString) { headerParameters.Authorization = `Bearer ${tokenString}`; } } const response = yield this.request({ path: `/routes`, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); if (this.isJsonMime(response.headers.get('content-type'))) { return new runtime.JSONApiResponse(response); } else { return new runtime.TextApiResponse(response); } }); } /** * Get a list of available routes in the FastAPI application. * Get Routes */ getRoutesRoutesGet(initOverrides) { return __awaiter(this, void 0, void 0, function* () { const response = yield this.getRoutesRoutesGetRaw(initOverrides); return yield response.value(); }); } /** * * Home */ homeGetRaw(initOverrides) { return __awaiter(this, void 0, void 0, function* () { const queryParameters = {}; const headerParameters = {}; if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = yield token('bearer', []); if (tokenString) { headerParameters.Authorization = `Bearer ${tokenString}`; } } const response = yield this.request({ path: `/`, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); if (this.isJsonMime(response.headers.get('content-type'))) { return new runtime.JSONApiResponse(response); } else { return new runtime.TextApiResponse(response); } }); } /** * * Home */ homeGet(initOverrides) { return __awaiter(this, void 0, void 0, function* () { const response = yield this.homeGetRaw(initOverrides); return yield response.value(); }); } /** * * List Available Teams */ listAvailableTeamsTeamAvailableGetRaw(requestParameters, initOverrides) { return __awaiter(this, void 0, void 0, function* () { const queryParameters = {}; if (requestParameters.responseModel != null) { queryParameters.response_model = requestParameters.responseModel; } const headerParameters = {}; if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = yield token('bearer', []); if (tokenString) { headerParameters.Authorization = `Bearer ${tokenString}`; } } const response = yield this.request({ path: `/team/available`, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); if (this.isJsonMime(response.headers.get('content-type'))) { return new runtime.JSONApiResponse(response); } else { return new runtime.TextApiResponse(response); } }); } /** * * List Available Teams */ listAvailableTeamsTeamAvailableGet() { return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) { const response = yield this.listAvailableTeamsTeamAvailableGetRaw(requestParameters, initOverrides); return yield response.value(); }); } /** * List all keys for a given user / team / organization. Returns: { \"keys\": List[str] or List[UserAPIKeyAuth], \"total_count\": int, \"current_page\": int, \"total_pages\": int, } * List Keys */ listKeysKeyListGetRaw(requestParameters, initOverrides) { return __awaiter(this, void 0, void 0, function* () { const queryParameters = {}; if (requestParameters.page != null) { queryParameters.page = requestParameters.page; } if (requestParameters.size != null) { queryParameters.size = requestParameters.size; } if (requestParameters.userId != null) { queryParameters.user_id = requestParameters.userId; } if (requestParameters.teamId != null) { queryParameters.team_id = requestParameters.teamId; } if (requestParameters.organizationId != null) { queryParameters.organization_id = requestParameters.organizationId; } if (requestParameters.keyAlias != null) { queryParameters.key_alias = requestParameters.keyAlias; } if (requestParameters.returnFullObject != null) { queryParameters.return_full_object = requestParameters.returnFullObject; } if (requestParameters.includeTeamKeys != null) { queryParameters.include_team_keys = requestParameters.includeTeamKeys; } const headerParameters = {}; if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = yield token('bearer', []); if (tokenString) { headerParameters.Authorization = `Bearer ${tokenString}`; } } const response = yield this.request({ path: `/key/list`, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response); }); } /** * List all keys for a given user / team / organization. Returns: { \"keys\": List[str] or List[UserAPIKeyAuth], \"total_count\": int, \"current_page\": int, \"total_pages\": int, } * List Keys */ listKeysKeyListGet() { return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) { const response = yield this.listKeysKeyListGetRaw(requestParameters, initOverrides); return yield response.value(); }); } /** * Provides more info about each model in /models, including config.yaml descriptions (except api key and api base) Parameters: litellm_model_id: Optional[str] = None (this is the value of `x-litellm-model-id` returned in response headers) - When litellm_model_id is passed, it will return the info for that specific model - When litellm_model_id is not passed, it will return the info for all models Returns: Returns a dictionary containing information about each model. Example Response: ```json { \"data\": [ { \"model_name\": \"fake-openai-endpoint\", \"litellm_params\": { \"api_base\": \"https://exampleopenaiendpoint-production.up.railway.app/\", \"model\": \"openai/fake\" }, \"model_info\": { \"id\": \"112f74fab24a7a5245d2ced3536dd8f5f9192c57ee6e332af0f0512e08bed5af\", \"db_model\": false } } ] } ``` * Model Info V1 */ modelInfoV1V1ModelInfoGetRaw(requestParameters, initOverrides) { return __awaiter(this, void 0, void 0, function* () { const queryParameters = {}; if (requestParameters.litellmModelId != null) { queryParameters.litellm_model_id = requestParameters.litellmModelId; } const headerParameters = {}; if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = yield token('bearer', []); if (tokenString) { headerParameters.Authorization = `Bearer ${tokenString}`; } } const response = yield this.request({ path: `/v1/model/info`, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); if (this.isJsonMime(response.headers.get('content-type'))) { return new runtime.JSONApiResponse(response); } else { return new runtime.TextApiResponse(response); } }); } /** * Provides more info about each model in /models, including config.yaml descriptions (except api key and api base) Parameters: litellm_model_id: Optional[str] = None (this is the value of `x-litellm-model-id` returned in response headers) - When litellm_model_id is passed, it will return the info for that specific model - When litellm_model_id is not passed, it will return the info for all models Returns: Returns a dictionary containing information about each model. Example Response: ```json { \"data\": [ { \"model_name\": \"fake-openai-endpoint\", \"litellm_params\": { \"api_base\": \"https://exampleopenaiendpoint-production.up.railway.app/\", \"model\": \"openai/fake\" }, \"model_info\": { \"id\": \"112f74fab24a7a5245d2ced3536dd8f5f9192c57ee6e332af0f0512e08bed5af\", \"db_model\": false } } ] } ``` * Model Info V1 */ modelInfoV1V1ModelInfoGet() { return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) { const response = yield this.modelInfoV1V1ModelInfoGetRaw(requestParameters, initOverrides); return yield response.value(); }); } /** * Use `/model/info` - to get detailed model information, example - pricing, mode, etc. This is just for compatibility with openai projects like aider. * Model List */ modelListV1ModelsGetRaw(requestParameters, initOverrides) { return __awaiter(this, void 0, void 0, function* () { const queryParameters = {}; if (requestParameters.returnWildcardRoutes != null) { queryParameters.return_wildcard_routes = requestParameters.returnWildcardRoutes; } if (requestParameters.teamId != null) { queryParameters.team_id = requestParameters.teamId; } const headerParameters = {}; if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = yield token('bearer', []); if (tokenString) { headerParameters.Authorization = `Bearer ${tokenString}`; } } const response = yield this.request({ path: `/v1/models`, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); if (this.isJsonMime(response.headers.get('content-type'))) { return new runtime.JSONApiResponse(response); } else { return new runtime.TextApiResponse(response); } }); } /** * Use `/model/info` - to get detailed model information, example - pricing, mode, etc. This is just for compatibility with openai projects like aider. * Model List */ modelListV1ModelsGet() { return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) { const response = yield this.modelListV1ModelsGetRaw(requestParameters, initOverrides); return yield response.value(); }); } /** * Provider Budget Routing - Get Budget, Spend Details https://docs.litellm.ai/docs/proxy/provider_budget_routing Use this endpoint to check current budget, spend and budget reset time for a provider Example Request ```bash curl -X GET http://localhost:4000/provider/budgets -H \"Content-Type: application/json\" -H \"Authorization: Bearer sk-1234\" ``` Example Response ```json { \"providers\": { \"openai\": { \"budget_limit\": 1e-12, \"time_period\": \"1d\", \"spend\": 0.0, \"budget_reset_at\": null }, \"azure\": { \"budget_limit\": 100.0, \"time_period\": \"1d\", \"spend\": 0.0, \"budget_reset_at\": null }, \"anthropic\": { \"budget_limit\": 100.0, \"time_period\": \"10d\", \"spend\": 0.0, \"budget_reset_at\": null }, \"vertex_ai\": { \"budget_limit\": 100.0, \"time_period\": \"12d\", \"spend\": 0.0, \"budget_reset_at\": null } } } ``` * Provider Budgets */ providerBudgetsProviderBudgetsGetRaw(initOverrides) { return __awaiter(this, void 0, void 0, function* () { const queryParameters = {}; const headerParameters = {}; if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = yield token('bearer', []); if (tokenString) { headerParameters.Authorization = `Bearer ${tokenString}`; } } const response = yield this.request({ path: `/provider/budgets`, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response); }); } /** * Provider Budget Routing - Get Budget, Spend Details https://docs.litellm.ai/docs/proxy/provider_budget_routing Use this endpoint to check current budget, spend and budget reset time for a provider Example Request ```bash curl -X GET http://localhost:4000/provider/budgets -H \"Content-Type: application/json\" -H \"Authorization: Bearer sk-1234\" ``` Example Response ```json { \"providers\": { \"openai\": { \"budget_limit\": 1e-12, \"time_period\": \"1d\", \"spend\": 0.0, \"budget_reset_at\": null }, \"azure\": { \"budget_limit\": 100.0, \"time_period\": \"1d\", \"spend\": 0.0, \"budget_reset_at\": null }, \"anthropic\": { \"budget_limit\": 100.0, \"time_period\": \"10d\", \"spend\": 0.0, \"budget_reset_at\": null }, \"vertex_ai\": { \"budget_limit\": 100.0, \"time_period\": \"12d\", \"spend\": 0.0, \"budget_reset_at\": null } } } ``` * Provider Budgets */ providerBudgetsProviderBudgetsGet(initOverrides) { return __awaiter(this, void 0, void 0, function* () { const response = yield this.providerBudgetsProviderBudgetsGetRaw(initOverrides); return yield response.value(); }); } /** * Update a pass-through endpoint * Update Pass Through Endpoints */ updatePassThroughEndpointsConfigPassThroughEndpointEndpointIdPostRaw(requestParameters, initOverrides) { return __awaiter(this, void 0, void 0, function* () { if (requestParameters.endpointId == null) { throw new runtime.RequiredError('endpointId', 'Required parameter "endpointId" was null or undefined when calling updatePassThroughEndpointsConfigPassThroughEndpointEndpointIdPost().'); } const queryParameters = {}; const headerParameters = {}; if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = yield token('bearer', []); if (tokenString) { headerParameters.Authorization = `Bearer ${tokenString}`; } } const response = yield this.request({ path: `/config/pass_through_endpoint/{endpoint_id}`.replace(`{${'endpoint_id'}}`, encodeURIComponent(String(requestParameters.endpointId))), method: 'POST', headers: headerParameters, query: queryParameters, }, initOverrides); if (this.isJsonMime(response.headers.get('content-type'))) { return new runtime.JSONApiResponse(response); } else { return new runtime.TextApiResponse(response); } }); } /** * Update a pass-through endpoint * Update Pass Through Endpoints */ updatePassThroughEndpointsConfigPassThroughEndpointEndpointIdPost(requestParameters, initOverrides) { return __awaiter(this, void 0, void 0, function* () { const response = yield this.updatePassThroughEndpointsConfigPassThroughEndpointEndpointIdPostRaw(requestParameters, initOverrides); return yield response.value(); }); } }