RAGSearchUnity下載RAGSearchUnity源代碼下載

RAGSearchUnity

其他源碼

v1.0.1

下載

ragsearchunity：Unity的語義搜索！

Ragsearchunity允許在Unity引擎內實現語義搜索。
這是一個檢索增強發電（RAG）系統，可通過可用的最佳開源檢索模型授權。
ragsearchunity建立在令人敬畏的尖銳轉換器和usearch庫的頂部。

_{一眼•如何提供幫助•設置•如何使用•示例•許可證}

一目了然

跨平台！ Windows，Linux和MacOS
？在本地運行而無需訪問Internet。沒有數據離開遊戲！
⚡大約最近的鄰居（ANN）大量快速搜索
？支持最佳檢索模型
？易於設置和使用
？免費用於個人和商業目的

在Unity上測試：2021 LTS，2022 LTS，2023

如何提供幫助

加入我們的不和諧，打個招呼！
明星倉庫並傳播有關該項目的信息！
提交功能請求或錯誤作為問題，甚至提交PR並成為合作者！

設定

在Unity中打開包裝管理器： Window > Package Manager
單擊+按鈕，然後Add package from git URL
使用存儲庫URL https://github.com/undreamai/RAGSearchUnity.git ，然後單擊Add

如何使用

Ragsearchunity通過檢索功能（RAG）系統實現超快速的相似性搜索功能。
這是如下所作的。

構建您提供文本輸入的數據（短語，段落，文檔）以添加到數據中
每個輸入分為句子（可選），並用深度學習模型編碼為嵌入。

搜索您可以搜索查詢文本輸入。
再次對輸入進行編碼，並檢索數據中最相似的文本輸入或句子。

使用搜索：

為嵌入模型創建一個空的遊戲對象？
在GameObject Inspector中，單擊Add Component ，然後選擇“ Embedding腳本”）。
從下拉列表中選擇您喜歡的模型以下載它（BGE Small，BGE Base或Minilm V6）。

在您的腳本中，您可以按以下方式使用它？：

 using RAGSearchUnity ;

public class MyScript : MonoBehaviour
{
  public Embedding embedding ;
  SearchEngine search ;

  void Game ( ) {
    .. .
    string [ ] inputs = new string [ ] {
      " Hi! I'm a search system. " , " the weather is nice. I like it. " , " I'm a RAG system "
    } ;
    // build the embedding
    EmbeddingModel model = embedding . GetModel ( ) ;
    search = new SearchEngine ( model ) ;
    foreach ( string input in inputs ) search . Add ( input ) ;
    // get the 2 most similar phrases
    string [ ] similar = search . Search ( " hello! " , 2 ) ;
    // or get the 2 most similar sentences
    string [ ] similarSentences = search . SearchSentences ( " hello! " , 2 ) ;
    .. .
  }
}

最後，在腳本的GameObject的檢查員中，選擇上面創建的嵌入遊戲對像作為嵌入屬性。

您可以將數據與嵌入一起保存：

search . Save ( " Embeddings.zip " ) ;

並從磁盤加載它們：

 SearchEngine search = SearchEngine . Load ( model , " Embeddings.zip " ) ;

您還可以指定要使用或不拆分的定係數：

 // use ".", "!", "?" as delimiters
search = new SearchEngine ( model , " .!? " ) ;
// don't split sentences
search = new SearchEngine ( model , null ) ;

如果要管理多個獨立搜索，Ragsearchunity提供了MultiSearchEngine類別，以易於使用：

 MultiSearchEngine multisearch = new MultiSearchEngine ( model ) ;

// add a text for a specific search
multisearch . Add ( " hi I'm Luke " , " search1 " ) ;
multisearch . Add ( " Searching, searching, searching... " , " search1 " ) ;
multisearch . Add ( " hi I'm Jane " , " search2 " ) ;

// search for similar text in all searches
string [ ] similar = multisearch . Search ( " hello! " , 2 ) ;
// search for similar texts within a specific search
string [ ] similar = multisearch . Search ( " hi there! " , 1 , " search1 " ) ;