Circle V2 API Docs
    Preparing search index...

    Type Alias AgentQuestionResult

    Public result of a single audit question run. Shape-compatible with the legacy AuditQuestionResult, extended with confidence and evidenceTrail, and a needs_review status for abstentions.

    type AgentQuestionResult = {
        abstainReason: AbstainReason | null;
        answer: string;
        auditQuestionId: AuditQuestionId | null;
        citation: Citation[] | null;
        citationsVerified: boolean;
        confidence: number;
        documents: ResultDocument[];
        evidenceTrail: EvidenceItem[];
        question: string;
        recommendation: string | null;
        shortFormAnswer: string | null;
        status: FinalStatus | null;
    }
    Index

    Properties

    abstainReason answer auditQuestionId citation citationsVerified confidence documents evidenceTrail question recommendation shortFormAnswer status

    Properties

    abstainReason: AbstainReason | null

    Why the run had nothing to answer from; null when it had documents.

    answer: string
    auditQuestionId: AuditQuestionId | null
    citation: Citation[] | null
    citationsVerified: boolean

    Every cited quote verified against its source doc (the verifyCitations check); true when disabled.

    confidence: number
    documents: ResultDocument[]
    evidenceTrail: EvidenceItem[]
    question: string
    recommendation: string | null
    shortFormAnswer: string | null
    status: FinalStatus | null

    Settings

    Member Visibility

    On This Page

    Properties