Skip to content

Conversation

@giriraj-singh-couchbase
Copy link
Contributor

This pull request updates the frontmatter metadata for several tutorial files to reflect new indexing methods in Couchbase and renames the files accordingly. The main changes involve replacing references to older indexing methods (GSI and FTS) with newer ones (Hyperscale, Composite Vector Index, and Search Vector Index) across AWS Bedrock, Azure OpenAI, and Claude AI tutorial directories.

Tutorial index method updates:

  • Updated tutorial paths, titles, and descriptions to use "Hyperscale Vector Index", "Composite Vector Index", or "Search Vector Index" instead of "GSI" or "FTS". [1] [2] [3] [4] [5] [6]
  • Updated tags to reflect the new index types and removed references to "GSI" and "FTS". [1] [2] [3] [4] [5] [6]
  • Added alt_paths metadata for tutorials using Hyperscale and Composite Vector Index to support alternate URL paths. [1] [2] [3]

File renaming and organization:

  • Renamed tutorial frontmatter files to match the new indexing method names, improving clarity and consistency in file organization. [1] [2] [3] [4] [5] [6]

@github-actions
Copy link

github-actions bot commented Nov 24, 2025

Caution

Notebooks or Frontmatter Files Have Been Modified

  • Please ensure that a frontmatter.md file is accompanying the notebook file, and that the frontmatter is up to date.
  • These changes will be published to the developer portal tutorials only if frontmatter.md is included.
  • Proofread all changes before merging, as changes to notebook and frontmatter content will update the developer tutorial.

28 Notebook Files Modified:

Notebook File Frontmatter Included?
awsbedrock/query_based/RAG_with_Couchbase_and_Bedrock.ipynb
awsbedrock/search_based/RAG_with_Couchbase_and_Bedrock.ipynb
azure/query_based/RAG_with_Couchbase_and_AzureOpenAI.ipynb
azure/search_based/RAG_with_Couchbase_and_AzureOpenAI.ipynb
claudeai/query_based/RAG_with_Couchbase_and_Claude(by_Anthropic).ipynb
claudeai/search_based/RAG_with_Couchbase_and_Claude(by_Anthropic).ipynb
cohere/query_based/RAG_with_Couchbase_and_Cohere.ipynb
cohere/search_based/RAG_with_Couchbase_and_Cohere.ipynb
crewai-short-term-memory/query_based/CouchbaseStorage_Demo.ipynb
crewai-short-term-memory/search_based/CouchbaseStorage_Demo.ipynb
crewai/query_based/RAG_with_Couchbase_and_CrewAI.ipynb
crewai/search_based/RAG_with_Couchbase_and_CrewAI.ipynb
haystack/query_based/RAG_with_Couchbase_Capella_and_OpenAI.ipynb
haystack/search_based/RAG_with_Couchbase_Capella_and_OpenAI.ipynb
huggingface/query_based/hugging_face.ipynb
huggingface/search_based/hugging_face.ipynb
jinaai/query_based/RAG_with_Couchbase_and_Jina_AI.ipynb
jinaai/search_based/RAG_with_Couchbase_and_Jina_AI.ipynb
lamaindex/query_based/RAG_with_Couchbase_Capella_and_OpenAI.ipynb
lamaindex/search_based/RAG_with_Couchbase_Capella_and_OpenAI.ipynb
mistralai/query_based/mistralai.ipynb
mistralai/search_based/mistralai.ipynb
openrouter-deepseek/query_based/RAG_with_Couchbase_and_Openrouter_Deepseek.ipynb
openrouter-deepseek/search_based/RAG_with_Couchbase_and_Openrouter_Deepseek.ipynb
pydantic_ai/query_based/RAG_with_Couchbase_and_PydanticAI.ipynb
pydantic_ai/search_based/RAG_with_Couchbase_and_PydanticAI.ipynb
smolagents/query_based/RAG_with_Couchbase_and_SmolAgents.ipynb
smolagents/search_based/RAG_with_Couchbase_and_SmolAgents.ipynb

34 Frontmatter Files Modified:

Frontmatter File
awsbedrock/query_based/frontmatter.md
awsbedrock/search_based/frontmatter.md
azure/query_based/frontmatter.md
azure/search_based/frontmatter.md
claudeai/query_based/frontmatter.md
claudeai/search_based/frontmatter.md
cohere/query_based/frontmatter.md
cohere/search_based/frontmatter.md
crewai-short-term-memory/gsi/frontmatter.md
crewai-short-term-memory/query_based/frontmatter.md
crewai-short-term-memory/search_based/frontmatter.md
crewai/gsi/frontmatter.md
crewai/query_based/frontmatter.md
crewai/search_based/frontmatter.md
haystack/query_based/frontmatter.md
haystack/search_based/frontmatter.md
huggingface/gsi/frontmatter.md
huggingface/query_based/frontmatter.md
huggingface/search_based/frontmatter.md
jinaai/query_based/frontmatter.md
jinaai/search_based/frontmatter.md
lamaindex/query_based/frontmatter.md
lamaindex/search_based/frontmatter.md
mistralai/gsi/frontmatter.md
mistralai/query_based/frontmatter.md
mistralai/search_based/frontmatter.md
openrouter-deepseek/query_based/frontmatter.md
openrouter-deepseek/search_based/frontmatter.md
pydantic_ai/gsi/frontmatter.md
pydantic_ai/query_based/frontmatter.md
pydantic_ai/search_based/frontmatter.md
smolagents/gsi/frontmatter.md
smolagents/query_based/frontmatter.md
smolagents/search_based/frontmatter.md
Note: frontmatter will be checked and tested in the Test Frontmatter workflow.

