lucenenet

Bem-vindo ao Apache Lucene.NET

Pesquisa poderosa de texto completo para .NET

Apache Lucene.NET é uma biblioteca de pesquisa de texto completo de código aberto escrita em C#. É uma versão do popular projeto Java Apache Lucene.

Apache Lucene.NET é uma biblioteca .NET que fornece recursos poderosos de indexação e pesquisa, bem como verificação ortográfica, destaque de ocorrências e recursos avançados de análise/tokenização.

Lucene.NET versão 4.8 (ainda em beta) é executado em todos os lugares em que o .NET é executado, incluindo Windows, Unix, MacOS, Android e iOS.

O site Apache Lucene.NET está em: http://lucenenet.apache.org

Estruturas suportadas

Lucene.NET 3.0.3

• .NET Framework 4.0
• .NET Framework 3.5

Lucene.NET 4.8.0

• .NET 8.0
• .NET 6.0
• Padrão .NET 2.1
• Padrão .NET 2.0
• .NET Framework 4.6.2

Status

Versão de lançamento mais recente: Lucene.NET 3.0.3

Trabalhando em direção ao Lucene.NET 4.8.0 (atualmente em BETA)

• A versão beta é extremamente estável
• Tem mais de 7.800 testes de unidade aprovados
• Integra-se bem com .NET 8.0 e .NET 6.0 (bem como outras versões não suportadas)
• Suporta .NET Standard 2.1 e .NET Standard 2.0
• Suporta .NET Framework 4.6.2+
• Alguns desenvolvedores já o utilizam em ambientes de produção

Download

Lucene.NET 3.0.3

Biblioteca Central

 PM> Install-Package Lucene.Net

Todos os pacotes

• Lucene.Net - Biblioteca principal
• Lucene.Net.Contrib - Várias funcionalidades e extras contribuídos por usuários
• Lucene.Net.Contrib.Spatial - Pesquisa Geoespacial
• Lucene.Net.Contrib.Spatial.NTS - Pesquisa geoespacial com suporte para NetTopologySuite.

Lucene.NET 4.8.0

Biblioteca Central

 PM> Install-Package Lucene.Net -Pre

Todos os pacotes

• Lucene.Net - Biblioteca principal
• Lucene.Net.Analysis.Common – Analisadores para indexação de conteúdo em diferentes idiomas e domínios
• Lucene.Net.Analysis.Kuromoji - Analisador Morfológico Japonês
• Lucene.Net.Analysis.Morfologik - Analisador para lematização de dicionário, dicionário polonês integrado
• Lucene.Net.Analysis.OpenNLP - Integração com biblioteca OpenNLP
• Lucene.Net.Analysis.Phonetic - Analisador para indexação de assinaturas fonéticas (para pesquisa por sons semelhantes)
• Lucene.Net.Analysis.SmartCn - Analisador para indexação de chinês
• Lucene.Net.Analysis.Stempel - Analisador para indexação de polonês
• Lucene.Net.Benchmark - Sistema para benchmarking Lucene
• Lucene.Net.Classification - Módulo de classificação para Lucene
• Lucene.Net.Codecs - Codecs Lucene e formatos de postagem
• Lucene.Net.Expressions - Valores calculados dinamicamente para classificar/facetar/pesquisar com base em uma gramática conectável
• Lucene.Net.Facet - Indexação facetada e recursos de pesquisa
• Lucene.Net.Grouping - Coletores para agrupar resultados de pesquisa
• Lucene.Net.Highlighter - Destaca palavras-chave de pesquisa nos resultados
• Lucene.Net.ICU - Analisadores e marcadores especializados de ICU (componentes internacionais para Unicode)
• Lucene.Net.Join - junções de tempo de indexação e tempo de consulta para conteúdo normalizado
• Lucene.Net.Memory - Implementação de índice na memória de documento único
• Lucene.Net.Misc - Ferramentas de índice e outros códigos diversos
• Lucene.Net.Queries - Filtros e consultas que são adicionados ao núcleo do Lucene
• Lucene.Net.QueryParser - Analisadores de texto para consulta e estrutura de análise
• Utilitário de replicação de arquivos Lucene.Net.Replicator
• Lucene.Net.Sandbox – Várias contribuições de terceiros e novas ideias
• Lucene.Net.Spatial - Pesquisa geoespacial
• Lucene.Net.Suggest - Suporte para sugestão automática e verificação ortográfica
• Lucene.Net.TestFramework – Estrutura para testar aplicativos baseados em Lucene

Documentação

Temos documentação preliminar para Lucene.NET 4.8.0 no site Lucene.NET.

A API é semelhante ao Java Lucene 4.8.0, que também pode ser útil revisar.

NOTA: Estamos trabalhando para corrigir problemas com a documentação, mas precisaríamos de mais ajuda, pois é um projeto enorme. Veja #206.

Versões legadas

• Documentação da API Lucene.Net 3.0.3
• Documentação da API Lucene.Net 2.9.4

Demonstrações e ferramentas

Existem várias demonstrações implementadas como aplicativos de console simples que podem ser copiados e colados no Visual Studio ou compilados na linha de comando no projeto Lucene.Net.Demo.

