@singlestore/ai - npm Package Compare versions

Comparing version 0.0.11 to 0.0.12

dist/index.d.ts

 import { ChatCompletionMessageParam } from 'openai/resources/chat/completions';
 import { OpenAI } from 'openai';
 
-type ChatCompletionStream = AsyncGenerator<string>;
+type ChatCompletionPrompt = string;
+type ChatCompletionModel = string;
+type ChatCompletionChunk = string;
+type ChatCompletionStream = AsyncGenerator<ChatCompletionChunk>;
 type ChatCompletionMessage = ChatCompletionMessageParam;
-interface ChatCompletionCreateOptions<T = any> {
+interface CreateChatCompletionOptions<T = any> {
     model: T | (string & {});
@@ -12,21 +15,25 @@ systemRole: string;
 }
-type ChatCompletionCreateReturnType<T = any> = T extends {
+type CreateChatCompletionResult<T = any> = T extends {
     stream: true;
 } ? ChatCompletionStream : string;
+type OnChatCompletionStreamChunk = (chunk: ChatCompletionChunk) => Promise<void> | void;
 interface ChatCompletions {
-    getModels(): string[];
-    create<T extends Partial<ChatCompletionCreateOptions>>(prompt: string, options?: T): Promise<ChatCompletionCreateReturnType<T>>;
-    handleStream(stream: ChatCompletionStream, onChunk?: (chunk: string) => Promise<void> | void): Promise<string>;
+    getModels(): ChatCompletionModel[];
+    create<T extends Partial<CreateChatCompletionOptions>>(prompt: ChatCompletionPrompt, options?: T): Promise<CreateChatCompletionResult<T>>;
+    handleStream(stream: ChatCompletionStream, onChunk?: OnChatCompletionStreamChunk): Promise<string>;
 }
 
-interface EmbeddingsCreateOptions<T = any> {
+type Embedding = number[];
+type EmbeddingModel = string;
+type CreateEmbeddingsInput = string | string[];
+interface CreateEmbeddingsOptions<T = any> {
     model: T | (string & {});
 }
 interface Embeddings {
-    getModels(): string[];
-    create<T extends Partial<EmbeddingsCreateOptions>>(input: string | string[], options?: T): Promise<number[][]>;
+    getModels(): EmbeddingModel[];
+    create<T extends Partial<CreateEmbeddingsOptions>>(input: CreateEmbeddingsInput, options?: T): Promise<Embedding[]>;
 }
 
 type OpenAIChatCompletionModel = "gpt-4o" | "gpt-4o-2024-05-13" | "gpt-4o-2024-08-06" | "gpt-4o-mini" | "gpt-4o-mini-2024-07-18" | "gpt-4-turbo" | "gpt-4-turbo-2024-04-09" | "gpt-4-turbo-preview" | "gpt-4-0125-preview" | "gpt-4-1106-preview" | "gpt-4" | "gpt-4-0613" | "gpt-3.5-turbo-0125" | "gpt-3.5-turbo" | "gpt-3.5-turbo-1106" | "gpt-3.5-turbo-instruct";
-type OpenAIChatCompletionsCreateOptions = ChatCompletionCreateOptions<OpenAIChatCompletionModel> & Omit<Parameters<OpenAI["chat"]["completions"]["create"]>[0], keyof ChatCompletionCreateOptions>;
+type CreateOpenAIChatCompletionOptions = CreateChatCompletionOptions<OpenAIChatCompletionModel> & Omit<Parameters<OpenAI["chat"]["completions"]["create"]>[0], keyof CreateChatCompletionOptions>;
 declare class OpenAIChatCompletions implements ChatCompletions {
@@ -36,8 +43,8 @@ private _openai;
     getModels(): OpenAIChatCompletionModel[];
-    create<T extends Partial<OpenAIChatCompletionsCreateOptions>>(prompt: string, options?: T): Promise<ChatCompletionCreateReturnType<T>>;
-    handleStream(stream: ChatCompletionStream, onChunk?: (chunk: string) => Promise<void> | void): Promise<string>;
+    create<T extends Partial<CreateOpenAIChatCompletionOptions>>(prompt: string, options?: T): Promise<CreateChatCompletionResult<T>>;
+    handleStream(stream: ChatCompletionStream, onChunk?: OnChatCompletionStreamChunk): Promise<string>;
 }
 
 type OpenAIEmbeddingModel = "text-embedding-3-small" | "text-embedding-3-large" | "text-embedding-ada-002";
-type OpenAIChatEmbeddingsCreateOptions = EmbeddingsCreateOptions<OpenAIEmbeddingModel> & Omit<Parameters<OpenAI["embeddings"]["create"]>[0], "input" | keyof EmbeddingsCreateOptions>;
+type OpenAIChatEmbeddingsCreateOptions = CreateEmbeddingsOptions<OpenAIEmbeddingModel> & Omit<Parameters<OpenAI["embeddings"]["create"]>[0], "input" | keyof CreateEmbeddingsOptions>;
 declare class OpenAIEmbeddings implements Embeddings {
@@ -47,20 +54,16 @@ private _openai;
     getModels(): OpenAIEmbeddingModel[];
-    create<T extends Partial<OpenAIChatEmbeddingsCreateOptions>>(input: string | string[], options?: T): Promise<number[][]>;
+    create<T extends Partial<OpenAIChatEmbeddingsCreateOptions>>(input: CreateEmbeddingsInput, options?: T): Promise<Embedding[]>;
 }
 
-type AIConfig = {
-    embeddings: Embeddings;
-    chatCompletions: ChatCompletions;
-    openAIApiKey: string;
+type AIConfig<T extends Embeddings, U extends ChatCompletions> = {
+    embeddings?: T;
+    chatCompletions?: U;
+    openAIApiKey?: string;
 };
-declare class AI<T extends Partial<AIConfig> = Partial<AIConfig>> {
-    embeddings: T extends {
-        embeddings: Embeddings;
-    } ? T["embeddings"] : OpenAIEmbeddings;
-    chatCompletions: T extends {
-        chatCompletions: ChatCompletions;
-    } ? T["chatCompletions"] : OpenAIChatCompletions;
-    constructor(config: T);
+declare class AI<T extends Embeddings = OpenAIEmbeddings, U extends ChatCompletions = OpenAIChatCompletions> {
+    embeddings: T;
+    chatCompletions: U;
+    constructor(config: AIConfig<T, U>);
 }
 
-export { AI, type AIConfig, type ChatCompletionCreateOptions, type ChatCompletionCreateReturnType, type ChatCompletionMessage, type ChatCompletionStream, type ChatCompletions, type Embeddings, type EmbeddingsCreateOptions, type OpenAIChatCompletionModel, OpenAIChatCompletions, type OpenAIChatCompletionsCreateOptions, type OpenAIChatEmbeddingsCreateOptions, type OpenAIEmbeddingModel, OpenAIEmbeddings };
+export { AI, type AIConfig, type ChatCompletionChunk, type ChatCompletionMessage, type ChatCompletionModel, type ChatCompletionPrompt, type ChatCompletionStream, type ChatCompletions, type CreateChatCompletionOptions, type CreateChatCompletionResult, type CreateEmbeddingsInput, type CreateEmbeddingsOptions, type CreateOpenAIChatCompletionOptions, type Embedding, type EmbeddingModel, type Embeddings, type OnChatCompletionStreamChunk, type OpenAIChatCompletionModel, OpenAIChatCompletions, type OpenAIChatEmbeddingsCreateOptions, type OpenAIEmbeddingModel, OpenAIEmbeddings };

package.json

 {
   "name": "@singlestore/ai",
-  "version": "0.0.11",
+  "version": "0.0.12",
   "license": "Apache-2.0",
@@ -5,0 +5,0 @@ "sideEffects": false,

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

4959612

increased by0.01%

Lines of code

25065

increased by0.02%

Number of medium supply chain risk alerts

8

decreased by-11.11%

No dependency changes