promptql-go-sdk

PromptQL Go SDK

A Go SDK for interacting with the PromptQL APIs.

Installation

go get github.com/hasura/promptql-go-sdk

Get started

Prerequisite

• If you are new to PromptQL, follow the quickstart guide of PromptQL to create a project.
• Create a PromptQL API Key in the project settings tab on https://console.hasura.io.
• Your Project API endpoint and security headers.

Use PromptQL SDK

Create the PromptQL client with required configurations:

import (
    "github.com/hasura/promptql-go-sdk/promptql"
)

func main() {
    client, err := promptql.NewClient("<promptql-api-key>", &promptql.ClientConfig{
        DdnBaseURL: "https://your-ddn-project",
        DdnHeaders: map[string]string{
            // authorization headers to your ddn project
            // "Authorization": "access-token",
        },
    })

    if err != nil {
        log.Fatalf("failed to create client: %s", err)
    }

    result, err := client.Query(
        context.Background(), 
        promptql.NewQueryRequestMessage("what can you do?"),
    )
    if err != nil {
        panic(err)
    }

    if len(result.AssistantActions) > 0 {
        if msg := result.AssistantActions[0].Message.Get(); msg != nil {
            log.Println(msg)
        }
    }

    // I can help you analyze data...
}

Reference

Natural Language

The Natural Language Query API allows you to interact with PromptQL directly, sending messages and receiving responses.

Non-Streaming

func (c *Client) Query(ctx context.Context, body api.QueryRequest) (*api.QueryResponse, error)

Streaming

The streaming response sends chunks of data in Server-Sent Events (SSE) format. If the callback isn't set the client returns the raw response and you need to handle the response manually.

func (c *Client) QueryStream(ctx context.Context, body api.QueryRequest, callback QueryStreamCallback) error

The library supports a QueryChunks struct to help you combine chunks into a query response.

Example:

chunks := promptql.NewQueryChunks()

err := client.QueryStream(
    context.Background(), 
    promptql.NewQueryRequestMessage("get list customers"), 
    func(chunk api.QueryResponseChunk) error {
        log.Println(chunk)

        if err := chunks.Add(chunk); err != nil {
            log.Println("failed to add chunk:", err)
        }
        
        return nil
    },
)

if err != nil {
    panic(err)
}

if chunks.IsError() {
    log.Println("error": chunks.GetErrorChunk().Error)
} else if len(result.AssistantActions) > 0 {
    if msg := result.AssistantActions[0].Message.Get(); msg != nil {
        log.Println(msg)
    }
}

Execute Program

Execute a PromptQL program with your data.

func (c *Client) ExecuteProgram(ctx context.Context, body api.ExecuteRequest) (*api.PromptQlExecutionResult, error)

Development

Generate codes

Use the following command to update Go types of PromptQL APIs from the OpenAPI document.

make openapi-gen