nexus-agents - v2.80.0
    Preparing search index...

    Interface DocumentationResult

    Documentation result from DocumentationExpert.

    interface DocumentationResult {
        content: string;
        structuredData?: Record<string, unknown>;
        recommendations?: string[];
        warnings?: string[];
        confidence: number;
        modelUsed?: string;
        documentationType: "api" | "readme" | "guide" | "reference";
        sections?: DocumentationSection[];
        apiDocs?: ApiDocumentation;
    }

    Hierarchy (View Summary)

    Index

    Properties

    content structuredData? recommendations? warnings? confidence modelUsed? documentationType sections? apiDocs?

    Properties

    content

    content: string

    Primary result content

    structuredData?: Record<string, unknown>

    Structured data if applicable

    recommendations?: string[]

    Recommendations or suggestions

    warnings?: string[]

    Warnings or issues found

    confidence: number

    Confidence score (0-1)

    modelUsed?: string

    Model used for this expert's execution (Issue #817)

    documentationType: "api" | "readme" | "guide" | "reference"

    Documentation type

    sections?: DocumentationSection[]

    Generated documentation sections

    apiDocs?: ApiDocumentation

    API documentation

    Settings

    Member Visibility

    On This Page

    Properties