dokumetry/src/index.js

An NPM Package for tracking OpenAI API calls and sending usage metrics to Doku

import initOpenAI from "./providers/openai.js";
import initCohere from "./providers/cohere.js";
import initAnthropic from "./providers/anthropic.js";
import initMistral from "./providers/mistral.js";
import initAzureOpenAI from "./providers/azure_openai.js";

/**
 * Represents the configuration for Doku.
 * @class DokuConfig
 */
class DokuConfig {
	static dokuUrl = null;
	static apiKey = null;
	static llm = null;
	static environment = null;
	static applicationName = null;
	static skipResp = null;
}

/**
 * Initializes OpenAI functionality with performance tracking and data logging.
 *
 * @param {Object} llm - The OpenAI function object.
 * @param {string} dokuUrl - The URL for logging data.
 * @param {string} apiKey - The authentication apiKey.
 * @param {string} environment - The environment.
 * @param {string} applicationName - The application name.
 * @param {boolean} skipResp - To skip waiting for API resopnse.
 * @return {void}
 *
 * @jsondoc
 * {
 *   "description": "Performance tracking for OpenAI APIs",
 *   "params": [
 *     {"name": "llm", "type": "Object", "description": "OpenAI function."},
 *     {"name": "dokuUrl", "type": "string", "description": "The URL"},
 *     {"name": "apiKey", "type": "string", "description": "The auth apiKey."},
 *     {"name": "environment", "type": "string", "description": "The environment."},
 *     {"name": "applicationName", "type": "string", "description": "The application name."},
 *     {"name": "skipResp", "type": "boolean", "description": "To skip waiting for API resopnse."}
 *   ],
 *   "returns": {"type": "void"},
 *   "example": {
 *     "description": "Example usage of init function.",
 *     "code": "init(openaiFunc, 'https://example.com/log', 'authToken');"
 *   }
 * }
 */
function init({
	llm,
	dokuUrl,
	apiKey,
	environment = "default",
	applicationName = "default",
	skipResp = false,
}) {
	DokuConfig.dokuUrl = dokuUrl;
	DokuConfig.apiKey = apiKey;
	DokuConfig.llm = llm;
	DokuConfig.environment = environment;
	DokuConfig.applicationName = applicationName;
	DokuConfig.skipResp = skipResp;

	if (
		llm.fineTuning &&
		typeof llm.completions.create === "function" &&
		!llm.baseURL.includes("azure.com")
	) {
		initOpenAI({
			llm,
			dokuUrl,
			apiKey,
			environment,
			applicationName,
			skipResp,
		});
	} else if (
		llm.fineTuning &&
		typeof llm.completions.create === "function" &&
		llm.baseURL.includes("azure.com")
	) {
		initAzureOpenAI({
			llm,
			dokuUrl,
			apiKey,
			environment,
			applicationName,
			skipResp,
		});
	} else if (llm.generate && typeof llm.rerank === "function") {
		initCohere({
			llm,
			dokuUrl,
			apiKey,
			environment,
			applicationName,
			skipResp,
		});
	} else if (llm.messages && typeof llm.messages.create === "function") {
		initAnthropic({
			llm,
			dokuUrl,
			apiKey,
			environment,
			applicationName,
			skipResp,
		});
	} else if (llm.listModels && typeof llm.chatStream === "function") {
		initMistral({
			llm,
			dokuUrl,
			apiKey,
			environment,
			applicationName,
			skipResp,
		});
	}
}

// Setting up the dokumetry namespace object
const DokuMetry = {
	init: init,
};

export default DokuMetry;