RAGSearchUnity

Ragsearchunity: семантический поиск в Unity!

Ragsearchunity позволяет реализовать семантический поиск в двигателе Unity.
Это система извлечения дополненного поколения (RAG), наделенная лучшими доступными моделями поиска с открытым исходным кодом.
Ragsearchunity построена на вершине удивительных резких трансформаторов и библиотек Usearch.

_{С первого взгляда • Как помочь • Настройка • Как использовать • Примеры • Лицензия}

С первого взгляда

• Кросс-платформ! Windows, Linux и MacOS
• ? Работает локально без доступа к Интернету. Никакие данные никогда не покидают игру!
• ⚡ Быстрый прокатный поиск с приблизительными ближайшими соседями (ANN)
• ? Поддержка лучших моделей поиска
• ? Легко настроить и использовать
• ? Бесплатно использовать как для личных, так и для коммерческих целей

Проверено на Unity: 2021 LTS, 2022 LTS, 2023

Как помочь

• Присоединяйтесь к нам в Discord и скажите привет!
• Светь репо и распространить информацию о проекте!
• Отправьте запросы на функции или ошибки в качестве проблем или даже отправьте пиар и станьте сотрудником!

Настраивать

• Откройте менеджер пакетов в Unity: Window > Package Manager
• Нажмите кнопку + и выберите Add package from git URL
• Используйте URL репозитория https://github.com/undreamai/RAGSearchUnity.git и нажмите « Add

Как использовать

RagsearchUnity реализует супер-фанатную функциональность поиска сходства с помощью системы извлечения с аугированной (RAG).
Это работает следующим образом.

Создание данных, которые вы предоставляете текстовым входам (фраза, абзац, документ), чтобы добавить в данные
Каждый вход разделен на предложения (необязательно) и кодируется в встраивании с моделью глубокого обучения.

Поиск вы можете затем найти ввод текста запроса.
Ввод снова кодируется, и наиболее похожие текстовые входы или предложения в данных получены.

Чтобы использовать поиск:

• Создайте пустой GameObject для модели встраивания?
  В инспекторе GameObject нажмите 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 " ) ;

Вот и все !

Примеры

Образец HamletSearch содержит примерную систему поиска для игры Гамлета? Чтобы установить образец:

• Откройте диспетчер пакетов: Window > Package Manager
• Выберите пакет RAGSearchUnity . На вкладке Samples нажмите Import рядом с образцом.

Образец можно запустить со Scene.unity Сцена, которую он содержит в их папке.
В сцене выберите « Embedding GameObject» и загрузите одну из моделей ( Download model ).
Сохраните сцену, беги и наслаждайтесь!

Лицензия

Лицензия ragsearchunity-MIT (License.md) и использует сторонние программное обеспечение и модели с лицензиями MIT и Apache (сторонние уведомления.md).