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

Phundal-bugfixes across 3 scripts #1598

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

phundal-openai
Copy link
Contributor

Summary

How_to_call_functions_for_knowledge_retrieval.ipynb

  • removed hard coded query, and max_results in get_articles arxiv.Search routine along with removing sort_by routine that was interfering with retrieval accuracy.
  • Changed formatting on display (show markdown) of testing routines to improve readability
  • Re-ran notebook to display accurate results

Getting_started_with_Qdrant_and_OpenAI.ipynb

  • Updated links in prerequisites to match current platform urls.
  • updated call to qdrant client.create_collection (was recreate_collection) to match current library requirements.
  • Changed model in Search Data section to be text-embedding-ada-002 to match embeddings in file and allow results to work as intended by the notebook.

Using_Qdrant_for_embeddings_search.ipynb

  • Updated load data routine to give user progress as well as match other scripts in the folder.
  • Updated Setup section to launch docker versus having the user have to do it manually.

Motivation

In most cases the notebooks were not operating at all, or displaying data incorrectly. Also there were incorrect comments in some cases.


For new content

When contributing new content, read through our contribution guidelines, and mark the following action items as completed:

  • I have added a new entry in registry.yaml (and, optionally, in authors.yaml) so that my content renders on the cookbook website.
  • I have conducted a self-review of my content based on the contribution guidelines:
    • Relevance: This content is related to building with OpenAI technologies and is useful to others.
    • Uniqueness: I have searched for related examples in the OpenAI Cookbook, and verified that my content offers new insights or unique information compared to existing documentation.
    • Spelling and Grammar: I have checked for spelling or grammatical mistakes.
    • Clarity: I have done a final read-through and verified that my submission is well-organized and easy to understand.
    • Correctness: The information I include is correct and all of my code executes successfully.
    • Completeness: I have explained everything fully, including all necessary references and citations.

We will rate each of these areas on a scale from 1 to 4, and will only accept contributions that score 3 or higher on all areas. Refer to our contribution guidelines for more details.

removed hard coded query, and max_results in get_articles arxiv.Search routine along with removing sort_by routine that was interferring with retreival of accurate results.  Changed formatting on display of testing routines to improve readability, re-ran notebook to have accurate results and allow notebook to work as intended.
Updated links in prerequisites to match current platform urls, updated call to qdrant client.create_collection (was recreate_collection) to match current library requirements. Changed model in Search Data section to be text-embedding-ada-002 to match embeddings in file and allow results to work as intended by the notebook.  Using_Qdrant_for_embed: Updated load data routine to give user progress as well as match other scripts in the folder. Updated Setup section to launch docker versus having the user have to do it manually.
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