Interface SmartResponseComponentConfig

Hierarchy

Properties

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

Properties

Optional config

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

Configuration for smartreponse expect the agentId, clientGroupId and apiUrl.

Type declaration

  • Optional agentId?: string
  • Optional apiUrl?: string
  • Optional clientGroupId?: string
  • Optional searchEndpoint?: string

Optional defaultQuery

defaultQuery?: {
    input?: string;
}

Type declaration

  • Optional input?: string

    Default Value

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

Optional prompt

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

Specifies the agent instructions provided to GenAI Bridge

Type declaration

  • Optional instructions?: string

    Default Value

    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.

  • Optional schema?: object

    Default Value

    { "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 } }

Optional shadowDom

shadowDom?: boolean

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

Default Value

true

Optional strings

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

Type declaration

Optional template

template?: string

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

For more information, see Components.

Optional useCustomStyle

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

Theme

On This Page