Skip to content

Commit

Permalink
Moving the app into the root directory.
Browse files Browse the repository at this point in the history
Signed-off-by: jzonthemtn <[email protected]>
  • Loading branch information
jzonthemtn committed Jan 2, 2025
1 parent bd2ffb3 commit eb8bb37
Show file tree
Hide file tree
Showing 145 changed files with 28 additions and 691 deletions.
14 changes: 14 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,17 @@ gradle-app.setting
.project
.classpath

# Ignore Gradle project-specific cache directory
.gradle

# Ignore Gradle build output directory
build

# intellij files
.idea/
*.iml
*.ipr
*.iws
build-idea/
out/

File renamed without changes.
File renamed without changes.
63 changes: 5 additions & 58 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,64 +1,11 @@
# Search Evaluation Framework
# OpenSearch Evaluation Framework

This repository contains the search quality evaluation framework as described in the [RFC](https://github.com/opensearch-project/OpenSearch/issues/15354).
This is an application to perform search evaluation.

Note: Some of the data files in this repository are tracked by `git lfs`.
## Building

## Repository Contents

* `data` - The data directory contains scripts for creating random UBI queries and events for purposes of development and testing.
* `opensearch-search-quality-evaluation-plugin` - An OpenSearch plugin that extends the OpenSearch Scheduler plugin that provides the ability to generate scheduled (and on-demand) implicit judgments from UBI data.
* `opensearch-search-quality-implicit-judgments` - A standalone Java application to generate implicit judgments from indexed UBI data.

## OpenSearch Search Quality Evaluation Plugin

This is an OpenSearch plugin that extends the OpenSearch Scheduler plugin that provides the ability to generate scheduled (and on-demand) implicit judgments from UBI data.

To use the plugin:

```
./gradlew build
cd opensearch-search-quality-evaluation-plugin
docker compose build
docker compose up
```

To create a schedule to generate implicit judgments:
Build the project from the top-level directory to build all projects.

```
curl -s -X POST "http://localhost:9200/_plugins/search_quality_eval/schedule?id=1&click_model=coec&job_name=test&interval=60" | jq
```

See the created job:

```
curl -s http://localhost:9200/search_quality_eval_scheduled_jobs/_search | jq
```

To run an on-demand job without scheduling:

mvn clean install
```
curl -X POST "http://localhost:9200/_plugins/search_quality_eval/judgments?click_model=coec&max_rank=20" | jq
```

To see the job runs:

```
curl -X POST "http://localhost:9200/search_quality_eval_completed_jobs/_search" | jq
```

See the first 10 judgments:

```
curl -s http://localhost:9200/judgments/_search | jq
```

## OpenSearch Search Quality Implicit Judgments

This is a standalone Java application to generate implicit judgments from indexed UBI data. It runs outside OpenSearch and queries the UBI indexes to get the data for calculating the implicit judgments.

To run it, run the `org.opensearch.eval.App` class. This will connect to OpenSearch running on `localhost:9200`. It expects the `ubi_events` and `ubi_queries` indexes to exist and be populated.

## License

This code is licensed under the Apache 2.0 License. See [LICENSE.txt](LICENSE.txt).
4 changes: 0 additions & 4 deletions build.gradle

This file was deleted.

File renamed without changes.
12 changes: 0 additions & 12 deletions gradle/libs.versions.toml

This file was deleted.

Binary file removed gradle/wrapper/gradle-wrapper.jar
Binary file not shown.
7 changes: 0 additions & 7 deletions gradle/wrapper/gradle-wrapper.properties

This file was deleted.

252 changes: 0 additions & 252 deletions gradlew

This file was deleted.

Loading

0 comments on commit eb8bb37

Please sign in to comment.