# Convai Chatbot

**Convai Chatbot** is an Actor component responsible for processing and getting a response for the voice audio coming from the [**Convai Player**](/api-docs/plugins-and-integrations/unreal-engine/blueprints-reference/convai-player.md) component. It plays the audio response and has a variety of useful events for transcription, actions, text response, and others.

## Properties and Functions

<figure><img src="/files/UMkw997O7GGWI7Nwzcr3" alt=""><figcaption><p>Convai Chatbot properties and functions</p></figcaption></figure>

### Character Variables

| Property                          | Type               | Description                                                                                                                                                                                                                                           |
| --------------------------------- | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Character Id                      | FString            | The character ID you would like to assign to the component.                                                                                                                                                                                           |
| Interrupt Voice Fade Out Duration | Float              | Time in seconds to gradually fade out voice response when interrupted until it is stopped.                                                                                                                                                            |
| Language Code                     | FString            | Read the value of Language Code.                                                                                                                                                                                                                      |
| Ready Player Me Link              | FString            | Read the value of Ready Player Me Link.                                                                                                                                                                                                               |
| Session Id                        | FString            | To track memory of a previous conversation, set to -1 means no previous conversation, (this property will change as you talk to the character) you can save the session ID for a conversation and then set it back later on to resume a conversation. |
| Voice Type                        | FString            | Read the value of the Variable VoiceType.                                                                                                                                                                                                             |
| Environment                       | UConvaiEnvironment | Contains all relevant objects and characters in the scene including the (Player), and also all the actions doable by the character.                                                                                                                   |
| Avatar Image Link                 | FString            | Read the value of Avatoar Image Link.                                                                                                                                                                                                                 |
| Character Name                    | FString            | Read the value of variable CharacterName.                                                                                                                                                                                                             |
| Backstory                         | FString            | Read the value of variable Backstory.                                                                                                                                                                                                                 |

### Conversation States

| Function               | Returns   | Description                                                                                        |
| ---------------------- | --------- | -------------------------------------------------------------------------------------------------- |
| `Is in Conversation()` | `Boolean` | Returns **True,** if the character is talked to, is talking, or is processing the response.        |
| `Is Talking( )`        | `Boolean` | Returns **True,** if the character is currently talking.                                           |
| `Is Thinking()`        | `Boolean` | Returns **True,** if the character is still processing and has not received the full response yet. |
| `Is Listening ()`      | `Boolean` | Returns **True,** if the character is currently listening to the player.                           |

### Lip Sync

| Function              | Returns            | Description                                                                      |
| --------------------- | ------------------ | -------------------------------------------------------------------------------- |
| `Supports Lip Sync()` | `Boolean`          | Returns `True`, if LipSync component is available and attached to the character. |
| `Get Viseme Names()`  | `Array of Strings` | Returns list of viseme names.                                                    |
| `Get Visemes()`       | `Array of Float`   | Returns last predicted viseme scores.                                            |

## Conversation Management

| Function               | Returns | Description                                                                                                                      |
| ---------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------- |
| `Interrupt Speech()`   | `Void`  | Interrupts the current speech with a provided fade out duration.                                                                 |
| `Reset Conversation()` | `Void`  | Reset the conversation with the character and remove previous memory. This is the same as setting the session ID property to -1. |

### Events

<figure><img src="/files/tQ6bzM1yldHkmwFm9TYL" alt=""><figcaption><p><strong>Convai Chatbot</strong> component events schematic</p></figcaption></figure>

### Event Names and Description.&#x20;

<table><thead><tr><th width="262">Event Name</th><th>Description</th></tr></thead><tbody><tr><td>On Actions Received</td><td>Called when new actions are received from the character.</td></tr><tr><td>On Text Received</td><td>Called when new text is received from the character.</td></tr><tr><td>On Transcription Received</td><td>Called when new transcription is available.</td></tr><tr><td>On Started Talking</td><td>Called when the character starts talking.</td></tr><tr><td>On Finished Talking</td><td>Called when the character stops talking.</td></tr><tr><td>On Failure</td><td>Called when there is an error.</td></tr></tbody></table>

### Event Parameters

<table><thead><tr><th width="260">Parameter</th><th>Description</th></tr></thead><tbody><tr><td>Bot Text</td><td>The received text</td></tr><tr><td>Audio Duration</td><td>Duration of spoken received text. Is equal to zero if only text was received and no audio.</td></tr><tr><td>Is Final</td><td>True if this is the last chunk of text/transcription to be received.</td></tr><tr><td>Transcription</td><td>The transcription received.</td></tr><tr><td>Is Transcription Ready</td><td>True if the received transcription is ready and is not going to change anymore, false if the transcription is still in an intermediate state and is going to change.</td></tr></tbody></table>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/blueprints-reference/convai-chatbot.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
Event Name	Description
On Actions Received	Called when new actions are received from the character.
On Text Received	Called when new text is received from the character.
On Transcription Received	Called when new transcription is available.
On Started Talking	Called when the character starts talking.
On Finished Talking	Called when the character stops talking.
On Failure	Called when there is an error.
Parameter	Description
Bot Text	The received text
Audio Duration	Duration of spoken received text. Is equal to zero if only text was received and no audio.
Is Final	True if this is the last chunk of text/transcription to be received.
Transcription	The transcription received.
Is Transcription Ready	True if the received transcription is ready and is not going to change anymore, false if the transcription is still in an intermediate state and is going to change.