> For a complete documentation index, fetch https://docs.voximplant.ai/llms.txt

# Yandex

Yandex provides a VoxEngine client for connecting a call or media unit to the Yandex Realtime API over WebSocket.

Use `Yandex.createRealtimeAPIClient(...)` to create a `RealtimeAPIClient` for the current scenario.

## Related guides

Learn how Yandex Realtime fits into a VoxEngine call flow.

## Contents

*  [Usage](#usage): required module import and basic flow.
*  [Factory functions](#factory-functions): create the Yandex Realtime API client.
*  [Methods](#methods): session, items, and response control methods.
*  [Events](#events): WebSocket media bridge events.
*  [RealtimeAPIEvents](#realtimeapievents): Yandex Realtime API event names and payload fields.

## Usage

Add the module before using the namespace:

```js
require(Modules.Yandex);
```

Create the client, bridge media, and listen for Yandex Realtime API events.

## Factory functions

###  createRealtimeAPIClient

Creates a [Yandex.RealtimeAPIClient](/api-reference/voxengine/yandex#realtimeapiclient) instance.

```ts
createRealtimeAPIClient(parameters: RealtimeAPIClientParameters): Promise<Yandex.RealtimeAPIClient>
```

**Parameters**

| Parameter    | Type                                                   | Req. | Description |
| ------------ | ------------------------------------------------------ | ---- | ----------- |
| `parameters` | <code>RealtimeAPI<wbr />Client<wbr />Parameters</code> | ✓    |             |

**Returns**

| Type                                            | Description                                                                |
| ----------------------------------------------- | -------------------------------------------------------------------------- |
| <code>Promise\<Yandex.RealtimeAPIClient></code> | Resolves to the [`Yandex.RealtimeAPIClient`](#realtimeapiclient) instance. |

## RealtimeAPIClient

## Methods

### &#x20;addEventListener

Adds a handler for the specified [Yandex.RealtimeAPIEvents](/api-reference/voxengine/yandex#realtimeapievents) or [Yandex.Events](/api-reference/voxengine/yandex#events) event. Use only functions as handlers; anything except a function leads to the error and scenario termination when a handler is called.

```ts
addEventListener(event: Yandex.Events | Yandex.RealtimeAPIEvents | string, callback: (event: object) => any): void
```

**Parameters**

| Parameter  | Type                                                                                  | Req. | Description                                   |
| ---------- | ------------------------------------------------------------------------------------- | ---- | --------------------------------------------- |
| `event`    | <code>Yandex.<wbr />Events \| Yandex.<wbr />RealtimeAPI<wbr />Events \| string</code> | ✓    | Event constant or event name to subscribe to. |
| `callback` | <code>(event: object) => any</code>                                                   | ✓    | Function called when the event is emitted.    |

**Returns**

| Type   | Description              |
| ------ | ------------------------ |
| `void` | Does not return a value. |

### &#x20;clearMediaBuffer

Clears the Yandex WebSocket media buffer.

```ts
clearMediaBuffer(parameters?: ClearMediaBufferParameters): void
```

**Parameters**

| Parameter    | Type                                                  | Req. | Description |
| ------------ | ----------------------------------------------------- | ---- | ----------- |
| `parameters` | <code>ClearMedia<wbr />Buffer<wbr />Parameters</code> | ✗    |             |

**Returns**

| Type   | Description              |
| ------ | ------------------------ |
| `void` | Does not return a value. |

### &#x20;close

Closes the Yandex connection (over WebSocket) or connection attempt.

```ts
close(): void
```

**Parameters**

This method does not accept parameters.

**Returns**

| Type   | Description              |
| ------ | ------------------------ |
| `void` | Does not return a value. |

### &#x20;conversationItemCreate

Add a new Item to the Conversation's context.

```ts
conversationItemCreate(parameters: Object): void
```

**Parameters**

| Parameter    | Type     | Req. | Description |
| ------------ | -------- | ---- | ----------- |
| `parameters` | `Object` | ✓    |             |

**Returns**

| Type   | Description              |
| ------ | ------------------------ |
| `void` | Does not return a value. |

### &#x20;conversationItemDelete

Send this event when you want to remove any item from the conversation history.

```ts
conversationItemDelete(parameters: Object): void
```

**Parameters**

| Parameter    | Type     | Req. | Description |
| ------------ | -------- | ---- | ----------- |
| `parameters` | `Object` | ✓    |             |

**Returns**

| Type   | Description              |
| ------ | ------------------------ |
| `void` | Does not return a value. |

### &#x20;conversationItemRetrieve

Send this event when you want to retrieve the server's representation of a specific item in the conversation history.

```ts
conversationItemRetrieve(parameters: Object): void
```

**Parameters**

| Parameter    | Type     | Req. | Description |
| ------------ | -------- | ---- | ----------- |
| `parameters` | `Object` | ✓    |             |

**Returns**

| Type   | Description              |
| ------ | ------------------------ |
| `void` | Does not return a value. |

### &#x20;conversationItemTruncate

Send this event to truncate a previous assistant message’s audio.

```ts
conversationItemTruncate(parameters: Object): void
```

**Parameters**

| Parameter    | Type     | Req. | Description |
| ------------ | -------- | ---- | ----------- |
| `parameters` | `Object` | ✓    |             |

**Returns**

| Type   | Description              |
| ------ | ------------------------ |
| `void` | Does not return a value. |

### &#x20;id

Returns the RealtimeAPIClient id.

```ts
id(): string
```

**Parameters**

This method does not accept parameters.

**Returns**

| Type     | Description                 |
| -------- | --------------------------- |
| `string` | The requested string value. |

### &#x20;removeEventListener

Removes a handler for the specified [Yandex.RealtimeAPIEvents](/api-reference/voxengine/yandex#realtimeapievents) or [Yandex.Events](/api-reference/voxengine/yandex#events) event.

```ts
removeEventListener(event: Yandex.Events | Yandex.RealtimeAPIEvents | string, callback?: (event: object) => any): void
```

**Parameters**

| Parameter  | Type                                                                                  | Req. | Description                                   |
| ---------- | ------------------------------------------------------------------------------------- | ---- | --------------------------------------------- |
| `event`    | <code>Yandex.<wbr />Events \| Yandex.<wbr />RealtimeAPI<wbr />Events \| string</code> | ✓    | Event constant or event name to subscribe to. |
| `callback` | <code>(event: object) => any</code>                                                   | ✗    | Function called when the event is emitted.    |

**Returns**

| Type   | Description              |
| ------ | ------------------------ |
| `void` | Does not return a value. |

### &#x20;responseCancel

Send this event to cancel an in-progress response.

```ts
responseCancel(parameters: Object): void
```

**Parameters**

| Parameter    | Type     | Req. | Description |
| ------------ | -------- | ---- | ----------- |
| `parameters` | `Object` | ✓    |             |

**Returns**

| Type   | Description              |
| ------ | ------------------------ |
| `void` | Does not return a value. |

### &#x20;responseCreate

This event instructs the server to create a Response, which means triggering model inference.

```ts
responseCreate(parameters: Object): void
```

**Parameters**

| Parameter    | Type     | Req. | Description |
| ------------ | -------- | ---- | ----------- |
| `parameters` | `Object` | ✓    |             |

**Returns**

| Type   | Description              |
| ------ | ------------------------ |
| `void` | Does not return a value. |

### &#x20;sendMediaTo

Starts sending media from the Yandex (via WebSocket) to the media unit. Yandex works in real time.

```ts
sendMediaTo(mediaUnit: VoxMediaUnit, parameters?: SendMediaParameters): void
```

**Parameters**

| Parameter    | Type                                    | Req. | Description |
| ------------ | --------------------------------------- | ---- | ----------- |
| `mediaUnit`  | `VoxMediaUnit`                          | ✓    |             |
| `parameters` | <code>SendMedia<wbr />Parameters</code> | ✗    |             |

**Returns**

| Type   | Description              |
| ------ | ------------------------ |
| `void` | Does not return a value. |

### &#x20;sessionUpdate

Send this event to update the session’s configuration.

```ts
sessionUpdate(parameters: Object): void
```

**Parameters**

| Parameter    | Type     | Req. | Description |
| ------------ | -------- | ---- | ----------- |
| `parameters` | `Object` | ✓    |             |

**Returns**

| Type   | Description              |
| ------ | ------------------------ |
| `void` | Does not return a value. |

### &#x20;stopMediaTo

Stops sending media from the Yandex (via WebSocket) to the media unit.

```ts
stopMediaTo(mediaUnit: VoxMediaUnit): void
```

**Parameters**

| Parameter   | Type           | Req. | Description |
| ----------- | -------------- | ---- | ----------- |
| `mediaUnit` | `VoxMediaUnit` | ✓    |             |

**Returns**

| Type   | Description              |
| ------ | ------------------------ |
| `void` | Does not return a value. |

### &#x20;webSocketId

Returns the Yandex WebSocket id.

```ts
webSocketId(): string
```

**Parameters**

This method does not accept parameters.

**Returns**

| Type     | Description                 |
| -------- | --------------------------- |
| `string` | The requested string value. |

## Events

These events describe audio received through the Yandex WebSocket media bridge.

### &#x20;WebSocketMediaStarted

Triggered when the audio stream sent by a third party through an Yandex WebSocket is started playing.

Event constant: `Events.WebSocketMediaStarted`

**Payload**

| Field                                | Type                                     | Req. | Description                                                                                                                                       |
| ------------------------------------ | ---------------------------------------- | ---- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| `client`                             | <code>RealtimeAPI<wbr />Client</code>    | ✓    | The [Yandex.RealtimeAPIClient](/api-reference/voxengine/yandex#realtimeapiclient) instance.                                                       |
| `tag`                                | `string`                                 | ✗    | Special tag to name audio streams sent over one WebSocket connection. With it, one can send 2 audios to 2 different media units at the same time. |
| `encoding`                           | `string`                                 | ✗    | Audio encoding formats.                                                                                                                           |
| <code>custom<wbr />Parameters</code> | <code>\{ \[key: string]: string }</code> | ✗    | Custom parameters.                                                                                                                                |

### &#x20;WebSocketMediaEnded

Triggers after the end of the audio stream sent by a third party through an Yandex WebSocket (**1 second of silence**).

Event constant: `Events.WebSocketMediaEnded`

**Payload**

| Field       | Type                                   | Req. | Description                                                                                                                                       |
| ----------- | -------------------------------------- | ---- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| `client`    | <code>RealtimeAPI<wbr />Client</code>  | ✓    | The [Yandex.RealtimeAPIClient](/api-reference/voxengine/yandex#realtimeapiclient) instance.                                                       |
| `tag`       | `string`                               | ✗    | Special tag to name audio streams sent over one WebSocket connection. With it, one can send 2 audios to 2 different media units at the same time. |
| `mediaInfo` | <code>WebSocket<wbr />MediaInfo</code> | ✗    | Information about the audio stream that can be obtained after the stream stops or pauses (**1 second of silence**).                               |

## RealtimeAPIEvents

These events mirror server messages from the Yandex Realtime API. The `data` field contains the provider event payload.

<a id="-unknown" />

The unknown event.

Event constant: `RealtimeAPIEvents.Unknown`

**Payload**

<a id="-httpresponse" />

The HTTP response event.

Event constant: `RealtimeAPIEvents.HTTPResponse`

**Payload**

<a id="-websocketerror" />

The WebSocket error response event.

Event constant: `RealtimeAPIEvents.WebSocketError`

**Payload**

<a id="-connectorinformation" />

Contains information about connector.

Event constant: `RealtimeAPIEvents.ConnectorInformation`

**Payload**

<a id="-error" />

Returned when an error occurs, which could be a client problem or a server problem.[https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerError](https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerError)

Event constant: `RealtimeAPIEvents.Error`

**Payload**

<a id="-sessioncreated" />

Returned when a Session is created.[https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerSessionCreated](https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerSessionCreated)

Event constant: `RealtimeAPIEvents.SessionCreated`

**Payload**

<a id="-sessionupdated" />

Returned when a session is updated with a session.update event, unless there is an error.[https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerSessionUpdated](https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerSessionUpdated)

Event constant: `RealtimeAPIEvents.SessionUpdated`

**Payload**

<a id="-conversationitemcreated" />

Returned when a new Item is created in the Conversation.[https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerConversationItemCreated](https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerConversationItemCreated)

Event constant: `RealtimeAPIEvents.ConversationItemCreated`

**Payload**

<a id="-conversationitemretrieved" />

Returned when a conversation item is retrieved with conversation.item.retrieve.[https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerConversationItemRetrieved](https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerConversationItemRetrieved)

Event constant: `RealtimeAPIEvents.ConversationItemRetrieved`

**Payload**

<a id="-conversationiteminputaudiotranscriptioncompleted" />

This event is the output of audio transcription for user audio written to the user audio buffer.[https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerConversationItemInputAudioTranscriptionCompleted](https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerConversationItemInputAudioTranscriptionCompleted)

Event constant: `RealtimeAPIEvents.ConversationItemInputAudioTranscriptionCompleted`

**Payload**

<a id="-conversationiteminputaudiotranscriptiondelta" />

Returned when the text value of an input audio transcription content part is updated with incremental transcription results.[https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerConversationItemInputAudioTranscriptionDelta](https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerConversationItemInputAudioTranscriptionDelta)

Event constant: `RealtimeAPIEvents.ConversationItemInputAudioTranscriptionDelta`

**Payload**

<a id="-conversationiteminputaudiotranscriptionsegment" />

Returned when an input audio transcription segment is identified for an item.[https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerConversationItemInputAudioTranscriptionSegment](https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerConversationItemInputAudioTranscriptionSegment)

Event constant: `RealtimeAPIEvents.ConversationItemInputAudioTranscriptionSegment`

**Payload**

<a id="-conversationiteminputaudiotranscriptionfailed" />

Returned when input audio transcription is configured, and a transcription request for a user message failed.[https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerConversationItemInputAudioTranscriptionFailed](https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerConversationItemInputAudioTranscriptionFailed)

Event constant: `RealtimeAPIEvents.ConversationItemInputAudioTranscriptionFailed`

**Payload**

<a id="-conversationitemtruncated" />

Returned when an earlier assistant audio message item is truncated by the client with a conversation.item.truncate event.[https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerConversationItemTruncated](https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerConversationItemTruncated)

Event constant: `RealtimeAPIEvents.ConversationItemTruncated`

**Payload**

<a id="-conversationitemdeleted" />

Returned when an item in the conversation is deleted by the client with a conversation.item.delete event.[https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerConversationItemDeleted](https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerConversationItemDeleted)

Event constant: `RealtimeAPIEvents.ConversationItemDeleted`

**Payload**

<a id="-inputaudiobuffercommitted" />

Returned when an input audio buffer is committed.[https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerInputAudioBufferCommitted](https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerInputAudioBufferCommitted)

Event constant: `RealtimeAPIEvents.InputAudioBufferCommitted`

**Payload**

<a id="-inputaudiobuffercleared" />

Returned when the input audio buffer is cleared by the client with an input\_audio\_buffer.clear event.[https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerInputAudioBufferCleared](https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerInputAudioBufferCleared)

Event constant: `RealtimeAPIEvents.InputAudioBufferCleared`

**Payload**

<a id="-inputaudiobufferdtmfeventreceived" />

Returned when a DTMF event is received (telephony integrations). [https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerInputAudioBufferDtmfEventReceived](https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerInputAudioBufferDtmfEventReceived)

Event constant: `RealtimeAPIEvents.InputAudioBufferDTMFEventReceived`

**Payload**

<a id="-inputaudiobufferspeechstarted" />

Sent by the server when in server\_vad mode to indicate that speech has been detected in the audio buffer.[https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerInputAudioBufferSpeechStarted](https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerInputAudioBufferSpeechStarted)

Event constant: `RealtimeAPIEvents.InputAudioBufferSpeechStarted`

**Payload**

<a id="-inputaudiobufferspeechstopped" />

Returned in server\_vad mode when the server detects the end of speech in the audio buffer.[https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerInputAudioBufferSpeechStopped](https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerInputAudioBufferSpeechStopped)

Event constant: `RealtimeAPIEvents.InputAudioBufferSpeechStopped`

**Payload**

<a id="-inputaudiobuffertimeouttriggered" />

Returned when the Server VAD timeout is triggered for the input audio buffer.[https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerInputAudioBufferTimeoutTriggered](https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerInputAudioBufferTimeoutTriggered)

Event constant: `RealtimeAPIEvents.InputAudioBufferTimeoutTriggered`

**Payload**

<a id="-outputaudiobuffercleared" />

Returned when the output audio buffer is cleared.[https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerOutputAudioBufferCleared](https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerOutputAudioBufferCleared)

Event constant: `RealtimeAPIEvents.OutputAudioBufferCleared`

**Payload**

<a id="-outputaudiobufferstarted" />

Returned when the output audio buffer starts playing/streaming.[https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerOutputAudioBufferStarted](https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerOutputAudioBufferStarted)

Event constant: `RealtimeAPIEvents.OutputAudioBufferStarted`

**Payload**

<a id="-outputaudiobufferstopped" />

Returned when the output audio buffer stops.[https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerOutputAudioBufferStopped](https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerOutputAudioBufferStopped)

Event constant: `RealtimeAPIEvents.OutputAudioBufferStopped`

**Payload**

<a id="-responsecreated" />

Returned when a new Response is created.[https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerResponseCreated](https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerResponseCreated)

Event constant: `RealtimeAPIEvents.ResponseCreated`

**Payload**

<a id="-responsedone" />

Returned when a Response is done streaming.[https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerResponseDone](https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerResponseDone)

Event constant: `RealtimeAPIEvents.ResponseDone`

**Payload**

<a id="-responseoutputitemadded" />

Returned when a new Item is created during Response generation.[https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerResponseOutputItemAdded](https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerResponseOutputItemAdded)

Event constant: `RealtimeAPIEvents.ResponseOutputItemAdded`

**Payload**

<a id="-responseoutputitemdone" />

Returned when an Item is done streaming.[https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerResponseOutputItemDone](https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerResponseOutputItemDone)

Event constant: `RealtimeAPIEvents.ResponseOutputItemDone`

**Payload**

<a id="-responsecontentpartadded" />

Returned when a new content part is added to an assistant message item during response generation.[https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerResponseContentPartAdded](https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerResponseContentPartAdded)

Event constant: `RealtimeAPIEvents.ResponseContentPartAdded`

**Payload**

<a id="-responsecontentpartdone" />

Returned when a content part is done streaming in an assistant message item.[https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerResponseContentPartDone](https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerResponseContentPartDone)

Event constant: `RealtimeAPIEvents.ResponseContentPartDone`

**Payload**

<a id="-responseoutputtextdelta" />

Returned when the text value of an "output\_text" content part is updated.[https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerResponseOutputTextDelta](https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerResponseOutputTextDelta)

Event constant: `RealtimeAPIEvents.ResponseOutputTextDelta`

**Payload**

<a id="-responseoutputtextdone" />

Returned when the text value of an "output\_text" content part is done streaming.[https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerResponseOutputTextDone](https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerResponseOutputTextDone)

Event constant: `RealtimeAPIEvents.ResponseOutputTextDone`

**Payload**

<a id="-responseoutputaudiotranscriptdelta" />

Returned when the model-generated transcription of audio output is updated.[https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerResponseOutputAudioTranscriptDelta](https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerResponseOutputAudioTranscriptDelta)

Event constant: `RealtimeAPIEvents.ResponseOutputAudioTranscriptDelta`

**Payload**

<a id="-responseoutputaudiotranscriptdone" />

Returned when the model-generated transcription of audio output is done streaming.[https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerResponseOutputAudioTranscriptDone](https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerResponseOutputAudioTranscriptDone)

Event constant: `RealtimeAPIEvents.ResponseOutputAudioTranscriptDone`

**Payload**

<a id="-responseoutputaudiodone" />

Returned when the model-generated audio is done.[https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerResponseMcpCallArgumentsDone](https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerResponseMcpCallArgumentsDone)

Event constant: `RealtimeAPIEvents.ResponseOutputAudioDone`

**Payload**

<a id="-responsefunctioncallargumentsdelta" />

Returned when the model-generated function call arguments are updated.[https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerResponseFunctionCallArgumentsDelta](https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerResponseFunctionCallArgumentsDelta)

Event constant: `RealtimeAPIEvents.ResponseFunctionCallArgumentsDelta`

**Payload**

<a id="-responsefunctioncallargumentsdone" />

Returned when the model-generated function call arguments are done streaming.[https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerResponseFunctionCallArgumentsDone](https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerResponseFunctionCallArgumentsDone)

Event constant: `RealtimeAPIEvents.ResponseFunctionCallArgumentsDone`

**Payload**

<a id="-responsemcpcallargumentsdelta" />

Returned when MCP tool call arguments are updated during response generation.[https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerResponseMcpCallArgumentsDelta](https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerResponseMcpCallArgumentsDelta)

Event constant: `RealtimeAPIEvents.ResponseMCPCallArgumentsDelta`

**Payload**

<a id="-responsemcpcallargumentsdone" />

Returned when MCP tool call arguments are finalized during response generation.[https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerResponseMcpCallArgumentsDone](https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerResponseMcpCallArgumentsDone)

Event constant: `RealtimeAPIEvents.ResponseMCPCallArgumentsDone`

**Payload**

<a id="-responsemcpcallinprogress" />

Returned when an MCP tool call has started and is in progress.[https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerResponseMcpCallInProgress](https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerResponseMcpCallInProgress)

Event constant: `RealtimeAPIEvents.ResponseMCPCallInProgress`

**Payload**

<a id="-responsemcpcallcompleted" />

Returned when an MCP tool call has completed successfully.[https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerResponseMcpCallCompleted](https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerResponseMcpCallCompleted)

Event constant: `RealtimeAPIEvents.ResponseMCPCallCompleted`

**Payload**

<a id="-responsemcpcallfailed" />

Returned when an MCP tool call has failed.[https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerResponseMcpCallFailed](https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerResponseMcpCallFailed)

Event constant: `RealtimeAPIEvents.ResponseMCPCallFailed`

**Payload**

<a id="-mcplisttoolsinprogress" />

Returned when listing MCP tools is in progress for an item.[https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerMcpListToolsInProgress](https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerMcpListToolsInProgress)

Event constant: `RealtimeAPIEvents.MCPListToolsInProgress`

**Payload**

<a id="-mcplisttoolscompleted" />

Returned when listing MCP tools has completed for an item.[https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerMcpListToolsCompleted](https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerMcpListToolsCompleted)

Event constant: `RealtimeAPIEvents.MCPListToolsCompleted`

**Payload**

<a id="-mcplisttoolsfailed" />

Returned when listing MCP tools has failed for an item.[https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerMcpListToolsFailed](https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerMcpListToolsFailed)

Event constant: `RealtimeAPIEvents.MCPListToolsFailed`

**Payload**

<a id="-ratelimitsupdated" />

Emitted at the beginning of a Response to indicate the updated rate limits.[https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerRateLimitsUpdated](https://yandex.cloud/ru/docs/ai-studio/serverEvents/realtimeServerRateLimitsUpdated)

Event constant: `RealtimeAPIEvents.RateLimitsUpdated`

**Payload**