Skip to content

Commit 0ed62a1

Browse files
authored
Drop API section (#1499)
Is already in the navigation sidebar, and currently not shown by default.
1 parent 71163ac commit 0ed62a1

1 file changed

Lines changed: 8 additions & 12 deletions

File tree

docs/deep-search/index.mdx

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -27,19 +27,19 @@ The answer is formatted in Markdown and can include links to relevant files, dir
2727

2828
## Best practices
2929

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

3434
For use cases where you're looking for exhaustive answers (for example, "Find all files with the `.XYZ` file extension in `foo' repo that contain the word`bar`), Code Search still excels, while Deep Search will only utilize a sample of the results. Deep Search will perform a Code Search query as a source, which you can use to continue an exhaustive search within the Code Search product.
3535

3636
### Examples of prompts
3737

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

4444
## Conversation sharing
4545

@@ -79,10 +79,6 @@ Conversation sharing is disabled by default. To enable conversation sharing, ask
7979

8080
Deep Search is only available to customers using the [Sourcegraph Model Provider](/model-provider). Customers who configure and access their own models via BYOK cannot use the Deep Search feature.
8181

82-
## API access
83-
84-
For programmatic access to Deep Search functionality, see the [Deep Search API documentation](/deep-search/api).
85-
8682
## Monitoring consumption
8783

8884
Customers can request access to [Enterprise Portal](/admin/enterprise-portal#deep-search-usage-monitoring) to monitor Deep Search usage and quota limits..

0 commit comments

Comments
 (0)