AI Dev Kit
Search Results for

    Show / Hide Table of Contents

    Class ResponseFormat

    Inheritance
    object
    ResponseFormat
    JsonSchemaFormat
    Namespace: Glitch9.AIDevKit
    Assembly: .dll
    Syntax
    public class ResponseFormat

    Constructors

    ResponseFormat()

    Declaration
    public ResponseFormat()

    ResponseFormat(Enum)

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

    ResponseFormat(string)

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

    Properties

    IsObject

    Declaration
    public bool IsObject { get; }
    Property Value
    Type Description
    bool

    IsString

    Declaration
    public bool IsString { get; protected set; }
    Property Value
    Type Description
    bool

    Type

    The type of the format returned by the API.

    Declaration
    public string Type { get; set; }
    Property Value
    Type Description
    string

    Methods

    Equals(object)

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

    Declaration
    public override bool Equals(object obj)
    Parameters
    Type Name Description
    object obj

    The object to compare with the current object.

    Returns
    Type Description
    bool

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

    Overrides
    object.Equals(object)

    GetHashCode()

    Serves as the default hash function.

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    int

    A hash code for the current object.

    Overrides
    object.GetHashCode()

    ToString()

    Returns a string that represents the current object.

    Declaration
    public override string ToString()
    Returns
    Type Description
    string

    A string that represents the current object.

    Overrides
    object.ToString()

    Operators

    operator ==(ResponseFormat, ResponseFormat)

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

    implicit operator string(ResponseFormat)

    Declaration
    public static implicit operator string(ResponseFormat wrapper)
    Parameters
    Type Name Description
    ResponseFormat wrapper
    Returns
    Type Description
    string

    implicit operator ResponseFormat(Enum)

    Declaration
    public static implicit operator ResponseFormat(Enum type)
    Parameters
    Type Name Description
    Enum type
    Returns
    Type Description
    ResponseFormat

    implicit operator ResponseFormat(string)

    Declaration
    public static implicit operator ResponseFormat(string type)
    Parameters
    Type Name Description
    string type
    Returns
    Type Description
    ResponseFormat

    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

    ResponseFormatExtensions.ToEnum<TFormatEnum>(ResponseFormat)
    In this article
    Back to top Generated by DocFX