Skip to content

docs: clarify notebook instructions #613

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

Open
zjuzhongwen wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: clarify notebook instructions #613

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/langchain-retrieval-agent.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -911,7 +911,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"## Recieving context snippets instead of responses\n",
"## Receiving context snippets instead of responses\n",
"\n",
"The Context API allows us to take advantage of the data preprocessing, chunking, and search capabilities of the Assistant, without needing to generate a response. Instead, a set of relevant snippets are returned from the Assistant, which are chunks of data from our documents. You can think of it as a search API plus some extras, that make it easy to maximize the relevance of returned documents.\n",
"\n",
Expand Down Expand Up @@ -4066,7 +4066,7 @@
"\n",
"def feedback_bot(state: State):\n",
" \"\"\"\n",
" Generates feedback on study guide, using described critera. Depending on feedback, is routed\n",
" Generates feedback on study guide, using described criteria. Depending on feedback, is routed\n",
" to the study guide generator or the query generator.\n",
"\n",
"\n",
Expand Down Expand Up @@ -4097,7 +4097,7 @@
"\n",
" You will return Pass, Rewrite, or More Context.\n",
"\n",
" Rewrites are when no more information is necssary to be found, but the study guide needs more improvement.\n",
" Rewrites are when no more information is necessary to be found, but the study guide needs more improvement.\n",
"\n",
" More Context is when the context is not enough to complete the study guide, and the study guide needs more information from our book to be useful.\n",
"\n",
Expand Down Expand Up @@ -4427,4 +4427,4 @@
},
"nbformat": 4,
"nbformat_minor": 4
}
}
2 changes: 1 addition & 1 deletion docs/pinecone-quickstart.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@
"source": [
"## Initialize a client\n",
"\n",
"Use the generated API key to intialize a Pinecone client:"
"Use the generated API key to initialize a Pinecone client:"
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion docs/quick-tour/namespacing.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
"\n",
"Namespacing is a feature in Pinecone that allows you to partition your data in an index. When you read from or write to a namespace in an index, you only access data in that particular namespace. Namespacing is useful when you want to reuse the same data processing pipeline but maintain strict separation between subsets of your data.\n",
"\n",
"If your use-case is one where you feel a temptation to create multiple indexes programatically, consider whether the sort of multitenancy provided by namespaces would be a better solution to isolate different parts of your data.\n",
"If your use-case is one where you feel a temptation to create multiple indexes programmatically, consider whether the sort of multitenancy provided by namespaces would be a better solution to isolate different parts of your data.\n",
"\n",
"For example, if you were building a movie recommender system, you could use namespacing to separate recommendations by genre. But if you need more flexibility in how you group and search records, putting genre information into metadata and using metadata filtering would probably be a better fit."
]
Expand Down