Interface AskResponse

Response from an AI agent when asked a question or given a task.

interface AskResponse {
    annotations?: Record<string, AiFileAnnotation>;
    responseString: string;
    routing?: AiModelRoutingResult;
    validation?: AiAnswerValidationResult;
}

Index

Properties

annotations? responseString routing? validation?

Properties

`Optional`annotations

annotations?: Record<string, AiFileAnnotation>

Optional annotations that provide additional context or metadata about the response.

responseString

responseString: string

The main text response from the AI agent.

`Optional`routing

routing?: AiModelRoutingResult

Set when model was an AiModelRoutingOptions: which model answered and what the routing call cost.

`Optional`validation

validation?: AiAnswerValidationResult

Judge verdict, present when answer validation is enabled.