Skip to content

README.md

Latest commit

 

History

History
102 lines (81 loc) · 3.7 KB

README.md

File metadata and controls

102 lines (81 loc) · 3.7 KB
Raw

DocsGPT Go SDK

A Go client for the DocsGPT chat API: the OpenAI-compatible /v1/chat/completions endpoint, with streaming, tool calls, sources and conversation ids. It is the client docsgpt-cli is built on.

go get github.com/arc53/DocsGPT-cli/sdk

The import path ends in /sdk; the package is docsgpt.

import docsgpt "github.com/arc53/DocsGPT-cli/sdk"

client := docsgpt.NewClient("https://gptcloud.arc53.com", apiKey)
resp, err := client.Send(ctx, docsgpt.ChatRequest{
	Messages: []docsgpt.Message{{Role: "user", Content: "What is DocsGPT?"}},
})

apiKey is an agent API key (DocsGPT → Agent settings → API key).

Streaming and tools

Run streams the answer, runs tool calls through your handler and sends the results back until the model is done:

res, err := client.Run(ctx, messages, docsgpt.RunOptions{
	Stream: true,
	Tools:  tools,
	OnDelta: func(d docsgpt.Delta, _ string) { fmt.Print(d.Content) },
	OnToolCall: func(tc docsgpt.ToolCall) string {
		return runTool(tc) // the result the model sees
	},
})
// res.Messages: the history with the new turns
// res.ConversationID: pass it in RunOptions to continue the conversation
// res.Sources, res.Model, res.Usage

A tool that returns images uses OnToolResult instead: its ToolResult carries the text and Parts (ImagePart), which the server shows to the model.

API What
Send, SendStream One request, whole or streamed (StreamHandler per delta)
Run The tool-call loop, streamed or not; RunWithTools is its older positional form (deprecated)
ToolResult, OnToolResult A tool result with images for the model
Message.Parts, AttachmentPart Images and files in a message (below)
Models The key's agent (GET /v1/models); a cheap way to check a key
APIError A non-2xx reply: status code, body, Message() (the server's message, one line), Code(), RetryAfter
RetryPolicy Client.Retry: how failed chat requests are sent again

Images and files

A user message carries images and files as content parts after its text; the server stores them as the conversation's attachments (PDFs, office documents, spreadsheets, text, PNG/JPEG/WebP images), so later turns of the conversation see them too.

data, _ := os.ReadFile("shot.png")
msg := docsgpt.Message{
	Role:    "user",
	Content: "Why does this fail?",
	Parts:   []docsgpt.ContentPart{docsgpt.AttachmentPart("shot.png", data)},
}

AttachmentPart sends an image (told by its bytes) as an image_url part and anything else as a file part named by its file name; ImagePart, FilePart and TextPart build one kind. With Parts, the message goes out with the OpenAI content array; one read back with a content array has every part in Parts, and Text() joins its text.

Retries

NewClient retries a chat request up to 3 times (after 2s, 4s, 8s) when it failed before any of the answer arrived: 408, 429, 502, 503, 504, or a connection refused, reset or timed out. A Retry-After is honoured, up to MaxDelay (a longer one returns the error at once), and so is x-should-retry: false; a spent usage limit (error_code ending in limit-reached) is not retried. A stream that fails once it has started is never retried, so an answer never comes twice.

client.Retry.OnRetry = func(ev docsgpt.RetryEvent) {
	log.Printf("retrying (%d/%d) in %s: %v", ev.Attempt, ev.MaxRetries, ev.Delay, ev.Err)
}
client.Retry = docsgpt.RetryPolicy{} // never retry

Cancelling the context ends a wait at once.

Versioning

The module has no dependencies beyond the standard library. It is versioned independently of the CLI, under sdk/vX.Y.Z tags, and is below v1, so the API may still change.