Skip to content
This repository was archived by the owner on Sep 2, 2025. It is now read-only.

Commit ac0ab5f

Browse files
author
Tracey Carter
committed
added activation and links to other resources
1 parent ffec9b9 commit ac0ab5f

File tree

3 files changed

+21
-8
lines changed

3 files changed

+21
-8
lines changed
510 KB
Loading

get-started/o11y-ai-promptlibrary.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ Providing entity names and types will generally lead to more focused, better, an
8080

8181
What makes a prompt poor quality?
8282
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
83-
Not providing entity names and types in your prompt makes the prompt unhelpful. The prompt, “What’s wrong with the api-gateway?” does not provide entity names or types. The level of specificity is low and returns an overwhelming set of responses that might or might not be useful in your troubleshooting.
83+
Not providing entity names and types in your prompt makes the prompt unhelpful. The prompt “What’s wrong with the api-gateway?” does not provide entity names or types. The level of specificity is low and returns an overwhelming set of responses that might or might not be useful in your troubleshooting.
8484

8585
What makes a prompt good quality?
8686
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -189,7 +189,7 @@ This prompt is good because it gives the service and the time range. Telling the
189189

190190
Example prompt 3: Excellent
191191
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
192-
:guilabel:`Paymentservice in online boutique env is having issues in past 15 mins. Look for any relevant error exemplar traces. Once you've identified the exemplar traces, analyze each full trace by its trace ID`
192+
:guilabel:`Paymentservice in online boutique env is having issues in past 15 mins. Look for any relevant error exemplar traces. After identifying the exemplar traces, analyze each full trace by its trace ID`
193193

194194
The third example prompt expands on the second example prompt. The second example prompt was good, but the third is excellent. One way to improve a prompt when you don’t know more specific information is to instruct the Assistant to extract certain details, then you can further prompt the Assistant using the extracted details. In this excellent example prompt, the Assistant extracts traces. Then it examines the traces and provides you with its analysis. From there, you can ask more and more specific questions based on information in the Assistant’s analysis. You might want to tell the Assistant how many exemplar traces to analyze so that the Assistant does not overwhelm you with a very large response and exceed context limitations of the conversation.
195195

@@ -209,8 +209,8 @@ When you want to create a chart in Splunk Observability Cloud, you might prompt
209209

210210
The preceding prompt is excellent because it gives the Assistant a fair amount of detail on what you want to know. The Assistant can make a functional chart based on the information you provide. You can follow up to adjust your chart after you see it. For example, you can then tell the Assistant to adjust the chart to a particular 30-minute window.
211211

212+
Other resources
213+
==================================================================================
214+
For specific instructions on how access and use the AI Assistant, see :guilabel:`o11y-ai:`.
212215

213-
214-
215-
216-
216+
To learn about Splunk's commitment to responsible AI, see :new-page:`Responsible AI for AI Assistant in Observability Cloud <http://splunk.com/en_us/about-splunk/splunk-data-security-and-privacy/responsible-ai-for-ai-assistant-in-observability-cloud.html>`.

get-started/o11y-ai.rst

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,9 @@ Alternatively, you can select from the two suggested prompts:
4747
:width: 40%
4848
:alt: This image shows the location of the AI Assistant for Observability.
4949

50-
.. note:: When you ask questions or submit instructions that require the AI Assistant to query logs, there will be an impact on your SVC quota.
50+
.. note:: When you ask questions or submit instructions that require the AI Assistant to query logs, there is an impact on your SVC quota.
5151

52-
feedback
52+
Feedback
5353
----------------------------------------------------------------------------------
5454
You can give feedback to the AI Assistant in development team by selecting the thumbs up or thumbs down icon that appears after each AI Assistant response.
5555

@@ -91,7 +91,20 @@ When you interact with AI Assistant in Observability Cloud, Splunk collects and
9191
* - Usage data
9292
- Usage data is more fully described in the Splunk Privacy Statement. Examples include “thumbs up”, “thumbs down”, “chat id”, “copy”, “tokens used”, and “response length”.
9393

94+
You can activate and deactivate data sharing by going to :guilabel:`Settings`. On the General Organization Settings page, go to the AI Assistant Management section. Select :guilabel:`AI Assistant in Observability` to activate the AI Assistant for your organization.
95+
96+
If you do not want to share your data, deselect :guilabel:`Allow my AI service data to be used for research and development purposes`.
97+
98+
.. image:: /_images/get-started/activate-assistant.png
99+
:width: 70%
100+
:alt: This screenshot shows how Splunk Observability Cloud products serve the different layers and processes in an organization's environment.
101+
94102
Service limitations
95103
==================================================================================
96104
A Splunk Observability Cloud organization has a limit of 3,000 prompts per month and no more than 10 prompts per minute.
97105

106+
Other resources
107+
==================================================================================
108+
Learn how to prompt the AI Assistant effectively by reading :ref:`o11y-ai-promptlibrary`. You can find general guidance on how to prompt the Assistant to achieve the best results, as well as see sample prompts and learn what makes a prompt excellent, good, or poor.
109+
110+
To learn about Splunk's commitment to responsible AI, see :new-page:`Responsible AI for AI Assistant in Observability Cloud <http://splunk.com/en_us/about-splunk/splunk-data-security-and-privacy/responsible-ai-for-ai-assistant-in-observability-cloud.html>`.

0 commit comments

Comments
 (0)