ILangfuseDatasetClient
NexusLabs.Foundry.Langfuse¶
ILangfuseDatasetClient Interface¶
Reads, creates, and populates Langfuse datasets — the named collections of evaluation cases that experiment runs are scored against.
Properties¶
ILangfuseDatasetClient.IsEnabled Property¶
Gets a value indicating whether Langfuse dataset operations are available. Mutating members are no-ops when false; read members fail explicitly rather than returning an empty dataset.
Property Value¶
Methods¶
ILangfuseDatasetClient.EnsureDatasetAsync(string) Method¶
Ensures a dataset with the given name exists, creating it only when absent, with no description. Safe to call on every run.
Parameters¶
name System.String
The dataset name.
Returns¶
System.Threading.Tasks.Task
A task that completes when the dataset exists in Langfuse.
ILangfuseDatasetClient.EnsureDatasetAsync(string, string, CancellationToken) Method¶
Ensures a dataset with the given name exists, creating it only when absent. Safe to call on every run.
System.Threading.Tasks.Task EnsureDatasetAsync(string name, string? description, System.Threading.CancellationToken cancellationToken);
Parameters¶
name System.String
The dataset name.
description System.String
A description applied when the dataset is created, or null for none.
cancellationToken System.Threading.CancellationToken
A cancellation token.
Returns¶
System.Threading.Tasks.Task
A task that completes when the dataset exists in Langfuse.
ILangfuseDatasetClient.GetDatasetAsync(LangfuseDatasetSelection) Method¶
Loads dataset metadata and fully materializes every active item before returning.
System.Threading.Tasks.Task<NexusLabs.Foundry.Langfuse.LangfuseDatasetSnapshot> GetDatasetAsync(NexusLabs.Foundry.Langfuse.LangfuseDatasetSelection selection);
Parameters¶
selection LangfuseDatasetSelection
The hosted dataset selection.
Returns¶
System.Threading.Tasks.Task<LangfuseDatasetSnapshot>
The dataset metadata, selection, and complete ordered item snapshot.
Exceptions¶
System.ArgumentNullException
selection is null.
System.ArgumentException
The dataset name is empty or whitespace.
System.InvalidOperationException
Langfuse is not configured.
LangfuseException
The provider request or response is invalid or inconsistent.
ILangfuseDatasetClient.GetDatasetAsync(LangfuseDatasetSelection, CancellationToken) Method¶
Loads dataset metadata and fully materializes every active item before returning.
System.Threading.Tasks.Task<NexusLabs.Foundry.Langfuse.LangfuseDatasetSnapshot> GetDatasetAsync(NexusLabs.Foundry.Langfuse.LangfuseDatasetSelection selection, System.Threading.CancellationToken cancellationToken);
Parameters¶
selection LangfuseDatasetSelection
The hosted dataset selection.
cancellationToken System.Threading.CancellationToken
A cancellation token.
Returns¶
System.Threading.Tasks.Task<LangfuseDatasetSnapshot>
The dataset metadata, selection, and complete ordered item snapshot.
Exceptions¶
System.ArgumentNullException
selection is null.
System.ArgumentException
The dataset name is empty or whitespace.
System.InvalidOperationException
Langfuse is not configured.
LangfuseException
The provider request or response is invalid or inconsistent.
System.OperationCanceledException
cancellationToken was canceled.
ILangfuseDatasetClient.ListDatasetItemsAsync(LangfuseDatasetSelection) Method¶
Lists the first page of up to 50 active items from the latest hosted dataset.
System.Threading.Tasks.Task<NexusLabs.Foundry.Langfuse.LangfusePage<NexusLabs.Foundry.Langfuse.LangfuseDatasetItemSnapshot>> ListDatasetItemsAsync(NexusLabs.Foundry.Langfuse.LangfuseDatasetSelection selection);
Parameters¶
selection LangfuseDatasetSelection
The hosted dataset selection.
Returns¶
System.Threading.Tasks.Task<NexusLabs.Foundry.Langfuse.LangfusePage<LangfuseDatasetItemSnapshot>>
The validated active-item page.
Exceptions¶
System.ArgumentNullException
selection is null.
System.ArgumentException
The dataset name is empty or whitespace.
System.InvalidOperationException
Langfuse is not configured.
LangfuseException
The provider request or response is invalid.
ILangfuseDatasetClient.ListDatasetItemsAsync(LangfuseDatasetSelection, int, int, CancellationToken) Method¶
Lists one page of active items from the latest or explicitly versioned hosted dataset.
System.Threading.Tasks.Task<NexusLabs.Foundry.Langfuse.LangfusePage<NexusLabs.Foundry.Langfuse.LangfuseDatasetItemSnapshot>> ListDatasetItemsAsync(NexusLabs.Foundry.Langfuse.LangfuseDatasetSelection selection, int page, int pageSize, System.Threading.CancellationToken cancellationToken);
Parameters¶
selection LangfuseDatasetSelection
The hosted dataset selection.
page System.Int32
The one-based page number.
pageSize System.Int32
The number of items to request, from 1 through 100.
cancellationToken System.Threading.CancellationToken
A cancellation token.
Returns¶
System.Threading.Tasks.Task<NexusLabs.Foundry.Langfuse.LangfusePage<LangfuseDatasetItemSnapshot>>
The validated active-item page.
Exceptions¶
System.ArgumentNullException
selection is null.
System.ArgumentException
The dataset name is empty or whitespace.
System.ArgumentOutOfRangeException
page or pageSize is outside its supported range.
System.InvalidOperationException
Langfuse is not configured.
LangfuseException
The provider request or response is invalid.
System.OperationCanceledException
cancellationToken was canceled.
ILangfuseDatasetClient.ListDatasetsAsync() Method¶
Lists the first page of up to 50 hosted datasets in provider order.
System.Threading.Tasks.Task<NexusLabs.Foundry.Langfuse.LangfusePage<NexusLabs.Foundry.Langfuse.LangfuseDataset>> ListDatasetsAsync();
Returns¶
System.Threading.Tasks.Task<NexusLabs.Foundry.Langfuse.LangfusePage<LangfuseDataset>>
The validated first dataset page.
Exceptions¶
System.InvalidOperationException
Langfuse is not configured.
LangfuseException
The provider request or response is invalid.
ILangfuseDatasetClient.ListDatasetsAsync(int, int, CancellationToken) Method¶
Lists one page of hosted datasets in provider order.
System.Threading.Tasks.Task<NexusLabs.Foundry.Langfuse.LangfusePage<NexusLabs.Foundry.Langfuse.LangfuseDataset>> ListDatasetsAsync(int page, int pageSize, System.Threading.CancellationToken cancellationToken);
Parameters¶
page System.Int32
The one-based page number.
pageSize System.Int32
The number of datasets to request, from 1 through 100.
cancellationToken System.Threading.CancellationToken
A cancellation token.
Returns¶
System.Threading.Tasks.Task<NexusLabs.Foundry.Langfuse.LangfusePage<LangfuseDataset>>
The validated dataset page.
Exceptions¶
System.ArgumentOutOfRangeException
page or pageSize is outside its supported range.
System.InvalidOperationException
Langfuse is not configured.
LangfuseException
The provider request or response is invalid.
System.OperationCanceledException
cancellationToken was canceled.
ILangfuseDatasetClient.UpsertItemAsync(LangfuseDatasetItem) Method¶
Upserts a dataset item without an explicit cancellation token. When Id is set, an existing item with that id is updated; otherwise a new item is created.
Parameters¶
item LangfuseDatasetItem
The item to upsert.
Returns¶
System.Threading.Tasks.Task
A task that completes when the item has been persisted.
ILangfuseDatasetClient.UpsertItemAsync(LangfuseDatasetItem, CancellationToken) Method¶
Upserts a dataset item. When Id is set, an existing item with that id is updated; otherwise a new item is created.
System.Threading.Tasks.Task UpsertItemAsync(NexusLabs.Foundry.Langfuse.LangfuseDatasetItem item, System.Threading.CancellationToken cancellationToken);
Parameters¶
item LangfuseDatasetItem
The item to upsert.
cancellationToken System.Threading.CancellationToken
A cancellation token.
Returns¶
System.Threading.Tasks.Task
A task that completes when the item has been persisted.