Skip to content

AGENTS.md

Latest commit

 

History

History
67 lines (47 loc) · 2.67 KB

AGENTS.md

File metadata and controls

67 lines (47 loc) · 2.67 KB

AGENTS.md

This file provides guidance to Codex (Codex.ai/code) when working with code in this repository.

Project Overview

C# SDK for the Voyage AI embedding and reranking API, auto-generated from the Voyage AI OpenAPI specification using AutoSDK. Published as a NuGet package under the tryAGI organization.

Build Commands

# Build the solution
dotnet build VoyageAI.slnx

# Build for release (also produces NuGet package)
dotnet build VoyageAI.slnx -c Release

# Run integration tests (requires VOYAGEAI_API_KEY env var)
dotnet test src/tests/VoyageAI.IntegrationTests/VoyageAI.IntegrationTests.csproj

# Regenerate SDK from OpenAPI spec
cd src/libs/VoyageAI && ./generate.sh

Architecture

Code Generation Pipeline

The SDK code is entirely auto-generated -- do not manually edit files in src/libs/VoyageAI/Generated/.

  1. src/libs/VoyageAI/openapi.yaml -- the Voyage AI OpenAPI spec (fetched from https://raw.githubusercontent.com/voyage-ai/openapi/main/voyage-openapi.yml)
  2. src/helpers/FixOpenApiSpec/ -- converts OpenAPI 3.1 to 3.0 format for compatibility
  3. src/libs/VoyageAI/generate.sh -- orchestrates: download spec, fix spec, run AutoSDK CLI, output to Generated/
  4. CI auto-updates the spec and creates PRs if changes are detected

Hand-Written Extensions

Path Purpose
Extensions/VoyageAIClient.EmbeddingGenerator.cs MEAI IEmbeddingGenerator<string, Embedding<float>> implementation
Extensions/MultimodalInput.cs Typed helpers for multimodal embeddings (text + image inputs)
Extensions/RateLimitRetryHandler.cs HTTP 429 retry with exponential backoff

Project Layout

Project Purpose
src/libs/VoyageAI/ Main SDK library (VoyageAIClient)
src/tests/VoyageAI.IntegrationTests/ Integration tests against real Voyage AI API
src/helpers/FixOpenApiSpec/ OpenAPI spec fixer tool
src/helpers/GenerateDocs/ Documentation generator from integration tests
src/helpers/TrimmingHelper/ NativeAOT/trimming compatibility validator

Build Configuration

  • Target: net10.0 (single target)
  • Language: C# preview with nullable reference types
  • Signing: Strong-named assemblies via src/key.snk
  • Versioning: Semantic versioning from git tags (v prefix) via MinVer
  • Analysis: All .NET analyzers enabled, AOT/trimming compatibility enforced
  • Testing: MSTest + FluentAssertions

CI/CD

  • Uses shared workflows from HavenDV/workflows repo
  • Dependabot updates NuGet packages weekly (auto-merged)
  • Documentation deployed to GitHub Pages via MkDocs Material