The turbopuffer C# SDK provides convenient access to the turbopuffer HTTP API from applications written in C#.
It is generated with Stainless.
The HTTP API documentation can be found at turbopuffer.com/docs/api-overview.
Install the package from NuGet:
dotnet add package TurbopufferThis library requires .NET Standard 2.0 or later.
See the examples directory for complete and runnable examples.
using System;
using Turbopuffer;
using Turbopuffer.Models.Namespaces;
TurbopufferClient client = new();
NamespaceWriteParams parameters = new()
{
DistanceMetric = DistanceMetric.CosineDistance,
UpsertRows =
[
new()
{
ID = "2108ed60-6851-49a0-9016-8325434f3845",
Vector = new(
[
0.1, 0.2
]
),
},
],
};
var response = await client.Namespace("products").Write(parameters);
Console.WriteLine(response);Configure the client using environment variables:
using Turbopuffer;
// Configured using the TURBOPUFFER_API_KEY, TURBOPUFFER_REGION and TURBOPUFFER_BASE_URL environment variables
TurbopufferClient client = new();Or manually:
using Turbopuffer;
TurbopufferClient client = new()
{
Region = "gcp-us-central1",
ApiKey = "tpuf_A1...",
};Or using a combination of the two approaches.
See this table for the available options:
| Property | Environment variable | Required | Default value |
|---|---|---|---|
ApiKey |
TURBOPUFFER_API_KEY |
true | - |
Region |
TURBOPUFFER_REGION |
false | - |
BaseUrl |
TURBOPUFFER_BASE_URL |
true | "https://{region}.turbopuffer.com" |
To temporarily use a modified client configuration, while reusing the same connection and thread pools, call WithOptions on any client or service:
using System;
var page = await client
.WithOptions(options =>
options with
{
BaseUrl = "https://example.com",
Timeout = TimeSpan.FromSeconds(42),
}
)
.Namespaces(parameters);
Console.WriteLine(page);Using a with expression makes it easy to construct the modified options.
The WithOptions method does not affect the original client or service.
To send a request to the turbopuffer API, build an instance of some Params class and pass it to the corresponding client method. When the response is received, it will be deserialized into an instance of a C# class.
For example, client.Namespace("ns").Write should be called with an instance of NamespaceWriteParams, and it will return an instance of Task<NamespaceWriteResponse>.
The SDK defines methods that deserialize responses into instances of C# classes. However, these methods don't provide access to the response headers, status code, or the raw response body.
To access this data, prefix any HTTP method call on a client or service with WithRawResponse:
var response = await client.WithRawResponse.Namespace("ns").Write(parameters);
var statusCode = response.StatusCode;
var headers = response.Headers;The raw HttpResponseMessage can also be accessed through the RawMessage property.
For non-streaming responses, you can deserialize the response into an instance of a C# class if needed:
using System;
using Turbopuffer.Models.Namespaces;
var response = await client.WithRawResponse.Namespace("ns").Write(parameters);
NamespaceWriteResponse deserialized = await response.Deserialize();
Console.WriteLine(deserialized);The SDK throws custom unchecked exception types:
TurbopufferApiException: Base class for API errors. See this table for which exception subclass is thrown for each HTTP status code:
| Status | Exception |
|---|---|
| 400 | TurbopufferBadRequestException |
| 401 | TurbopufferUnauthorizedException |
| 403 | TurbopufferForbiddenException |
| 404 | TurbopufferNotFoundException |
| 422 | TurbopufferUnprocessableEntityException |
| 429 | TurbopufferRateLimitException |
| 5xx | Turbopuffer5xxException |
| others | TurbopufferUnexpectedStatusCodeException |
Additionally, all 4xx errors inherit from Turbopuffer4xxException.
-
TurbopufferIOException: I/O networking errors. -
TurbopufferInvalidDataException: Failure to interpret successfully parsed data. For example, when accessing a property that's supposed to be required, but the API unexpectedly omitted it from the response. -
TurbopufferException: Base class for all exceptions.
The SDK defines methods that return a paginated lists of results. It provides convenient ways to access the results either one page at a time or item-by-item across all pages.
To iterate through all results across all pages, use the Paginate method, which automatically fetches more pages as needed. The method returns an IAsyncEnumerable:
using System;
var page = await client.Namespaces(parameters);
await foreach (var item in page.Paginate())
{
Console.WriteLine(item);
}To access individual page items and manually request the next page, use the Items property, and HasNext and Next methods:
using System;
var page = await client.Namespaces();
while (true)
{
foreach (var item in page.Items)
{
Console.WriteLine(item);
}
if (!page.HasNext())
{
break;
}
page = await page.Next();
}The SDK automatically retries 4 times by default, with a short exponential backoff between requests.
Only the following error types are retried:
- Connection errors (for example, due to a network connectivity problem)
- 408 Request Timeout
- 409 Conflict
- 429 Rate Limit
- 5xx Internal
The API may also explicitly instruct the SDK to retry or not retry a request.
To set a custom number of retries, configure the client using the MaxRetries method:
using Turbopuffer;
TurbopufferClient client = new() { MaxRetries = 5 };Or configure a single method call using WithOptions:
using System;
var page = await client
.WithOptions(options =>
options with { MaxRetries = 5 }
)
.Namespaces(parameters);
Console.WriteLine(page);Requests time out after 1 minute by default.
To set a custom timeout, configure the client using the Timeout option:
using System;
using Turbopuffer;
TurbopufferClient client = new() { Timeout = TimeSpan.FromSeconds(42) };Or configure a single method call using WithOptions:
using System;
var page = await client
.WithOptions(options =>
options with { Timeout = TimeSpan.FromSeconds(42) }
)
.Namespaces(parameters);
Console.WriteLine(page);Compression defaults to off. When enabled, the SDK gzip-compresses request bodies and lets the
default HttpClient advertise and transparently decompress gzip responses. Set the Compression
option to true:
using Turbopuffer;
TurbopufferClient client = new() { Compression = true };Or configure a single method call using WithOptions:
var page = await client
.WithOptions(options =>
options with { Compression = true }
)
.Namespaces(parameters);To route requests through a proxy, configure your client with a custom HttpClient:
using System.Net;
using System.Net.Http;
using Turbopuffer;
var httpClient = new HttpClient
(
new HttpClientHandler
{
Proxy = new WebProxy("https://example.com:8080")
}
);
TurbopufferClient client = new() { HttpClient = httpClient };The SDK is typed for convenient usage of the documented API. However, it also supports working with undocumented or not yet supported parts of the API.
To set undocumented parameters, a constructor exists that accepts dictionaries for additional header, query, and body values. If the method type doesn't support request bodies (e.g. GET requests), the constructor will only accept a header and query dictionary.
using System.Collections.Generic;
using System.Text.Json;
using Turbopuffer.Models.Namespaces;
NamespaceWriteParams parameters = new
(
rawHeaderData: new Dictionary<string, JsonElement>()
{
{ "Custom-Header", JsonSerializer.SerializeToElement(42) }
},
rawQueryData: new Dictionary<string, JsonElement>()
{
{ "custom_query_param", JsonSerializer.SerializeToElement(42) }
},
rawBodyData: new Dictionary<string, JsonElement>()
{
{ "custom_body_param", JsonSerializer.SerializeToElement(42) }
}
)
{
// Documented properties can still be added here.
// In case of conflict, these parameters take precedence over the custom parameters.
DeleteByFilter = Filter.Eq("attr", "value")
};The raw parameters can also be accessed through the RawHeaderData, RawQueryData, and RawBodyData (if available) properties.
This can also be used to set a documented parameter to an undocumented or not yet supported value, as long as the parameter is optional. If the parameter is required, omitting its init property will result in a compile-time error. To work around this, the FromRawUnchecked method can be used:
using System.Collections.Generic;
using System.Text.Json;
using Turbopuffer.Models.Namespaces;
var parameters = NamespaceBranchFromParams.FromRawUnchecked
(
rawHeaderData: new Dictionary<string, JsonElement>(),
rawQueryData: new Dictionary<string, JsonElement>(),
rawBodyData: new Dictionary<string, JsonElement>
{
{
"source_namespace",
JsonSerializer.SerializeToElement("custom value")
}
}
);Undocumented properties, or undocumented values of documented properties, on nested parameters can be set similarly, using a dictionary in the constructor of the nested parameter.
using System.Collections.Generic;
using System.Text.Json;
using Turbopuffer.Models.Namespaces;
NamespaceWriteParams parameters = new()
{
PatchByFilter = new
(
new Dictionary<string, JsonElement>
{
{ "custom_nested_param", JsonSerializer.SerializeToElement(42) }
}
)
};Required properties on the nested parameter can also be changed or omitted using the FromRawUnchecked method:
using System.Collections.Generic;
using System.Text.Json;
using Turbopuffer.Models.Namespaces;
NamespaceWriteParams parameters = new()
{
PatchByFilter = PatchByFilter.FromRawUnchecked
(
new Dictionary<string, JsonElement>
{
{ "required_property", JsonSerializer.SerializeToElement("custom value") }
}
)
};To access undocumented response properties, the RawData property can be used:
using System.Text.Json;
var response = client.Namespace("ns").Write(parameters)
if (response.RawData.TryGetValue("my_custom_key", out JsonElement value))
{
// Do something with `value`
}RawData is a IReadonlyDictionary<string, JsonElement>. It holds the full data received from the API server.
In rare cases, the API may return a response that doesn't match the expected type. For example, the SDK may expect a property to contain a string, but the API could return something else.
By default, the SDK will not throw an exception in this case. It will throw TurbopufferInvalidDataException only if you directly access the property.
If you would prefer to check that the response is completely well-typed upfront, then either call Validate:
var response = client.Namespace("ns").Write(parameters);
response.Validate();Or configure the client using the ResponseValidation option:
using Turbopuffer;
TurbopufferClient client = new() { ResponseValidation = true };Or configure a single method call using WithOptions:
using System;
var response = await client
.WithOptions(options =>
options with { ResponseValidation = true }
)
.Namespace("ns").Write(parameters);
Console.WriteLine(response);This package generally follows SemVer conventions, though certain backwards-incompatible changes may be released as minor versions:
- Changes to library internals which are technically public but not intended or documented for external use. (Please open a GitHub issue to let us know if you are relying on such internals.)
- Changes that we do not expect to impact the vast majority of users in practice.
We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.
We are keen for your feedback; please open an issue with questions, bugs, or suggestions.