mirror of
https://github.com/iLoveElysia/openbilibili.git
synced 2026-09-02 07:38:04 -05:00
179 lines
6.3 KiB
Markdown
179 lines
6.3 KiB
Markdown
# Riot search
|
||
|
||
<img align="right" src="logo/512px.svg" width="15%"/>
|
||
|
||
<!--<img align="right" src="https://raw.githubusercontent.com/go-ego/ego/master/logo.jpg">-->
|
||
<!--<a href="https://circleci.com/gh/go-ego/ego/tree/dev"><img src="https://img.shields.io/circleci/project/go-ego/ego/dev.svg" alt="Build Status"></a>-->
|
||
[](https://circleci.com/gh/go-ego/riot)
|
||
|
||
[](https://codecov.io/gh/go-ego/riot)
|
||
[](https://travis-ci.org/go-ego/riot)
|
||
[](https://goreportcard.com/report/github.com/go-ego/riot)
|
||
[](https://godoc.org/github.com/go-ego/riot)
|
||
[](https://github.com/go-ego/riot/releases/latest)
|
||
[](https://gitter.im/go-ego/ego?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
||
<!--<a href="https://github.com/go-ego/ego/releases"><img src="https://img.shields.io/badge/%20version%20-%206.0.0%20-blue.svg?style=flat-square" alt="Releases"></a>-->
|
||
|
||
<!--  -->
|
||
Go Open Source, Distributed, Simple and efficient full text search engine.
|
||
|
||
[简体中文](https://github.com/go-ego/riot/blob/master/README_zh.md)
|
||
|
||
# Features
|
||
|
||
* [Efficient indexing and search](/docs/en/benchmarking.md) (1M blog 500M data 28 seconds index finished, 1.65 ms search response time, 19K search QPS）
|
||
* Support for [logical search](https://github.com/go-ego/riot/blob/master/docs/en/logic.md)
|
||
* Support Chinese word segmentation (use [gse word segmentation package](https://github.com/go-ego/gse) concurrent word, speed 27MB / s）
|
||
* Support the calculation of the keyword in the text [close to the distance](/docs/en/token_proximity.md)（token proximity）
|
||
* Support calculation [BM25 correlation](/docs/en/bm25.md)
|
||
* Support [custom scoring field and scoring rules](/docs/en/custom_scoring_criteria.md)
|
||
* Support [add online, delete index](/docs/en/realtime_indexing.md)
|
||
* Support heartbeat
|
||
* Support multiple [persistent storage](/docs/en/persistent_storage.md)
|
||
* Support [distributed index and search](https://github.com/go-ego/riot/tree/master/data)
|
||
* Can be achieved [distributed index and search](/docs/en/distributed_indexing_and_search.md)
|
||
|
||
* [Look at Word segmentation rules](https://github.com/go-ego/riot/blob/master/docs/en/segmenter.md)
|
||
|
||
|
||
Riot v0.10.0 was released in Nov 2017, check the [Changelog](https://github.com/go-ego/riot/blob/master/docs/CHANGELOG.md) for the full details.
|
||
|
||
## Requirements
|
||
Go version >= 1.8
|
||
|
||
### Vendored Dependencies
|
||
|
||
Riot uses [dep](https://github.com/golang/dep) to vendor dependencies, but we don't commit the vendored packages themselves to the Riot git repository. Therefore, a simple go get is not supported because the command is not vendor aware.
|
||
|
||
Please manage it with dep, run `dep ensure`, to clone dependencies.
|
||
|
||
## Installation/Update
|
||
|
||
```
|
||
go get -u github.com/go-ego/riot
|
||
```
|
||
|
||
## [Build-tools](https://github.com/go-ego/re)
|
||
```
|
||
go get -u github.com/go-ego/re
|
||
```
|
||
### re riot
|
||
To create a new riot application
|
||
|
||
```
|
||
$ re riot my-riotapp
|
||
```
|
||
|
||
### re run
|
||
|
||
To run the application we just created, you can navigate to the application folder and execute:
|
||
```
|
||
$ cd my-riotapp && re run
|
||
```
|
||
|
||
## Usage:
|
||
|
||
#### [Look at an example](/examples/simple/main.go)
|
||
|
||
```go
|
||
package main
|
||
|
||
import (
|
||
"log"
|
||
|
||
"github.com/go-ego/riot"
|
||
"github.com/go-ego/riot/types"
|
||
)
|
||
|
||
var (
|
||
// searcher is coroutine safe
|
||
searcher = riot.Engine{}
|
||
)
|
||
|
||
func main() {
|
||
// Init
|
||
searcher.Init(types.EngineOpts{
|
||
// Using: 4,
|
||
NotUseGse: true,
|
||
})
|
||
defer searcher.Close()
|
||
|
||
text := "Google Is Experimenting With Virtual Reality Advertising"
|
||
text1 := `Google accidentally pushed Bluetooth update for Home
|
||
speaker early`
|
||
text2 := `Google is testing another Search results layout with
|
||
rounded cards, new colors, and the 4 mysterious colored dots again`
|
||
|
||
// Add the document to the index, docId starts at 1
|
||
searcher.Index(1, types.DocData{Content: text})
|
||
searcher.Index(2, types.DocData{Content: text1}, false)
|
||
searcher.IndexDoc(3, types.DocData{Content: text2}, true)
|
||
|
||
// Wait for the index to refresh
|
||
searcher.Flush()
|
||
// engine.FlushIndex()
|
||
|
||
// The search output format is found in the types.SearchResp structure
|
||
log.Print(searcher.Search(types.SearchReq{Text:"google testing"}))
|
||
}
|
||
```
|
||
|
||
It is very simple!
|
||
|
||
### Use default engine:
|
||
|
||
```Go
|
||
package main
|
||
|
||
import (
|
||
"log"
|
||
|
||
"github.com/go-ego/riot"
|
||
"github.com/go-ego/riot/types"
|
||
)
|
||
|
||
var (
|
||
searcher = riot.New("zh")
|
||
)
|
||
|
||
func main() {
|
||
data := types.DocData{Content: `I wonder how, I wonder why
|
||
, I wonder where they are`}
|
||
data1 := types.DocData{Content: "所以, 你好, 再见"}
|
||
data2 := types.DocData{Content: "没有理由"}
|
||
searcher.Index(1, data)
|
||
searcher.Index(2, data1)
|
||
searcher.Index(3, data2)
|
||
searcher.Flush()
|
||
|
||
req := types.SearchReq{Text: "你好"}
|
||
search := searcher.Search(req)
|
||
log.Println("search...", search)
|
||
}
|
||
```
|
||
|
||
#### [Look at more Examples](https://github.com/go-ego/riot/tree/master/examples)
|
||
|
||
#### [Look at Store example](https://github.com/go-ego/riot/blob/master/examples/store/main.go)
|
||
#### [Look at Logic search example](https://github.com/go-ego/riot/blob/master/examples/logic/main.go)
|
||
|
||
#### [Look at Pinyin search example](https://github.com/go-ego/riot/blob/master/examples/pinyin/main.go)
|
||
|
||
#### [Look at different dict and language search example](https://github.com/go-ego/riot/blob/master/examples/dict/main.go)
|
||
|
||
#### [Look at benchmark example](https://github.com/go-ego/riot/blob/master/examples/benchmark/benchmark.go)
|
||
|
||
#### [Riot search engine templates, client and dictionaries](https://github.com/go-ego/riot/tree/master/data)
|
||
|
||
## Donate
|
||
|
||
Supporting riot, [buy me a coffee](https://github.com/go-vgo/buy-me-a-coffee).
|
||
|
||
#### Paypal
|
||
|
||
Donate money by [paypal](https://www.paypal.me/veni0/25) to my account [vzvway@gmail.com](vzvway@gmail.com)
|
||
|
||
## License
|
||
|
||
Riot is primarily distributed under the terms of the Apache License (Version 2.0), base on [wukong](https://github.com/huichen/wukong).
|