lib/api-client-react/src/generated/api.schemas.ts

/**
 * Generated by orval v8.9.1 🍺
 * Do not edit manually.
 * Api
 * Io HST Search Engine API
 * OpenAPI spec version: 0.1.0
 */
export interface HealthStatus {
  status: string;
}

export interface SearchInput {
  /**
     * @minLength 1
     * @maxLength 500
     */
  query: string;
  /**
     * @minimum 1
     * @maximum 12
     */
  target?: number;
}

export interface SearchResult {
  answer: string;
  sources: string[];
  /** @nullable */
  topUrl?: string | null;
  query: string;
  intent?: string;
  selfReferential?: boolean;
  sourceCount?: number;
  processingMs?: number;
}

export interface ModelInput {
  /**
     * @minLength 1
     * @maxLength 1500
     */
  prompt: string;
  /**
     * @minimum 1
     * @maximum 1024
     */
  maxTokens?: number;
  /**
     * @minimum 0.01
     * @maximum 2
     */
  temperature?: number;
  /**
     * @minimum 1
     * @maximum 200
     */
  topK?: number;
  /**
     * @minimum 0.01
     * @maximum 1
     */
  topP?: number;
  /**
     * @minimum 1
     * @maximum 2
     */
  repetitionPenalty?: number;
  /**
     * @minimum 0
     * @maximum 2
     */
  presencePenalty?: number;
  /**
     * @minimum 1
     * @maximum 8
     */
  nSamples?: number;
}

export interface ModelResult {
  text: string;
  step: number;
  checkpoint?: string;
  coherenceScore?: number;
  bestOfN?: number;
  bestScore?: number;
  /** @nullable */
  error?: string | null;
}

export type FeedbackInputRating = typeof FeedbackInputRating[keyof typeof FeedbackInputRating];


export const FeedbackInputRating = {
  up: 'up',
  down: 'down',
} as const;

export interface FeedbackInput {
  /**
     * @minLength 1
     * @maxLength 500
     */
  query: string;
  rating: FeedbackInputRating;
  sources?: string[];
  /** @maxLength 8000 */
  answer?: string;
}

export interface FeedbackResult {
  ok: boolean;
  ts: number;
}

export type FeedbackStatsSourcesItem = {
  source: string;
  up: number;
  down: number;
  multiplier: number;
};

export interface FeedbackStats {
  totalFeedback: number;
  totalUp: number;
  totalDown: number;
  sources: FeedbackStatsSourcesItem[];
}

export interface FineTuneInput {
  /**
     * @minimum 1
     * @maximum 200
     */
  steps?: number;
  /**
     * @minimum 1e-7
     * @maximum 0.001
     */
  lr?: number;
  /**
     * @minimum 64
     * @maximum 1024
     */
  seqLen?: number;
}

export type FineTuneStateStatus = typeof FineTuneStateStatus[keyof typeof FineTuneStateStatus];


export const FineTuneStateStatus = {
  idle: 'idle',
  running: 'running',
  success: 'success',
  failed: 'failed',
} as const;

export type FineTuneStateGuideStats = { [key: string]: unknown };

export type FineTuneStateLogItem = { [key: string]: unknown };

export interface FineTuneState {
  status: FineTuneStateStatus;
  /** @nullable */
  startedAt?: number | null;
  /** @nullable */
  finishedAt?: number | null;
  steps?: number;
  currentStep?: number;
  /** @nullable */
  loss?: number | null;
  /** @nullable */
  avgLoss?: number | null;
  /** @nullable */
  error?: string | null;
  /** @nullable */
  checkpointOut?: string | null;
  activeCheckpoint?: string;
  fineTunedExists?: boolean;
  guideStats?: FineTuneStateGuideStats;
  log?: FineTuneStateLogItem[];
  ok?: boolean;
}

export interface ModelStatus {
  available: boolean;
  message: string;
  /** @nullable */
  step?: number | null;
  /** @nullable */
  checkpoint?: string | null;
}