promptgun 0.9.0 → 0.10.1

package/README.md

@@ -18,22 +18,20 @@ for await (const chunk of stream) {
 
 ### Data output - single
 ```typescript
-const count /* type: boolean */ = await ai
+const count /* type: number */ = await ai
   .chat('How many countries are in the EU')
-  .to(o => o.number())
+  .toNumber()
 ```
 Promptgun will both tell the LLM what shape its output data should be, parse that data to JS types and –if you use Typescript– return the matching Typescript type.
 
 You can do this for types of any complexity:
 ```typescript
-const restaurants /* type: {name: string, address: string}[] */ = await ai
+const restaurants /* type: {name: string, address?: string}[] */ = await ai
   .chat('Give 5 top restaurants in London')
-  .to(o => o
-    .array(e => e
-      .object(o => o
-        .hasString('name')
-        .hasString('address')
-      )
+  .toArray(o => o
+    .object(o => o
+      .hasString('name')
+      .canHaveString('address')
     )
   )
 ```
@@ -41,12 +39,10 @@ const restaurants /* type: {name: string, address: string}[] */ = await ai
 You can also put instructions to the LLM in your type spec:
 ```typescript
 const restaurants /* type: {name: string, address: string}[] */ = await ai
-  .chat('Give 5 top restaurants in London')
-  .to(o => o
-    .object(o => o
-      .hasString('name')
-      .hasString('description', 'A 50 character description')
-    )
+  .chat('Give the top restaurant in London')
+  .toObject(o => o
+    .hasString('name')
+    .hasString('description', 'A 50 character description')
   )
 ```
 
@@ -72,12 +68,10 @@ And iterating (not awaiting) any streamed json element simply gives the stream o
 ```typescript
 const parsedPartialJsonStream = ai
   .chat('What are the top 5 restaurants in New York City?')
-  .json(d => d
-    .canBeArray(el => el
-      .canBeObject(obj => obj
-        .hasString('name')
-        .hasString('address')
-      )
+  .toArray(o => o
+    .object(o => o
+      .hasString('name')
+      .hasString('address')
     )
   )
 for await (const parsedPartialJson of parsedPartialJsonStream) {

package/build/index.d.ts

@@ -863,7 +863,12 @@ export declare class BasicPrompt<PSArgs> implements AsyncGenerator<string>, Prom
     finally(onfinally?: (() => void) | null | undefined): Promise<string>;
     get [Symbol.toStringTag](): string;
     to<Json extends AnyJson = AnyJson>(type: (value: EmptyTypeSpec<unknown>) => TypeSpec<Json>): JsonPrompt<PSArgs, Json>;
-    toJson(): JsonPrompt<PSArgs, AnyJson>;
+    toBoolean(): JsonPrompt<PSArgs, boolean>;
+    toString(): JsonPrompt<PSArgs, string>;
+    toNumber(): JsonPrompt<PSArgs, number>;
+    toObject<T_obj extends {}>(properties: (arg: TypeMemberSpec<{}>) => TypeMemberSpec<T_obj>): JsonPrompt<PSArgs, T_obj>;
+    toArray<T_arr extends AnyJson>(element: (arg: EmptyTypeSpec<unknown>) => TypeSpec<T_arr>): JsonPrompt<PSArgs, T_arr[]>;
+    toAny(): JsonPrompt<PSArgs, AnyJson>;
     private getResponseAsString;
 }
 
@@ -908,6 +913,7 @@ export declare class EmptyTypeSpec<T> extends TypeSpec<T> {
     constant<Value extends (string | number | boolean)>(value: Value, ...otherValues: Value[]): FullPropTypeSpec<Combine<T, Value>>;
     null(): FullTypeSpec<Combine<T, null>>;
     undefined(): FullTypeSpec<Combine<T, undefined>>;
+    any(): FullTypeSpec<Combine<T, AnyJson>>;
 }
 
 export declare class FullPropTypeSpec<T> extends PropTypeSpec<T> {