ailiaLLM.AiliaLLMModel Class Reference

Inheritance diagram for ailiaLLM.AiliaLLMModel:

Collaboration diagram for ailiaLLM.AiliaLLMModel:

Public Member Functions
bool	Create ()
	Create a instance. More...
bool	Open (string model_path, uint n_ctx=0)
	Open a model. More...
bool	OpenMultimodalProjector (string mmproj_path)
	Open a multimodal projector file. More...
bool	GetMultimodalCapabilities (ref bool vision_support, ref bool audio_support)
	Check if multimodal features are supported. More...
virtual void	Close ()
	Destroys instance. More...
virtual void	Dispose ()
	Release resources. More...
bool	SetSamplingParam (uint top_k, float top_p, float temp, uint dist)
	Set the sampling parameter. More...
bool	SetPrompt (List< AiliaLLMChatMessage > messages)
	Set prompt messages. More...
bool	SetMultimodalPrompt (List< AiliaLLMMultimodalChatMessage > messages)
	Set multimodal prompt messages. More...
bool	Generate (ref bool done)
	Perform encode. More...
string	GetDeltaText ()
	Set prompt messages. More...
bool	ContextFull ()
	Check if the context length limit has been reached. More...
uint	PromptTokenCount ()
	Gets the number of prompt tokens. More...
uint	GeneratedTokenCount ()
	Gets the number of tokens generated. More...

Protected Member Functions
virtual void	Dispose (bool disposing)

Member Function Documentation

Close()

virtual void ailiaLLM.AiliaLLMModel.Close ( )

inlinevirtual

Destroys instance.

Destroys and initializes the instance.

    {
        if (net != IntPtr.Zero){
            AiliaLLM.ailiaLLMDestroy(net);
            net = IntPtr.Zero;
        }
    }

ContextFull()

bool ailiaLLM.AiliaLLMModel.ContextFull ( )

inline

Check if the context length limit has been reached.

Returns

True if the limit is reached, false otherwise.

    {
        return context_full;
    }

Create()

bool ailiaLLM.AiliaLLMModel.Create ( )

inline

Create a instance.

Returns

If this function is successful, it returns true , or false otherwise.

                        {
        if (net != IntPtr.Zero){
            Close();
        }
 
        int status = AiliaLLM.ailiaLLMCreate(ref net);
        if (status != 0){
            if (logging)
            {
                Debug.Log("ailiaLLMCreate failed " + status);
            }
            return false;
        }
 
        return true;
    }

Dispose() [1/2]

virtual void ailiaLLM.AiliaLLMModel.Dispose ( )

inlinevirtual

Release resources.

    {
        Dispose(true);
    }

Dispose() [2/2]

virtual void ailiaLLM.AiliaLLMModel.Dispose ( bool  disposing )

inlineprotectedvirtual

    {
        if (disposing){
            // release managed resource
        }
        Close(); // release unmanaged resource
    }

Generate()

bool ailiaLLM.AiliaLLMModel.Generate ( ref bool  done )

inline

Perform encode.

Parameters

done	Is done generation

Returns

If this function is successful, it returns array of tokens , or empty array otherwise.

    {
        uint done_uint = 0;
        int status = AiliaLLM.ailiaLLMGenerate(net, ref done_uint);
        context_full = false;
        done = (done_uint == 1);
        if (status != 0){
            if (logging)
            {
                Debug.Log("ailiaLLMGenerate failed " + status);
            }
            if (status == AiliaLLM.AILIA_LLM_STATUS_CONTEXT_FULL){
                context_full = true;
            }
            return false;
        }
        return true;
    }

GeneratedTokenCount()

uint ailiaLLM.AiliaLLMModel.GeneratedTokenCount ( )

inline

Gets the number of tokens generated.

Returns

Number of tokens generated. 0 if failed.

                                     {
        if (net == IntPtr.Zero){
            return 0;
        }
        uint count = 0;
        int status = AiliaLLM.ailiaLLMGetGeneratedTokenCount(net, ref count);
        if (status != 0){
            if (logging)
            {
                Debug.Log("ailiaLLMGetGeneratedTokenCount failed " + status);
            }
            return 0;
        }
        return count;
    }

GetDeltaText()

string ailiaLLM.AiliaLLMModel.GetDeltaText ( )

inline

Set prompt messages.

Returns

