OpenAIRealtimeModel
Namespace: Vercel.AI.OpenAI
public sealed class OpenAIRealtimeModel : IRealtimeModelOpenAI Realtime session URI builder and WebSocket client.
Inheritance: object
Implements: IRealtimeModel
Constructors
Section titled “Constructors”OpenAIRealtimeModel(OpenAIProvider, string)
Section titled “OpenAIRealtimeModel(OpenAIProvider, string)”public OpenAIRealtimeModel(OpenAIProvider provider, string modelId)Creates a realtime model.
Parameters
| Name | Type | Description |
|---|---|---|
provider |
OpenAIProvider | |
modelId |
string |
Properties
Section titled “Properties”ModelId
Section titled “ModelId”public string ModelId { get; }Model id.
Value: string
Provider
Section titled “Provider”public string Provider { get; }Provider id.
Value: string
Methods
Section titled “Methods”BuildUri()
Section titled “BuildUri()”public Uri BuildUri()WebSocket URI for this model.
Returns: Uri
ConnectAsync(CancellationToken)
Section titled “ConnectAsync(CancellationToken)”public Task<IRealtimeSession> ConnectAsync(CancellationToken cancellationToken)Opens a realtime session.
Parameters
| Name | Type | Description |
|---|---|---|
cancellationToken |
CancellationToken |
Returns: Task<IRealtimeSession>
CreateClientSecretAsync(int?, CancellationToken)
Section titled “CreateClientSecretAsync(int?, CancellationToken)”public Task<OpenAIRealtimeClientSecret> CreateClientSecretAsync(int? expiresAfterSeconds, CancellationToken cancellationToken)Requests a realtime client secret. <code class=“paramref”>expiresAfterSeconds</code> is omitted when null.
Parameters
| Name | Type | Description |
|---|---|---|
expiresAfterSeconds |
int? | |
cancellationToken |
CancellationToken |
Returns: Task<OpenAIRealtimeClientSecret>
Apache-2.0 · Copyright 2023 Vercel, Inc. · unofficial community port, not an official Vercel product