Class ResponseFormat

Namespace

Glitch9.AIDevKit

public class ResponseFormat

Inheritance

object

ResponseFormat

Derived

JsonSchemaFormat

Extension Methods

StrictJsonSchemaExtensions.ExtractJsonSchema(ResponseFormat, bool)

Constructors

ResponseFormat()

public ResponseFormat()

ResponseFormat(string)

public ResponseFormat(string type)

Parameters

type string

Properties

Auto

public static ResponseFormat Auto { get; }

Property Value

ResponseFormat

IsJsonSchema

public bool IsJsonSchema { get; }

Property Value

bool

IsObject

public bool IsObject { get; }

Property Value

bool

IsString

public bool IsString { get; protected set; }

Property Value

bool

JsonObject

public static ResponseFormat JsonObject { get; }

Property Value

ResponseFormat

Text

public static ResponseFormat Text { get; }

Property Value

ResponseFormat

Type

The type of the format returned by the API.

public string Type { get; set; }

Property Value

string

Methods

Equals(object)

Determines whether the specified object is equal to the current object.

public override bool Equals(object obj)

Parameters

obj object

The object to compare with the current object.

Returns

bool

true if the specified object is equal to the current object; otherwise, false.

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.

Operators

operator ==(ResponseFormat, ResponseFormat)

public static bool operator ==(ResponseFormat left, ResponseFormat right)

Parameters

left ResponseFormat

right ResponseFormat

Returns

bool

implicit operator StrictJsonSchema(ResponseFormat)

public static implicit operator StrictJsonSchema(ResponseFormat format)

Parameters

format ResponseFormat

Returns

StrictJsonSchema

implicit operator JsonSchema(ResponseFormat)

public static implicit operator JsonSchema(ResponseFormat format)

Parameters

format ResponseFormat

Returns

JsonSchema

implicit operator string(ResponseFormat)

public static implicit operator string(ResponseFormat wrapper)

Parameters

wrapper ResponseFormat

Returns

string

implicit operator ResponseFormat(StrictJsonSchema)

public static implicit operator ResponseFormat(StrictJsonSchema strictJsonSchema)

Parameters

strictJsonSchema StrictJsonSchema

Returns

ResponseFormat

implicit operator ResponseFormat(string)

public static implicit operator ResponseFormat(string type)

Parameters

type string

Returns

ResponseFormat

implicit operator ResponseFormat(Type)

public static implicit operator ResponseFormat(Type type)

Parameters

type Type

Returns

ResponseFormat

operator !=(ResponseFormat, ResponseFormat)

public static bool operator !=(ResponseFormat left, ResponseFormat right)

Parameters

left ResponseFormat

right ResponseFormat

Returns

bool