Skip to content
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
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
63 changes: 63 additions & 0 deletions docs/code-search/types/deep-search.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
# Deep Search

<p className="subtitle">Learn more about Sourcegraph's Deep Search.</p>

<Callout type="note"> New in version 6.4. Deep Search is a feature currently in research preview for Enterprise customers with access to Cody and Code Search. Because Deep Search is in research preview, the feature might change significantly in the future as we make improvements and adjust to user feedback. Please reach out to your account team to request access. </Callout>

Deep Search is an agentic code search tool.
It receives a natural language question about a codebase, performs an in-depth search, and returns a detailed answer. The user can also ask follow-up questions to further improve the answer.

Under the hood, Deep Search is an AI agent that uses a variety of tools to generate its answer. The tools include various modes of Sourcegraph's code search and code navigation tools. The use of tools in an agentic loop enables Deep Search to iteratively refine its understanding of the question and codebase, searching until it is confident in its answer.

Deep Search displays a list of sources it used to generate the answer. The sources are the various types of searches it performs as well as the files it reads.
The answer is formatted in Markdown. If prompted to do so, Deep Search can also generate diagrams as part of its answer.

## Best practices
- Give the agent a starting point for the search: mention relevant repositories, files, directories or symbol names. The more specific you are, the faster the search will be.
- Provide reasonably scoped questions. The agent will perform much better if it does not have to read the entire codebase at once.
- Check the list of sources. This is extremely useful for debugging and for understanding where the answer came from. If something is missing, ask a follow-up question and mention the missing source.

### Examples of prompts
- Find examples of logger usage and show examples of the different types of logging we use.
- I want to know when the indexing queue functionality was last changed in `sourcegraph/zoekt`. Show me the last few commit diffs touching this code and explain the changes.
- Look at the GraphQL APIs available in `sourcegraph/sourcegraph`. Are any of them unused? The client code is in `sourcegraph/cody`.
- Which tools do we use in our build processes defined in `BUILD.bazel` files?
- Generate a diagram of the request flow in `src/backend`. Mark the auth and rate limit points.

## Enabling Deep Search
Deep Search can only be used on Sourcegraph instances with licenses for both Code Search and Cody.

Deep Search is disabled by default. To enable it, ask your site administrator to set `experimentalFeatures.deepSearch.enabled = "true"` in your site configuration.

For optimal performance, we have specialized Deep Search to only use one model. __Currently, Deep Search only supports Claude Sonnet 4.__

### Configuring Deep Search on Amazon Bedrock
Include configuration for Claude Sonnet 4 in [modelOverrides](/cody/enterprise/model-configuration#model-overrides) in your site configuration. Refer to [Model Configuration](/cody/enterprise/model-configuration) for more info on how to configure models.

Example for Sonnet 4 configuration inside `modelOverrides`:
```json
{
"modelRef": "aws-bedrock::v1::claude-sonnet-4",
"modelName": "us.anthropic.claude-sonnet-4-20250514-v1:0",
"displayName": "Claude Sonnet 4 (AWS Bedrock)",
"capabilities": [
"chat",
"tools",
],
"category": "balanced",
"status": "stable",
"contextWindow": {
"maxInputTokens": 200000,
"maxOutputTokens": 32000,
}
},
```

Then, configure Deep Search to use this model in `experimentalFeatures`:
```json
"experimentalFeatures": {
"deepSearch.enabled": true,
"deepSearch.model": "aws-bedrock::v1::claude-sonnet-4"
},
```

3 changes: 2 additions & 1 deletion src/data/navigation.ts
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,8 @@ export const navigation: NavigationItem[] = [
{ title: "Search Snippets", href: "/code-search/working/snippets", },
{ title: "Search Subexpressions", href: "/code-search/working/search_subexpressions", },
{ title: "Saved Searches", href: "/code-search/working/saved_searches", },
{ title: "Structural Search", href: "/code-search/types/structural", }
{ title: "Structural Search", href: "/code-search/types/structural", },
{ title: "Deep Search", href: "/code-search/types/deep-search", },
]
},
{
Expand Down