NucleusDatabase.Client 1.2.3

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. .NET Standard 2.0 This package targets .NET Standard 2.0. The package is compatible with this framework or higher. 
dotnet add package NucleusDatabase.Client --version 1.2.3
                    


                    

                
NuGet\Install-Package NucleusDatabase.Client -Version 1.2.3
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="NucleusDatabase.Client" Version="1.2.3" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="NucleusDatabase.Client" Version="1.2.3" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="NucleusDatabase.Client" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add NucleusDatabase.Client --version 1.2.3
                    


                    

                
#r "nuget: NucleusDatabase.Client, 1.2.3"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package NucleusDatabase.Client@1.2.3
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=NucleusDatabase.Client&version=1.2.3
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=NucleusDatabase.Client&version=1.2.3
                    


                            Install as a Cake Tool

NucleusDatabase.Client

Typed .NET client for the Nucleus RAG database HTTP API.

Nucleus is an all-in-one RAG engine: it stores, chunks, embeds (in-process) and indexes your documents, then answers natural-language searches with hybrid (vector + BM25) retrieval and optional reranking. This client talks to a running nucleus-server instance over HTTP.

Targets netstandard2.0 and net8.0 — works on .NET Framework 4.6.1+, .NET Core, .NET 5–10, Unity and Xamarin.

Install

dotnet add package NucleusDatabase.Client

Quick start

using Nucleus.Client;

using var nucleus = new NucleusClient("http://127.0.0.1:8080", "nuc_your_token");

// Admin: create a domain (each domain pins an embedding model).
var domain = await nucleus.CreateDomainAsync("fiscal");

// Upload a raw file (PDF/DOCX/XLSX/HTML/MD/TXT) — extracted in-engine.
byte[] bytes = File.ReadAllBytes("IRPF_2026.pdf");
await nucleus.UploadFileAsync(
    domain.Id, "IRPF_2026.pdf", bytes,
    subdomain: "irpf", labels: new[] { "2026", "irpf" });

// Search (hybrid retrieval; optional rerank server-side).
var hits = await nucleus.SearchAsync(domain.Id, new SearchRequest
{
    Query = "tipos de retención de IRPF en 2026",
    K = 5,
    Subdomain = "irpf"
});

foreach (var h in hits)
    Console.WriteLine($"{h.Score:F3}  {h.Text}");

Highlights

  • Hybrid search: dense (vector) + sparse (BM25) fused with RRF, plus optional cross-encoder reranking and MMR diversity.
  • Transparent ingest: upload raw files (PDF, DOCX, XLSX, HTML, MD, TXT…) or text; the engine extracts, chunks, embeds and indexes.
  • Structure: organize by domain → subdomain → document → chunk, with labels for filtering.
  • Async ingest: ingestion returns a job_id; poll GetJobAsync until Done.
  • Scoped tokens: the token you pass determines read/write/admin access per domain.

Error handling

Errors surface as NucleusApiException with .StatusCode and a message:

try
{
    var hits = await nucleus.SearchAsync(domain.Id, req);
}
catch (NucleusApiException ex) when (ex.StatusCode == 403)
{
    // token lacks Read scope on this domain
}

License

MIT OR Apache-2.0.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.2.3 113 7/15/2026
1.2.2 107 7/15/2026