UNPKG

@cotofe/service-of-litellm

Version:

OpenAPI client for @cotofe/service-of-litellm

464 lines (463 loc) 27.6 kB
"use strict"; /** * 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()); }); }; Object.defineProperty(exports, "__esModule", { value: true }); exports.GetUserDailyActivityUserDailyActivityGetViewByEnum = exports.GetGlobalSpendReportGlobalSpendReportGetGroupByEnum = exports.BudgetSpendTrackingApi = void 0; const runtime = require("../runtime"); /** * */ class BudgetSpendTrackingApi extends runtime.BaseAPI { /** * * Add Allowed Ip */ addAllowedIpAddAllowedIpPostRaw(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: `/add/allowed_ip`, method: 'POST', headers: headerParameters, query: queryParameters, body: requestParameters.ipAddress, }, initOverrides); if (this.isJsonMime(response.headers.get('content-type'))) { return new runtime.JSONApiResponse(response); } else { return new runtime.TextApiResponse(response); } }); } /** * * Add Allowed Ip */ addAllowedIpAddAllowedIpPost() { return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) { const response = yield this.addAllowedIpAddAllowedIpPostRaw(requestParameters, initOverrides); return yield response.value(); }); } /** * Accepts all the params of completion_cost. Calculate spend **before** making call: Note: If you see a spend of $0.0 you need to set custom_pricing for your model: https://docs.litellm.ai/docs/proxy/custom_pricing ``` curl --location \'http://localhost:4000/spend/calculate\' --header \'Authorization: Bearer sk-1234\' --header \'Content-Type: application/json\' --data \'{ \"model\": \"anthropic.claude-v2\", \"messages\": [{\"role\": \"user\", \"content\": \"Hey, how\'\'\'s it going?\"}] }\' ``` Calculate spend **after** making call: ``` curl --location \'http://localhost:4000/spend/calculate\' --header \'Authorization: Bearer sk-1234\' --header \'Content-Type: application/json\' --data \'{ \"completion_response\": { \"id\": \"chatcmpl-123\", \"object\": \"chat.completion\", \"created\": 1677652288, \"model\": \"gpt-3.5-turbo-0125\", \"system_fingerprint\": \"fp_44709d6fcb\", \"choices\": [{ \"index\": 0, \"message\": { \"role\": \"assistant\", \"content\": \"Hello there, how may I assist you today?\" }, \"logprobs\": null, \"finish_reason\": \"stop\" }] \"usage\": { \"prompt_tokens\": 9, \"completion_tokens\": 12, \"total_tokens\": 21 } } }\' ``` * Calculate Spend */ calculateSpendSpendCalculatePostRaw(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: `/spend/calculate`, method: 'POST', headers: headerParameters, query: queryParameters, body: requestParameters.spendCalculateRequest, }, initOverrides); if (this.isJsonMime(response.headers.get('content-type'))) { return new runtime.JSONApiResponse(response); } else { return new runtime.TextApiResponse(response); } }); } /** * Accepts all the params of completion_cost. Calculate spend **before** making call: Note: If you see a spend of $0.0 you need to set custom_pricing for your model: https://docs.litellm.ai/docs/proxy/custom_pricing ``` curl --location \'http://localhost:4000/spend/calculate\' --header \'Authorization: Bearer sk-1234\' --header \'Content-Type: application/json\' --data \'{ \"model\": \"anthropic.claude-v2\", \"messages\": [{\"role\": \"user\", \"content\": \"Hey, how\'\'\'s it going?\"}] }\' ``` Calculate spend **after** making call: ``` curl --location \'http://localhost:4000/spend/calculate\' --header \'Authorization: Bearer sk-1234\' --header \'Content-Type: application/json\' --data \'{ \"completion_response\": { \"id\": \"chatcmpl-123\", \"object\": \"chat.completion\", \"created\": 1677652288, \"model\": \"gpt-3.5-turbo-0125\", \"system_fingerprint\": \"fp_44709d6fcb\", \"choices\": [{ \"index\": 0, \"message\": { \"role\": \"assistant\", \"content\": \"Hello there, how may I assist you today?\" }, \"logprobs\": null, \"finish_reason\": \"stop\" }] \"usage\": { \"prompt_tokens\": 9, \"completion_tokens\": 12, \"total_tokens\": 21 } } }\' ``` * Calculate Spend */ calculateSpendSpendCalculatePost() { return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) { const response = yield this.calculateSpendSpendCalculatePostRaw(requestParameters, initOverrides); return yield response.value(); }); } /** * * Delete Allowed Ip */ deleteAllowedIpDeleteAllowedIpPostRaw(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: `/delete/allowed_ip`, method: 'POST', headers: headerParameters, query: queryParameters, body: requestParameters.ipAddress, }, initOverrides); if (this.isJsonMime(response.headers.get('content-type'))) { return new runtime.JSONApiResponse(response); } else { return new runtime.TextApiResponse(response); } }); } /** * * Delete Allowed Ip */ deleteAllowedIpDeleteAllowedIpPost() { return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) { const response = yield this.deleteAllowedIpDeleteAllowedIpPostRaw(requestParameters, initOverrides); return yield response.value(); }); } /** * Get Daily Spend per Team, based on specific startTime and endTime. Per team, view usage by each key, model [ { \"group-by-day\": \"2024-05-10\", \"teams\": [ { \"team_name\": \"team-1\" \"spend\": 10, \"keys\": [ \"key\": \"1213\", \"usage\": { \"model-1\": { \"cost\": 12.50, \"input_tokens\": 1000, \"output_tokens\": 5000, \"requests\": 100 }, \"audio-modelname1\": { \"cost\": 25.50, \"seconds\": 25, \"requests\": 50 }, } } ] ] } * Get Global Spend Report */ getGlobalSpendReportGlobalSpendReportGetRaw(requestParameters, initOverrides) { return __awaiter(this, void 0, void 0, function* () { const queryParameters = {}; if (requestParameters.startDate != null) { queryParameters.start_date = requestParameters.startDate; } if (requestParameters.endDate != null) { queryParameters.end_date = requestParameters.endDate; } if (requestParameters.groupBy != null) { queryParameters.group_by = requestParameters.groupBy; } if (requestParameters.apiKey != null) { queryParameters.api_key = requestParameters.apiKey; } if (requestParameters.internalUserId != null) { queryParameters.internal_user_id = requestParameters.internalUserId; } if (requestParameters.teamId != null) { queryParameters.team_id = requestParameters.teamId; } if (requestParameters.customerId != null) { queryParameters.customer_id = requestParameters.customerId; } 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: `/global/spend/report`, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response); }); } /** * Get Daily Spend per Team, based on specific startTime and endTime. Per team, view usage by each key, model [ { \"group-by-day\": \"2024-05-10\", \"teams\": [ { \"team_name\": \"team-1\" \"spend\": 10, \"keys\": [ \"key\": \"1213\", \"usage\": { \"model-1\": { \"cost\": 12.50, \"input_tokens\": 1000, \"output_tokens\": 5000, \"requests\": 100 }, \"audio-modelname1\": { \"cost\": 25.50, \"seconds\": 25, \"requests\": 50 }, } } ] ] } * Get Global Spend Report */ getGlobalSpendReportGlobalSpendReportGet() { return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) { const response = yield this.getGlobalSpendReportGlobalSpendReportGetRaw(requestParameters, initOverrides); return yield response.value(); }); } /** * [BETA] This is a beta endpoint. It will change. Meant to optimize querying spend data for analytics for a user. Returns: (by date/team/org/user/model/api_key/model_group/provider) - spend - prompt_tokens - completion_tokens - total_tokens - api_requests - breakdown by team, organization, user, model, api_key, model_group, provider * Get User Daily Activity */ getUserDailyActivityUserDailyActivityGetRaw(requestParameters, initOverrides) { return __awaiter(this, void 0, void 0, function* () { const queryParameters = {}; if (requestParameters.startDate != null) { queryParameters.start_date = requestParameters.startDate; } if (requestParameters.endDate != null) { queryParameters.end_date = requestParameters.endDate; } if (requestParameters.groupBy != null) { queryParameters.group_by = requestParameters.groupBy; } if (requestParameters.viewBy != null) { queryParameters.view_by = requestParameters.viewBy; } if (requestParameters.teamId != null) { queryParameters.team_id = requestParameters.teamId; } if (requestParameters.orgId != null) { queryParameters.org_id = requestParameters.orgId; } if (requestParameters.model != null) { queryParameters.model = requestParameters.model; } if (requestParameters.apiKey != null) { queryParameters.api_key = requestParameters.apiKey; } if (requestParameters.page != null) { queryParameters.page = requestParameters.page; } if (requestParameters.pageSize != null) { queryParameters.page_size = requestParameters.pageSize; } 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: `/user/daily/activity`, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response); }); } /** * [BETA] This is a beta endpoint. It will change. Meant to optimize querying spend data for analytics for a user. Returns: (by date/team/org/user/model/api_key/model_group/provider) - spend - prompt_tokens - completion_tokens - total_tokens - api_requests - breakdown by team, organization, user, model, api_key, model_group, provider * Get User Daily Activity */ getUserDailyActivityUserDailyActivityGet() { return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) { const response = yield this.getUserDailyActivityUserDailyActivityGetRaw(requestParameters, initOverrides); return yield response.value(); }); } /** * ADMIN ONLY / MASTER KEY Only Endpoint Globally reset spend for All API Keys and Teams, maintain LiteLLM_SpendLogs 1. LiteLLM_SpendLogs will maintain the logs on spend, no data gets deleted from there 2. LiteLLM_VerificationTokens spend will be set = 0 3. LiteLLM_TeamTable spend will be set = 0 * Global Spend Reset */ globalSpendResetGlobalSpendResetPostRaw(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: `/global/spend/reset`, 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); } }); } /** * ADMIN ONLY / MASTER KEY Only Endpoint Globally reset spend for All API Keys and Teams, maintain LiteLLM_SpendLogs 1. LiteLLM_SpendLogs will maintain the logs on spend, no data gets deleted from there 2. LiteLLM_VerificationTokens spend will be set = 0 3. LiteLLM_TeamTable spend will be set = 0 * Global Spend Reset */ globalSpendResetGlobalSpendResetPost(initOverrides) { return __awaiter(this, void 0, void 0, function* () { const response = yield this.globalSpendResetGlobalSpendResetPostRaw(initOverrides); return yield response.value(); }); } /** * LiteLLM Enterprise - View Spend Per Request Tag. Used by LiteLLM UI Example Request: ``` curl -X GET \"http://0.0.0.0:4000/spend/tags\" -H \"Authorization: Bearer sk-1234\" ``` Spend with Start Date and End Date ``` curl -X GET \"http://0.0.0.0:4000/spend/tags?start_date=2022-01-01&end_date=2022-02-01\" -H \"Authorization: Bearer sk-1234\" ``` * Global View Spend Tags */ globalViewSpendTagsGlobalSpendTagsGetRaw(requestParameters, initOverrides) { return __awaiter(this, void 0, void 0, function* () { const queryParameters = {}; if (requestParameters.startDate != null) { queryParameters.start_date = requestParameters.startDate; } if (requestParameters.endDate != null) { queryParameters.end_date = requestParameters.endDate; } if (requestParameters.tags != null) { queryParameters.tags = requestParameters.tags; } 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: `/global/spend/tags`, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response); }); } /** * LiteLLM Enterprise - View Spend Per Request Tag. Used by LiteLLM UI Example Request: ``` curl -X GET \"http://0.0.0.0:4000/spend/tags\" -H \"Authorization: Bearer sk-1234\" ``` Spend with Start Date and End Date ``` curl -X GET \"http://0.0.0.0:4000/spend/tags?start_date=2022-01-01&end_date=2022-02-01\" -H \"Authorization: Bearer sk-1234\" ``` * Global View Spend Tags */ globalViewSpendTagsGlobalSpendTagsGet() { return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) { const response = yield this.globalViewSpendTagsGlobalSpendTagsGetRaw(requestParameters, initOverrides); return yield response.value(); }); } /** * View all spend logs, if request_id is provided, only logs for that request_id will be returned Example Request for all logs ``` curl -X GET \"http://0.0.0.0:8000/spend/logs\" -H \"Authorization: Bearer sk-1234\" ``` Example Request for specific request_id ``` curl -X GET \"http://0.0.0.0:8000/spend/logs?request_id=chatcmpl-6dcb2540-d3d7-4e49-bb27-291f863f112e\" -H \"Authorization: Bearer sk-1234\" ``` Example Request for specific api_key ``` curl -X GET \"http://0.0.0.0:8000/spend/logs?api_key=sk-Fn8Ej39NkBQmUagFEoUWPQ\" -H \"Authorization: Bearer sk-1234\" ``` Example Request for specific user_id ``` curl -X GET \"http://0.0.0.0:8000/spend/logs?user_id=ishaan@berri.ai\" -H \"Authorization: Bearer sk-1234\" ``` * View Spend Logs */ viewSpendLogsSpendLogsGetRaw(requestParameters, initOverrides) { return __awaiter(this, void 0, void 0, function* () { const queryParameters = {}; if (requestParameters.apiKey != null) { queryParameters.api_key = requestParameters.apiKey; } if (requestParameters.userId != null) { queryParameters.user_id = requestParameters.userId; } if (requestParameters.requestId != null) { queryParameters.request_id = requestParameters.requestId; } if (requestParameters.startDate != null) { queryParameters.start_date = requestParameters.startDate; } if (requestParameters.endDate != null) { queryParameters.end_date = requestParameters.endDate; } 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: `/spend/logs`, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response); }); } /** * View all spend logs, if request_id is provided, only logs for that request_id will be returned Example Request for all logs ``` curl -X GET \"http://0.0.0.0:8000/spend/logs\" -H \"Authorization: Bearer sk-1234\" ``` Example Request for specific request_id ``` curl -X GET \"http://0.0.0.0:8000/spend/logs?request_id=chatcmpl-6dcb2540-d3d7-4e49-bb27-291f863f112e\" -H \"Authorization: Bearer sk-1234\" ``` Example Request for specific api_key ``` curl -X GET \"http://0.0.0.0:8000/spend/logs?api_key=sk-Fn8Ej39NkBQmUagFEoUWPQ\" -H \"Authorization: Bearer sk-1234\" ``` Example Request for specific user_id ``` curl -X GET \"http://0.0.0.0:8000/spend/logs?user_id=ishaan@berri.ai\" -H \"Authorization: Bearer sk-1234\" ``` * View Spend Logs */ viewSpendLogsSpendLogsGet() { return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) { const response = yield this.viewSpendLogsSpendLogsGetRaw(requestParameters, initOverrides); return yield response.value(); }); } /** * LiteLLM Enterprise - View Spend Per Request Tag Example Request: ``` curl -X GET \"http://0.0.0.0:8000/spend/tags\" -H \"Authorization: Bearer sk-1234\" ``` Spend with Start Date and End Date ``` curl -X GET \"http://0.0.0.0:8000/spend/tags?start_date=2022-01-01&end_date=2022-02-01\" -H \"Authorization: Bearer sk-1234\" ``` * View Spend Tags */ viewSpendTagsSpendTagsGetRaw(requestParameters, initOverrides) { return __awaiter(this, void 0, void 0, function* () { const queryParameters = {}; if (requestParameters.startDate != null) { queryParameters.start_date = requestParameters.startDate; } if (requestParameters.endDate != null) { queryParameters.end_date = requestParameters.endDate; } 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: `/spend/tags`, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response); }); } /** * LiteLLM Enterprise - View Spend Per Request Tag Example Request: ``` curl -X GET \"http://0.0.0.0:8000/spend/tags\" -H \"Authorization: Bearer sk-1234\" ``` Spend with Start Date and End Date ``` curl -X GET \"http://0.0.0.0:8000/spend/tags?start_date=2022-01-01&end_date=2022-02-01\" -H \"Authorization: Bearer sk-1234\" ``` * View Spend Tags */ viewSpendTagsSpendTagsGet() { return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) { const response = yield this.viewSpendTagsSpendTagsGetRaw(requestParameters, initOverrides); return yield response.value(); }); } } exports.BudgetSpendTrackingApi = BudgetSpendTrackingApi; /** * @export * @enum {string} */ var GetGlobalSpendReportGlobalSpendReportGetGroupByEnum; (function (GetGlobalSpendReportGlobalSpendReportGetGroupByEnum) { GetGlobalSpendReportGlobalSpendReportGetGroupByEnum["Team"] = "team"; GetGlobalSpendReportGlobalSpendReportGetGroupByEnum["Customer"] = "customer"; GetGlobalSpendReportGlobalSpendReportGetGroupByEnum["ApiKey"] = "api_key"; })(GetGlobalSpendReportGlobalSpendReportGetGroupByEnum || (exports.GetGlobalSpendReportGlobalSpendReportGetGroupByEnum = GetGlobalSpendReportGlobalSpendReportGetGroupByEnum = {})); /** * @export * @enum {string} */ var GetUserDailyActivityUserDailyActivityGetViewByEnum; (function (GetUserDailyActivityUserDailyActivityGetViewByEnum) { GetUserDailyActivityUserDailyActivityGetViewByEnum["Team"] = "team"; GetUserDailyActivityUserDailyActivityGetViewByEnum["Organization"] = "organization"; GetUserDailyActivityUserDailyActivityGetViewByEnum["User"] = "user"; })(GetUserDailyActivityUserDailyActivityGetViewByEnum || (exports.GetUserDailyActivityUserDailyActivityGetViewByEnum = GetUserDailyActivityUserDailyActivityGetViewByEnum = {}));