Skip to content

Commit fa35380

Browse files
authored
Update index name in quickstart notebook (#442)
## Problem Want to make it easier to track indexes created from this notebook. ## Solution Use a unique index name to make tracking easier. ## Type of Change - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] This change requires a documentation update - [ ] Infrastructure change (CI configs, etc) - [ ] Non-code change (docs, etc) - [ ] None of the above: (explain here) ## Test Plan Describe specific steps for validating this change.
1 parent ed1d46e commit fa35380

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

docs/pinecone-quickstart.ipynb

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -107,11 +107,11 @@
107107
"source": [
108108
"## Create an index\n",
109109
"\n",
110-
"In Pinecone, there are two types of indexes for storing vector data: [Dense indexes](https://docs.pinecone.io/guides/indexes/understanding-indexes#dense-indexes) store dense vectors for semantic search, and [sparse indexes](https://docs.pinecone.io/guides/indexes/understanding-indexes#sparse-indexes) store sparse vectors for lexical/keyword search.\n",
110+
"In Pinecone, there are two types of indexes for storing vector data: [Dense indexes](https://docs.pinecone.io/guides/index-data/indexing-overview#dense-indexes) store dense vectors for semantic search, and [sparse indexes](https://docs.pinecone.io/guides/index-data/indexing-overview#sparse-indexes) store sparse vectors for lexical/keyword search.\n",
111111
"\n",
112-
"For this quickstart, create a dense index that is integrated with an [embedding model hosted by Pinecone](https://docs.pinecone.io/guides/inference/understanding-inference#embedding-models). With integrated models, you upsert and search with text and have Pinecone generate vectors automatically.\n",
112+
"For this quickstart, create a dense index that is integrated with an [embedding model hosted by Pinecone](https://docs.pinecone.io/guides/index-data/create-an-index#embedding-models). With integrated models, you upsert and search with text and have Pinecone generate vectors automatically.\n",
113113
"\n",
114-
"**Note:** If you prefer to use external embedding models, see [Bring your own vectors](https://docs.pinecone.io/guides/indexes/understanding-indexes#bring-your-own-vectors)."
114+
"**Note:** If you prefer to use external embedding models, see [Bring your own vectors](https://docs.pinecone.io/guides/index-data/indexing-overview#bring-your-own-vectors)."
115115
]
116116
},
117117
{
@@ -124,7 +124,7 @@
124124
"source": [
125125
"# Create a dense index with integrated embedding\n",
126126
"\n",
127-
"index_name = \"dense-index\"\n",
127+
"index_name = \"quickstart-notebook\"\n",
128128
"\n",
129129
"if not pc.has_index(name=index_name):\n",
130130
" pc.create_index_for_model(\n",
@@ -220,7 +220,7 @@
220220
"id": "f5vNb1pugnR5"
221221
},
222222
"source": [
223-
"[Upsert](https://docs.pinecone.io/guides/data/upsert-data) the sample dataset into a new namespace in your index.\n",
223+
"[Upsert](https://docs.pinecone.io/guides/index-data/upsert-data) the sample dataset into a new namespace in your index.\n",
224224
"\n",
225225
"Because your index is integrated with an embedding model, you provide the textual statements and Pinecone converts them to dense vectors automatically."
226226
]
@@ -251,7 +251,7 @@
251251
"source": [
252252
"## Check index stats\n",
253253
"\n",
254-
"Pinecone is eventually consistent, so there can be a slight delay before new or changed records are visible to queries. You can [view index stats](https://docs.pinecone.io/guides/data/check-data-freshness#verify-record-counts) to check if the current vector count matches the number of vectors you upserted (50):"
254+
"Pinecone is eventually consistent, so there can be a slight delay before new or changed records are visible to queries. You can [view index stats](https://docs.pinecone.io/guides/index-data/check-data-freshness#verify-record-counts) to check if the current vector count matches the number of vectors you upserted (50):"
255255
]
256256
},
257257
{
@@ -296,7 +296,7 @@
296296
"source": [
297297
"## Semantic search\n",
298298
"\n",
299-
"[Search the dense index](https://docs.pinecone.io/guides/data/query-data#semantic-search) for ten records that are most semantically similar to the query, `Famous historical structures and monuments`.\n",
299+
"[Search the dense index](https://docs.pinecone.io/guides/search/semantic-search) for ten records that are most semantically similar to the query, `Famous historical structures and monuments`.\n",
300300
"\n",
301301
"Again, because your index is integrated with an embedding model, you provide the query as text and Pinecone converts the text to a dense vector automatically."
302302
]
@@ -362,7 +362,7 @@
362362
"source": [
363363
"Notice that most of the results are about historical structures and monuments. However, a few unrelated statements are included as well and are ranked high in the list, for example, statements about Shakespeare and renewable energy.\n",
364364
"\n",
365-
"To get a more accurate ranking, search again but this time [rerank the initial results](https://docs.pinecone.io/guides/data/query-data#rerank-results) based on their relevance to the query."
365+
"To get a more accurate ranking, search again but this time [rerank the initial results](https://docs.pinecone.io/guides/search/rerank-results) based on their relevance to the query."
366366
]
367367
},
368368
{
@@ -426,9 +426,9 @@
426426
"\n",
427427
"Reranking results is one of the most effective ways to improve search accuracy and relevance, but there are many other techniques to consider. For example:\n",
428428
"\n",
429-
"* [Filtering by metadata](https://docs.pinecone.io/guides/data/query-data#filter-by-metadata): When records contain additional metadata, you can limit the search to records matching a filter expression.\n",
429+
"* [Filtering by metadata](https://docs.pinecone.io/guides/search/filter-by-metadata): When records contain additional metadata, you can limit the search to records matching a filter expression.\n",
430430
"\n",
431-
"* [Hybrid search](https://docs.pinecone.io/guides/data/query-data#hybrid-search): You can add lexical search to capture precise keyword matches (e.g., product SKUs, email addresses, domain-specific terms) in addition to semantic matches.\n",
431+
"* [Hybrid search](https://docs.pinecone.io/guides/search/hybrid-search): You can add lexical search to capture precise keyword matches (e.g., product SKUs, email addresses, domain-specific terms) in addition to semantic matches.\n",
432432
"\n",
433433
"* [Chunking strategies](https://www.pinecone.io/learn/chunking-strategies/): You can chunk your content in different ways to get better results. Consider factors like the length of the content, the complexity of queries, and how results will be used in your application."
434434
]

0 commit comments

Comments
 (0)