TREC OpenSearch Documentation
Website
Dashboard
Documentation
1. Participant guide
2. API Reference
3. Local API installation
4. Developer information
TREC OpenSearch Documentation
ΒΆ
1. Participant guide
1.1. Schedule
1.2. Key Concepts
1.3. Usage Scenarios
1.4. Implement a Client
1.4.1. Initialize
1.4.2. Obtain Queries
1.4.3. Obtain Doclists
1.4.4. Obtain Feedback and Update Runs
1.5. Running a Client
1.6. Getting Help
1.7. Citation
2. API Reference
2.1. API Reference for Participants
2.1.1. Query
2.1.2. Doclist
2.1.3. Doc
2.1.4. Run
2.1.5. Feedback
2.1.6. Outcome
2.1.7. Historical Feedback
2.2. API Reference for Sites
2.2.1. Query
2.2.2. Doclist
2.2.3. Doc
2.2.4. Ranking
2.2.5. Feedback
2.2.6. Historical Feedback
3. Local API installation
3.1. API Installation Tutorial
3.1.1. Obtain source code
3.1.2. Install prerequisites
3.1.3. Done?
3.1.4. Setup MongoDB
3.1.5. Run the API
3.1.6. Fill the Database
3.1.7. Running Clients
3.1.8. Dashboard Installation
3.2. Advanced options
3.2.1. Create users
3.2.2. Export the database
3.2.3. Reset the Database
3.2.4. Remove all runs for a participant
4. Developer information
4.1. Object structure
4.2. Information for developers
4.2.1. Run end-to-end test
4.2.2. Coding Style
4.2.3. Building Documentation
4.2.4. Replicating the MongoDB database
4.2.5. Install MongoDB on machine without root access