OpenApiFunctionDefinitionFunction 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:: OpenApiFunctionDefinitionFunction.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 OpenApiFunctionDefinitionFunction.

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

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

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

Inheritance: Object
OpenApiFunctionDefinitionFunction

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

Constructors

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

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

Applies to

Feedback

Was this page helpful?