C# SDK

The C# SDK is the Smritea.Sdk NuGet package. It gives you an async SmriteaClient with four calls: AddAsync, SearchAsync, GetAsync and DeleteAsync. The package targets .NET 10.

InstallCopy Anchor Link

dotnet add package Smritea.Sdk

Import the namespace:

using Smritea.Sdk;

Create a clientCopy Anchor Link

SmriteaClient takes your API key and your app ID. You must pass both, and a null value throws ArgumentNullException. The client implements IDisposable. Create the keys in the dashboard; see Create an app and API key.

The client has no timeout parameter. Set a timeout on the HttpClient you pass in. Dispose does not dispose a client you supplied.

MethodsCopy Anchor Link

Every method takes a CancellationToken ct = default as its last argument.

The opts argument is optional. The GetAllAsync method exists but throws NotImplementedException. Use SearchAsync to find memories.

The names Memory, MemoryCreationResult and SearchResult are the SDK's own short names for generated types. Only the SDK assembly can use these short names. Your code can name the public generated types in Smritea.Internal.Autogen.Model: MemoryResponse, CreateMemoryResponse and SearchMemoryResponse. Declare results with var. To name one, add an alias such as using SearchResult = Smritea.Internal.Autogen.Model.SearchMemoryResponse;.

Add optionsCopy Anchor Link

Build options with the fluent methods on new AddOptions().

Build a RelativeStanding with new RelativeStanding(). Chain WithImportance(float), WithDecayFactor(float) 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

Build options with the fluent methods on new SearchOptions().

You cannot combine WithValidAt with WithFromTime or WithToTime.

Memory scopeCopy Anchor Link

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

ResultsCopy Anchor Link

SearchAsync returns a list of results. Each one has a Score and a Memory.

AddAsync returns a MemoryCreationResult.

ExceptionsCopy Anchor Link

Every error derives from SmriteaException. The SDK picks the class from the HTTP status.

Each exception has HTTPStatus, Code, Retryable, Body and RequestId. SmriteaTooManyRequestsException also has RetryAfter, in seconds.

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.

using Smritea.Sdk;

var client = new SmriteaClient(
    apiKey: Environment.GetEnvironmentVariable("SMRITEA_API_KEY")!,
    appId: Environment.GetEnvironmentVariable("SMRITEA_APP_ID")!);
var alice = new MemoryScope()
    .WithActorId("alice")
    .WithActorType("user");

try
{
    await client.AddAsync("Alice is vegetarian and loves hiking",
        new AddOptions().WithScope(alice));
    var results = await client.SearchAsync("What does Alice eat?",
        new SearchOptions().WithScope(alice));
    foreach (var r in results)
        Console.WriteLine($"{r.Score:F2}  {r.Memory.Content}");
}
catch (SmriteaPaymentRequiredException)
{
    Console.WriteLine("Plan quota used up (402)");
}
catch (SmriteaTooManyRequestsException ex)
{
    Console.WriteLine($"Rate limited. Retry in {ex.RetryAfter}s");
}
catch (SmriteaException ex)
{
    Console.WriteLine($"{ex.HTTPStatus} {ex.Code} {ex.RequestId}");
}

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.