It returns text.

    {
        uint len = 0;
        int status = AiliaLLM.ailiaLLMGetDeltaTextSize(net, ref len);
        if (status != 0){
            if (logging)
            {
                Debug.Log("ailiaLLMGetDeltaTextSize failed " + status);
            }
            return "";
        }
        byte[] text = new byte [len];
        GCHandle handle = GCHandle.Alloc(text, GCHandleType.Pinned);
        IntPtr output = handle.AddrOfPinnedObject();
        status = AiliaLLM.ailiaLLMGetDeltaText(net, output, len);
        handle.Free();
        if (status != 0){
            if (logging)
            {
                Debug.Log("ailiaLLMGetDeltaText failed " + status);
            }
            return "";
        }
        
        byte[] new_buf = new byte [buf.Length + len - 1];
        for (int i = 0; i < buf.Length; i++){
            new_buf[i] = buf[i];
        }
        for (int i = 0; i < len - 1; i++){ // NULLの削除
            new_buf[buf.Length + i] = text[i];
        }
        buf = new_buf;
 
        string decoded_text = System.Text.Encoding.UTF8.GetString(buf); // Unicode Decode Errorは発生しない
        string delta_text = "";
        if (decoded_text.Length > before_text.Length){
            delta_text = decoded_text.Substring(before_text.Length);
        }
        before_text = decoded_text;
        return delta_text;
    }

GetMultimodalCapabilities()

bool ailiaLLM.AiliaLLMModel.GetMultimodalCapabilities ( ref bool  vision_support, ref bool  audio_support  )

inline

Check if multimodal features are supported.

Parameters

vision_support	Whether image processing is supported
audio_support	Whether audio processing is supported

Returns

If this function is successful, it returns true , or false otherwise.

                                                                                          {
        uint vision_uint = 0;
        uint audio_uint = 0;
        int status = AiliaLLM.ailiaLLMGetMultimodalCapabilities(net, ref vision_uint, ref audio_uint);
        if (status != 0){
            if (logging)
            {
                Debug.Log("ailiaLLMGetMultimodalCapabilities failed " + status);
            }
            return false;
        }
        vision_support = (vision_uint == 1);
        audio_support = (audio_uint == 1);
        return true;
    }

Open()

bool ailiaLLM.AiliaLLMModel.Open ( string  model_path, uint  n_ctx = 0  )

inline

Open a model.

Parameters

