Skip to content

Commit d42a98f

Browse files
committed
edits per BA
1 parent d2fec5a commit d42a98f

File tree

5 files changed

+33
-17
lines changed

5 files changed

+33
-17
lines changed

docs/search/copilot.md

Lines changed: 33 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
2121
<p><a href="/docs/beta"><span className="beta">Preview Release</span></a></p>
2222
This is a Preview release. To learn more, contact your Sumo Logic account executive.
2323

24-
Sumo Logic Copilot is an AI-powered assistant that accelerates investigations and troubleshooting in logs by allowing you to ask questions in plain English, get contextual suggestions—minimizing the need to write log queries.
24+
Sumo Logic Copilot is an AI-powered assistant that accelerates investigations and troubleshooting in logs by allowing you to ask questions in plain English and get contextual suggestions, helping first responders get answers faster.
2525

26-
With its intuitive interface, Copilot automatically generates log searches from natural language queries, helping you quickly investigate performance issues, anomalies, and security threats. It guides you through investigations step-by-step with AI-driven suggestions to refine your results for faster, more accurate resolutions. Copilot enhances incident resolution with expert level insights to accelerate root cause identification and empower informed decisions.
26+
With its intuitive interface, Copilot automatically generates log searches from natural language queries, helping you quickly investigate performance issues, anomalies, and security threats. It also guides you through investigations step-by-step with AI-driven suggestions to refine your results for faster, more accurate resolutions. Overall, Copilot enhances incident resolution with expert level insights.
2727

2828
### Key features
2929

@@ -34,13 +34,17 @@ Copilot reduces manual effort by combining prebuilt insights with natural langua
3434
* **Conversation history**. Save and resume any troubleshooting session without losing context.
3535
* **Auto-visualize**. Copilot renders charts based on search results automatically. These charts can be added to dashboards from within Copilot.
3636

37+
### Security and compliance
38+
39+
<!-- under legal review -->
40+
3741

3842
### Who benefits from Copilot?
3943

4044
Copilot is ideal for:
4145

4246
* **On-call engineers**. Accelerate time to resolution by surfacing key troubleshooting insights.
43-
* **Security engineers**. Obtain security insights rapidly for faster threat detection.
47+
* **Security engineers**. Obtain security insights rapidly for faster security incident resolution.
4448

4549
## How to use Copilot
4650

@@ -54,15 +58,15 @@ From the [**Classic UI**](/docs/get-started/sumo-logic-ui-classic), navigate to
5458

5559
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="150" />
5660

57-
### Step 2: Select a source category
61+
### Step 2: Review the auto-selected source
5862

59-
Click **Select Source Category** - the source expression box - and type/select the data source of the log messages you want to investigate. In this example, we'll select a source for AWS WAF.
63+
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.
6064

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

6367
### Step 3: Execute a Suggestion
6468

65-
Click on any of the prebuilt **Suggestions** prompts to launch your investigation. These AI-curated natural language insights are customized for the specific data source you've chosen.
69+
Click on any of the prebuilt **Suggestions** prompts to launch your investigation. These AI-curated natural language insights are tailored to the specific data source you've chosen.
6670

6771
In this example, we'll click `Count the number of log entries by the collector ID`. This translates the insight to a log query and renders results.
6872

@@ -73,27 +77,38 @@ In this example, we'll click `Count the number of log entries by the collector I
7377
<details>
7478
<summary>Manual entry (not recommended)</summary>
7579

76-
In the **Ask Something...** field, you can manually enter a natural language prompt similar to the prebuilt ones under **Suggestions**. Because manually typing an AI prompt requires careful precision for optimal performance, we recommend sticking with the prebuilt prompts.
80+
In the **Ask Something...** field, you can manually enter a natural language prompt similar to the prebuilt ones under **Suggestions**.
7781

7882
<img src={useBaseUrl('img/search/copilot/manual-entry.png')} alt="Copilot time period" style={{border: '1px solid gray'}} width="600" />
7983

80-
Broad questions do not return good results. When your question is framed as a query about a small, well-defined problem, Copilot answers more accurately. If your statement cannot be translated into a query, this field will say "Failed translation".
84+
Broad questions may not yield accurate results. For best outcomes, frame your queries around a small, well-defined problem. If Copilot is unable to translate your prompt into a query, it will display "Failed translation".
8185

82-
Express your chain of thought to the AI by breaking up your prompt into smaller problems that the AI can answer more accurately.<br/><img src={useBaseUrl('img/search/copilot/copilot-periods.gif')} alt="Copilot time period" style={{border: '1px solid gray'}} width="700" />
86+
Break your questions into smaller, specific prompts to help Copilot provide more accurate answers.<br/><img src={useBaseUrl('img/search/copilot/copilot-periods.gif')} alt="Copilot time period" style={{border: '1px solid gray'}} width="700" />
8387
</details>
8488

8589

8690
#### Time range
8791

88-
1. Click the clock icon and select your desired time range from the dropdown.<br/><img src={useBaseUrl('img/search/copilot/time-period.png')} alt="Copilot time period" style={{border: '1px solid gray'}} width="500" />
92+
By default, Copilot searches run with a 15-minute time range. If your search returns no results, consider expanding the time range.
93+
94+
1. Click the clock icon and select your desired time range from the dropdown.<br/><img src={useBaseUrl('img/search/copilot/time-period.png')} alt="Copilot time period" style={{border: '1px solid gray'}} width="400" />
8995
1. Click the search button.<br/><img src={useBaseUrl('img/search/copilot/search-button.png')} alt="Copilot search button" style={{border: '1px solid gray'}} width="250" />
9096

