Class ResponseFormat

Inheritance
object
ResponseFormat
JsonSchemaFormat
Inherited Members
Namespace: Glitch9.AIDevKit
Assembly: Glitch9.AIDevKit.dll
Syntax
[JsonConverter(typeof(ResponseFormatConverter))]
public class ResponseFormat

Constructors

| Edit this page View Source

ResponseFormat()

Declaration
[JsonConstructor]
public ResponseFormat()
| Edit this page View Source

ResponseFormat(string)

Declaration
public ResponseFormat(string type)
Parameters
Type Name Description
string type

Properties

| Edit this page View Source

Auto

Declaration
public static ResponseFormat Auto { get; }
Property Value
Type Description
ResponseFormat
| Edit this page View Source

IsJsonSchema

Declaration
public bool IsJsonSchema { get; }
Property Value
Type Description
bool
| Edit this page View Source

IsObject

Declaration
public bool IsObject { get; }
Property Value
Type Description
bool
| Edit this page View Source

IsString

Declaration
public bool IsString { get; protected set; }
Property Value
Type Description
bool
| Edit this page View Source

JsonObject

Declaration
public static ResponseFormat JsonObject { get; }
Property Value
Type Description
ResponseFormat
| Edit this page View Source

Text

Declaration
public static ResponseFormat Text { get; }
Property Value
Type Description
ResponseFormat
| Edit this page View Source

Type

The type of the format returned by the API.

Declaration
[JsonProperty("type")]
public string Type { get; set; }
Property Value
Type Description
string

Methods

| Edit this page View Source

Equals(object)

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
object obj
Returns
Type Description
bool
Overrides
| Edit this page View Source

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
int
Overrides
| Edit this page View Source

ToString()

Declaration
public override string ToString()
Returns
Type Description
string
Overrides

Operators

| Edit this page View Source

operator ==(ResponseFormat, ResponseFormat)

Declaration
public static bool operator ==(ResponseFormat left, ResponseFormat right)
Parameters
Type Name Description
ResponseFormat left
ResponseFormat right
Returns
Type Description
bool
| Edit this page View Source

implicit operator StrictJsonSchema(ResponseFormat)

Declaration
public static implicit operator StrictJsonSchema(ResponseFormat format)
Parameters
Type Name Description
ResponseFormat format
Returns
Type Description
StrictJsonSchema
| Edit this page View Source

implicit operator JsonSchema(ResponseFormat)

Declaration
public static implicit operator JsonSchema(ResponseFormat format)
Parameters
Type Name Description
ResponseFormat format
Returns
Type Description
JsonSchema
| Edit this page View Source

implicit operator string(ResponseFormat)

Declaration
public static implicit operator string(ResponseFormat wrapper)
Parameters
Type Name Description
ResponseFormat wrapper
Returns
Type Description
string
| Edit this page View Source

implicit operator ResponseFormat(StrictJsonSchema)

Declaration
public static implicit operator ResponseFormat(StrictJsonSchema strictJsonSchema)
Parameters
Type Name Description
StrictJsonSchema strictJsonSchema
Returns
Type Description
ResponseFormat
| Edit this page View Source

implicit operator ResponseFormat(string)

Declaration
public static implicit operator ResponseFormat(string type)
Parameters
Type Name Description
string type
Returns
Type Description
ResponseFormat
| Edit this page View Source

implicit operator ResponseFormat(Type)

Declaration
public static implicit operator ResponseFormat(Type type)
Parameters
Type Name Description
Type type
Returns
Type Description
ResponseFormat
| Edit this page View Source

operator !=(ResponseFormat, ResponseFormat)

Declaration
public static bool operator !=(ResponseFormat left, ResponseFormat right)
Parameters
Type Name Description
ResponseFormat left
ResponseFormat right
Returns
Type Description
bool

Extension Methods