RAGSearchUnity

ragsearchunity：unityでのセマンティック検索！

Ragsearchunityでは、Unityエンジン内でセマンティック検索を実装できます。
これは、利用可能な最高のオープンソース検索モデルに力を与えた検索拡張生成（RAG）システムです。
Ragsearchunityは、素晴らしいシャープ変換者とUsearchライブラリの上に構築されています。

_{一目で•支援方法•セットアップ•使用方法•例•ライセンス}

一目で

• クロスプラットフォーム！ Windows、Linux、MacOS
• ？インターネットにアクセスせずにローカルに実行されます。ゲームを離れるデータはありません！
• ⚡blazing近い最近の隣人との猛烈な検索（ANN）
• ？最良の検索モデルのサポート
• ？セットアップと使用が簡単です
• ？個人的および商業的な目的で自由に使用できます

Unityでテスト：2021 LTS、2022 LTS、2023

助ける方法

• Discordに参加して、こんにちはと言ってください！
• レポを主演し、プロジェクトについての言葉を広めましょう！
• 機能要求またはバグを問題として送信するか、PRを提出してコラボレーターになりましょう！

設定

• unityでパッケージマネージャーを開く： Window > Package Manager
• +ボタンをクリックして、 Add package from git URLを選択します
• リポジトリURL https://github.com/undreamai/RAGSearchUnity.gitを使用して、 Addをクリックします

使い方

Ragsearchunityは、検索された生成（RAG）システムを使用して、超高速類似性検索機能を実装しています。
これは次のように機能します。

データを提供するデータの構築（フレーズ、段落、ドキュメント）を提供してデータに追加します
各入力は文（オプション）に分割され、深い学習モデルの埋め込みにエンコードされます。

検索すると、クエリテキスト入力を検索できます。
入力は再びエンコードされ、データ内の最も類似したテキスト入力または文が取得されます。

検索を使用するには：

• 埋め込みモデルに空のGameObjectを作成しますか？
  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の検査官で、上記の埋め込みプロパティとして作成された埋め込み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 " ) ;

それだけです ！

例

HamleTearchサンプルには、ハムレットプレイの例の検索システムが含まれていますか？サンプルをインストールするには：

• パッケージマネージャーを開きます： Window > Package Manager
• RAGSearchUnityパッケージを選択します。 Samplesタブから、[サンプルの横にあるImportをクリックします。

サンプルは、フォルダー内に含まれるシーン。 Scene.unityシーンで実行できます。
シーンで、 Embedding GameObjectを選択し、モデルの1つをダウンロードします（ Download model ）。
シーンを保存し、走って楽しんでください！

ライセンス

RagsearchunityのライセンスはMIT（License.MD）であり、MITおよびApacheライセンス（サードパーティの通知）を使用してサードパーティのソフトウェアとモデルを使用します。