Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update documentation according to v28 changelog #287

Draft
wants to merge 15 commits into
base: v28.0
Choose a base branch
from
Draft

Update documentation according to v28 changelog #287

wants to merge 15 commits into from
+860 −33

Conversation

tharropoulos
Copy link
Collaborator

@tharropoulos tharropoulos commented Jan 30, 2025 •
edited
Loading

Change Summary

Stemming and Word Handling

  1. Custom Stemming Dictionaries

    • Added new stemming.md documentation
    • Added navigation menu item for stemming
    • Added dictionary-based word mapping functionality
    • Updated collection schema with stem_dictionary parameter
    • Added pre-made English plurals dictionary with download link

  2. Field-Level Token Controls

    • Added field-level token_separators and symbols_to_index configuration
    • Updated collections schema with field-level parameter documentation
    • Added examples in search tips guide
    • Documented precedence rules over collection-level settings

Search Result Sorting

  1. Random Sorting

    • Added _rand() sorting parameter documentation
    • Documented seed value behavior and use cases
    • Added examples for both seeded and unseeded random sorting
    • Included tips for timestamp usage and combinations

  2. Pivot-Based Sorting

    • Added pivot sorting parameter documentation
    • Documented ascending/descending pivot behavior
    • Added examples with timestamp-based pivot sorting
    • Described use cases like reference point proximity

  3. Decay Function Sorting

    • Added documentation for gauss, linear, and exp decay functions
    • Included implementation details and parameter descriptions
    • Added timestamp-based decay sorting examples
    • Documented best practices for each decay type

  4. Text Match Score Bucketing

    • Added bucket_size parameter documentation
    • Described grouping of results into relevance buckets
    • Added examples showing bucketing with secondary sorting
    • Documented bucket size behavior and recommendations

Search Enhancement

  1. Hybrid Search Re-ranking
    • Added rerank_hybrid_matches parameter documentation
    • Updated vector search documentation with re-ranking behavior
    • Added examples showing score differences with re-ranking
    • Expanded semantic search guide with detailed explanations

Geographic Features

  1. Geographic Polygons
    • Added new geopolygon field type
    • Documented polygon area storage and point-in-polygon queries
    • Added creation and search examples for polygon territories
    • Updated field types documentation

Collection Management

  1. Collection Truncation
    • Added truncate collection endpoint documentation
    • Implemented code examples in all supported languages
    • Added sample response format
    • Documented difference between truncate and delete operations

PR Checklist

@tharropoulos
docs(stemming): add custom stemming dictionaries
63632e9 
- add new `stemming.md` documentation explaining basic and custom stemming
- add stemming menu item in navigation config.js
- update collections schema docs with custom stemming functionality
- update FAQs with custom stemming example and explanation
@tharropoulos
docs(sort_by): add random sorting functionality
0657780 
- add documentation for `_rand()` sorting parameter
- document seed value behavior and constraints
- add examples of random sorting with and without seeds
- include tips about timestamp usage and combining with other sorts
@tharropoulos
docs(hybrid-search): add hybrid match re-ranking functionality
ff2a54f 
- add documentation for `rerank_hybrid_matches` parameter
- update vector-search.md with re-ranking behavior and examples
- expand semantic-search guide with detailed re-ranking explanation
- add code samples showing score differences with re-ranking
@tharropoulos
docs(sort_by): add pivot sorting functionality
347ee47 
- add documentation for `pivot` sorting parameter
- describe ascending and descending pivot sort behavior
- include example with timestamp pivot sorting
- document use cases and combination with other sort fields
@tharropoulos
docs(stemming): clarify porter stemming behavior
6b16e7b 
- add disclaimer about rules-based stemming limitations
- explain potential side effects with brand names and locations
- clarify impact on search relevance for specialized content
@tharropoulos
docs(sort_by): add decay function sorting
dd9c641 
- add decay function sorting documentation with gauss, linear, exp functions
- include implementation details and parameter descriptions
- add examples using timestamp-based decay sorting
- document best practices and tips for each decay function
@tharropoulos
docs(stemming): add pre-made english plurals dictionary
7a1bcbe 
- add section about pre-made stemming dictionaries
- include download link for english plurals dictionary
- document benefits of using pre-made dictionary vs algorithmic stemming
@tharropoulos
docs(fields): add field-level token separators and symbols
0e07bdf 
- add support for field-level `token_separators` and `symbols_to_index` config
- update collections schema documentation with field-level parameters
- add example in search tips guide
- clarify precedence over collection-level settings
@tharropoulos
docs(sort_by): add text match score bucketing
c18b90e 
- add `bucket_size` parameter for text match score sorting
- implement grouping of results into relevance buckets
- add examples demonstrating bucketing with secondary sort criteria
- document bucket size behavior and best practices
@tharropoulos
docs(collections): add collection truncate operation
43b16a2 
- add truncate collection endpoint documentation
- implement code examples in all supported languages
- include sample response format
- explain difference between truncate and delete operations
@tharropoulos
docs(geo-poly): add support for geographic polygons
b19a8b9 
- add new `geopolygon` field type
- implement polygon area storage and point-in-polygon queries
- update field types documentation with geopolygon details
- add examples of creating and searching polygon territories
@tharropoulos
docs(search): add max_filter_by_candidates parameter
6466790 
- add control over fuzzy filter_by candidates limit
- update documentation for filter parameters
- add parameter description and default value
- document use case for prefix filtering control
@tharropoulos
docs(collections): add schema change status endpoint
b1eb0f4 
- add GET /operations/schema_changes endpoint documentation
- include sample response showing progress metrics
- document validation and alteration status tracking
- explain empty response behavior for no changes
@tharropoulos
docs(vector): add remote model API key update support
bb2ebf5 
- add API endpoint for updating embedding model API keys
- document PATCH request format for key updates
- include example for OpenAI embedding model
- add warning about required field parameters
@tharropoulos
docs(vector): clarify distance metrics behavior
ca96eee 
- document default cosine similarity metric
- explain distance_threshold behavior in different contexts
- add details about sorting with distance thresholds
- include examples of threshold usage
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@tharropoulos