Action
    Preparing search index...

    Provides methods for an insight agent to interact with the user, including reporting progress and prompting for input.

    2.5

    Hierarchy (View Summary)

    Index

    Methods

    Default capability

    Extended capability 'AI'

    Methods

    • Casts this object to the specified type. Throws error on failure.

      Type Parameters

      • T1

        The target type of the cast.

      • T2

        The type of the object to cast.

      Parameters

      Returns T1

    • Determines whether the specified object is equal to the current object.

      Parameters

      • obj: any

        The object to compare with the current object.

      Returns boolean

      true if the specified object is equal to the current object; otherwise, false.

    • Serves as the default hash function.

      Returns number

      A hash code for the current object.

    • Returns a string that represents the current object.

      Returns string

      A string that represents the current object.

    • Casts this object to the specified type. Returns null on failure.

      Type Parameters

      • T1

        The target type of the cast.

      • T2

        The type of the object to cast.

      Parameters

      Returns T1 | null

    • Determines whether the specified object instances are considered equal.

      Parameters

      • objA: any

        The first object to compare.

      • objB: any

        The second object to compare.

      Returns boolean

      true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.

    Default capability

    • Prompts the user with a question and returns the user's response as a string.

      Parameters

      • question: string | String

        The question to display to the user. Cannot be null or empty.

      Returns string

      A string containing the user's response. Returns null if the user cancels the prompt.

      2.5

    • Prompts the user with a question and returns the user's response as a string.

      Parameters

      • question: string | String

        The question to display to the user. Cannot be null or empty.

      • ...options: UserQuestionOption[]

        The options to display.

      Returns string

      A string containing the user's response. Returns null if the user cancels the prompt.

      2.5

    • Reports progress to the user. The progress string can be displayed in the UI to inform the user about the current state of an operation or task. This method allows insights to provide feedback to the user about ongoing processes.

      Parameters

      • progress: string | String

        The current progress text.

      Returns void

      2.5

    Extended capability 'AI'