Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(community): AILanguageModel interface #7025

Merged
merged 2 commits into from
Oct 20, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
93 changes: 81 additions & 12 deletions libs/langchain-community/src/experimental/llms/chrome_ai.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,25 +5,94 @@ import { GenerationChunk } from "@langchain/core/outputs";
import { IterableReadableStream } from "@langchain/core/utils/stream";
import { BaseLLMParams, LLM } from "@langchain/core/language_models/llms";

export interface AI {
canCreateTextSession(): Promise<AIModelAvailability>;
createTextSession(options?: AITextSessionOptions): Promise<AITextSession>;
defaultTextSessionOptions(): Promise<AITextSessionOptions>;
export interface AILanguageModelFactory {
create(options?: AILanguageModelCreateOptions): Promise<AILanguageModel>;
capabilities(): Promise<AILanguageModelCapabilities>;
}

export interface AITextSession {
prompt(input: string): Promise<string>;
promptStreaming(input: string): ReadableStream;
export interface AILanguageModel extends EventTarget {
prompt(
input: AILanguageModelPromptInput,
options?: AILanguageModelPromptOptions
): Promise<string>;
promptStreaming(
input: AILanguageModelPromptInput,
options?: AILanguageModelPromptOptions
): ReadableStream;

countPromptTokens(
input: AILanguageModelPromptInput,
options?: AILanguageModelPromptOptions
): Promise<number>;

get maxTokens(): number;
get tokensSoFar(): number;
get tokensLeft(): number;

get topK(): number;
get temperature(): number;

oncontextoverflow: (event: Event) => void;

clone(options?: AILanguageModelCloneOptions): Promise<AILanguageModel>;
destroy(): void;
clone(): AITextSession;
}

export interface AITextSessionOptions {
interface AILanguageModelCapabilities {
readonly available: AICapabilityAvailability;
languageAvailable(languageTag: string): AICapabilityAvailability;

get defaultTopK(): number | undefined;
get maxTopK(): number | undefined;
get defaultTemperature(): number | undefined;
get maxTemperature(): number | undefined;
}

interface AILanguageModelCreateOptions {
signal?: AbortSignal;
monitor?: AICreateMonitorCallback;
systemPrompt?: string;
initialPrompts?: AILanguageModelInitialPrompt[];
topK: number;
temperature: number;
}

export type AIModelAvailability = "readily" | "after-download" | "no";
export interface AILanguageModelInitialPrompt {
role: AILanguageModelInitialPromptRole;
content: string;
}

export interface AILanguageModelPrompt {
role: AILanguageModelPromptRole;
content: string;
}

export interface AILanguageModelPromptOptions {
signal?: AbortSignal;
}

export interface AILanguageModelCloneOptions {
signal?: AbortSignal;
}

export type AILanguageModelPromptInput =
| string
| AILanguageModelPrompt
| AILanguageModelPrompt[];

enum AILanguageModelInitialPromptRole {
"system",
"user",
"assistant",
}

enum AILanguageModelPromptRole {
"user",
"assistant",
}

export type AICapabilityAvailability = "yes" | "no";
export type AICreateMonitorCallback = () => void;

export interface ChromeAIInputs extends BaseLLMParams {
topK?: number;
Expand Down Expand Up @@ -93,14 +162,14 @@ export class ChromeAI extends LLM<ChromeAICallOptions> {
`Could not initialize ChromeAI instance. Make sure you are running a version of Chrome with the proper experimental flags enabled.\n\nError message: ${e.message}`
);
}
const { available } = await aiInstance.assistant.capabilities();
const { available } = await aiInstance.languageModel.capabilities();
if (available === "no") {
throw new Error("The AI model is not available.");
} else if (available === "after-download") {
throw new Error("The AI model is not yet downloaded.");
}

const session = await aiInstance.assistant.create({
const session = await aiInstance.languageModel.create({
systemPrompt: this.systemPrompt,
topK: this.topK,
temperature: this.temperature,
Expand Down
Loading