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.

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

Extend Postman collection based on Typesense v28 #5

Open
wants to merge 9 commits into
base: master
Choose a base branch
from

Conversation

tharropoulos
Copy link

TLDR

Extended Postman collection with JOINs, Analytics, Image Search, Stemming, and Stopwords APIs.

Change Summary

What is this?

This PR enhances the Typesense Postman collection by adding several new API sections that cover advanced search functionalities. It adds examples for JOINs, Analytics, Query Suggestions, Image Search, Stemming, and Stopwords, making it easier for developers to test and understand Typesense's full capabilities.

Changes

Added Features:

  1. JOINs API Section:

    • Added folder with endpoints for creating related collections with references
    • Included examples for one-to-one relationships (books-authors)
    • Included examples for one-to-many relationships (customers-orders)
    • Demonstrated nested array results strategy for efficient data retrieval
  2. Analytics & Query Suggestions API Section:

    • Added endpoints for creating analytics collections and rules
    • Added endpoints for listing and deleting analytics rules
    • Included example for searching with query suggestions
    • Updated environment variables with analytics collection and rule names
  3. Image Search API Section:

    • Added endpoints for collection creation with image field
    • Included examples for indexing images with embedded vectors
    • Added search endpoints for text-to-image and image-to-image similarity search
    • Updated environment variables with image collection name
  4. Stemming API Section:

    • Added endpoints for importing, listing, and retrieving stemming dictionaries
    • Included example for creating collections with stemming configuration
    • Added environment variable for stemming dictionary name
  5. Stopwords API Section:

    • Added endpoints for creating, updating, and retrieving stopwords sets
    • Included example for searching with stopwords
    • Added environment variable for stopword set name
  6. Semantic Search Section:

    • Added folder for vector embedding-based semantic search
    • Included examples for creating collections with embedding fields
    • Added endpoint for semantic search queries
  7. Other Improvements:

    • Added endpoint for truncating collections
    • Fixed default API key in environment to use xyz instead of 1234
    • Added documentation links for all new API sections

Each new section includes examples with proper request configurations, making it easy for users to understand and experiment with Typesense's powerful search capabilities.

PR Checklist

- Add new stopwords API folder with 5 endpoints:
  - Create/update stopwords set
  - List all stopwords sets
  - Retrieve a specific stopwords set
  - Delete a stopwords set
  - Search with stopwords parameter
- Add `stopword_set_name` environment variable
- Include documentation link to Typesense stopwords API
- Add new stemming API folder with 4 endpoints:
 - Import stemming dictionary
 - List all stemming dictionaries
 - Retrieve a specific stemming dictionary
 - Create collection with stemming configuration
- Add `stemming_dictionary_name` environment variable
- Include documentation link to Typesense stemming API
- add new collection folder for image search API
- include endpoints for collection creation with image field
- add endpoints for indexing and searching images
- update environment variables with image collection name
- add new collection folder for analytics & query suggestions API
- include endpoints for creating analytics collections and rules
- add endpoints for listing and deleting analytics rules
- add endpoint for searching with query suggestions
- update environment variables with analytics collection and rule names
- add new collection folder for JOINs API
- include endpoints for creating related collections with references
- add examples for one-to-one and one-to-many relationship queries
- demonstrate nested array results strategy
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant