OpenApiFunctionDefinition Class
Definition
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 input definition information for an openapi function.
public class OpenApiFunctionDefinition : Azure.AI.AgentServer.Contracts.Generated.Common.IUtf8JsonSerializable, System.ClientModel.Primitives.IJsonModel<Azure.AI.AgentServer.Contracts.Generated.OpenAI.OpenApiFunctionDefinition>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.AgentServer.Contracts.Generated.OpenAI.OpenApiFunctionDefinition>type OpenApiFunctionDefinition = class
interface IUtf8JsonSerializable
interface IJsonModel<OpenApiFunctionDefinition>
interface IPersistableModel<OpenApiFunctionDefinition>Public Class OpenApiFunctionDefinition
Implements IJsonModel(Of OpenApiFunctionDefinition), IPersistableModel(Of OpenApiFunctionDefinition), IUtf8JsonSerializable- Inheritance
-
OpenApiFunctionDefinition
- Implements
Constructors
| Name | Description |
|---|---|
| OpenApiFunctionDefinition() |
Initializes a new instance of OpenApiFunctionDefinition for deserialization. |
| OpenApiFunctionDefinition(String, BinaryData, OpenApiAuthDetails) |
Initializes a new instance of OpenApiFunctionDefinition. |
| OpenApiFunctionDefinition(String, String, BinaryData, OpenApiAuthDetails, IList<String>, IList<OpenApiFunctionDefinitionFunction>, IDictionary<String, BinaryData>) |
Initializes a new instance of OpenApiFunctionDefinition. |
Properties
| Name | Description |
|---|---|
| Auth |
Open API authentication details Please note OpenApiAuthDetails is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include OpenApiAnonymousAuthDetails, OpenApiManagedAuthDetails and OpenApiProjectConnectionAuthDetails. |
| DefaultParams |
List of OpenAPI spec parameters that will use user-provided defaults. |
| Description |
A description of what the function does, used by the model to choose when and how to call the function. |
| Functions |
List of function definitions used by OpenApi tool. |
| Name |
The name of the function to be called. |
| Spec |
The openapi function shape, 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:
|
Methods
| Name | Description |
|---|---|
| DeserializeOpenApiFunctionDefinition(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<OpenApiFunctionDefinition>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
| IJsonModel<OpenApiFunctionDefinition>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
| IPersistableModel<OpenApiFunctionDefinition>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
| IPersistableModel<OpenApiFunctionDefinition>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
| IPersistableModel<OpenApiFunctionDefinition>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |
| IUtf8JsonSerializable.Write(Utf8JsonWriter) | |
