Add semantic search workshop#172
Open
keshawillz wants to merge 1 commit into
Open
Conversation
Signed-off-by: Kesha Williams <KeshaS@comcast.net>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
A 10-minute hands-on workshop that builds semantic search over real GitHub issues using Oracle AI Database 26ai,
langchain-oracledb, and GitHub Codespaces. Pulls 15 recent issues fromoracle/python-oracledb, embeds them withsentence-transformers, runs similarity and hybrid-filter queries, and shows the rawVECTOR_DISTANCEandJSON_VALUESQL running underneath the LangChain abstraction.The exact question it answers
How do I use Oracle AI Database and
langchain-oracledbto find semantically similar text records, and how do I combine vector similarity with metadata filters like status and labels?Target audience
Intermediate Python developers (familiar with REST APIs and basic SQL, new to vector search).
How to run
Follow the sparse-checkout instructions in the workshop README to pull just this folder, install dependencies from
.devcontainer/requirements.txt, set up FreeSQL credentials in a.envfile (template provided), opennotebook.ipynb, and run all cells. End-to-end runs in well under a minute.What's in the PR
workshops/semantic-search-github-issues/notebook.ipynbworkshops/semantic-search-github-issues/README.mdworkshops/semantic-search-github-issues/.devcontainer/devcontainer.jsonworkshops/semantic-search-github-issues/.devcontainer/requirements.txtworkshops/semantic-search-github-issues/.devcontainer/cache_model.pyall-MiniLM-L6-v2at container build timeworkshops/semantic-search-github-issues/.env.exampleworkshops/semantic-search-github-issues/.gitignore.envfrom commitsWhat the workshop covers
python-oracledbthin mode, credentials loaded from.envDocumentobjects with metadataHuggingFaceEmbeddingsOracleVS.from_documents()similarity_search)state=openmetadata filter)VECTOR_DISTANCEandJSON_VALUEto show the underlying database operationsSponsorship disclosure
This workshop was developed in partnership with Oracle via Freeman & Forrest. The disclosure is included in the workshop's README and in the accompanying YouTube video description.
OCA
Signed and approved under Kesha Williams (KeshaS@comcast.net). All commits in this PR are signed off with the matching email.
Open questions for reviewers
A few things worth confirming during review:
/workshops/since the bundle (devcontainer, README, notebook, env example) matches the workshop pattern described in the repo README. If it fits better elsewhere, happy to restructure.