@empathyco/x-components/docs/API-reference/api/x-components.aistate.md

Empathy X Components

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [AiState](./x-components.aistate.md)

## AiState interface

Ai module state.

**Signature:**

```typescript
export interface AiState extends QueryState 
```
**Extends:** [QueryState](./x-components.querystate.md)

## Properties

<table><thead><tr><th>

Property


</th><th>

Modifiers


</th><th>

Type


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

[config](./x-components.aistate.config.md)


</td><td>


</td><td>

[AiConfig](./x-components.aiconfig.md)


</td><td>


</td></tr>
<tr><td>

[excludeOptions](./x-components.aistate.excludeoptions.md)


</td><td>


</td><td>

{ resultIds: Result\['id'\]\[\]; }


</td><td>


</td></tr>
<tr><td>

[origin](./x-components.aistate.origin.md)


</td><td>


</td><td>

[QueryOrigin](./x-components.queryorigin.md) \| null


</td><td>

The origin property of the request.


</td></tr>
<tr><td>

[params](./x-components.aistate.params.md)


</td><td>


</td><td>

Dictionary&lt;unknown&gt;


</td><td>

The extra params property of the state.


</td></tr>
<tr><td>

[queries](./x-components.aistate.queries.md)


</td><td>


</td><td>

AiSuggestionQuery\[\]


</td><td>


</td></tr>
<tr><td>

[relatedTags](./x-components.aistate.relatedtags.md)


</td><td>


</td><td>

RelatedTag\[\]


</td><td>

The list of the related tags, related to the `query` property of the state.


</td></tr>
<tr><td>

[searchTotalResults](./x-components.aistate.searchtotalresults.md)


</td><td>


</td><td>

number


</td><td>

The total results of the search response


</td></tr>
<tr><td>

[selectedFilters](./x-components.aistate.selectedfilters.md)


</td><td>


</td><td>

Dictionary&lt;Filter\[\]&gt;


</td><td>

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.


</td></tr>
<tr><td>

[suggestionsSearch](./x-components.aistate.suggestionssearch.md)


</td><td>


</td><td>

AiSuggestionSearch\[\]


</td><td>

The results per query retrieved by the suggestion search endpoint


</td></tr>
<tr><td>

[suggestionsSearchStatus](./x-components.aistate.suggestionssearchstatus.md)


</td><td>


</td><td>

[RequestStatus](./x-components.requeststatus.md)


</td><td>

Status for the suggestions search response


</td></tr>
<tr><td>

[suggestionsStatus](./x-components.aistate.suggestionsstatus.md)


</td><td>


</td><td>

[RequestStatus](./x-components.requeststatus.md)


</td><td>

Status for the suggestions response


</td></tr>
<tr><td>

[tagging](./x-components.aistate.tagging.md)


</td><td>


</td><td>

AiSuggestionTagging \| undefined


</td><td>


</td></tr>
</tbody></table>