Go SDK

The Go SDK lives in the github.com/SmrutAI/smritea-sdk/go module. Its package name is smritea. The client has four calls: Add, Search, Get and Delete. It needs Go 1.22 or later and is safe for concurrent use.

InstallCopy Anchor Link

go get github.com/SmrutAI/smritea-sdk/go

Import the module with the smritea alias:

import smritea "github.com/SmrutAI/smritea-sdk/go"

var _ = smritea.NewClient

Create a clientCopy Anchor Link

smritea.NewClient takes a ClientConfig and returns a *SmriteaClient. It never returns an error. You must set APIKey and AppID. Create them in the dashboard; see Create an app and API key.

The client has no timeout field. Set a timeout on the HTTPClient you pass in.

A bad TraceID does not fail NewClient. Every later call then returns a *SmriteaBadRequestError with the code INVALID_TRACE_ID, and sends no request.

MethodsCopy Anchor Link

Every method takes a context.Context first.

The GetAll method exists but always returns an error. Use Search to find memories.

Build options with the fluent helpers smritea.NewAddOptions() and smritea.NewSearchOptions(). Pass nil for no options.

Add optionsCopy Anchor Link

The table lists the builder methods that set the options for Add.

Build a *RelativeStanding with smritea.NewRelativeStanding(). Chain WithImportance(float32), WithDecayFactor(float32) and WithDecayFunction(string). The importance ranges from 0 to 1. The decay factor is 0 or higher. The decay function takes exponential, gaussian or linear. Decay affects quick_search, context_aware_search and deep_search with temporal or rrf_temporal; importance affects deep_search with rrf or rrf_temporal.

Search optionsCopy Anchor Link

The table lists the builder methods that set the options for Search.

You cannot combine WithValidAt with WithFromTime or WithToTime.

Memory scopeCopy Anchor Link

Build a scope with smritea.NewMemoryScope() and its With methods. Every field is optional. See Memory scope for the rules.

ResultsCopy Anchor Link

Search returns a slice of *SearchResult. The fields are pointers. Read them with the getters, which are safe on a nil value.

Add returns a *MemoryCreationResult.

ErrorsCopy Anchor Link

Every error embeds SmriteaError. The SDK picks the type from the HTTP status.

Each error has HTTPStatus, Code, Retryable, Body and RequestID. SmriteaTooManyRequestsError also has RetryAfter, in seconds.

Check the typed errors before *SmriteaError. errors.As into *SmriteaError does not match a typed error.

The SDK retries a 429 up to MaxRetries times. It never retries a 402. For every code, see Errors and codes.

ExampleCopy Anchor Link

This program stores a memory, searches for it and handles the failures.

package main

import (
	"context"
	"errors"
	"fmt"
	"os"

	smritea "github.com/SmrutAI/smritea-sdk/go"
)

func main() {
	client := smritea.NewClient(smritea.ClientConfig{
		APIKey: os.Getenv("SMRITEA_API_KEY"),
		AppID:  os.Getenv("SMRITEA_APP_ID"),
	})
	ctx := context.Background()
	scope := smritea.NewMemoryScope().
		WithActorID("alice").
		WithActorType("user")

	_, err := client.Add(ctx, "Alice is vegetarian and loves hiking",
		smritea.NewAddOptions().WithScope(scope))
	if err != nil {
		report(err)
		return
	}
	results, err := client.Search(ctx, "What does Alice eat?",
		smritea.NewSearchOptions().WithScope(scope))
	if err != nil {
		report(err)
		return
	}
	for _, r := range results {
		fmt.Printf("%.2f  %s\n", r.GetScore(), r.Memory.GetContent())
	}
}

func report(err error) {
	var quota *smritea.SmriteaPaymentRequiredError
	var limited *smritea.SmriteaTooManyRequestsError
	var base *smritea.SmriteaError
	switch {
	case errors.As(err, &quota):
		fmt.Println("Plan quota used up (402)")
	case errors.As(err, &limited):
		wait := 0
		if limited.RetryAfter != nil {
			wait = *limited.RetryAfter
		}
		fmt.Println("Rate limited (429)", wait)
	case errors.As(err, &base):
		fmt.Println(base.HTTPStatus, base.Code, base.RequestID)
	default:
		fmt.Println(err)
	}
}

Don't see your language? Request it on GitHub. Search existing requests first and add a 👍 if yours is there. That helps the Smritea team rank requests.