CatgirlIntelligenceAgency/code/services-core/index-service/readme.md

# Index Service

The index service knows which document contains which keywords. 

## Central Classes

* [IndexService](src/main/java/nu/marginalia/index/IndexService.java) is the REST entry point that the internal API talks to.
* [IndexQueryService](src/main/java/nu/marginalia/index/svc/IndexQueryService.java) executes queries. 
* [SearchIndex](src/main/java/nu/marginalia/index/index/SearchIndex.java) owns the state of the index and helps with building a query strategy from parameters.
* [IndexResultValuator](src/main/java/nu/marginalia/index/results/IndexResultValuator.java) determines the best results.

## See Also

The index service relies heavily on the primitives in [index](../../index), 
such as [index/index-forward](../../index/index-forward/), [index/index-reverse](../../index/index-reverse/),
and [index/index-query](../../index/index-query).
Restructuring the git repo 2023-03-04 14:00:46 +01:00			`# Index Service`

			`The index service knows which document contains which keywords.`

			`## Central Classes`

			`* [IndexService](src/main/java/nu/marginalia/index/IndexService.java) is the REST entry point that the internal API talks to.`
			`* [IndexQueryService](src/main/java/nu/marginalia/index/svc/IndexQueryService.java) executes queries.`
			`* [SearchIndex](src/main/java/nu/marginalia/index/index/SearchIndex.java) owns the state of the index and helps with building a query strategy from parameters.`
index service readme refers to index primitives 2023-03-05 19:16:08 +01:00			`* [IndexResultValuator](src/main/java/nu/marginalia/index/results/IndexResultValuator.java) determines the best results.`

			`## See Also`

			`The index service relies heavily on the primitives in [index](../../index),`
More readmes, cleaning up dead code. 2023-03-05 19:31:43 +01:00			`such as [index/index-forward](../../index/index-forward/), [index/index-reverse](../../index/index-reverse/),`
			`and [index/index-query](../../index/index-query).`