model_path	Path for model
n_ctx	Context length for model (0 is model default）

Returns

If this function is successful, it returns true , or false otherwise.

                                                       {
        if (net == IntPtr.Zero){
            return false;
        }
 
        int status = 0;
        
        status = AiliaLLM.ailiaLLMOpenModelFile(net, model_path, n_ctx);
        if (status != 0){
            if (logging)
            {
                Debug.Log("ailiaLLMOpenModelFile failed " + status);
            }
            return false;
        }
 
        return true;
    }

OpenMultimodalProjector()

bool ailiaLLM.AiliaLLMModel.OpenMultimodalProjector ( string  mmproj_path )

inline

Open a multimodal projector file.

Parameters

mmproj_path

Path for MMPROJ file

Returns

If this function is successful, it returns true , or false otherwise.

                                                           {
        if (net == IntPtr.Zero){
            return false;
        }
 
        int status = AiliaLLM.ailiaLLMOpenMultimodalProjectorFile(net, mmproj_path);
        if (status != 0){
            if (logging)
            {
                Debug.Log("ailiaLLMOpenMultimodalProjectorFile failed " + status);
            }
            return false;
        }
 
        return true;
    }

PromptTokenCount()

uint ailiaLLM.AiliaLLMModel.PromptTokenCount ( )

inline

Gets the number of prompt tokens.

Returns

Number of prompt tokens. 0 if failed.

                                  {
        if (net == IntPtr.Zero){
            return 0;
        }
        uint count = 0;
        int status = AiliaLLM.ailiaLLMGetPromptTokenCount(net, ref count);
        if (status != 0){
            if (logging)
            {
                Debug.Log("ailiaLLMGetPromptTokenCount failed " + status);
            }
            return 0;
        }
        return count;
    }

SetMultimodalPrompt()

bool ailiaLLM.AiliaLLMModel.SetMultimodalPrompt ( List< AiliaLLMMultimodalChatMessage >  messages )

inline

Set multimodal prompt messages.

Parameters

messages

Multimodal prompt messages

Returns

If this function is successful, it returns true , or false otherwise.

    {
        List<GCHandle> handle_list = new List<GCHandle>();
        int len = messages.Count;
        byte[][] role_text_list = new byte [len][];
        byte[][] content_text_list = new byte [len][];
        AiliaLLM.AILIALLMMultimodalChatMessage [] message_list = new AiliaLLM.AILIALLMMultimodalChatMessage[len];
        
        // Prepare media data arrays
        List<byte[][]> media_type_lists = new List<byte[][]>();
        List<byte[][]> media_path_lists = new List<byte[][]>();
        List<AiliaLLM.AILIALLMMediaData[]> media_data_arrays = new List<AiliaLLM.AILIALLMMediaData[]>();
        
        for (int i = 0; i < len; i++){
            AiliaLLM.AILIALLMMultimodalChatMessage message = new AiliaLLM.AILIALLMMultimodalChatMessage();
 
            // Set role and content
            role_text_list[i] = System.Text.Encoding.UTF8.GetBytes(messages[i].role+"\u0000");
            GCHandle role_handle = GCHandle.Alloc(role_text_list[i], GCHandleType.Pinned);
            IntPtr role_input = role_handle.AddrOfPinnedObject();
 
            content_text_list[i] = System.Text.Encoding.UTF8.GetBytes(messages[i].content+"\u0000");
            GCHandle content_handle = GCHandle.Alloc(content_text_list[i], GCHandleType.Pinned);
            IntPtr content_input = content_handle.AddrOfPinnedObject();
 
            message.role = role_input;
            message.content = content_input;
 
            handle_list.Add(role_handle);
            handle_list.Add(content_handle);
 
            // Handle media data
            if (messages[i].media_data != null && messages[i].media_data.Count > 0){
                int media_count = messages[i].media_data.Count;
                message.media_count = (uint)media_count;
                
                byte[][] media_type_list = new byte[media_count][];
                byte[][] media_path_list = new byte[media_count][];
                AiliaLLM.AILIALLMMediaData[] media_array = new AiliaLLM.AILIALLMMediaData[media_count];
                
                for (int j = 0; j < media_count; j++){
                    AiliaLLM.AILIALLMMediaData media = new AiliaLLM.AILIALLMMediaData();
                    
                    // Media type
                    media_type_list[j] = System.Text.Encoding.UTF8.GetBytes(messages[i].media_data[j].media_type+"\u0000");
                    GCHandle type_handle = GCHandle.Alloc(media_type_list[j], GCHandleType.Pinned);
                    media.media_type = type_handle.AddrOfPinnedObject();
                    handle_list.Add(type_handle);
                    
                    // File path
                    if (!string.IsNullOrEmpty(messages[i].media_data[j].file_path)){
                        media_path_list[j] = System.Text.Encoding.UTF8.GetBytes(messages[i].media_data[j].file_path+"\u0000");
                        GCHandle path_handle = GCHandle.Alloc(media_path_list[j], GCHandleType.Pinned);
                        media.file_path = path_handle.AddrOfPinnedObject();
                        handle_list.Add(path_handle);
                    } else {
                        media.file_path = IntPtr.Zero;
                    }
                    
                    // Raw data
                    if (messages[i].media_data[j].data != null && messages[i].media_data[j].data.Length > 0){
                        GCHandle data_handle = GCHandle.Alloc(messages[i].media_data[j].data, GCHandleType.Pinned);
                        media.data = data_handle.AddrOfPinnedObject();
                        media.data_size = (uint)messages[i].media_data[j].data.Length;
                        handle_list.Add(data_handle);
                    } else {
                        media.data = IntPtr.Zero;
                        media.data_size = 0;
                    }
                    
                    media.width = messages[i].media_data[j].width;
                    media.height = messages[i].media_data[j].height;
                    
                    media_array[j] = media;
                }
                
                media_type_lists.Add(media_type_list);
                media_path_lists.Add(media_path_list);
                media_data_arrays.Add(media_array);
                
                // Allocate and set media_data pointer
                int media_size = Marshal.SizeOf(typeof(AiliaLLM.AILIALLMMediaData)) * media_count;
                IntPtr media_ptr = Marshal.AllocHGlobal(media_size);
                
                for (int j = 0; j < media_count; j++){
                    IntPtr offset = new IntPtr(media_ptr.ToInt64() + j * Marshal.SizeOf(typeof(AiliaLLM.AILIALLMMediaData)));
                    Marshal.StructureToPtr(media_array[j], offset, false);
                }
                
                message.media_data = media_ptr;
            } else {
                message.media_count = 0;
                message.media_data = IntPtr.Zero;
            }
            
            message_list[i] = message;
        }
 
        int size = Marshal.SizeOf(typeof(AiliaLLM.AILIALLMMultimodalChatMessage)) * message_list.Length;
        IntPtr ptr = Marshal.AllocHGlobal(size);
 
        int status = 0;
 
        try
        {
            for (int i = 0; i < message_list.Length; i++)
            {
                IntPtr offset = new IntPtr(ptr.ToInt64() + i * Marshal.SizeOf(typeof(AiliaLLM.AILIALLMMultimodalChatMessage)));
                Marshal.StructureToPtr(message_list[i], offset, false);
            }
 
            status = AiliaLLM.ailiaLLMSetMultimodalPrompt(net, ptr, (uint)len);
        }
        finally
        {
            // Free allocated memory
            Marshal.FreeHGlobal(ptr);
            for (int i = 0; i < message_list.Length; i++){
                if (message_list[i].media_data != IntPtr.Zero){
                    Marshal.FreeHGlobal(message_list[i].media_data);
                }
            }
        }
 
        for (int i = 0; i < handle_list.Count; i++){
            handle_list[i].Free();
        }
 
        context_full = false;
        buf = new byte[0];
        before_text = "";
 
        if (status != 0){
            if (logging)
            {
                Debug.Log("ailiaLLMSetMultimodalPrompt failed " + status);
            }
            if (status == AiliaLLM.AILIA_LLM_STATUS_CONTEXT_FULL){
                context_full = true;
            }
            return false;
        }
 
        return true;
    }

SetPrompt()

bool ailiaLLM.AiliaLLMModel.SetPrompt ( List< AiliaLLMChatMessage >  messages )

inline

Set prompt messages.

Parameters

messages

Prompt messages

Returns

If this function is successful, it returns true , or false otherwise.

    {
        List<GCHandle> handle_list = new List<GCHandle>();
        int len = messages.Count;
        byte[][] role_text_list = new byte [len][];
        byte[][] conntent_text_list = new byte [len][];
        AiliaLLM.AILIAChatMessage [] message_list = new AiliaLLM.AILIAChatMessage[len];
        for (int i = 0; i< len; i++){
            AiliaLLM.AILIAChatMessage message = new AiliaLLM.AILIAChatMessage();
 
            role_text_list[i] = System.Text.Encoding.UTF8.GetBytes(messages[i].role+"\u0000");
            GCHandle role_handle = GCHandle.Alloc(role_text_list[i], GCHandleType.Pinned);
            IntPtr role_input = role_handle.AddrOfPinnedObject();
 
            conntent_text_list[i] = System.Text.Encoding.UTF8.GetBytes(messages[i].content+"\u0000");
            GCHandle content_handle = GCHandle.Alloc(conntent_text_list[i], GCHandleType.Pinned);
            IntPtr content_input = content_handle.AddrOfPinnedObject();
 
            message.role = role_input;
            message.content = content_input;
            message_list[i] = message;
 
            handle_list.Add(role_handle);
            handle_list.Add(content_handle);
        }
 
        int size = Marshal.SizeOf(typeof(AiliaLLM.AILIAChatMessage)) * message_list.Length;
        IntPtr ptr = Marshal.AllocHGlobal(size);
 
        int status = 0;
 
        try
        {
            for (int i = 0; i < message_list.Length; i++)
            {
                IntPtr offset = new IntPtr(ptr.ToInt64() + i * Marshal.SizeOf(typeof(AiliaLLM.AILIAChatMessage)));
                Marshal.StructureToPtr(message_list[i], offset, false);
            }
 
            status = AiliaLLM.ailiaLLMSetPrompt(net, ptr, (uint)len);
        }
        finally
        {
            Marshal.FreeHGlobal(ptr);
        }
 
        for (int i = 0; i < handle_list.Count; i++){
            handle_list[i].Free();
        }
 
        context_full = false;
        buf = new byte[0];
        before_text = "";
 
        if (status != 0){
            if (logging)
            {
                Debug.Log("ailiaLLMSetPrompt failed " + status);
            }
            if (status == AiliaLLM.AILIA_LLM_STATUS_CONTEXT_FULL){
                context_full = true;
            }
            return false;
        }
 
        return true;
    }

SetSamplingParam()

bool ailiaLLM.AiliaLLMModel.SetSamplingParam ( uint  top_k, float  top_p, float  temp, uint  dist  )

inline

Set the sampling parameter.

Parameters

top_k	Sampling probability value's top number, default 40
top_p	Sampling probability value range, default 0.9 (0.9 to 1.0)
temp	Temperature parameter, default 0.4
dist	Seed, default 1234

Returns

If this function is successful, it returns true , or false otherwise.

                                                                                {
        int status = AiliaLLM.ailiaLLMSetSamplingParams(net, top_k, top_p, temp, dist);
        if (status != 0){
            if (logging)
            {
                Debug.Log("ailiaLLMSetSamplingParams failed " + status);
            }
            return false;
        }
        return true;
    }

---

The documentation for this class was generated from the following file:

• AiliaLLMModel.cs