promptgun 0.20.2 → 0.20.3

package/README.md

@@ -1,6 +1,31 @@
 # Promptgun
 
-The simplest, most advanced LLM prompting library.
+The simplest, most advanced LLM prompting and agent library.
+
+```typescript
+const restaurants = ai
+  .chat("Recommend 3 restaurants in Paris perfect for today's weather")
+  .tools(
+    defineTool({
+      name: 'get-weather',
+      parameters: spec => spec.string(),
+      function: async location => {
+        const response = await fetch(`https://api.weather.com/v1/current?location=${location}`)
+        return response.json()
+      }
+    })
+  )
+  .getArray(spec => spec.object(o => o
+    .hasString('name')
+    .hasString('cuisine')
+    .hasString('weatherReason', 'Why this restaurant fits today\'s weather')
+  ))
+
+// Process each restaurant as it streams in
+for await (const restaurant of restaurants) {
+  console.log(`${restaurant.name} (${restaurant.cuisine}): ${restaurant.weatherReason}`)
+}
+```
 
 # How to use
 ### Data output - streamed

package/build/index.d.ts

@@ -1086,7 +1086,7 @@ export declare type DeepPartial<T> = T extends object ? {
 
 export declare function defineTool<T>(config: {
     name: string;
-    description: string;
+    description?: string;
     parameters: (spec: EmptyTypeSpec<unknown>) => TypeSpec<T>;
     function: ToolFunction<T>;
 }): ToolDefinition<T>;
@@ -1485,7 +1485,7 @@ export declare enum TokenType {
 
 export declare type ToolDefinition<T = any> = {
     name: string;
-    description: string;
+    description?: string;
     parameters: TypeSpec<T>;
     function: ToolFunction<T>;
 };