👌 IMPROVE: SDK syntax (#87)

msaaddev · web-flow · commit 5439253b034f · 2025-02-28T20:41:21.000+01:00
diff --git a/README.md b/README.md
@@ -32,7 +32,7 @@ yarn add langbase
 
 ### Usage
 
-You can [`langbase.pipe.run()`](https://langbase.com/docs/sdk/pipe/run) to generate or stream from a Pipe.
+You can [`langbase.pipes.run()`](https://langbase.com/docs/sdk/pipe/run) to generate or stream from a Pipe.
 
 Check our [SDK documentation](https://langbase.com/docs/sdk) for more details.
 
@@ -60,9 +60,9 @@ LANGBASE_API_KEY="your-api-key"
 
 ---
 
-### Generate text [`langbase.pipe.run()`](https://langbase.com/docs/sdk/pipe/run)
+### Generate text [`langbase.pipes.run()`](https://langbase.com/docs/sdk/pipe/run)
 
-Set the `stream` to `false`. For more, check the API reference of [`langbase.pipe.run()`](https://langbase.com/docs/langbase-sdk/generate-text)
+Set the `stream` to `false`. For more, check the API reference of [`langbase.pipes.run()`](https://langbase.com/docs/langbase-sdk/generate-text)
 
 ```ts
 import 'dotenv/config';
@@ -76,7 +76,7 @@ const langbase = new Langbase({
 
 async function main() {
     // 2. Run the pipe with a question.
-    const response = await langbase.pipe.run({
+    const response = await langbase.pipes.run({
         stream: false,
         name: 'summary' // pipe name to run
         messages: [
@@ -96,9 +96,9 @@ main();
 
 ---
 
-### Stream text [`langbase.pipe.run()`](https://langbase.com/docs/sdk/pipe/run)
+### Stream text [`langbase.pipes.run()`](https://langbase.com/docs/sdk/pipe/run)
 
-Set the `stream` to `true`. For more, check the API reference of [`langbase.pipe.run()`](https://langbase.com/docs/langbase-sdk/generate-text)
+Set the `stream` to `true`. For more, check the API reference of [`langbase.pipes.run()`](https://langbase.com/docs/langbase-sdk/generate-text)
 
 ```ts
 import 'dotenv/config';
@@ -114,7 +114,7 @@ async function main() {
     const userMsg = 'Who is an AI Engineer?';
 
     // 2. Run the pipe with a question.
-    const {****stre**am**} = await langbase.pipe.run({
+    const {stream} = await langbase.pipes.run({
         stream: true,
         name: 'summary', // pipe name to run
         messages: [{role: 'user', content: userMsg}],
diff --git a/examples/nextjs/app/langbase/pipe/run-stream/route.ts b/examples/nextjs/app/langbase/pipe/run-stream/route.ts
@@ -10,7 +10,7 @@ export async function POST(req: NextRequest) {
 	});
 
 	// 2. Generate a stream by asking a question
-	const {stream, threadId} = await langbase.pipe.run({
+	const {stream, threadId} = await langbase.pipes.run({
 		messages: options.messages,
 		stream: true,
 		name: 'summary',
diff --git a/examples/nextjs/app/langbase/pipe/run/route.ts b/examples/nextjs/app/langbase/pipe/run/route.ts
@@ -10,7 +10,7 @@ export async function POST(req: NextRequest) {
 	});
 
 	// 2. Generate a stream by asking a question
-	const result = await langbase.pipe.run({
+	const result = await langbase.pipes.run({
 		messages: [{role: 'user', content: prompt}],
 		name: 'summary',
 		stream: false
diff --git a/examples/nodejs/agents/index.js b/examples/nodejs/agents/index.js
@@ -6,7 +6,7 @@ export default async function Route(request, env) {
 		apiKey: 'API_KEY',
 	});
 
-	const pipes = await langbase.pipe.list();
+	const pipes = await langbase.pipes.list();
 
 	// User code will be injected here
 	return new Response(JSON.stringify(pipes), {status: 200});
diff --git a/examples/nodejs/agents/index.ts b/examples/nodejs/agents/index.ts
@@ -6,7 +6,7 @@ export default async function Route(request, env) {
 		apiKey: 'API_KEY',
 	});
 
-	const pipes = await langbase.pipe.list();
+	const pipes = await langbase.pipes.list();
 
 	// User code will be injected here
 	return new Response(JSON.stringify(pipes), {status: 200});
diff --git a/examples/nodejs/agents/summarize.ts b/examples/nodejs/agents/summarize.ts
@@ -6,7 +6,7 @@ export default async function Route(request, env) {
 		apiKey: 'API_KEY',
 	});
 
-	const pipes = await langbase.pipe.list();
+	const pipes = await langbase.pipes.list();
 
 	// User code will be injected here
 	return new Response(JSON.stringify(pipes), {status: 200});
diff --git a/examples/nodejs/examples/memory/memory.create.ts b/examples/nodejs/examples/memory/memory.create.ts
@@ -6,7 +6,7 @@ const langbase = new Langbase({
 });
 
 async function main() {
-	const response = await langbase.memory.create({
+	const response = await langbase.memories.create({
 		name: 'memory-sdk',
 		embedding_model: 'cohere:embed-multilingual-v3.0'
 	});
diff --git a/examples/nodejs/examples/memory/memory.delete.ts b/examples/nodejs/examples/memory/memory.delete.ts
@@ -6,7 +6,7 @@ const langbase = new Langbase({
 });
 
 async function main() {
-	const response = await langbase.memory.delete({
+	const response = await langbase.memories.delete({
 		name: 'memory-sdk',
 	});
 
diff --git a/examples/nodejs/examples/memory/memory.docs.delete.ts b/examples/nodejs/examples/memory/memory.docs.delete.ts
@@ -6,7 +6,7 @@ const langbase = new Langbase({
 });
 
 async function main() {
-	const response = await langbase.memory.documents.delete({
+	const response = await langbase.memories.documents.delete({
 		memoryName: 'memory-sdk',
 		documentName: 'readme.md',
 	});
diff --git a/examples/nodejs/examples/memory/memory.docs.list.ts b/examples/nodejs/examples/memory/memory.docs.list.ts
@@ -6,7 +6,7 @@ const langbase = new Langbase({
 });
 
 async function main() {
-	const response = await langbase.memory.documents.list({
+	const response = await langbase.memories.documents.list({
 		memoryName: 'memory-sdk',
 	});
 
diff --git a/examples/nodejs/examples/memory/memory.docs.retry-embed.ts b/examples/nodejs/examples/memory/memory.docs.retry-embed.ts
@@ -6,7 +6,7 @@ const langbase = new Langbase({
 });
 
 async function main() {
-	const response = await langbase.memory.documents.embedding.retry({
+	const response = await langbase.memories.documents.embeddings.retry({
 		memoryName: 'memory-sdk',
 		documentName: 'memory.upload.doc.ts',
 	});
diff --git a/examples/nodejs/examples/memory/memory.docs.upload.ts b/examples/nodejs/examples/memory/memory.docs.upload.ts
@@ -15,7 +15,7 @@ async function main() {
 		'memory.docs.upload.ts',
 	);
 
-	const response = await langbase.memory.documents.upload({
+	const response = await langbase.memories.documents.upload({
 		document: fs.readFileSync(src),
 		memoryName: 'memory-sdk',
 		documentName: 'memory.docs.upload.ts',
diff --git a/examples/nodejs/examples/memory/memory.list.ts b/examples/nodejs/examples/memory/memory.list.ts
@@ -6,7 +6,7 @@ const langbase = new Langbase({
 });
 
 async function main() {
-	const response = await langbase.memory.list();
+	const response = await langbase.memories.list();
 	console.log(response);
 }
 
diff --git a/examples/nodejs/examples/memory/memory.retrieve.ts b/examples/nodejs/examples/memory/memory.retrieve.ts
@@ -6,7 +6,7 @@ const langbase = new Langbase({
 });
 
 async function main() {
-	const response = await langbase.memory.retrieve({
+	const response = await langbase.memories.retrieve({
 		memory: [
 			{
 				name: 'langbase-docs',
diff --git a/examples/nodejs/examples/pipes/multi-agent.ts b/examples/nodejs/examples/pipes/multi-agent.ts
@@ -12,7 +12,7 @@ const langbase = new Langbase({
 async function main() {
   // First agent: Summarize text
   const summarizeAgent = async (text: string) => {
-    const response = await langbase.pipe.run({
+    const response = await langbase.pipes.run({
       stream: false,
       name: "summarize",
       messages: [
@@ -31,7 +31,7 @@ async function main() {
 
   // Second agent: Generate questions
   const questionsAgent = async (summary: string) => {
-    const response = await langbase.pipe.run({
+    const response = await langbase.pipes.run({
       stream: false,
       name: "generate-questions",
       messages: [
diff --git a/examples/nodejs/examples/pipes/pipe.create.ts b/examples/nodejs/examples/pipes/pipe.create.ts
@@ -6,7 +6,7 @@ const langbase = new Langbase({
 });
 
 async function main() {
-	const response = await langbase.pipe.create({
+	const response = await langbase.pipes.create({
 		name: 'summary-pipe2',
 		status: 'private',
 	});
diff --git a/examples/nodejs/examples/pipes/pipe.list.ts b/examples/nodejs/examples/pipes/pipe.list.ts
@@ -6,7 +6,7 @@ const langbase = new Langbase({
 });
 
 async function main() {
-	const response = await langbase.pipe.list();
+	const response = await langbase.pipes.list();
 	console.log(response);
 }
 
diff --git a/examples/nodejs/examples/pipes/pipe.run.chat.ts b/examples/nodejs/examples/pipes/pipe.run.chat.ts
@@ -7,7 +7,7 @@ const langbase = new Langbase({
 
 async function main() {
 	// Message 1: Tell something to the LLM.
-	const response1 = await langbase.pipe.run({
+	const response1 = await langbase.pipes.run({
 		name: 'summary',
 		messages: [{role: 'user', content: 'My company is called Langbase'}],
 	});
@@ -17,7 +17,7 @@ async function main() {
 	// Message 2: Ask something about the first message.
 	// Continue the conversation in the same thread by sending
 	// `threadId` from the second message onwards.
-	const response2 = await langbase.pipe.run({
+	const response2 = await langbase.pipes.run({
 		name: 'summary',
 		threadId: response1.threadId!,
 		messages: [{role: 'user', content: 'Tell me the name of my company?'}],
diff --git a/examples/nodejs/examples/pipes/pipe.run.pipe.key.ts b/examples/nodejs/examples/pipes/pipe.run.pipe.key.ts
@@ -9,7 +9,7 @@ async function main() {
 	const userMsg = 'Who is an AI Engineer?';
 
 	// Get readable stream
-	const {stream, threadId, rawResponse} = await langbase.pipe.run({
+	const {stream, threadId, rawResponse} = await langbase.pipes.run({
 		messages: [{role: 'user', content: userMsg}],
 		stream: true,
 		rawResponse: true,
diff --git a/examples/nodejs/examples/pipes/pipe.run.stream.chat.ts b/examples/nodejs/examples/pipes/pipe.run.stream.chat.ts
@@ -6,7 +6,7 @@ const langbase = new Langbase({
 });
 
 // Message 1: Tell something to the LLM.
-const response1 = await langbase.pipe.run({
+const response1 = await langbase.pipes.run({
 	name: 'summary',
 	stream: true,
 	messages: [{role: 'user', content: 'My company is called Langbase'}],
@@ -21,7 +21,7 @@ runner1.on('content', content => {
 // Message 2: Ask something about the first message.
 // Continue the conversation in the same thread by sending
 // `threadId` from the second message onwards.
-const response2 = await langbase.pipe.run({
+const response2 = await langbase.pipes.run({
 	name: 'summary',
 	stream: true,
 	threadId: response1.threadId!,
diff --git a/examples/nodejs/examples/pipes/pipe.run.stream.llmkey.ts b/examples/nodejs/examples/pipes/pipe.run.stream.llmkey.ts
@@ -9,7 +9,7 @@ async function main() {
 	const userMsg = 'Who is an AI Engineer?';
 
 	// Get readable stream
-	const {stream, threadId, rawResponse} = await langbase.pipe.run({
+	const {stream, threadId, rawResponse} = await langbase.pipes.run({
 		messages: [{role: 'user', content: userMsg}],
 		stream: true,
 		rawResponse: true,
diff --git a/examples/nodejs/examples/pipes/pipe.run.stream.ts b/examples/nodejs/examples/pipes/pipe.run.stream.ts
@@ -9,7 +9,7 @@ async function main() {
 	const userMsg = 'Who is an AI Engineer?';
 
 	// Get readable stream
-	const {stream, threadId, rawResponse} = await langbase.pipe.run({
+	const {stream, threadId, rawResponse} = await langbase.pipes.run({
 		messages: [{role: 'user', content: userMsg}],
 		stream: true,
 		rawResponse: true,
diff --git a/examples/nodejs/examples/pipes/pipe.run.ts b/examples/nodejs/examples/pipes/pipe.run.ts
@@ -8,7 +8,7 @@ const langbase = new Langbase({
 async function main() {
 	const userMsg = 'Who is an AI Engineer?';
 
-	const response = await langbase.pipe.run({
+	const response = await langbase.pipes.run({
 		messages: [
 			{
 				role: 'user',
diff --git a/examples/nodejs/examples/pipes/pipe.tool.stream.ts b/examples/nodejs/examples/pipes/pipe.tool.stream.ts
@@ -8,7 +8,7 @@ const langbase = new Langbase({
 async function main() {
 	const userMsg = "What's the weather in SF";
 
-	const response = await langbase.pipe.run({
+	const response = await langbase.pipes.run({
 		messages: [
 			{
 				role: 'user',
diff --git a/examples/nodejs/examples/pipes/pipe.tool.ts b/examples/nodejs/examples/pipes/pipe.tool.ts
@@ -8,7 +8,7 @@ const langbase = new Langbase({
 async function main() {
 	const userMsg = "What's the weather in SF";
 
-	const response = await langbase.pipe.run({
+	const response = await langbase.pipes.run({
 		messages: [
 			{
 				role: 'user',
diff --git a/examples/nodejs/examples/pipes/pipe.update.ts b/examples/nodejs/examples/pipes/pipe.update.ts
@@ -6,7 +6,7 @@ const langbase = new Langbase({
 });
 
 async function main() {
-	const response = await langbase.pipe.update({
+	const response = await langbase.pipes.update({
 		name: 'summary-pipe',
 		description: 'This is a pipe updated with the SDK',
 		model: 'google:gemini-1.5-flash-8b-latest',
diff --git a/examples/nodejs/examples/threads/thread.delete.ts b/examples/nodejs/examples/threads/thread.delete.ts
diff --git a/examples/nodejs/examples/threads/thread.messages.add.ts b/examples/nodejs/examples/threads/thread.messages.add.ts
diff --git a/examples/nodejs/examples/threads/thread.messages.list.ts b/examples/nodejs/examples/threads/thread.messages.list.ts
diff --git a/examples/nodejs/examples/tools/crawl.ts b/examples/nodejs/examples/tools/crawl.ts
@@ -13,10 +13,10 @@ const langbase = new Langbase({
  * @link https://spider.cloud/docs/quickstart
  */
 async function main() {
-	const results = await langbase.tool.crawl({
+	const results = await langbase.tools.crawl({
 		url: ['https://langbase.com', 'https://langbase.com/about'],
-		max_pages: 1,
-		api_key: process.env.CRAWL_KEY,
+		maxPages: 1,
+		apiKey: process.env.CRAWL_KEY,
 	});
 
 	console.log(results);
diff --git a/examples/nodejs/examples/tools/web-search.ts b/examples/nodejs/examples/tools/web-search.ts
@@ -7,7 +7,7 @@ const langbase = new Langbase({
 });
 
 async function main() {
-	const results = await langbase.tool.webSearch({
+	const results = await langbase.tools.webSearch({
 		service: 'exa',
 		totalResults: 2,
 		query: 'What is Langbase?',
diff --git a/examples/nodejs/package.json b/examples/nodejs/package.json
diff --git a/packages/langbase/src/langbase/langbase.ts b/packages/langbase/src/langbase/langbase.ts
diff --git a/packages/langbase/src/pipes/pipes.ts b/packages/langbase/src/pipes/pipes.ts
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
