@hasura/promptql 2.0.0-alpha.1 → 2.0.0-alpha.10

package/README.md

@@ -1,6 +1,9 @@
 # PromptQL TypeScript SDK
 
-A TypeScript SDK for interacting with the [PromptQL API](https://promptql.hasura.io) by Hasura. PromptQL enables natural language querying of your data through an AI-powered interface.
+The PromptQL TypeScript SDK is a general-purpose SDK that interacts with the [PromptQL API](https://promptql.hasura.io) by Hasura. PromptQL enables natural language querying of your data through an AI-powered interface.
+
+> [!NOTE]
+> This SDK supports PromptQL v2. Please install [@hasura/promptql@1.0.0](https://www.npmjs.com/package/@hasura/promptql/v/1.0.0) if you wants to integrate PromptQL v1.
 
 ## Features
 
@@ -21,20 +24,20 @@ A TypeScript SDK for interacting with the [PromptQL API](https://promptql.hasura
 ## Installation
 
 ```bash
-npm install @hasura/promptql
+npm install @hasura/promptql@latest
 ```
 
 Or with your preferred package manager:
 
 ```bash
 # Yarn
-yarn add @hasura/promptql
+yarn add @hasura/promptql@latest
 
 # pnpm
-pnpm add @hasura/promptql
+pnpm add @hasura/promptql@latest
 
 # Bun
-bun add @hasura/promptql
+bun add @hasura/promptql@latest
 ```
 
 ## Quick Start
@@ -63,14 +66,14 @@ const sdk = new PromptQLSdk({
 });
 
 // Start a new thread
-const thread = await sdk.startThread({
+const thread = await sdk.thread.start({
   message: 'What are the top 10 customers by revenue?',
 });
 
 console.log('Thread ID:', thread.thread_id);
 
 // Stream events from the thread
-sdk.streamThreadEventsByThreadId(thread.thread_id).subscribe({
+sdk.thread.streamEvents(thread.thread_id).subscribe({
   next: (events) => {
     events.forEach(event => {
       console.log('Event:', event);
@@ -85,13 +88,13 @@ sdk.streamThreadEventsByThreadId(thread.thread_id).subscribe({
 
 ```typescript
 // Send a follow-up message to an existing thread
-const result = await sdk.sendMessageToThread({
+const result = await sdk.thread.sendMessage({
   threadId: 'existing-thread-id',
   message: 'Now show me their average order value',
 });
 
 // Stream the response
-sdk.streamThreadEventsByThreadId(result.thread_id, result.thread_event_id)
+sdk.streamEvents(result.thread_id, result.thread_event_id)
   .subscribe({
     next: (events) => console.log('New events:', events),
   });
@@ -112,14 +115,14 @@ const sdk = new PromptQLSdk({
 });
 
 // Start a new thread
-const thread = await sdk.startThread({
+const thread = await sdk.thread.start({
   message: 'What are the top 10 customers by revenue?',
 });
 
 console.log('Thread ID:', thread.thread_id);
 
 const events = await lastValueFrom(
-  sdk.streamThreadEventsByThreadId(
+  sdk.thread.streamEvents(
      result.thread_id,
   ),
 );
@@ -142,14 +145,14 @@ const sdk = new PromptQLSdk({
 });
 
 // Start a new thread
-const thread = await sdk.startThread({
+const thread = await sdk.thread.start({
   message: 'What are the top 10 customers by revenue?',
 });
 
 console.log('Thread ID:', thread.thread_id);
 
 // Stream events from the thread
-sdk.streamThreadEventsByThreadId(thread.thread_id)
+sdk.streamEvents(thread.thread_id)
   .pipe(
     pairwise(),
     map(([prev, curr]) => diffThreadEvents(prev, curr)),
@@ -168,7 +171,7 @@ sdk.streamThreadEventsByThreadId(thread.thread_id)
 ### Listing Threads
 
 ```typescript
-const threads = await sdk.getThreads({
+const threads = await sdk.thread.list({
   limit: 20,
   offset: 0,
   order_by: [{ created_at: 'desc' }],
@@ -185,7 +188,7 @@ threads.forEach(thread => {
 ### Get a Specific Thread
 
 ```typescript
-const thread = await sdk.getThreadById('thread-id');
+const thread = await sdk.thread.get('thread-id');
 console.log('Thread:', thread);
 ```
 
@@ -205,7 +208,7 @@ import {
   getUserMessageEvent,
 } from '@hasura/promptql';
 
-sdk.streamThreadEventsByThreadId(threadId).subscribe({
+sdk.thread.streamEvents(threadId).subscribe({
   next: (events) => {
     events.forEach(event => {
       // Check for plan generation start
@@ -288,72 +291,6 @@ interface PromptQLSdkOptions {
 }
 ```
 
-## API Reference
-
-### Class: `PromptQLSdk`
-
-#### Constructor
-
-```typescript
-new PromptQLSdk(options: PromptQLSdkOptions)
-```
-
-#### Methods
-
-##### `getThreads(variables)`
-
-List threads with optional filtering and pagination.
-
-```typescript
-getThreads(variables: GetThreadsQueryVariables): Promise<ThreadFragment[]>
-```
-
-##### `getThreadById(threadId)`
-
-Get a specific thread by ID.
-
-```typescript
-getThreadById(threadId: string): Promise<ThreadFragment | null | undefined>
-```
-
-##### `startThread(variables)`
-
-Start a new thread with a message.
-
-```typescript
-startThread(variables: StartThreadArguments): Promise<StartThreadOutput>
-```
-
-##### `sendMessageToThread(variables)`
-
-Send a message to an existing thread.
-
-```typescript
-sendMessageToThread(variables: SendMessageToThreadArguments): Promise<SendMessageToThreadOutput>
-```
-
-##### `subscribeThreadEventsByThreadId(threadId, threadEventId?)`
-
-Subscribe to events from a thread. Continues indefinitely.
-
-```typescript
-subscribeThreadEventsByThreadId(
-  threadId: string,
-  threadEventId?: string | null
-): Observable<ThreadEvent[]>
-```
-
-##### `streamThreadEventsByThreadId(threadId, threadEventId?)`
-
-Stream events from a thread. Automatically completes when interaction finishes.
-
-```typescript
-streamThreadEventsByThreadId(
-  threadId: string,
-  threadEventId?: string | null
-): Observable<ThreadEvent[]>
-```
-
 ## License
 
 Apache License 2.0 - see [LICENSE](LICENSE) file for details.

package/biome.json

@@ -2,7 +2,14 @@
 	"$schema": "https://biomejs.dev/schemas/2.3.13/schema.json",
 	"root": false,
 	"files": {
-		"includes": ["**/*.ts", "**/*.gql", "!src/generated/*", "!dist/**/*"]
+		"includes": [
+			"**/*.ts",
+			"**/*.gql",
+			"!src/generated/*",
+			"!dist/**/*"
+		]
 	},
-	"extends": ["@hasura/biome-config/base"]
-}
+	"extends": [
+		"../biome-config/base.json"
+	]
+}