Class Playground

Index

Constructors

Accessors

Methods

addPrompt addTestcase createSession getSession getSummary listSessions runAll runComparison

Constructors

constructor

new Playground(
    executor?: (
        prompt: PlaygroundPrompt,
        variables: Record<string, string>,
    ) => Promise<{ latencyMs: number; output: string; tokens?: number }>,
): Playground
Parameters
- Optionalexecutor: (
  prompt: PlaygroundPrompt,
  variables: Record<string, string>,
  ) => Promise<{ latencyMs: number; output: string; tokens?: number }>
Returns Playground
- Defined in src/agents/playground.ts:130

Accessors

sessionCount

get sessionCount(): number
Returns number
- Defined in src/agents/playground.ts:334

Methods

addPrompt

addPrompt(
sessionId: string,
prompt: Omit<PlaygroundPrompt, "id">,
): PlaygroundPrompt | undefined
Add a prompt variant to a session
Parameters
- sessionId: string
- prompt: Omit<PlaygroundPrompt, "id">
Returns PlaygroundPrompt | undefined
- Defined in src/agents/playground.ts:162

addTestcase

addTestcase(
sessionId: string,
testcase: Omit<PlaygroundTestcase, "id">,
): PlaygroundTestcase | undefined
Add a testcase to a session
Parameters
- sessionId: string
- testcase: Omit<PlaygroundTestcase, "id">
Returns PlaygroundTestcase | undefined
- Defined in src/agents/playground.ts:171

createSession

createSession(
name: string,
metadata?: Record<string, unknown>,
): PlaygroundSession
Create a new session
Parameters
- name: string
- Optionalmetadata: Record<string, unknown>
Returns PlaygroundSession
- Defined in src/agents/playground.ts:137

getSession

getSession(sessionId: string): PlaygroundSession | undefined
Get a session
Parameters
- sessionId: string
Returns PlaygroundSession | undefined
- Defined in src/agents/playground.ts:152

getSummary

getSummary(sessionId: string): PlaygroundSummary | undefined
Get session summary with aggregate scores
Parameters
- sessionId: string
Returns PlaygroundSummary | undefined
- Defined in src/agents/playground.ts:288

listSessions

listSessions(): PlaygroundSession[]
List all sessions

Returns PlaygroundSession[]
- Defined in src/agents/playground.ts:157

runAll

runAll(
sessionId: string,
options?: { metricGroupId?: string; runJudge?: boolean },
): Promise<PlaygroundRun[]>
Run all prompts against all testcases
Parameters
- sessionId: string
- Optionaloptions: { metricGroupId?: string; runJudge?: boolean }
Returns Promise<PlaygroundRun[]>
- Defined in src/agents/playground.ts:272

runComparison

runComparison(
    sessionId: string,
    testcaseId: string,
    options?: { metricGroupId?: string; runJudge?: boolean },
): Promise<PlaygroundRun | undefined>
Run all prompts against a single testcase
Parameters
- sessionId: string
- testcaseId: string
- Optionaloptions: { metricGroupId?: string; runJudge?: boolean }
Returns Promise<PlaygroundRun | undefined>
- Defined in src/agents/playground.ts:180