Railengine.Retrieval 1.1.0

Quick Start

The RailengineClient provides methods for searching and retrieving data from your engine.

using Railengine;
using Railengine.Models;
using System.Net.Http;

// Create client with HttpClient and PAT token
var httpClient = new HttpClient();
var patToken = Environment.GetEnvironmentVariable("RAILENGINE_PAT");
var client = new RailengineClient(httpClient, patToken);

// Engine ID from environment variable
var engineId = Guid.Parse(Environment.GetEnvironmentVariable("RAILENGINE_ENGINE_ID"));

// Search vectors by query text
var results = await client.SearchVectorsAsync<MyDocument>(
    engineId,
    query: "search term",
    threshold: 0.7f,
    top: 10
);

// Get a specific storage document by EventId
var document = await client.GetStorageDocumentByEventId<MyDocument>(
    engineId,
    eventId: Guid.Parse("event-id-here")
);

API Reference

SearchVectorsAsync<T>

Search the engine vector store using text query or pre-computed embedding.

Task<List<VectorSearchResult<T>>> SearchVectorsAsync<T>(
    Guid engineId,
    string query = null,           // Text query
    float[] embedding = null,      // Pre-computed embedding
    VectorStore vectorStore = default,
    float? threshold = 0.0f,       // Similarity threshold
    int? top = 10,                 // Number of results
    CancellationToken cancellationToken = default
);

GetStorageDocumentByEventId<T>

Retrieve a single storage document by EventId.

Task<RailengineStorageDocument<T>> GetStorageDocumentByEventId<T>(
    Guid engineId,
    Guid eventId,
    CancellationToken cancellationToken = default
);

ListStorageDocuments<T>

List most recently ingested storage documents with pagination.

Task<RailengineStorageDocuments<T>> ListStorageDocuments<T>(
    Guid engineId,
    string selectProperty = null,
    int pageNumber = 1,
    int pageSize = 25,
    CancellationToken cancellationToken = default
);

DeleteDocument

Deletes a specific document by its EventId

Task DeleteDocument(
    Guid engineId,
    Guid eventId,
    CancellationToken cancellationToken = default
);

Authentication Details

The RailengineClient uses a Personal Access Token (PAT) for authentication. Generate your PAT from the Railengine dashboard.

// Read credentials from environment variables
var patToken = Environment.GetEnvironmentVariable("RAILENGINE_PAT");
var engineId = Guid.Parse(Environment.GetEnvironmentVariable("RAILENGINE_ENGINE_ID"));

var client = new RailengineClient(httpClient, patToken);