// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. import * as Errors from './error'; import * as Uploads from './uploads'; import { type Agent } from './_shims/index'; import * as Core from './core'; import * as API from './resources/index'; export interface ClientOptions { /** * Defaults to process.env['GROQ_API_KEY']. */ apiKey?: string | undefined; /** * Override the default base URL for the API, e.g., "https://api.example.com/v2/" * * Defaults to process.env['GROQ_BASE_URL']. */ baseURL?: string | null | undefined; /** * Override the default base path for the API, e.g., "/openai/v1" */ basePath?: string | null | undefined; /** * Disable the cors check in the browser. * * Defaults to false. */ disableCorsCheck?: boolean; /** * The host of a proxy server to use for requests. */ proxy?: string | undefined; /** * The maximum amount of time (in milliseconds) that the client should wait for a response * from the server before timing out a single request. * * Note that request timeouts are retried by default, so in a worst-case scenario you may wait * much longer than this timeout before the promise succeeds or fails. */ timeout?: number; /** * An HTTP agent used to manage HTTP(S) connections. * * If not provided, an agent will be constructed by default in the Node.js environment, * otherwise no agent is used. */ httpAgent?: Agent; /** * Specify a custom `fetch` function implementation. * * If not provided, we use `node-fetch` on Node.js and otherwise expect that `fetch` is * defined globally. */ fetch?: Core.Fetch | undefined; /** * The maximum number of times that the client will retry a request in case of a * temporary failure, like a network error or a 5XX error from the server. * * @default 2 */ maxRetries?: number; /** * Default headers to include with every request to the API. * * These can be removed in individual requests by explicitly setting the * header to `undefined` or `null` in request options. */ defaultHeaders?: Core.Headers; /** * Default query parameters to include with every request to the API. * * These can be removed in individual requests by explicitly setting the * param to `undefined` in request options. */ defaultQuery?: Core.DefaultQuery; /** * By default, client-side use of this library is not allowed, as it risks exposing your secret API credentials to attackers. * Only set this option to `true` if you understand the risks and have appropriate mitigations in place. */ dangerouslyAllowBrowser?: boolean; } /** * API Client for interfacing with the Groq API. */ export class Groq extends Core.APIClient { apiKey: string; private _options: ClientOptions; /** * API Client for interfacing with the Groq API. * * @param {string | undefined} [opts.apiKey=process.env['GROQ_API_KEY'] ?? undefined] * @param {string} [opts.baseURL=process.env['GROQ_BASE_URL'] ?? https://api.groq.com] - Override the default base URL for the API. * @param {string} [opts.basePath=process.env['GROQ_BASE_PATH'] ?? /openai/v1] - Override the default base path for the API. * @param {boolean} [opts.disableCorsCheck=false] - Disable the cors check in the browser. * @param {string} [opts.proxy=undefined] - The host of a proxy server to use for requests. * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out. * @param {number} [opts.httpAgent] - An HTTP agent used to manage HTTP(s) connections. * @param {Core.Fetch} [opts.fetch] - Specify a custom `fetch` function implementation. * @param {number} [opts.maxRetries=2] - The maximum number of times the client will retry a request. * @param {Core.Headers} opts.defaultHeaders - Default headers to include with every request to the API. * @param {Core.DefaultQuery} opts.defaultQuery - Default query parameters to include with every request to the API. * @param {boolean} [opts.dangerouslyAllowBrowser=false] - By default, client-side use of this library is not allowed, as it risks exposing your secret API credentials to attackers. */ constructor({ baseURL = Core.readEnv('GROQ_BASE_URL'), apiKey = Core.readEnv('GROQ_API_KEY'), basePath = Core.readEnv('GROQ_BASE_PATH'), disableCorsCheck = Core.readEnv('GROQ_DISABLE_CORS_CHECK') === 'true', proxy = Core.readEnv('GROQ_PROXY') || undefined, ...opts }: ClientOptions = {}) { if (apiKey === undefined) { throw new Errors.GroqError( "The GROQ_API_KEY environment variable is missing or empty; either provide it, or instantiate the Groq client with an apiKey option, like new Groq({ apiKey: 'My API Key' }).", ); } const options: ClientOptions = { apiKey, ...opts, baseURL: baseURL || `https://api.groq.com`, basePath: basePath || `/openai/v1`, disableCorsCheck, proxy: proxy || undefined, }; if (!options.dangerouslyAllowBrowser && Core.isRunningInBrowser()) { throw new Errors.GroqError( "It looks like you're running in a browser-like environment.\n\nThis is disabled by default, as it risks exposing your secret API credentials to attackers.\nIf you understand the risks and have appropriate mitigations in place,\nyou can set the `dangerouslyAllowBrowser` option to `true`, e.g.,\n\nnew Groq({ apiKey, dangerouslyAllowBrowser: true })", ); } super({ baseURL: options.baseURL!, basePath: options.basePath!, disableCorsCheck: options.disableCorsCheck, proxy: options.proxy, timeout: options.timeout ?? 60000 /* 1 minute */, httpAgent: options.httpAgent, maxRetries: options.maxRetries, fetch: options.fetch, }); this._options = options; this.apiKey = apiKey; } completions: API.Completions = new API.Completions(this); chat: API.Chat = new API.Chat(this); embeddings: API.Embeddings = new API.Embeddings(this); audio: API.Audio = new API.Audio(this); models: API.Models = new API.Models(this); protected override defaultQuery(): Core.DefaultQuery | undefined { return this._options.defaultQuery; } protected override defaultHeaders(opts: Core.FinalRequestOptions): Core.Headers { return { ...super.defaultHeaders(opts), ...this._options.defaultHeaders, }; } protected override authHeaders(opts: Core.FinalRequestOptions): Core.Headers { return { Authorization: `Bearer ${this.apiKey}` }; } static Groq = this; static DEFAULT_TIMEOUT = 60000; // 1 minute static GroqError = Errors.GroqError; static APIError = Errors.APIError; static APIConnectionError = Errors.APIConnectionError; static APIConnectionTimeoutError = Errors.APIConnectionTimeoutError; static APIUserAbortError = Errors.APIUserAbortError; static NotFoundError = Errors.NotFoundError; static ConflictError = Errors.ConflictError; static RateLimitError = Errors.RateLimitError; static BadRequestError = Errors.BadRequestError; static AuthenticationError = Errors.AuthenticationError; static InternalServerError = Errors.InternalServerError; static PermissionDeniedError = Errors.PermissionDeniedError; static UnprocessableEntityError = Errors.UnprocessableEntityError; static toFile = Uploads.toFile; static fileFromPath = Uploads.fileFromPath; } export const { GroqError, APIError, APIConnectionError, APIConnectionTimeoutError, APIUserAbortError, NotFoundError, ConflictError, RateLimitError, BadRequestError, AuthenticationError, InternalServerError, PermissionDeniedError, UnprocessableEntityError, } = Errors; export import toFile = Uploads.toFile; export import fileFromPath = Uploads.fileFromPath; export namespace Groq { export import RequestOptions = Core.RequestOptions; export import Completions = API.Completions; export import CompletionUsage = API.CompletionUsage; export import Chat = API.Chat; export import Embeddings = API.Embeddings; export import CreateEmbeddingResponse = API.CreateEmbeddingResponse; export import Embedding = API.Embedding; export import EmbeddingCreateParams = API.EmbeddingCreateParams; export import Audio = API.Audio; export import Models = API.Models; export import Model = API.Model; export import ModelDeleted = API.ModelDeleted; export import ModelListResponse = API.ModelListResponse; export import ErrorObject = API.ErrorObject; export import FunctionDefinition = API.FunctionDefinition; export import FunctionParameters = API.FunctionParameters; } export class AI extends Groq {} export default { Groq, AI };