@giriraj-singh-couchbase giriraj-singh-couchbase marked this pull request as ready for review November 24, 2025 09:01
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates tutorial metadata to reflect Couchbase's newer vector indexing methods, replacing references to legacy "GSI" (Global Secondary Index) and "FTS" (Full-Text Search) with "Hyperscale Vector Index", "Composite Vector Index", and "Search Vector Index". The changes ensure consistent terminology across all tutorial frontmatter files and add alternate URL paths for improved discoverability.

Key Changes:

  • Renamed file paths, titles, and descriptions across all tutorials to use the new index type terminology
  • Updated tags to reflect new index types (removed "GSI" and "FTS", added "Hyperscale Vector Index", "Composite Vector Index", and "Search Vector Index")
  • Added alt_paths metadata for tutorials using Hyperscale and Composite Vector Index to support alternate URL routing

Reviewed changes

Copilot reviewed 29 out of 95 changed files in this pull request and generated 10 comments.

Show a summary per file
File Description
smolagents/search_based/frontmatter.md Updated path and tags from FTS to Search Vector Index
smolagents/query_based/frontmatter.md New file with Hyperscale/Composite Vector Index metadata and alt_paths
smolagents/gsi/frontmatter.md Removed legacy GSI tutorial frontmatter
pydantic_ai/search_based/frontmatter.md Updated path and tags from FTS to Search Vector Index
pydantic_ai/query_based/frontmatter.md Updated from GSI to Hyperscale/Composite Vector Index with alt_paths
openrouter-deepseek/search_based/frontmatter.md Updated path and tags from FTS to Search Vector Index
openrouter-deepseek/query_based/frontmatter.md Updated from GSI to Hyperscale/Composite Vector Index with alt_paths
mistralai/search_based/frontmatter.md Updated path and tags from FTS to Search Vector Index
mistralai/query_based/frontmatter.md Updated from GSI to Hyperscale/Composite Vector Index
lamaindex/search_based/frontmatter.md Updated path and tags from FTS to Search Vector Index
lamaindex/query_based/frontmatter.md Updated from GSI to Hyperscale/Composite Vector Index with alt_paths
jinaai/search_based/frontmatter.md Updated path and tags from FTS to Search Vector Index
jinaai/query_based/frontmatter.md Updated from GSI to Hyperscale/Composite Vector Index with alt_paths
huggingface/search_based/frontmatter.md Updated path and tags from FTS to Search Vector Index
huggingface/query_based/frontmatter.md Updated from GSI to Hyperscale/Composite Vector Index with alt_paths
haystack/search_based/frontmatter.md Updated path and tags from FTS to Search Vector Index
haystack/query_based/frontmatter.md Updated from GSI to Hyperscale/Composite Vector Index with alt_paths
crewai/search_based/frontmatter.md Updated path and tags from FTS to Search Vector Index
crewai/query_based/frontmatter.md Updated from GSI to Hyperscale/Composite Vector Index with alt_paths
crewai-short-term-memory/search_based/frontmatter.md Updated path and tags from FTS to Search Vector Index
crewai-short-term-memory/query_based/frontmatter.md Updated from GSI to Hyperscale/Composite Vector Index with alt_paths
cohere/search_based/frontmatter.md Updated path and tags from FTS to Search Vector Index
cohere/query_based/frontmatter.md Updated from GSI to Hyperscale/Composite Vector Index with alt_paths
claudeai/search_based/frontmatter.md Updated path and tags from FTS to Search Vector Index
claudeai/query_based/frontmatter.md Updated from GSI to Hyperscale/Composite Vector Index with alt_paths
azure/search_based/frontmatter.md Updated path and tags from FTS to Search Vector Index
azure/query_based/frontmatter.md Updated from GSI to Hyperscale/Composite Vector Index with alt_paths
awsbedrock/search_based/frontmatter.md Updated path and tags from FTS to Search Vector Index
awsbedrock/query_based/frontmatter.md Updated from GSI to Hyperscale/Composite Vector Index with alt_paths
Comments suppressed due to low confidence (1)

smolagents/search_based/frontmatter.md:1

  • Duplicate 'FTS' tag was removed from line 20, but the closing '---' delimiter on line 23 was also removed. The frontmatter section should end with '---'.
---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

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.

2 participants