Há também uma ferramenta de linha de comando dotnet disponível no NuGet. Ele contém todas as demonstrações, bem como ferramentas que mantêm seu índice Lucene.NET, apresentando operações como divisão, mesclagem, listagem de informações de segmento, correção, exclusão de segmentos, atualização, etc. contra isso!

• Pré-requisito: .NET 8.0 Runtime ou superior

 dotnet tool install lucene-cli -g --version 4.8.0-beta00015

NOTA: A versão da CLI que você instala deve corresponder à versão do Lucene.NET que você usa.

Depois de instalado, você pode explorar os comandos e opções disponíveis digitando o comando lucene .

Documentação lucene-cli

Como contribuir

Adoramos receber contribuições! Leia nosso Guia de Contribuição ou continue lendo para saber como você pode ajudar.

Junte-se a listas de discussão

Como ingressar em listas de discussão

Faça uma pergunta

Se você tiver uma pergunta geral sobre como fazer ou precisar de ajuda da comunidade Lucene.NET, inscreva-se na lista de discussão user enviando um e-mail para [email protected] e siga as instruções para verificar seu endereço de e-mail . Observe que você só precisa se inscrever uma vez.

Depois de se inscrever na lista de discussão, envie sua mensagem por e-mail para [email protected].

Alternativamente, você pode obter ajuda através da comunidade ativa do StackOverflow.

Não envie perguntas gerais de instruções ao GitHub, use o GitHub apenas para relatórios de bugs e tarefas.

Reportar um bug

Para relatar um bug, use o rastreador de problemas do GitHub.

NOTA: No passado, o projeto Lucene.NET usava o rastreador de problemas JIRA, que agora foi descontinuado. No entanto, estamos mantendo-o ativo para rastrear problemas legados. Envie quaisquer novos problemas ao GitHub.

Iniciar uma discussão

Para iniciar uma discussão de desenvolvimento sobre os recursos técnicos do Lucene.NET, envie um email para a lista de discussão dev enviando um email para [email protected] e siga as instruções para verificar seu endereço de email. Observe que você só precisa se inscrever uma vez.

Depois de se inscrever na lista de discussão, envie sua mensagem por e-mail para [email protected].

Envie uma solicitação pull

Antes de começar a trabalhar em uma solicitação pull, leia nosso guia de contribuição.

Construção e teste

Linha de comando

Pré-requisitos

1. PowerShell 5.0 ou superior (consulte esta pergunta para verificar sua versão do PowerShell)
2. SDK do .NET 8.0 ou superior

Execução

NOTA: Se o projeto estiver aberto no Visual Studio, sua restauração em segundo plano poderá interferir nesses comandos. É recomendável fechar todas as instâncias do Visual Studio que tenham Lucene.Net.sln abertas antes de executar.

Para construir o código-fonte, clone ou baixe e descompacte o repositório. Para versões específicas, baixe e descompacte o arquivo .src.zip da página de download da versão específica. No repositório ou raiz da distribuição, execute o comando build em um prompt de comando e inclua as opções desejadas na tabela de opções de build abaixo:

Windows

 > build [options]

Linux ou macOS

 ./build [options]

NOTA: O arquivo build precisará receber permissão para ser executado usando o comando chmod u+x build antes da primeira execução.

Opções de construção

As opções a seguir não diferenciam maiúsculas de minúsculas. Cada opção tem um formato abreviado indicado por um único - e um formato longo indicado por -- . As opções que exigem um valor devem ser seguidas por um espaço e, em seguida, pelo valor, semelhante à execução da CLI dotnet.

Curto	Longo	Descrição	Exemplo
-config	--configuração	A configuração de compilação ("Release" ou "Debug").	build ‑‑configuração Depuração
-mp	‑‑trabalhos paralelos máximos	O número máximo de trabalhos paralelos a serem executados durante o teste. Se não for fornecido, o padrão será 8.	build-t-mp 10
-pv	‑‑versão do pacote	A versão do pacote NuGet. Se não for fornecido, utilizará a versão do arquivo Version.proj.	build-pv 4.8.0-beta00001
-t	--teste	Executa os testes após a construção. Esta opção não requer um valor. Observe que o teste normalmente leva cerca de 40 minutos com 8 trabalhos paralelos.	construir -t
-fv	‑‑versão do arquivo	A versão do arquivo de montagem. Se não for fornecido, o padrão é o valor --package-version (excluindo qualquer rótulo de pré-lançamento). A versão assembly será derivada do componente de versão principal do valor passado, excluindo os componentes secundários, de construção e de revisão.	build ‑pv 4.8.0‑beta00001 ‑fv 4.8.0

Por exemplo, o comando a seguir cria um build de versão com o pacote NuGet versão 4.8.0-ci00015 e a versão de arquivo 4.8.0. A versão assembly será derivada do componente de versão principal do valor passado, excluindo os componentes secundários, de construção e de revisão (neste caso 4.0.0).

Windows

 > build ‑‑configuration Release ‑pv 4.8.0‑ci00015 ‑fv 4.8.0

