halo - v1.0.0
    Preparing search index...

    Interface ChatBuilder

    Represents a chat builder interface that defines methods for generating text and streaming responses.

    interface ChatBuilder {
        generateObject<OBJECT>(
            schema:
                | ZodType<OBJECT, ZodTypeDef, any>
                | ZodType<OBJECT, ZodTypeDef, OBJECT>,
        ): Promise<GenerateObjectResult<OBJECT>>;
        generateStream(): Promise<StreamTextResult<ToolSet, never>>;
        generateText(): Promise<GenerateTextResult<ToolSet, never>>;
    }
    Index

    Methods

    generateObject generateStream generateText

    Methods

    • Type Parameters

      • OBJECT

      Parameters

      Returns Promise<GenerateObjectResult<OBJECT>>

    • A method to generate a stream of text responses from the chat.

      Returns Promise<StreamTextResult<ToolSet, never>>

    • A method to generate a text response from the chat.

      Returns Promise<GenerateTextResult<ToolSet, never>>

    Settings

    Member Visibility

    On This Page

    Methods