Skip to content

Commit

Permalink
Updates changes to embeddings with 5.3 (#94)
Browse files Browse the repository at this point in the history
* Updates changes to embeddings with 5.3

* Add FAQs

* Rmv embeddings content

* VSCode embedding details
  • Loading branch information
MaedahBatool authored Feb 15, 2024
1 parent 9d87dcb commit d5770f1
Show file tree
Hide file tree
Showing 10 changed files with 39 additions and 564 deletions.
24 changes: 24 additions & 0 deletions docs/cody/core-concepts/embeddings.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Embeddings

<p className="subtitle">Learn how you can use embeddings with Cody for better code understanding.</p>

## What are embeddings?

Embeddings are a semantic representation of text that allows you to create a search index over your codebase. Cody splits your codebase into searchable chunks and sends them to an external service specified in your site's configuration for embedding. The resulting embedding index is stored in your local hard drive.

## Embeddings in VS Code

<Callout type= "info">As of Sourcegraph version 5.3, embeddings are only available to Cody Free and Cody Pro users on the VS Code extension.</Callout>

Cody Free and Pro users can leverage local embeddings for context fetching. Local embeddings are indexed from the **Enhanced Context** panel. Once indexed, Cody will use these embeddings to provide context to your search queries.

## Enable embeddings

To enable embeddings in VS Code IDE:

- Open a repository in your workspace
- Next, create a new Cody chat
- Inside the chat window, open the **Enhanced Context Selector** window and select **Enable Embeddings**
- This uploads the repository's context to OpenAI's Embeddings API and gets stored locally

<Callout type="note">Embeddings are no longer supported for Cody Enterprise and JetBrains IDE extension. You can learn more about Cody's [context fetching mechanism](/cody/core-concepts/context#context-fetching-mechanism).</Callout>
85 changes: 0 additions & 85 deletions docs/cody/embeddings/configure-embeddings.mdx

This file was deleted.

67 changes: 0 additions & 67 deletions docs/cody/embeddings/embedding-index.mdx

This file was deleted.

122 changes: 0 additions & 122 deletions docs/cody/embeddings/index.mdx

This file was deleted.

93 changes: 0 additions & 93 deletions docs/cody/embeddings/manage-embeddings.mdx

This file was deleted.

Loading

0 comments on commit d5770f1

Please sign in to comment.