Class AIResourceBase

Inheritance
object
Object
ScriptableObject
AIResourceBase
ModelBase
Voice
Implements
Inherited Members
ScriptableObject.SetDirty()
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.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<T>(T)
Object.Instantiate<T>(T, Vector3, Quaternion)
Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
Object.Instantiate<T>(T, Transform)
Object.Destroy(Object)
Object.DestroyImmediate(Object)
Object.DontDestroyOnLoad(Object)
Object.DestroyObject(Object)
Object.FindObjectsOfType<T>()
Object.FindObjectsByType<T>(FindObjectsSortMode)
Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
Object.FindObjectOfType<T>()
Object.FindFirstObjectByType<T>()
Object.FindAnyObjectByType<T>()
Object.FindFirstObjectByType<T>(FindObjectsInactive)
Object.FindAnyObjectByType<T>(FindObjectsInactive)
Object.name
Object.hideFlags
Namespace: Glitch9.AIDevKit
Assembly: Glitch9.AIDevKit.dll
Syntax
public abstract class AIResourceBase : ScriptableObject, IAIResource, IData, IHasId<string>, IHasName, IDeprecatable

Fields

| Edit this page View Source

api

Declaration
[SerializableString(typeof(Api))]
[JsonConverter(typeof(SerializableStringEnumConverter<Api>))]
[SerializeField]
protected SerializableString<Api> api
Field Value
Type Description
SerializableString<Api>
| Edit this page View Source

deprecated

Declaration
[SerializeField]
protected bool deprecated
Field Value
Type Description
bool
| Edit this page View Source

displayName

Declaration
[SerializeField]
protected string displayName
Field Value
Type Description
string
| Edit this page View Source

id

Declaration
[SerializeField]
protected string id
Field Value
Type Description
string
| Edit this page View Source

locked

Declaration
[SerializeField]
protected bool locked
Field Value
Type Description
bool

Properties

| Edit this page View Source

Api

The API service this asset uses (e.g., OpenAI, Google). This information is used to route requests to the correct AIClient.

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

Id

The unique identifier of the asset If it's a model: "gpt-3.5-turbo", "gemini-pro-vision" If it's a voice: "alloy"(OpenAI), "21m00Tcm4TlvDq8ikWAM"(ElevenLabs)

Declaration
public string Id { get; }
Property Value
Type Description
string
| 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 abstract bool IsCustom { get; }
Property Value
Type Description
bool
| Edit this page View Source

IsDeprecated

Indicates whether the asset is deprecated and should not be used in production. CRUDService will throw an exception if a deprecated asset is used.

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

Name

The name of the asset If it's a model: "gpt-3.5-turbo", "gemini-pro-vision" If it's a voice: "alloy"(OpenAI), "rachel"(ElevenLabs) This is a human-readable name for the model that can be displayed in the UI or logs.

Declaration
public virtual string Name { get; }
Property Value
Type Description
string

Methods

| Edit this page View Source

Equals(AIResourceBase)

Declaration
public bool Equals(AIResourceBase other)
Parameters
Type Name Description
AIResourceBase other
Returns
Type Description
bool
| 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
UnityEngine.Object.GetHashCode()
| Edit this page View Source

ToString()

Returns the name of the object.

Declaration
public override string ToString()
Returns
Type Description
string

The name returned by ToString.
Overrides
UnityEngine.Object.ToString()

Operators

| Edit this page View Source

operator ==(AIResourceBase, AIResourceBase)

Declaration
public static bool operator ==(AIResourceBase a, AIResourceBase b)
Parameters
Type Name Description
AIResourceBase a
AIResourceBase b
Returns
Type Description
bool
| Edit this page View Source

implicit operator string(AIResourceBase)

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

operator !=(AIResourceBase, AIResourceBase)

Declaration
public static bool operator !=(AIResourceBase a, AIResourceBase b)
Parameters
Type Name Description
AIResourceBase a
AIResourceBase b
Returns
Type Description
bool

Implements

Extension Methods