RAGSearchUnity

RagSearchUnity: pesquisa semântica na unidade!

A RagSearchUnity permite implementar a pesquisa semântica no mecanismo de unidade.
É um sistema de geração aumentada de recuperação (RAG) capacitada pelos melhores modelos de recuperação de código aberto disponíveis.
A RagSearchUnity é construída sobre as impressionantes transformistas e bibliotecas de pesquisa.

_{De relance • Como ajudar • Configuração • Como usar • Exemplos • Licença}

De relance

• Plataforma cruzada! Windows, Linux e MacOS
• ? Executa localmente sem acesso à Internet. Nenhum dado nunca sai do jogo!
• ⚡ Pesquisa rápida em chamas com vizinhos aproximados mais próximos (Ann)
• ? Suporte dos melhores modelos de recuperação
• ? Fácil de configurar e usar
• ? Livre para usar para fins pessoais e comerciais

Testado na Unidade: 2021 LTS, 2022 LTS, 2023

Como ajudar

• Junte -se a nós na Discord e diga oi!
• Estrela o repositório e espalhe a notícia sobre o projeto!
• Envie solicitações ou bugs de recurso como problemas ou até mesmo envie um PR e torne -se um colaborador!

Configurar

• Abra o gerenciador de pacotes em Unity: Window > Package Manager
• Clique no botão + e selecione Add package from git URL
• Use o URL do repositório https://github.com/undreamai/RAGSearchUnity.git e clique em Add

Como usar

A RagSearchUnity implementa uma funcionalidade de pesquisa de similaridade super-rápida com um sistema de geração de recuperação upentada (RAG).
Isso funciona da seguinte maneira.

Construindo os dados que você fornece entradas de texto (uma frase, parágrafo, documento) para adicionar aos dados
Cada entrada é dividida em frases (opcionais) e codificada em incorporações com um modelo de aprendizado profundo.

Pesquisando você pode procurar uma entrada de texto de consulta.
A entrada é novamente codificada e as entradas ou frases de texto mais semelhantes nos dados são recuperadas.

Para usar a pesquisa:

• Crie um GameObject vazio para o modelo de incorporação ?.
  No inspetor GameObject, clique em Add Component e selecione o script Embedding ).
• Selecione o modelo que você prefere na lista suspensa para fazer o download (BGE Small, BGE Base ou Minilm V6).

No seu script, você pode usá -lo da seguinte forma ?:

 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 ) ;
    .. .
  }
}

• Finalmente, no inspetor do GameObject do seu script, selecione a incorporação GameObject criada acima como a propriedade de incorporação.

Você pode salvar os dados junto com as incorporações:

search . Save ( " Embeddings.zip " ) ;

e carregue -os do disco:

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

Você também pode especificar os delimitadores para usar ou sem divisão:

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

Se você deseja gerenciar várias pesquisas independentes, o RagSearchUnity fornece a classe MultiSearchEngine para facilitar o uso:

 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 " ) ;

Isso é tudo !

Exemplos

A amostra Hamletsearch contém um sistema de pesquisa de exemplo para o Hamlet Play ?. Para instalar a amostra:

• Abra o gerenciador de pacotes: Window > Package Manager
• Selecione o pacote RAGSearchUnity . Na guia Samples , clique em Import ao lado da amostra.

A amostra pode ser executada com a Scene.unity Cena da unidade que ele contém dentro de sua pasta.
Na cena, selecione o GameObject Embedding e faça o download de um dos modelos ( Download model ).
Salve a cena, corra e aproveite!

Licença

A licença da RagSearchUnity é o MIT (Licença.md) e usa software e modelos de terceiros com licenças MIT e Apache (avisos de terceiros.md).