👌 IMPROVE: Examples and Types

Author: ahmadawais

examples/everything/generate-text.ts

@@ -1,9 +1,12 @@
+/**
+ * Generates a text completion using `generateText()`
+ *
+ * @docs: https://langbase.com/docs/langbase-sdk/generate-text
+ */
+
 import 'dotenv/config';
 import {Pipe} from 'langbase';
 
-// STREAM: OFF
-console.log('STREAM-OFF: generateText()');
-
 // 1. Initiate the Pipe.
 const pipe = new Pipe({
 	apiKey: process.env.PIPE_LESS_WORDY!,

examples/everything/stream-text.ts

@@ -1,9 +1,12 @@
+/**
+ * Generates a text completion using `streamText()`
+ *
+ * @docs: https://langbase.com/docs/langbase-sdk/stream-text
+ */
+
 import 'dotenv/config';
 import {Pipe} from 'langbase';
 
-// STREAM: ON
-console.log('STREAM-ON: streamText()');
-
 // 1. Initiate the Pipe.
 const pipe = new Pipe({
 	apiKey: process.env.PIPE_LESS_WORDY!,

packages/langbase/src/pipes/pipes.ts

@@ -1,24 +1,34 @@
 import {Request} from '../common/request';
 import {Stream} from '../common/stream';
 
+export type Role = 'user' | 'assistant' | 'system' | 'tool';
+
 export interface Message {
-	role: 'user' | 'assistant' | 'system';
+	role: Role;
 	content: string;
 }
 
 export interface GenerateOptions {
 	messages: Message[];
-	model?: string;
-	temperature?: number;
-	max_tokens?: number;
 }
 
-export interface Choice {
+interface ChoiceNonStream {
 	index: number;
-	delta?: {
-		content?: string;
-	};
-	message?: Message;
+	message: Message;
+	logprobs: boolean | null;
+	finish_reason: string;
+}
+
+interface ChoiceStream {
+	index: number;
+	delta: Delta;
+	logprobs: boolean | null;
+	finish_reason: string;
+}
+
+interface Delta {
+	role?: Role;
+	content?: string;
 }
 
 export interface Usage {
@@ -34,22 +44,22 @@ export interface GenerateNonStreamResponse {
 		object: string;
 		created: number;
 		model: string;
-		choices: Choice[];
+		choices: ChoiceNonStream[];
 		usage: Usage;
 		system_fingerprint: string | null;
 	};
 }
 
+export type GenerateStreamResponse = Stream<GenerateStreamChunk>;
+
 export interface GenerateStreamChunk {
 	id: string;
 	object: string;
 	created: number;
 	model: string;
-	choices: Choice[];
+	choices: ChoiceStream[];
 }
 
-export type GenerateStreamResponse = Stream<GenerateStreamChunk>;
-
 export interface PipeOptions {
 	apiKey: string;
 	baseUrl?: string;