@empathyco/x-components/docs/API-reference/api/x-components.aigetters.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; [AiGetters](./x-components.aigetters.md)

## AiGetters interface

Ai module getters.

**Signature:**

```typescript
export interface AiGetters 
```

## Properties

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

Property


</th><th>

Modifiers


</th><th>

Type


</th><th>

Description


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

[query](./x-components.aigetters.query.md)


</td><td>


</td><td>

string


</td><td>

The combination of the query and the selected related tags.


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

[suggestionsRequest](./x-components.aigetters.suggestionsrequest.md)


</td><td>


</td><td>

AiSuggestionsRequest


</td><td>

Request object to retrieve the streaming response using the ai suggestions adapter.


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

[suggestionsSearchRequest](./x-components.aigetters.suggestionssearchrequest.md)


</td><td>


</td><td>

AiSuggestionsSearchRequest \| null


</td><td>

Request object to retrieve the suggestions search based on queries or null if there is no valid queries to conform a valid request.


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