Search Results for

    Show / Hide Table of Contents

    Class Model

    ScriptableObject representation of a generative AI model with metadata, configuration, and pricing information. Supports token limits, ownership, creation time, and dynamic pricing for various content types (text, image, audio).

    Inheritance
    object
    Object
    ScriptableObject
    AIResourceBase
    ModelBase
    Model
    Implements
    IAIResource
    IData
    IHasId<string>
    IHasName
    IDeprecatable
    Inherited Members
    ModelBase.Type
    ModelBase.Capabilities
    ModelBase.Family
    ModelBase.InputModality
    ModelBase.OutputModality
    ModelBase.MaxN
    ModelBase.MaxInputTokens
    ModelBase.MaxOutputTokens
    ModelBase.IsFineTuned
    ModelBase.Prices
    ModelBase.ResourceName
    ModelBase.Voices
    ModelBase.EmbeddingDimension
    ModelBase.SupportedModes
    ModelBase.Supports(ModelCapability)
    ModelBase.GetApiKey()
    AIResourceBase.id
    AIResourceBase.displayName
    AIResourceBase.api
    AIResourceBase.deprecated
    AIResourceBase.locked
    AIResourceBase.Id
    AIResourceBase.Name
    AIResourceBase.Api
    AIResourceBase.IsDeprecated
    AIResourceBase.ToString()
    AIResourceBase.Equals(AIResourceBase)
    AIResourceBase.Equals(object)
    AIResourceBase.GetHashCode()
    ScriptableObject.SetDirty()
    ScriptableObject.CreateInstance(string)
    ScriptableObject.CreateInstance(Type)
    ScriptableObject.CreateInstance<T>()
    Object.GetEntityId()
    Object.GetInstanceID()
    Object.InstantiateAsync<T>(T)
    Object.InstantiateAsync<T>(T, Transform)
    Object.InstantiateAsync<T>(T, Vector3, Quaternion)
    Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)
    Object.InstantiateAsync<T>(T, int)
    Object.InstantiateAsync<T>(T, int, Transform)
    Object.InstantiateAsync<T>(T, int, Vector3, Quaternion)
    Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)
    Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion)
    Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion, CancellationToken)
    Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)
    Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, CancellationToken)
    Object.InstantiateAsync<T>(T, InstantiateParameters, CancellationToken)
    Object.InstantiateAsync<T>(T, int, InstantiateParameters, CancellationToken)
    Object.InstantiateAsync<T>(T, Vector3, Quaternion, InstantiateParameters, CancellationToken)
    Object.InstantiateAsync<T>(T, int, Vector3, Quaternion, InstantiateParameters, CancellationToken)
    Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, InstantiateParameters, CancellationToken)
    Object.Instantiate(Object, Vector3, Quaternion)
    Object.Instantiate(Object, Vector3, Quaternion, Transform)
    Object.Instantiate(Object)
    Object.Instantiate(Object, Scene)
    Object.Instantiate<T>(T, InstantiateParameters)
    Object.Instantiate<T>(T, Vector3, Quaternion, InstantiateParameters)
    Object.Instantiate(Object, Transform)
    Object.Instantiate(Object, Transform, bool)
    Object.Instantiate<T>(T)
    Object.Instantiate<T>(T, Vector3, Quaternion)
    Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
    Object.Instantiate<T>(T, Transform)
    Object.Instantiate<T>(T, Transform, bool)
    Object.Destroy(Object, float)
    Object.Destroy(Object)
    Object.DestroyImmediate(Object, bool)
    Object.DestroyImmediate(Object)
    Object.FindObjectsOfType(Type)
    Object.FindObjectsOfType(Type, bool)
    Object.FindObjectsByType(Type, FindObjectsSortMode)
    Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)
    Object.DontDestroyOnLoad(Object)
    Object.DestroyObject(Object, float)
    Object.DestroyObject(Object)
    Object.FindSceneObjectsOfType(Type)
    Object.FindObjectsOfTypeIncludingAssets(Type)
    Object.FindObjectsOfType<T>()
    Object.FindObjectsByType<T>(FindObjectsSortMode)
    Object.FindObjectsOfType<T>(bool)
    Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
    Object.FindObjectOfType<T>()
    Object.FindObjectOfType<T>(bool)
    Object.FindFirstObjectByType<T>()
    Object.FindAnyObjectByType<T>()
    Object.FindFirstObjectByType<T>(FindObjectsInactive)
    Object.FindAnyObjectByType<T>(FindObjectsInactive)
    Object.FindObjectsOfTypeAll(Type)
    Object.FindObjectOfType(Type)
    Object.FindFirstObjectByType(Type)
    Object.FindAnyObjectByType(Type)
    Object.FindObjectOfType(Type, bool)
    Object.FindFirstObjectByType(Type, FindObjectsInactive)
    Object.FindAnyObjectByType(Type, FindObjectsInactive)
    Object.name
    Object.hideFlags
    object.Equals(object, object)
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    Namespace: Glitch9.AIDevKit
    Assembly: Glitch9.AIDevKit.dll
    Syntax
    [JsonConverter(typeof(ModelConverter))]
    [CreateAssetMenu(menuName = "AI DevKit/AI Model", order = 2055)]
    public class Model : ModelBase, IAIResource, IData, IHasId<string>, IHasName, IDeprecatable

    Properties

    | Edit this page View Source

    IsCustom

    Indicates whether the asset is user-customized or not. If it's a model, it means the model is a fine-tuned version of a base model. If it's a voice, it means the voice is a custom voice created by the user.

    Declaration
    public override bool IsCustom { get; }
    Property Value
    Type Description
    bool
    Overrides
    AIResourceBase.IsCustom
    | Edit this page View Source

    IsLegacy

    Indicates whether the model is a legacy version. Legacy models often have a different endpoint or API structure.

    Declaration
    public override bool IsLegacy { get; }
    Property Value
    Type Description
    bool
    Overrides
    ModelBase.IsLegacy

    Methods

    | Edit this page View Source

    FirstValid(params string[])

    Declaration
    public static Model FirstValid(params string[] candidateIds)
    Parameters
    Type Name Description
    string[] candidateIds
    Returns
    Type Description
    Model
    | Edit this page View Source

    FirstValidId(params string[])

    Declaration
    public static string FirstValidId(params string[] candidateIds)
    Parameters
    Type Name Description
    string[] candidateIds
    Returns
    Type Description
    string
    | Edit this page View Source

    TryGet(out Model, params string[])

    Declaration
    public static bool TryGet(out Model model, params string[] candidateIds)
    Parameters
    Type Name Description
    Model model
    string[] candidateIds
    Returns
    Type Description
    bool

    Operators

    | Edit this page View Source

    implicit operator Model(string)

    Declaration
    public static implicit operator Model(string modelId)
    Parameters
    Type Name Description
    string modelId
    Returns
    Type Description
    Model

    Implements

    IAIResource
    IData
    IHasId<TId>
    IHasName
    IDeprecatable

    Extension Methods

    DefaultAgentSettingsUtility.EnsureAgentEmbeddingModel(Model)
    DefaultAgentSettingsUtility.EnsureAgentModerationModel(Model)
    DefaultAgentSettingsUtility.EnsureAgentTextGenerationModel(Model)
    DefaultAgentSettingsUtility.EnsureAgentUtilityModel(Model)
    ModelExtensions.EnsureModel(Model, ModelType, Model)
    ModelExtensions.EnsureModel(Model, ModelType, string)
    ModelExtensions.EnsureModel(Model, string)
    ModelPolicy.IsApi(Model, Api)
    ArrayExtensions.ToArrayOrEmpty<T>(T)
    ArrayExtensions.ToArrayOrNull<T>(T)
    EventExtensions.ToDelta<T>(T, string, int, string, bool)
    EventExtensions.ToDone<T>(T, string, int, string)
    EventExtensions.ToEvent<T>(T)
    EventExtensions.UpcastDelta<T1, T2>(T1, string, int, string, bool)
    FallbackExtensions.IsOr<TParent, TChild>(TParent, TChild)
    FileExtensions.ToFile<T>(T, string)
    ResponseCastingExtensions.GetResult<T>(T)
    ModelUtility.IsDalle2(ModelBase)
    ModelUtility.IsDalle3(ModelBase)
    ModelUtility.IsGemini(ModelBase)
    ModelUtility.IsGoogleImagen(ModelBase)
    ModelUtility.IsGptImage(ModelBase)
    ModelUtility.IsLanguageModel(ModelBase)
    ModelUtility.IsVeo2(ModelBase)
    ModelUtility.IsVeo3(ModelBase)
    ModelUtility.IsVeo3_1(ModelBase)
    ModelUtility.SupportsInpainting(ModelBase)
    CoreLibTypeExtensions.GetNameOrDash(IData)
    CoreLibTypeExtensions.GetIdOrNull(IHasId<string>)
    CoreLibTypeExtensions.IsNullOrEmptyId(IHasId<string>)
    SystemExtensions.GetName(object)
    UnityObjectExtensions.EncodeToBase64(Object)
    UnityObjectExtensions.ToBytes(Object)
    • Edit this page
    • View Source
    In this article
    Back to top AI DevKit Documentation