Share via


VoiceLiveFunctionDefinition Class

Definition

The definition of a function tool as used by the voicelive endpoint.

public class VoiceLiveFunctionDefinition : Azure.AI.VoiceLive.VoiceLiveToolDefinition, System.ClientModel.Primitives.IJsonModel<Azure.AI.VoiceLive.VoiceLiveFunctionDefinition>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.VoiceLive.VoiceLiveFunctionDefinition>
type VoiceLiveFunctionDefinition = class
    inherit VoiceLiveToolDefinition
    interface IJsonModel<VoiceLiveFunctionDefinition>
    interface IPersistableModel<VoiceLiveFunctionDefinition>
Public Class VoiceLiveFunctionDefinition
Inherits VoiceLiveToolDefinition
Implements IJsonModel(Of VoiceLiveFunctionDefinition), IPersistableModel(Of VoiceLiveFunctionDefinition)
Inheritance
VoiceLiveFunctionDefinition
Implements

Constructors

VoiceLiveFunctionDefinition(String)

Initializes a new instance of VoiceLiveFunctionDefinition.

Properties

Description

Gets or sets the Description.

Name

Gets or sets the Name.

Parameters

Gets or sets the Parameters.

To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"). : Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""). : Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }). : Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"). : Creates a payload of { "key": "value" }.

Methods

JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<VoiceLiveFunctionDefinition>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<VoiceLiveFunctionDefinition>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IJsonModel<VoiceLiveToolDefinition>.Create(Utf8JsonReader, ModelReaderWriterOptions) (Inherited from VoiceLiveToolDefinition)
IJsonModel<VoiceLiveToolDefinition>.Write(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from VoiceLiveToolDefinition)
IPersistableModel<VoiceLiveFunctionDefinition>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<VoiceLiveFunctionDefinition>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<VoiceLiveFunctionDefinition>.Write(ModelReaderWriterOptions)
IPersistableModel<VoiceLiveToolDefinition>.Create(BinaryData, ModelReaderWriterOptions) (Inherited from VoiceLiveToolDefinition)
IPersistableModel<VoiceLiveToolDefinition>.GetFormatFromOptions(ModelReaderWriterOptions) (Inherited from VoiceLiveToolDefinition)
IPersistableModel<VoiceLiveToolDefinition>.Write(ModelReaderWriterOptions) (Inherited from VoiceLiveToolDefinition)

Applies to