Skip to content

Commit 1a3c9f6

Browse files
ahmadawaisahmadawais
committed
📖 DOC: Lingo and defaults
1 parent 0c045cd commit 1a3c9f6

35 files changed

+310
-193
lines changed

‎apps/baseai.dev/content/docs.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎apps/baseai.dev/content/docs/api-reference/generate-text.mdx

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -196,9 +196,9 @@ The BaseAI core package provides a `generateText()` function that you can use in
196196
```ts {{ title: 'index.ts' }}
197197
import 'dotenv/config';
198198
import {Pipe, generateText} from '@baseai/core';
199-
import buildPipe from './baseai/pipes/agent';
199+
import pipeName from './baseai/pipes/agent';
200200

201-
const pipe = new Pipe(buildPipe());
201+
const pipe = new Pipe(pipeName());
202202

203203
async function main() {
204204
const response = await generateText({
@@ -215,7 +215,7 @@ The BaseAI core package provides a `generateText()` function that you can use in
215215
```ts {{ title: './baseai/pipes/agent.ts' }}
216216
import { PipeI } from '@baseai/core';
217217

218-
const buildPipe = (): PipeI => ({
218+
const pipeName = (): PipeI => ({
219219
apiKey: process.env.LANGBASE_API_KEY!, // Replace with your API key https://langbase.com/docs/api-reference/api-keys
220220
name: 'summarizer',
221221
description: 'A pipe that summarizes content and make it less wordy',
@@ -244,7 +244,7 @@ The BaseAI core package provides a `generateText()` function that you can use in
244244
tools: []
245245
});
246246

247-
export default buildPipe;
247+
export default pipeName;
248248
```
249249

250250
</CodeGroup>
@@ -256,9 +256,9 @@ The BaseAI core package provides a `generateText()` function that you can use in
256256
```ts {{ title: 'index.ts' }}
257257
import 'dotenv/config';
258258
import {Pipe, generateText} from '@baseai/core';
259-
import buildPipe from './baseai/pipes/agent';
259+
import pipeName from './baseai/pipes/agent';
260260

261-
const pipe = new Pipe(buildPipe());
261+
const pipe = new Pipe(pipeName());
262262

263263
async function main() {
264264
const response = await generateText({
@@ -276,7 +276,7 @@ The BaseAI core package provides a `generateText()` function that you can use in
276276
```ts {{ title: './baseai/pipes/agent.ts' }}
277277
import { PipeI } from '@baseai/core';
278278

279-
const buildPipe = (): PipeI => ({
279+
const pipeName = (): PipeI => ({
280280
apiKey: process.env.LANGBASE_API_KEY!, // Replace with your API key https://langbase.com/docs/api-reference/api-keys
281281
name: 'summarizer',
282282
description: 'A pipe that summarizes content and make it less wordy',
@@ -305,7 +305,7 @@ The BaseAI core package provides a `generateText()` function that you can use in
305305
tools: []
306306
});
307307

308-
export default buildPipe;
308+
export default pipeName;
309309
```
310310
</CodeGroup>
311311

@@ -316,9 +316,9 @@ The BaseAI core package provides a `generateText()` function that you can use in
316316
```ts {{ title: 'index.ts' }}
317317
import 'dotenv/config';
318318
import {Pipe, generateText} from '@baseai/core';
319-
import buildPipe from './baseai/pipes/agent';
319+
import pipeName from './baseai/pipes/agent';
320320

321-
const pipe = new Pipe(buildPipe());
321+
const pipe = new Pipe(pipeName());
322322

323323
async function main() {
324324
// Message 1: Tell something to the LLM.
@@ -350,7 +350,7 @@ The BaseAI core package provides a `generateText()` function that you can use in
350350
```ts {{ title: './baseai/pipes/agent.ts' }}
351351
import { PipeI } from '@baseai/core';
352352

353-
const buildPipe = (): PipeI => ({
353+
const pipeName = (): PipeI => ({
354354
apiKey: process.env.LANGBASE_API_KEY!, // Replace with your API key https://langbase.com/docs/api-reference/api-keys
355355
name: 'summarizer',
356356
description: 'A pipe that summarizes content and make it less wordy',
@@ -379,7 +379,7 @@ The BaseAI core package provides a `generateText()` function that you can use in
379379
tools: []
380380
});
381381

382-
export default buildPipe;
382+
export default pipeName;
383383
```
384384
</CodeGroup>
385385
</Col>

‎apps/baseai.dev/content/docs/api-reference/get-runner.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -139,9 +139,9 @@ The BaseAI core package provides a `getRunner()` function that you can use in yo
139139
```ts {{ title: 'index.ts' }}
140140
import 'dotenv/config';
141141
import {Pipe, streamText, getRunner} from '@baseai/core';
142-
import buildPipe from './baseai/pipes/agent';
142+
import pipeName from './baseai/pipes/agent';
143143

144-
const pipe = new Pipe(buildPipe());
144+
const pipe = new Pipe(pipeName());
145145

146146
async function main() {
147147
const {stream} = await streamText({
@@ -177,7 +177,7 @@ The BaseAI core package provides a `getRunner()` function that you can use in yo
177177
```ts {{ title: './baseai/pipes/agent.ts' }}
178178
import { PipeI } from '@baseai/core';
179179

180-
const buildPipe = (): PipeI => ({
180+
const pipeName = (): PipeI => ({
181181
apiKey: process.env.LANGBASE_API_KEY!, // Replace with your API key https://langbase.com/docs/api-reference/api-keys
182182
name: 'summarizer',
183183
description: 'A pipe that summarizes content and make it less wordy',
@@ -206,7 +206,7 @@ The BaseAI core package provides a `getRunner()` function that you can use in yo
206206
tools: []
207207
});
208208

209-
export default buildPipe;
209+
export default pipeName;
210210
```
211211

212212
</CodeGroup>

‎apps/baseai.dev/content/docs/api-reference/pipe-run.mdx

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ The BaseAI core package provides a `pipe.run()` function that you can use in you
4242
```ts {{ title: './baseai/pipes/agent.ts' }}
4343
import { PipeI } from '@baseai/core';
4444

45-
const buildPipe = (): PipeI => ({
45+
const pipeName = (): PipeI => ({
4646
apiKey: process.env.LANGBASE_API_KEY!, // Replace with your API key https://langbase.com/docs/api-reference/api-keys
4747
name: 'summarizer',
4848
description: 'A pipe that summarizes content and make it less wordy',
@@ -71,7 +71,7 @@ The BaseAI core package provides a `pipe.run()` function that you can use in you
7171
tools: []
7272
});
7373

74-
export default buildPipe;
74+
export default pipeName;
7575
```
7676
</CodeGroup>
7777

@@ -241,9 +241,9 @@ The BaseAI core package provides a `pipe.run()` function that you can use in you
241241

242242
```ts {{ title: 'index.ts' }}
243243
import {Pipe} from '@baseai/core';
244-
import buildPipe from '../baseai/pipes/agent';
244+
import pipeName from '../baseai/pipes/agent';
245245

246-
const pipe = new Pipe(buildPipe());
246+
const pipe = new Pipe(pipeName());
247247

248248
async function main() {
249249
const userMsg = 'Who is an AI Engineer?';
@@ -265,7 +265,7 @@ The BaseAI core package provides a `pipe.run()` function that you can use in you
265265
```ts {{ title: './baseai/pipes/agent.ts' }}
266266
import { PipeI } from '@baseai/core';
267267

268-
const buildPipe = (): PipeI => ({
268+
const pipeName = (): PipeI => ({
269269
apiKey: process.env.LANGBASE_API_KEY!, // Replace with your API key https://langbase.com/docs/api-reference/api-keys
270270
name: 'summarizer',
271271
description: 'A pipe that summarizes content and make it less wordy',
@@ -294,7 +294,7 @@ The BaseAI core package provides a `pipe.run()` function that you can use in you
294294
tools: []
295295
});
296296

297-
export default buildPipe;
297+
export default pipeName;
298298
```
299299

300300
</CodeGroup>
@@ -305,9 +305,9 @@ The BaseAI core package provides a `pipe.run()` function that you can use in you
305305

306306
```ts {{ title: 'index.ts' }}
307307
import {getRunner, Pipe} from '@baseai/core';
308-
import buildPipe from '../baseai/pipes/agent';
308+
import pipeName from '../baseai/pipes/agent';
309309

310-
const pipe = new Pipe(buildPipe());
310+
const pipe = new Pipe(pipeName());
311311

312312
async function main() {
313313
const userMsg = 'Who is an AI Engineer?';
@@ -344,7 +344,7 @@ The BaseAI core package provides a `pipe.run()` function that you can use in you
344344
```ts {{ title: './baseai/pipes/agent.ts' }}
345345
import { PipeI } from '@baseai/core';
346346

347-
const buildPipe = (): PipeI => ({
347+
const pipeName = (): PipeI => ({
348348
apiKey: process.env.LANGBASE_API_KEY!, // Replace with your API key https://langbase.com/docs/api-reference/api-keys
349349
name: 'summarizer',
350350
description: 'A pipe that summarizes content and make it less wordy',
@@ -373,7 +373,7 @@ The BaseAI core package provides a `pipe.run()` function that you can use in you
373373
tools: []
374374
});
375375

376-
export default buildPipe;
376+
export default pipeName;
377377
```
378378
</CodeGroup>
379379

@@ -384,9 +384,9 @@ The BaseAI core package provides a `pipe.run()` function that you can use in you
384384
```ts {{ title: 'index.ts' }}
385385
import 'dotenv/config';
386386
import {Pipe} from '@baseai/core';
387-
import buildPipe from './baseai/pipes/agent';
387+
import pipeName from './baseai/pipes/agent';
388388

389-
const pipe = new Pipe(buildPipe());
389+
const pipe = new Pipe(pipeName());
390390

391391
async function main() {
392392
const response = await pipe.run({
@@ -404,7 +404,7 @@ The BaseAI core package provides a `pipe.run()` function that you can use in you
404404
```ts {{ title: './baseai/pipes/agent.ts' }}
405405
import { PipeI } from '@baseai/core';
406406

407-
const buildPipe = (): PipeI => ({
407+
const pipeName = (): PipeI => ({
408408
apiKey: process.env.LANGBASE_API_KEY!, // Replace with your API key https://langbase.com/docs/api-reference/api-keys
409409
name: 'summarizer',
410410
description: 'A pipe that summarizes content and make it less wordy',
@@ -433,7 +433,7 @@ The BaseAI core package provides a `pipe.run()` function that you can use in you
433433
tools: []
434434
});
435435

436-
export default buildPipe;
436+
export default pipeName;
437437
```
438438
</CodeGroup>
439439

@@ -444,9 +444,9 @@ The BaseAI core package provides a `pipe.run()` function that you can use in you
444444
```ts {{ title: 'index.ts' }}
445445
import 'dotenv/config';
446446
import {Pipe} from '@baseai/core';
447-
import buildPipe from './baseai/pipes/agent';
447+
import pipeName from './baseai/pipes/agent';
448448

449-
const pipe = new Pipe(buildPipe());
449+
const pipe = new Pipe(pipeName());
450450

451451
async function main() {
452452
// Message 1: Tell something to the LLM.
@@ -478,7 +478,7 @@ The BaseAI core package provides a `pipe.run()` function that you can use in you
478478
```ts {{ title: './baseai/pipes/agent.ts' }}
479479
import { PipeI } from '@baseai/core';
480480

481-
const buildPipe = (): PipeI => ({
481+
const pipeName = (): PipeI => ({
482482
apiKey: process.env.LANGBASE_API_KEY!, // Replace with your API key https://langbase.com/docs/api-reference/api-keys
483483
name: 'summarizer',
484484
description: 'A pipe that summarizes content and make it less wordy',
@@ -507,7 +507,7 @@ The BaseAI core package provides a `pipe.run()` function that you can use in you
507507
tools: []
508508
});
509509

510-
export default buildPipe;
510+
export default pipeName;
511511
```
512512
</CodeGroup>
513513
</Col>

‎apps/baseai.dev/content/docs/api-reference/stream-text.mdx

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -198,9 +198,9 @@ The BaseAI core package provides a `streamText()` function that you can use in y
198198
```ts {{ title: 'index.ts' }}
199199
import 'dotenv/config';
200200
import {Pipe, streamText, getRunner} from '@baseai/core';
201-
import buildPipe from './baseai/pipes/agent';
201+
import pipeName from './baseai/pipes/agent';
202202

203-
const pipe = new Pipe(buildPipe());
203+
const pipe = new Pipe(pipeName());
204204

205205
async function main() {
206206
const {stream} = await streamText({
@@ -236,7 +236,7 @@ The BaseAI core package provides a `streamText()` function that you can use in y
236236
```ts {{ title: './baseai/pipes/agent.ts' }}
237237
import { PipeI } from '@baseai/core';
238238

239-
const buildPipe = (): PipeI => ({
239+
const pipeName = (): PipeI => ({
240240
apiKey: process.env.LANGBASE_API_KEY!, // Replace with your API key https://langbase.com/docs/api-reference/api-keys
241241
name: 'summarizer',
242242
description: 'A pipe that summarizes content and make it less wordy',
@@ -265,7 +265,7 @@ The BaseAI core package provides a `streamText()` function that you can use in y
265265
tools: []
266266
});
267267

268-
export default buildPipe;
268+
export default pipeName;
269269
```
270270

271271
</CodeGroup>
@@ -277,9 +277,9 @@ The BaseAI core package provides a `streamText()` function that you can use in y
277277
```ts {{ title: 'index.ts' }}
278278
import 'dotenv/config';
279279
import {Pipe, streamText, getRunner} from '@baseai/core';
280-
import buildPipe from './baseai/pipes/agent';
280+
import pipeName from './baseai/pipes/agent';
281281

282-
const pipe = new Pipe(buildPipe());
282+
const pipe = new Pipe(pipeName());
283283

284284
async function main() {
285285
const {stream} = await streamText({
@@ -315,7 +315,7 @@ The BaseAI core package provides a `streamText()` function that you can use in y
315315
```ts {{ title: './baseai/pipes/agent.ts' }}
316316
import { PipeI } from '@baseai/core';
317317

318-
const buildPipe = (): PipeI => ({
318+
const pipeName = (): PipeI => ({
319319
apiKey: process.env.LANGBASE_API_KEY!, // Replace with your API key https://langbase.com/docs/api-reference/api-keys
320320
name: 'summarizer',
321321
description: 'A pipe that summarizes content and make it less wordy',
@@ -344,7 +344,7 @@ The BaseAI core package provides a `streamText()` function that you can use in y
344344
tools: []
345345
});
346346

347-
export default buildPipe;
347+
export default pipeName;
348348
```
349349
</CodeGroup>
350350

@@ -355,9 +355,9 @@ The BaseAI core package provides a `streamText()` function that you can use in y
355355
```ts {{ title: 'index.ts' }}
356356
import 'dotenv/config';
357357
import {Pipe, streamText, getRunner} from '@baseai/core';
358-
import buildPipe from './baseai/pipes/agent';
358+
import pipeName from './baseai/pipes/agent';
359359

360-
const pipe = new Pipe(buildPipe());
360+
const pipe = new Pipe(pipeName());
361361

362362
async function main() {
363363
// Message 1: Tell something to the LLM.
@@ -425,7 +425,7 @@ The BaseAI core package provides a `streamText()` function that you can use in y
425425
```ts {{ title: './baseai/pipes/agent.ts' }}
426426
import { PipeI } from '@baseai/core';
427427

428-
const buildPipe = (): PipeI => ({
428+
const pipeName = (): PipeI => ({
429429
apiKey: process.env.LANGBASE_API_KEY!, // Replace with your API key https://langbase.com/docs/api-reference/api-keys
430430
name: 'summarizer',
431431
description: 'A pipe that summarizes content and make it less wordy',
@@ -454,7 +454,7 @@ The BaseAI core package provides a `streamText()` function that you can use in y
454454
tools: []
455455
});
456456

457-
export default buildPipe;
457+
export default pipeName;
458458
```
459459

460460
</CodeGroup>

‎apps/baseai.dev/content/docs/api-reference/use-pipe.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -468,15 +468,15 @@ The BaseAI core package provides a `usePipe()` hook that you can use in your app
468468
```
469469

470470
```ts {{ title: 'route.ts' }}
471-
import buildPipe from '@/baseai/pipes/agent';
471+
import pipeName from '@/baseai/pipes/agent';
472472
import {Pipe} from '@baseai/core';
473473
import {NextRequest} from 'next/server';
474474

475475
export async function POST(req: NextRequest) {
476476
const runOptions = await req.json();
477477

478478
// 1. Initiate the Pipe.
479-
const pipe = new Pipe(buildPipe());
479+
const pipe = new Pipe(pipeName());
480480

481481
// 2. Run the Pipe.
482482
const {stream, threadId} = await pipe.run(runOptions);
@@ -494,7 +494,7 @@ The BaseAI core package provides a `usePipe()` hook that you can use in your app
494494
```ts {{ title: './baseai/pipes/agent.ts' }}
495495
import { PipeI } from '@baseai/core';
496496

497-
const buildPipe = (): PipeI => ({
497+
const pipeName = (): PipeI => ({
498498
apiKey: process.env.LANGBASE_API_KEY!, // Replace with your API key https://langbase.com/docs/api-reference/api-keys
499499
name: 'summarizer',
500500
description: 'A pipe that summarizes content and make it less wordy',
@@ -523,7 +523,7 @@ The BaseAI core package provides a `usePipe()` hook that you can use in your app
523523
tools: []
524524
});
525525

526-
export default buildPipe;
526+
export default pipeName;
527527
```
528528

529529
</CodeGroup>

0 commit comments

Comments
 (0)