Skip to content

Commit 6cbe775

Browse files
kimsaucehimanshu219
authored andcommitted
Copilot fixes (#4791)
* Copilot GA * add article ref * Edits per BA * edits per BA * expand on glossary * add more best practices * minor fix * Update docs/search/copilot.md * Delete blog-service/2024-12-02-search-copilot.md * Update docs/search/copilot.md * sidebar * add back preview * Copilot fixes * imgs * note fix * More edits per BA * add opt out info
1 parent 98fe9c8 commit 6cbe775

File tree

3 files changed

+24
-19
lines changed

3 files changed

+24
-19
lines changed

docs/search/copilot.md

Lines changed: 24 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -68,13 +68,15 @@ In this section, you'll learn the recommended workflow for using Copilot effecti
6868

6969
To start using Copilot:
7070

71-
From the [**Classic UI**](/docs/get-started/sumo-logic-ui-classic), navigate to the **Copilot** tab.<br/><img src={useBaseUrl('img/search/copilot/copilot-tab.png')} alt="Copilot tab" style={{border: '1px solid gray'}} width="200" />
71+
From the [**Classic UI**](/docs/get-started/sumo-logic-ui-classic), navigate to the **Copilot** tab.<br/><img src={useBaseUrl('img/search/copilot/copilot-tab.png')} alt="Copilot tab" style={{border: '1px solid gray'}} width="250" />
7272

73-
From the [**New UI**](/docs/get-started/sumo-logic-ui), click **Copilot** in the left nav.<br/><img src={useBaseUrl('img/search/copilot/copilot-tab-new.png')} alt="Copilot tab" style={{border: '1px solid gray'}} width="200" />
73+
From the [**New UI**](/docs/get-started/sumo-logic-ui), click **Copilot** in the left nav.<br/><img src={useBaseUrl('img/search/copilot/copilot-tab-new.png')} alt="Copilot tab" style={{border: '1px solid gray'}} width="250" />
7474

7575
### Step 2: Review the auto-selected source
7676

77-
Review the auto-selected **Source Category** and adjust it if needed. The source category is selected based on Copilot’s assessment of user intent. You can also type a source expression in the box. In either approach, you are defining the scope of your exploration. In this example, we'll select a source for AWS WAF. For indexes, type `_index=<index name>`.
77+
Review the auto-selected **Source Category** and adjust it if needed. The source category is selected based on Copilot’s assessment of user intent. You can also type a source expression in the box. In either approach, you are defining the scope of your exploration.
78+
79+
In this example, we'll select a source for AWS WAF. For indexes, type `_index=<index name>`. Autocompletion is supported for sources; type a few words, view source suggestions and pick one.
7880

7981
<img src={useBaseUrl('img/search/copilot/source-category.png')} alt="Copilot source category" style={{border: '1px solid gray'}} width="600" />
8082

@@ -86,9 +88,9 @@ In this example, we'll click `Count the number of log entries by the collector I
8688

8789
<img src={useBaseUrl('img/search/copilot/suggestions.png')} alt="Copilot time period" style={{border: '1px solid gray'}} width="600" />
8890

89-
#### Ask a question
91+
### Step 4: Ask a question
9092

91-
In the **Ask Something...** field, you can manually enter a natural language prompt similar to the prebuilt ones under **Suggestions**. In addition, use autocompletions if appropriate. Type a work in the search bar to trigger completions based on the keyword.
93+
In the **Ask Something...** field, you can manually enter a natural language prompt similar to the prebuilt ones under **Suggestions**. In addition, use autocompletions if appropriate. Type a word in the search bar to trigger completions based on the keyword.
9294

9395
<!-- TO DO BA to upload to YouTube DEMO: https://drive.google.com/file/d/10XUn4DQD3K91V3Qf5heCizkHJneTaBJ7/view?usp=sharing
9496
-->
@@ -104,16 +106,22 @@ Break your questions into smaller, specific requirements to help Copilot provide
104106
see https://drive.google.com/file/d/10XUn4DQD3K91V3Qf5heCizkHJneTaBJ7/view?usp=sharing
105107
--->
106108

107-
Copilot is built on [Sumo Logic search query language](/docs/search/search-query-language). Below are key functions you can call using natural language prompts:
109+
##### Tips and tricks
108110

109-
* `Count logs by` [field(s)]
110-
* `Group logs by` [field(s)]
111+
* **Start with a broad query**. Begin with a query like `Show me the most recent logs` to understand the structure and available fields in your logs.
112+
* **Disambiguate field names**. If fields have similar names and cause confusion, explicitly specify the field (e.g., `<field_name>`) to improve accuracy.
113+
* **Experiment with phrasing**. Try multiple variations of a query to provide context and receive more relevant suggestions.
114+
* **Include time or variations to add `timeslice` as a dimension**. When timeslicing data, include the term `time` in your query. For example: `Count requests, every 1m, different code challenges and user used during login attempts by time`.
115+
116+
Below are examples of how you can phrase queries if the autocompletions and contextual suggestions are not relevant to you:
117+
118+
* `Count logs by` [field(s)] and `Group logs by` [field(s)] produce the same result
111119
* `Sort by` [field(s)] [in descending order]
112-
* `Percentage breakdown in` [field] `values`
120+
* `Percentage by` [field] `values`
113121
* `Find` [stat] `for` [field] (max, min, standard deviation, etc.)
114122
* `Filter by` [field] `contains` [keyword]
115123
:::note
116-
Keyword searches are case-sensitive
124+
Keyword searches are case-sensitive.
117125
:::
118126
* `Apply logreduce to logs`
119127

@@ -122,13 +130,6 @@ Additional prompts can trigger more advanced activities (e.g., mapping network a
122130
* `Analyze risk and severity of network activity`
123131
* `Identify top application categories accessed`
124132

125-
##### Tips and tricks
126-
127-
* **Start with a broad query**. Begin with a query like `Show me the most recent logs` to understand the structure and available fields in your logs.
128-
* **Clarify field names**. If fields have similar names and cause confusion, explicitly specify the field (e.g., `<field_name>`) to improve accuracy.
129-
* **Experiment with phrasing**. Try multiple variations of a query to provide context and receive more relevant suggestions.
130-
* **Include time for timeslicing**. When timeslicing data, include the term `time` in your query. For example: `Count requests, every 1m, different code challenges and user used during login attempts by time`.
131-
132133
#### Time range
133134

134135
By default, Copilot searches run with a 15-minute time range. If your search returns no results, consider expanding the time range.
@@ -197,7 +198,7 @@ Second, you can resume from a specific query in a conversation by clicking on th
197198
To start a fresh exploration, click **New Conversation**. This clears your current session and allows you to begin with a clean slate.<br/><img src={useBaseUrl('img/search/copilot/new-conversation.png')} alt="Copilot new conversation" style={{border: '1px solid gray'}} width="700" />
198199

199200

200-
### Step 4: Open in Log Search
201+
### Step 5: Open in Log Search
201202

202203
Click the **Open in Log Search** icon, which will copy your query from Copilot over to a new log search, allowing you to utilize all of Sumo Logic's search functionality. You can continue investigating, save the search, and remediate.
203204

@@ -264,7 +265,7 @@ To summarize, you conclude there is malicious activity originating from certain
264265

265266
## Role Based Access Control
266267

267-
Role Based Access Control is not supported for contextual suggestions and autocompletions. It is possible for a user who is blocked by [log search RBAC](/docs/manage/users-roles/roles/construct-search-filter-for-role/) to view suggestions or completions for unpermitted source expressions. However, they will not be executed by the search and will see the error: `""`.
268+
Role Based Access Control is not supported for contextual suggestions and autocompletions. It is possible for a user who is blocked by [log search RBAC](/docs/manage/users-roles/roles/construct-search-filter-for-role/) to view suggestions or completions for unpermitted source expressions. However, they will not be executed by the search.
268269

269270
## Feedback
270271

@@ -275,3 +276,7 @@ We want your feedback! Let us know what you think by clicking the thumbs up or t
275276
You can also leave feedback on errors.
276277

277278
<img src={useBaseUrl('img/search/copilot/feedback-error.png')} alt="Copilot feedback icons" style={{border: '1px solid gray'}} width="800" />
279+
280+
## Opt out
281+
282+
To opt out of Copilot, contact our [support team](https://support.sumologic.com/support/s/).
-4.35 KB
Loading
529 Bytes
Loading

0 commit comments

Comments
 (0)