@empathyco/x-components
Version:
Empathy X Components
34 lines (25 loc) • 2.21 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [AiState](./x-components.aistate.md)
## AiState interface
Ai module state.
**Signature:**
```typescript
export interface AiState extends QueryState
```
**Extends:** [QueryState](./x-components.querystate.md)
## Properties
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [config](./x-components.aistate.config.md) | | [AiConfig](./x-components.aiconfig.md) | |
| [isNoResults](./x-components.aistate.isnoresults.md) | | boolean | Flag to indicate that the AI response has no results |
| [origin](./x-components.aistate.origin.md) | | [QueryOrigin](./x-components.queryorigin.md) \| null | The origin property of the request. |
| [params](./x-components.aistate.params.md) | | Dictionary<unknown> | The extra params property of the state. |
| [queries](./x-components.aistate.queries.md) | | AiSuggestionQuery\[\] | |
| [relatedTags](./x-components.aistate.relatedtags.md) | | RelatedTag\[\] | The list of the related tags, related to the <code>query</code> property of the state. |
| [responseText](./x-components.aistate.responsetext.md) | | string | The streamed field from suggestion response. |
| [selectedFilters](./x-components.aistate.selectedfilters.md) | | Dictionary<Filter\[\]> | The dictionary of selected filters, used to perform the AI requests. The key is the facet ID, and the value the list of filters for that facet. |
| [suggestionsLoading](./x-components.aistate.suggestionsloading.md) | | boolean | Loading state for the suggestions response |
| [suggestionsSearch](./x-components.aistate.suggestionssearch.md) | | AiSuggestionSearch\[\] | The results per query retrieved by the suggestion search endpoint |
| [suggestionsSearchLoading](./x-components.aistate.suggestionssearchloading.md) | | boolean | Loading state for the suggestions search response |
| [suggestionText](./x-components.aistate.suggestiontext.md) | | string | |
| [tagging](./x-components.aistate.tagging.md) | | AiSuggestionTagging \| undefined | |