@bridgeline-digital/hawksearch-handlebars-ui
    Preparing search index...

    Interface SmartResponseComponentConfig

    interface SmartResponseComponentConfig {
        config: {
            agentId: string;
            apiUrl?: string;
            clientGroupId: string;
            searchEndpoint?: string;
        };
        defaultQuery?: { input?: string };
        prompt?: { instructions?: string; schema?: object };
        shadowDom?: boolean;
        strings?: { header?: string; noresults?: string };
        template?: string;
        useCustomStyle?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    config defaultQuery? prompt? shadowDom? strings? template? useCustomStyle?

    Properties

    config: {
        agentId: string;
        apiUrl?: string;
        clientGroupId: string;
        searchEndpoint?: string;
    }

    Configuration for smartreponse expect the agentId, clientGroupId and apiUrl.

    Type Declaration

    • agentId: string

      The unique identifier for the smart response agent

    • OptionalapiUrl?: string
    • clientGroupId: string

      The client group ID for the smart response configuration

    • OptionalsearchEndpoint?: string
    defaultQuery?: { input?: string }

    Type Declaration

    • Optionalinput?: string

      in case no user input is found, smart response component uses this as default input

    prompt?: { instructions?: string; schema?: object }

    Specifies the agent instructions provided to GenAI Bridge

    Type Declaration

    • Optionalinstructions?: string

      You are a recommendation agent, specialized in finding the perfect match for a user. Answer the question from the user extensivelly. You will be provided with a user input and an array of products. Based on the user input and products, determine a maximum of 3 of the most relevant products based on the user input. Do not provide any information about amount of products you're returning.

    • Optionalschema?: object

      { "name": "smartresponse_summary", "description": "Recommedation message and product details which includes name, description, url, price and imageUrl", "strict": true, "schema": { "type": "object", "properties": { "recommendation": { "type": "string" }, "products": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" }, "description": { "type": "string" }, "price": { "type": "number" }, "imageUrl": { "type": "string" } }, "required": [ "name", "url", "description", "price", "imageUrl" ], "additionalProperties": false } } }, "required": [ "recommendation", "products" ], "additionalProperties": false } }

    shadowDom?: boolean

    Specifies whether the component should be rendered in the Shadow DOM. This is highly recommended to avoid CSS conflicts.

    true

    strings?: { header?: string; noresults?: string }

    Type Declaration

    • Optionalheader?: string

      SmartResponse

    • Optionalnoresults?: string

      No Results found

    template?: string

    Specifies a custom template to be used instead of the default template.

    For more information, see Components.

    useCustomStyle?: boolean

    Specifies whether the component should be rendered in the avoid injecting the css to head of the page. This would only effect when shadowDom false

    Settings

    Member Visibility

    On This Page

    Properties