9197
#### Chart type
9298

93-
Copilot will attempt to auto-visualize your data. For example, you might ask `Top ip by geo` and the translation will add a geo lookup and render results on a map. An example is below.
99+
Copilot will automatically attempt to visualize your data. For example, a query like `Top ip by geo` will trigger a geo lookup and display the results on a map:
94100

95101
<img src={useBaseUrl('img/search/copilot/copilot-geo-chart.png')} alt="Copilot chart types" style={{border: '1px solid gray'}} width="800" />
96102

103+
The following rules are used to deduce chart type:
104+
* If both latitude and longitude fields exist, it returns a MAP chart type.
105+
* If there is only one field and one record, it returns an SVP chart type. Example query: `(_sourceCategory=ic/linux/gcp) | count by %"_sourcename" | count`
106+
* If a `sort` operator is present and there are string fields, it returns a TABLE. Given that there is a `sort` operator, probably the user is interested in `count`. Query: `(_sourceCategory=ic/linux/gcp) | count by %"_sourcename" | sort by _count`
107+
* If there is a `_timeslice` field, it returns LINE chart type if there are numeric fields or a TABLE chart type if there are string fields.
108+
* If there is one string field, one numeric field, and record count is less than 6, it returns a PIE chart type. Query: `(_sourceCategory=ic/linux/gcp) | count by %"_sourcename"`.
109+
* If there is one string field, less than 3 numeric field, and record count is less than 20, it returns a LINE chart.
110+
* If none of the above conditions are met, it defaults to returning a TABLE chart type.
111+
97112
If required, select your preferred chart type, such as **Table**, **Bar**, **Column**, or **Line** view to visualize your results. You can also click **Add to Dashboard** to export an AI-generated dashboard for root cause analysis.
98113

99114
<img src={useBaseUrl('img/search/copilot/chart-types.png')} alt="Copilot chart types" style={{border: '1px solid gray'}} width="500" />
@@ -113,7 +128,7 @@ You can manually edit your log search query code if needed.
113128
| where _schema != "unknown"
114129
| sum(_count) by _sourceCategory
115130
```
116-
* If your log query contains a mix JSON and non-JSON formatting (i.e., a log file is partially JSON), you can isolate the JSON portion by adding `{` to the source expression to trigger **Suggestions**.<br/><img src={useBaseUrl('img/search/copilot/copilot-json.png')} alt="Copilot JSON formatting" style={{border: '1px solid gray'}} width="350" />
131+
* If your log query contains a mix of JSON and non-JSON formatting (i.e., a log file is partially JSON), you can isolate the JSON portion by adding `{` to the source expression to trigger **Suggestions**.<br/><img src={useBaseUrl('img/search/copilot/copilot-json.png')} alt="Copilot JSON formatting" style={{border: '1px solid gray'}} width="350" />
117132
</details>
118133

119134
1. Click in the code editor field and edit your search. Not familiar with Sumo Logic query language? See [Search Query Language](/docs/search/search-query-language) to learn more.<br/><img src={useBaseUrl('img/search/copilot/code-editor.png')} alt="Copilot time period" style={{border: '1px solid gray'}} width="500" />
@@ -123,18 +138,19 @@ You can manually edit your log search query code if needed.
123138
To save space, you can use the **Hide Log Query** icon to collapse the log query code.<br/><img src={useBaseUrl('img/search/copilot/show-hide-query.png')} alt="Copilot time period" style={{border: '1px solid gray'}} width="500" />
124139
:::
125140

126-
#### Recent history
141+
#### History
127142

128-
To view your recent prompts from your current session, click the recent history icon.<br/><img src={useBaseUrl('img/search/copilot/recent-history.png')} alt="recent-history.png" style={{border: '1px solid gray'}} width="700" />
143+
Often, users work on multiple incidents at the same time. To view Copilot interactions related to these incidents, click **History**.<br/><img src={useBaseUrl('img/search/copilot/history.png')} alt="Copilot History" style={{border: '1px solid gray'}} width="700" />
129144

145+
You can resume a conversation in two ways:
130146

131-
#### History
147+
First, the Resume conversation icon picks up from the last query in a conversation.<br/><img src={useBaseUrl('img/search/copilot/resume-convo-history1.png')} alt="Copilot History" style={{border: '1px solid gray'}} width="700" />
132148

133-
To view your entire prompt history across all conversations, click **History**.<br/><img src={useBaseUrl('img/search/copilot/history.png')} alt="Copilot History" style={{border: '1px solid gray'}} width="700" />
149+
Second, you can resume from a specific query in a conversation by clicking on the row in the conversation history and then clicking on the gray area on the right side, as shown below.<br/><img src={useBaseUrl('img/search/copilot/resume-convo-history2.png')} alt="Copilot History" style={{border: '1px solid gray'}} width="700" />
134150

135151
#### New Conversation
136152

137-
To start over and begin a new investigation, click **New Conversation**. <br/><img src={useBaseUrl('img/search/copilot/new-conversation.png')} alt="Copilot new conversation" style={{border: '1px solid gray'}} width="700" />
153+
To start a new exploration, click **New Conversation**. <br/><img src={useBaseUrl('img/search/copilot/new-conversation.png')} alt="Copilot new conversation" style={{border: '1px solid gray'}} width="700" />
138154

139155

140156
### Step 4: Open in Log Search
-59.9 KB
Binary file not shown.
164 KB
Loading
164 KB
Loading
-11.2 KB
Loading

0 commit comments

Comments
 (0)