Skip to content

Commit dfdba5d

Browse files
authored
Merge branch 'main' into copilot-ga-final
2 parents c5f4228 + 3fc6f73 commit dfdba5d

File tree

2 files changed

+16
-13
lines changed

2 files changed

+16
-13
lines changed

docs/api/search-job.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -66,21 +66,19 @@ So, a 404 status is generated in these two situations:
6666

6767
You can start requesting results asynchronously while the job is running and page through partial results while the job is in progress.
6868

69-
70-
7169
## Search Job Result Limits
7270

7371
| Data Tier | Non-aggregate Search |
7472
| :- | :- |
75-
| Continuous | Can return up to 10M records and 100K messages per search. |
76-
| Frequent | Can return up to 10M records and 100K messages per search. |
77-
| Infrequent | Can return up to 10M records and 100K messages per search. |
73+
| Continuous | Can return up to 100K messages per search. |
74+
| Frequent | Can return up to 100K messages per search. |
75+
| Infrequent | Can return up to 100K messages per search. |
7876

7977
:::info
80-
Flex Licensing model can return up to 10M records and 100K messages per search.
78+
Flex Licensing model can return up to 100K messages per search.
8179
:::
8280

83-
If you need more results, you'll need to break up your search into several searches that span smaller blocks of the time range needed. For example, if your search runs for a week and returns 70 million records, consider breaking it into at least seven searches, each spanning a day.
81+
If you need more results, you'll need to break up your search into several searches that span smaller blocks of the time range needed.
8482

8583
## Rate limit throttling
8684

@@ -110,10 +108,9 @@ The following figure shows the process flow for search jobs.
110108
2. **Response.** Sumo Logic responds with a job ID. If there’s a problem with the request, an error code is provided (see the list of error codes following the figure).
111109
3. **Request.** Use the job ID to request search status. This needs to be done at least every 20-30 seconds so the search session is not canceled due to inactivity.
112110
4. **Response.** Sumo Logic responds with job status. An error code (404) is returned if the request could not be completed. The status includes the current state of the search job (gathering results, done executing, etc.). It also includes the message and record counts based on how many results have already been found while executing the search. For non-aggregation queries, only the number of messages is reported. For aggregation queries, the number of records produced is also reported. The search job status provides access to an implicitly generated histogram of the distribution of found messages over the time range specified for the search job. During and after execution, the API can be used to request available messages and records in a paging fashion.
113-
5. **Request.** You request results. It’s not necessary for the search to be complete for the user to request results; the process works asynchronously. You can repeat the request as often as needed to keep seeing updated results, keeping in mind the rate limits. The Search Job API can return up to 10M records and 100K messages per search.
111+
5. **Request.** You request results. It’s not necessary for the search to be complete for the user to request results; the process works asynchronously. You can repeat the request as often as needed to keep seeing updated results, keeping in mind the rate limits. The Search Job API can return 100K messages per search.
114112
6. **Response.** Sumo Logic delivers JSON-formatted search results as requested. The API can deliver partial results that the user can start paging through, even as new results continue to come in. If there’s a problem with the results, an error code is provided (see the list of error codes following the figure).
115113

116-
117114
## Errors
118115

119116
**Generic errors that apply to all APIs**

docs/search/copilot.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,10 @@ In this example, we'll click `Count the number of log entries by the collector I
9393

9494
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.
9595

96+
<img src={useBaseUrl('img/search/copilot/manual-entry.png')} alt="Copilot time period" style={{border: '1px solid gray'}} width="600" />
97+
98+
#### Video: Autocomplete in action
99+
96100
<Iframe url="https://player.vimeo.com/video/1034043268?badge=0&amp;autopause=0&amp;player_id=0&amp;app_id=58479"
97101
width="854px"
98102
height="480px"
@@ -104,14 +108,16 @@ In the **Ask Something...** field, you can manually enter a natural language pro
104108
allowfullscreen
105109
/>
106110

107-
108-
<img src={useBaseUrl('img/search/copilot/manual-entry.png')} alt="Copilot time period" style={{border: '1px solid gray'}} width="600" />
109-
110111
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".
111112

112113
Break your questions into smaller, specific requirements 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" />
113114

114-
##### Tips and tricks
115+
<!-- TO DO
116+
##### Autocompletion for natural language
117+
see https://drive.google.com/file/d/10XUn4DQD3K91V3Qf5heCizkHJneTaBJ7/view?usp=sharing
118+
--->
119+
120+
#### Tips and tricks
115121

116122
* **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.
117123
* **Disambiguate field names**. If fields have similar names and cause confusion, explicitly specify the field (e.g., `<field_name>`) to improve accuracy.

0 commit comments

Comments
 (0)