Mirror/MarginaliaSearch
1
0
Fork 0
mirror of https://github.com/MarginaliaSearch/MarginaliaSearch.git synced 2025-02-23 21:18:58 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

(docs) Improve query service documentation

Browse Source
This commit is contained in:
Viktor Lofgren 2024-01-13 21:16:45 +01:00
parent 07a916a720
commit c042650382
1 changed files with 11 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
code/services-core/query-service/readme.md
View File

@ -4,9 +4,18 @@ The [index-service](../index-service) speaks a lower level query specification l
that is difficult to build an application out of. The query service exists as an interpreter
to that format.
## Web Interface
The query service also offers a basic web interface for testing queries, or
running the search engine as a white-label service without all the Marginalia Search
specific stuff. This mode of operations is available through a `barebones` install.
The web interface also offers a JSON API for machine-based queries.
## Main Classes
* [QueryService](src/main/java/nu/marginalia/query/QueryService.java)
* [QueryService](src/main/java/nu/marginalia/query/QueryService.java) - The REST service implementation
* [QueryGRPCService](src/main/java/nu/marginalia/query/QueryGRPCService.java) - The GRPC service implementation
## See Also