Circle V2 API Docs
    Preparing search index...

    Function runAuditQuestionAgent

    • Parameters

      • options: RunAuditQuestionAgentOptions

      Returns Promise<
          | {
              answer: string;
              citation: | { quote: string; source: { name: string; page: unknown } }[]
              | null;
              recommendation: null;
              shortFormAnswer: null;
              status: null;
          }
          | {
              answer: string;
              citation: | {
                  quote: string;
                  source: { documentId: string
                  | null; name: string; page: unknown };
              }[]
              | null;
              recommendation: string
              | null;
              shortFormAnswer: string | null;
              status:
                  | "pass"
                  | "fail"
                  | "needs_review"
                  | "not_applicable"
                  | "missing"
                  | "late"
                  | "not_due_yet";
          }
          | {
              answer: string;
              citation: | {
                  quote: string;
                  source: { documentId: string
                  | null; name: string; page: unknown };
              }[]
              | null;
              recommendation: string
              | null;
              shortFormAnswer: null;
              status: "warning" | "pass" | "fail" | "not_applicable";
          },
      >