API Reference
=============

This section contains the API reference for all configuration classes, organized by category.

Root configurations
-------------------

- :doc:`BenchmarkConfig` - Configuration for ``veeksha.benchmark`` runs
- :doc:`CapacitySearchConfig` - Configuration for ``veeksha.capacity_search`` runs

Session generators
------------------

.. toctree::
   :maxdepth: 1

   Base Session Generator <BaseSessionGeneratorConfig>
   Lmeval Session Generator <LmevalSessionGeneratorConfig>
   Synthetic Session Generator <SyntheticSessionGeneratorConfig>
   Trace Session Generator <TraceSessionGeneratorConfig>

Traffic schedulers
------------------

.. toctree::
   :maxdepth: 1

   Base Traffic <BaseTrafficConfig>
   Concurrent Traffic <ConcurrentTrafficConfig>
   Rate Traffic <RateTrafficConfig>
   Sequential Launch Traffic <SequentialLaunchTrafficConfig>

Clients
-------

.. toctree::
   :maxdepth: 1

   Base Client <BaseClientConfig>
   OpenAI Chat Completions Client <OpenAIChatCompletionsClientConfig>
   OpenAI Completions Client <OpenAICompletionsClientConfig>
   OpenAI Router Client <OpenAIRouterClientConfig>

Servers
-------

.. toctree::
   :maxdepth: 1

   Base Server <BaseServerConfig>
   SGLang Server <SglangServerConfig>
   Vajra Server <VajraServerConfig>
   vLLM Server <VllmServerConfig>

Evaluators
----------

.. toctree::
   :maxdepth: 1

   Base Evaluator <BaseEvaluatorConfig>
   LMEval Accuracy Evaluator <LMEvalAccuracyEvaluatorConfig>
   Performance Evaluator <PerformanceEvaluatorConfig>

Channel performance
-------------------

.. toctree::
   :maxdepth: 1

   Audio Channel Performance <AudioChannelPerformanceConfig>
   Image Channel Performance <ImageChannelPerformanceConfig>
   Text Channel Performance <TextChannelPerformanceConfig>
   Video Channel Performance <VideoChannelPerformanceConfig>

Length generators
-----------------

.. toctree::
   :maxdepth: 1

   Base Length Generator <BaseLengthGeneratorConfig>
   Fixed Length Generator <FixedLengthGeneratorConfig>
   Inverse Gaussian Length Generator <InverseGaussianLengthGeneratorConfig>
   Stair Length Generator <StairLengthGeneratorConfig>
   Uniform Length Generator <UniformLengthGeneratorConfig>
   Zipf Length Generator <ZipfLengthGeneratorConfig>

Interval generators
-------------------

.. toctree::
   :maxdepth: 1

   Base Interval Generator <BaseIntervalGeneratorConfig>
   Fixed Interval Generator <FixedIntervalGeneratorConfig>
   Gamma Interval Generator <GammaIntervalGeneratorConfig>
   Poisson Interval Generator <PoissonIntervalGeneratorConfig>

Channel generators
------------------

.. toctree::
   :maxdepth: 1

   Audio Channel Generator <AudioChannelGeneratorConfig>
   Base Channel Generator <BaseChannelGeneratorConfig>
   Image Channel Generator <ImageChannelGeneratorConfig>
   Text Channel Generator <TextChannelGeneratorConfig>
   Video Channel Generator <VideoChannelGeneratorConfig>

Session graph generators
------------------------

.. toctree::
   :maxdepth: 1

   Base Session Graph Generator <BaseSessionGraphGeneratorConfig>
   Branching Session Graph Generator <BranchingSessionGraphGeneratorConfig>
   Linear Session Graph Generator <LinearSessionGraphGeneratorConfig>
   Single Request Session Graph Generator <SingleRequestSessionGraphGeneratorConfig>

Trace flavors
-------------

.. toctree::
   :maxdepth: 1

   Base Trace Flavor <BaseTraceFlavorConfig>
   RAG Trace Flavor <RAGTraceFlavorConfig>
   Request Log Trace Flavor <RequestLogTraceFlavorConfig>
   Shared Prefix Trace Flavor <SharedPrefixTraceFlavorConfig>
   Timed Synthetic Session Trace Flavor <TimedSyntheticSessionTraceFlavorConfig>
   Untimed Content Multi Turn Trace Flavor <UntimedContentMultiTurnTraceFlavorConfig>

SLO configs
-----------

.. toctree::
   :maxdepth: 1

   Base Slo <BaseSloConfig>
   Constant Slo <ConstantSloConfig>

Other
-----

.. toctree::
   :maxdepth: 1

   Audio Output Spec <AudioOutputSpecConfig>
   Decode Window <DecodeWindowConfig>
   Image Output Spec <ImageOutputSpecConfig>
   Output Spec <OutputSpecConfig>
   Runtime <RuntimeConfig>
   Text Output Spec <TextOutputSpecConfig>
   Trace Recorder <TraceRecorderConfig>
   Video Output Spec <VideoOutputSpecConfig>
   Wandb <WandbConfig>