Share via


OpenAPIFunctionEntry Class

Definition

The OpenAPIFunctionEntry.

public class OpenAPIFunctionEntry : System.ClientModel.Primitives.IJsonModel<Azure.AI.Projects.OpenAI.OpenAPIFunctionEntry>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Projects.OpenAI.OpenAPIFunctionEntry>
type OpenAPIFunctionEntry = class
    interface IJsonModel<OpenAPIFunctionEntry>
    interface IPersistableModel<OpenAPIFunctionEntry>
Public Class OpenAPIFunctionEntry
Implements IJsonModel(Of OpenAPIFunctionEntry), IPersistableModel(Of OpenAPIFunctionEntry)
Inheritance
OpenAPIFunctionEntry
Implements

Constructors

Name Description
OpenAPIFunctionEntry(String, BinaryData)

Initializes a new instance of OpenAPIFunctionEntry.

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" }.

Methods

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

Explicit Interface Implementations

Name Description
IJsonModel<OpenAPIFunctionEntry>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<OpenAPIFunctionEntry>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<OpenAPIFunctionEntry>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<OpenAPIFunctionEntry>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<OpenAPIFunctionEntry>.Write(ModelReaderWriterOptions)

Applies to