atomic-generated-answer

This is for:

Developer
In this article

The atomic-generated-answer component uses Coveo Machine Learning (Coveo ML) models to automatically generate an answer to a query executed by the user. For more information, see About Relevance Generative Answering (RGA)

Properties

Property Attribute Description Type Default

answerStyle

answer-style

The answer style to apply when the component first loads. Options: - default: Generate the answer without specific formatting instructions. - bullet: Generate the answer as a bulleted list. - step: Generate the answer as step-by-step instructions. - concise: Generate the answer as briefly as possible.

"bullet" | "concise" | "default" | "step"

'default'

collapsible

collapsible

Whether to allow the answer to be collapsed when the text is taller than 250px.

boolean | undefined

withRephraseButtons

with-rephrase-buttons

Whether to render the rephrase buttons that lets the user rephrase the answer.

boolean | undefined

withToggle

with-toggle

Whether to render a toggle button that lets the user hide or show the answer.

boolean | undefined

Shadow Parts

Part Description

answer-code-block

The generated answer multi-line code blocks.

answer-emphasis

The generated answer emphasized text elements.

answer-heading-1

The generated answer level 1 heading elements.

answer-heading-2

The generated answer level 2 heading elements.

answer-heading-3

The generated answer level 3 heading elements.

answer-heading-4

The generated answer level 4 heading elements.

answer-heading-5

The generated answer level 5 heading elements.

answer-heading-6

The generated answer level 6 heading elements.

answer-inline-code

The generated answer inline code elements.

answer-list-item

The generated answer list item elements for both ordered and unordered lists.

answer-ordered-list

The generated answer ordered list elements.

answer-paragraph

The generated answer paragraph elements.

answer-quote-block

The generated answer quote block elements.

answer-strong

The generated answer strong text elements.

answer-table

The generated answer table elements.

answer-table-container

The generated answer table container elements.

answer-table-content

The generated answer table content cell elements.

answer-table-header

The generated answer table header cell elements.

answer-unordered-list

The generated answer unordered list elements.

citation

The link that allows the user to navigate to the item.

citation-popover

The pop-up that shows an item preview when the user hovers over the citation.

citations-label

The header of the citations list.

container

The container displaying the generated answer.

copy-button

The "Copy answer" button.

feedback-button

The "like" and "dislike" buttons.

generated-text

The text of the generated answer.

header-label

The header of the generated answer container.

rephrase-button

The button for each of the rephrase options (step-by-step instructions, bulleted list, and summary).

rephrase-button-label

The label of the rephrase button.

rephrase-buttons

The container of the rephrase buttons section.

rephrase-buttons-container

The container of the rephrase buttons.

rephrase-label

The header of the rephrase options.

retry-container

The container for the "retry" section.

toggle

The switch to toggle the visibility of the generated answer.