AzureFunctionDefinitionFunction Class

Definition

Namespace:: Azure.AI.AgentServer.Contracts.Generated.OpenAI

Assembly:: Azure.AI.AgentServer.Contracts.dll

Package:: Azure.AI.AgentServer.Contracts v1.0.0-beta.4

Source:: AzureFunctionDefinitionFunction.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

The AzureFunctionDefinitionFunction.

public class AzureFunctionDefinitionFunction : Azure.AI.AgentServer.Contracts.Generated.Common.IUtf8JsonSerializable, System.ClientModel.Primitives.IJsonModel<Azure.AI.AgentServer.Contracts.Generated.OpenAI.AzureFunctionDefinitionFunction>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.AgentServer.Contracts.Generated.OpenAI.AzureFunctionDefinitionFunction>

type AzureFunctionDefinitionFunction = class
    interface IUtf8JsonSerializable
    interface IJsonModel<AzureFunctionDefinitionFunction>
    interface IPersistableModel<AzureFunctionDefinitionFunction>

Public Class AzureFunctionDefinitionFunction
Implements IJsonModel(Of AzureFunctionDefinitionFunction), IPersistableModel(Of AzureFunctionDefinitionFunction), IUtf8JsonSerializable

Inheritance: Object
AzureFunctionDefinitionFunction

Implements: IUtf8JsonSerializable IJsonModel<AzureFunctionDefinitionFunction> IPersistableModel<AzureFunctionDefinitionFunction> IPersistableModel<T>

Constructors

Name	Description
AzureFunctionDefinitionFunction()	Initializes a new instance of AzureFunctionDefinitionFunction for deserialization.
AzureFunctionDefinitionFunction(String, BinaryData)	Initializes a new instance of AzureFunctionDefinitionFunction.
AzureFunctionDefinitionFunction(String, String, BinaryData, IDictionary<String,BinaryData>)	Initializes a new instance of AzureFunctionDefinitionFunction.

Properties

Name	Description
Description	A description of what the function does, used by the model to choose when and how to call the function.
Name	The name of the function to be called.
Parameters	The parameters the functions accepts, described as a JSON Schema object. 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" }.

Name

Description

A description of what the function does, used by the model to choose when and how to call the function.

Name

The name of the function to be called.

Parameters

The parameters the functions accepts, described as a JSON Schema object.

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

Name	Description
DeserializeAzureFunctionDefinitionFunction(JsonElement, ModelReaderWriterOptions)
FromResponse(Response)	Deserializes the model from a raw response.
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
ToRequestContent()	Convert into a RequestContent.

Explicit Interface Implementations

Name	Description
IJsonModel<AzureFunctionDefinitionFunction>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<AzureFunctionDefinitionFunction>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<AzureFunctionDefinitionFunction>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<AzureFunctionDefinitionFunction>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<AzureFunctionDefinitionFunction>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.
IUtf8JsonSerializable.Write(Utf8JsonWriter)

Applies to

Feedback

Was this page helpful?