DA-1317 update crew ai cook book with the latest terminology

[giriraj-singh-couchbase]

This pull request primarily updates the terminology and content of the CrewAI and Couchbase RAG tutorial to reflect the latest Couchbase vector index features. It replaces references to "GSI vector index" and "BHIVE" with "Hyperscale and Composite vector indexes," updates technical explanations and code comments, and renames files for clarity. The changes also remove outdated frontmatter files and update links and descriptions accordingly.

Documentation and Terminology Updates:

• Updated all references from "GSI vector index" and "BHIVE" to "Hyperscale and Composite vector indexes" throughout the tutorial notebook, including section titles, technical explanations, code comments, and output messages. This ensures the tutorial aligns with the latest Couchbase vector index terminology and features.

• Updated documentation links to point to the current Couchbase Vector Index documentation and clarified the differences between index types.

• Updated installation and requirements text to reference Hyperscale and Composite vector storage, replacing GSI-specific language.

File Organization and Metadata:

• Renamed the tutorial notebook from crewai/gsi/RAG_with_Couchbase_and_CrewAI.ipynb to crewai/query_based/RAG_with_Couchbase_and_CrewAI.ipynb and updated all internal links and references to the new path.

• Removed outdated frontmatter metadata files for both FTS and GSI-based tutorials: crewai/fts/frontmatter.md and crewai/gsi/frontmatter.md.

These changes modernize the tutorial, improve clarity, and ensure consistency with current Couchbase vector search capabilities.

[github-actions]

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.

2 Notebook Files Modified:

Notebook File	Frontmatter Included?
crewai/query_based/RAG_with_Couchbase_and_CrewAI.ipynb	✅
crewai/search_based/RAG_with_Couchbase_and_CrewAI.ipynb	✅

4 Frontmatter Files Modified:

Frontmatter File
crewai/fts/frontmatter.md
crewai/gsi/frontmatter.md
crewai/query_based/frontmatter.md
crewai/search_based/frontmatter.md
Note: frontmatter will be checked and tested in the Test Frontmatter workflow.

[gemini-code-assist]

Summary of Changes

Hello @giriraj-singh-couchbase, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly modernizes the CrewAI and Couchbase RAG tutorial by updating its core terminology and content. It transitions from older "GSI vector index" and "BHIVE" references to the contemporary "Hyperscale and Composite vector indexes," ensuring the tutorial accurately reflects the latest Couchbase vector search features. The changes also involve a logical restructuring of tutorial files and the removal of deprecated metadata, enhancing clarity and consistency for users.

Highlights

• Terminology Update: Replaced all instances of "GSI vector index" and "BHIVE" with the new "Hyperscale and Composite vector indexes" across the tutorial content, code comments, and output messages to align with current Couchbase terminology.
• Documentation Alignment: Updated relevant documentation links and technical explanations to reflect the latest Couchbase vector index features and clarify the distinctions between different index types.
• File Renaming and Restructuring: Renamed tutorial notebooks and associated files, moving them into query_based (for Hyperscale/Composite indexes) and search_based (for Search Vector Index) directories. Outdated frontmatter metadata files were also removed.
• Content Modernization: Revised installation requirements, library descriptions, and performance testing sections within the notebooks to consistently use the new vector index terminology and capabilities.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[Copilot]

Pull request overview

This PR modernizes the CrewAI cookbook tutorials by updating terminology from deprecated "GSI vector index" and "BHIVE" to current "Hyperscale and Composite Vector Indexes". The changes ensure consistency with Couchbase's latest vector search capabilities and improve tutorial organization.

Key Changes:

• Replaced all references to "GSI vector index" and "BHIVE" with "Hyperscale and Composite Vector Indexes" throughout tutorial content
• Reorganized tutorial files from gsi/ and fts/ directories to query_based/ and search_based/ directories
• Updated documentation links to point to current Couchbase Vector Index documentation

Reviewed changes

Copilot reviewed 6 out of 9 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
crewai/search_based/frontmatter.md	New frontmatter for Search Vector Index tutorial with updated terminology
crewai/search_based/RAG_with_Couchbase_and_CrewAI.ipynb	Updated Search Vector Index tutorial with improved structure and terminology
crewai/query_based/frontmatter.md	New frontmatter for Hyperscale/Composite Vector Index tutorial
crewai/query_based/RAG_with_Couchbase_and_CrewAI.ipynb	Comprehensive terminology update from GSI/BHIVE to Hyperscale/Composite throughout
crewai/gsi/frontmatter.md	Removed deprecated GSI frontmatter file
crewai/fts/frontmatter.md	Removed deprecated FTS frontmatter file

Comments suppressed due to low confidence (1)

crewai/query_based/RAG_with_Couchbase_and_CrewAI.ipynb:1

• Inconsistent terminology: this line uses 'Hyperscale vector indexes' (plural) while other similar print statements in the same section use 'Hyperscale' (singular). Consider using 'Hyperscale delivers production-ready performance' for consistency with the surrounding code.

{

---

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

[gemini-code-assist]

Code Review

This pull request provides a comprehensive update to the CrewAI cookbook, aligning the terminology with the latest Couchbase vector index features. The changes are systematic and well-executed, replacing outdated terms like 'GSI' and 'BHIVE' with 'Hyperscale and Composite vector indexes' across the tutorial notebooks, documentation, and file structure. The file renaming and markdown formatting improvements also enhance the clarity and organization of the content. I found one minor typo in the documentation, which I've flagged in a specific comment. Overall, this is an excellent and thorough update that significantly improves the quality and accuracy of the tutorial.

[VirajAgarwal1]

Thanks for the PR, just some minor changes and we're good to go.

[VirajAgarwal1]

couple of minor final changes

[VirajAgarwal1]

Thanks for the PR!