Linux ou macOS

 ./build ‑‑configuration Release ‑pv 4.8.0‑ci00015 ‑fv 4.8.0

No exemplo acima, estamos usando "ci" na versão do pacote para indicar que esta não é uma versão beta lançada publicamente, mas sim a saída de uma construção de integração contínua do master que ocorreu após o beta00014, mas antes do lançamento do beta00015.

Os pacotes NuGet são gerados pela compilação no diretório /_artifacts/NuGetPackages/ . Os resultados do teste (se aplicável) são enviados para o diretório /_artifacts/TestResults/ .

Você pode configurar o Visual Studio para ler os pacotes NuGet como qualquer feed NuGet seguindo estas etapas:

1. No Visual Studio, clique com o botão direito na solução no Solution Explorer e escolha "Gerenciar pacotes NuGet para solução"
2. Clique no ícone de engrenagem próximo ao menu suspenso Fontes do pacote.
3. Clique no ícone + (para adicionar)
4. Dê um nome à fonte, como Lucene.Net Local Packages
5. Clique no botão ... próximo ao campo Origem e escolha a pasta /src/_artifacts/NuGetPackages em seu sistema local.
6. Clique em OK

Então, tudo o que você precisa fazer é escolher o feed Lucene.Net Local Packages no menu suspenso (no Gerenciador de pacotes NuGet) e você pode pesquisar, instalar e atualizar os pacotes NuGet da mesma forma que faria com qualquer feed baseado na Internet.

Estúdio visual

Pré-requisitos

1. Visual Studio 2022 ou superior
2. SDK do .NET 8.0 ou superior

Execução

1. Abra Lucene.Net.sln no Visual Studio.
2. Escolha a estrutura de destino a ser testada abrindo .build/TestTargetFramework.props e descomentando o <TargetFramework> correspondente (e comentando todos os outros).
3. Crie um projeto ou a solução inteira e aguarde o Visual Studio descobrir os testes – isso pode levar vários minutos.
4. Execute ou depure os testes no Test Explorer, opcionalmente usando os filtros desejados.

NOTA: Ao executar testes no Visual Studio, certifique-se de definir a arquitetura padrão do processador como 64 bits para evitar ficar sem memória virtual em alguns testes.

Azure DevOps

Configuramos nosso arquivo azure-pipelines.yml com padrões lógicos para que qualquer pessoa com uma conta Azure DevOps possa criar Lucene.NET e executar os testes com o mínimo de esforço. Até mesmo uma conta gratuita do Azure DevOps funcionará, mas os testes serão executados muito mais rapidamente se a conta for configurada como pública, o que permite a execução simultânea de até 10 trabalhos paralelos.

Pré-requisitos

1. Uma conta do Azure DevOps.
2. Uma bifurcação deste repositório no GitHub ou no Azure DevOps. O restante destas instruções pressupõe um fork do GitHub.

Execução

Se você ainda não tiver um pipeline configurado:

1. Crie uma organização Azure DevOps. Se você já possui um que deseja usar, pode pular esta etapa.
2. Crie um projeto Azure DevOps. Recomendamos nomear o projeto como Lucene.NET. Observe que se você estiver usando uma conta gratuita do Azure DevOps, deverá optar por tornar o projeto público para habilitar 10 trabalhos paralelos. Se você tornar o projeto privado, receberá apenas 1 trabalho paralelo. Além disso, se estiver desabilitando recursos, certifique-se de deixar o Pipelines habilitado.
3. Crie um pipeline do Azure DevOps.
   • Clique em “Pipelines” no menu esquerdo.
   • Clique no botão "Criar pipeline" ou "Novo pipeline", dependendo se já existe algum pipeline.
   • Selecione GitHub como local para encontrar o arquivo YAML.
   • Selecione o fork deste repositório que você criou em "Pré-requisitos". Observe que, se esta for uma nova conta do Azure DevOps, talvez seja necessário configurar permissões extras para acessar sua conta do GitHub.
   • Em seguida, é apresentada uma página "Revise seu YAML" mostrando o conteúdo de azure-pipelines.yml . Há documentação próxima ao topo do arquivo indicando as variáveis ​​que podem ser configuradas para habilitar opções adicionais, mas observe que a configuração padrão executará automaticamente a compilação e todos os testes.
   • Clique no botão “Executar” no canto superior direito da página.

Se você já tem um pipeline configurado:

1. Clique em “Pipelines” no menu esquerdo.
2. Selecione o pipeline que você deseja executar.
3. Clique no botão "Fila" no canto superior direito.
4. (Opcional) Selecione a ramificação e substitua quaisquer variáveis ​​no pipeline para esta execução.
5. Clique no botão "Executar".

Observe que após a conclusão da compilação, o artefato nuget contém arquivos .nupkg que podem ser baixados para sua máquina local, onde você pode configurar uma pasta local para atuar como um feed NuGet.

Também é possível adicionar um ID de feed do Azure DevOps a uma nova variável chamada ArtifactFeedID , mas estamos obtendo resultados mistos devido a problemas de permissão.