You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* 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
Copy file name to clipboardExpand all lines: docs/search/copilot.md
+24-19Lines changed: 24 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -68,13 +68,15 @@ In this section, you'll learn the recommended workflow for using Copilot effecti
68
68
69
69
To start using Copilot:
70
70
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" />
72
72
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" />
74
74
75
75
### Step 2: Review the auto-selected source
76
76
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.
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.
92
94
93
95
<!-- TO DO BA to upload to YouTube DEMO: https://drive.google.com/file/d/10XUn4DQD3K91V3Qf5heCizkHJneTaBJ7/view?usp=sharing
94
96
-->
@@ -104,16 +106,22 @@ Break your questions into smaller, specific requirements to help Copilot provide
104
106
see https://drive.google.com/file/d/10XUn4DQD3K91V3Qf5heCizkHJneTaBJ7/view?usp=sharing
105
107
--->
106
108
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
108
110
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
111
119
*`Sort by`[field(s)][in descending order]
112
-
*`Percentage breakdown in`[field]`values`
120
+
*`Percentage by`[field]`values`
113
121
*`Find`[stat]`for`[field] (max, min, standard deviation, etc.)
114
122
*`Filter by`[field]`contains`[keyword]
115
123
:::note
116
-
Keyword searches are case-sensitive
124
+
Keyword searches are case-sensitive.
117
125
:::
118
126
*`Apply logreduce to logs`
119
127
@@ -122,13 +130,6 @@ Additional prompts can trigger more advanced activities (e.g., mapping network a
122
130
*`Analyze risk and severity of network activity`
123
131
*`Identify top application categories accessed`
124
132
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
-
132
133
#### Time range
133
134
134
135
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
197
198
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" />
198
199
199
200
200
-
### Step 4: Open in Log Search
201
+
### Step 5: Open in Log Search
201
202
202
203
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.
203
204
@@ -264,7 +265,7 @@ To summarize, you conclude there is malicious activity originating from certain
264
265
265
266
## Role Based Access Control
266
267
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.
268
269
269
270
## Feedback
270
271
@@ -275,3 +276,7 @@ We want your feedback! Let us know what you think by clicking the thumbs up or t
0 commit comments