Skip to content

docs: add embedding-driven semantic search guide and integrate with concepts#139

Merged
benhalpern merged 1 commit into
mainfrom
docs/semantic-search-guide
Jul 13, 2026
Merged

docs: add embedding-driven semantic search guide and integrate with concepts#139
benhalpern merged 1 commit into
mainfrom
docs/semantic-search-guide

Conversation

@benhalpern

@benhalpern benhalpern commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

This PR introduces a new documentation guide for the newly added embedding-driven semantic search functionality in Forem's API.

Summary of Changes:

  1. New Guide: Created docs/semantic-search.md documenting the new GET /api/articles/semantic_search and GET /api/concepts/search endpoints, highlighting parameters like threshold, explanations of distance vs. similarity, and curl request/response examples.
  2. Concepts Guide Update: Updated docs/concepts.md to document the semantic concept search endpoint (GET /api/concepts/search) and cross-link to the new Semantic Search guide.
  3. API Reference Index Link: Linked the new guide in docs/api.md for better discoverability.

View with Codesmith Autofix with Codesmith
Need help on this PR? Tag /codesmith with what you need. Autofix is disabled.

@benhalpern
benhalpern requested a review from a team as a code owner July 13, 2026 22:07
@benhalpern
benhalpern merged commit 27a0a24 into main Jul 13, 2026
5 of 6 checks passed
@benhalpern
benhalpern deleted the docs/semantic-search-guide branch July 13, 2026 22:08
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