Skip to content

Commit e14f037

Browse files
Incorporated feedback
1 parent 7460dd3 commit e14f037

File tree

3 files changed

+79
-32
lines changed

3 files changed

+79
-32
lines changed

src/content/docs/agentic-ai/knowledge-integration/overview.mdx

Lines changed: 37 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -13,17 +13,27 @@ redirects:
1313
This feature is currently provided as part of a preview program pursuant to our [pre-release policies](/docs/licenses/license-information/referenced-policies/new-relic-pre-release-policy).
1414
</Callout>
1515

16-
New Relic AI uses large language models (LLMs) and New Relic's data platform to help you understand your system and how to better glean insights about the performance of those systems. It allows you to ask questions, troubleshoot issues, and explore telemetry data using plain language.
16+
To provide more context-specific answers, New Relic AI can use a technique called Retrieval Augmented Generation (RAG) through the New Relic AI knowledge connector. While New Relic AI LLMs have a vast general knowledge, RAG enhances their responses.
1717

18-
To provide more context-specific answers, New Relic AI can use a technique called Retrieval Augmented Generation (RAG) through the New Relic AI knowledge connector. While foundation LLMs have a vast general knowledge, RAG enhances their responses by retrieving relevant information from your external data sources.
18+
By setting up the New Relic AI knowledge connector, you can expect tangible outcomes such as faster incident resolution, more accurate and context-aware AI responses, and reduced manual searching across multiple documents. This unified approach helps your team make better decisions and respond to issues more efficiently.
1919

2020
## How it works
21-
The New Relic AI knowledge connector integrates your internal knowledge with the analytical power of New Relic AI through the following three-step process:
22-
- **Index:** The first step is to connect your content and knowledge bases, such as Confluence, to the New Relic AI platform. Once connected, the knowledge connector will perform an initial indexing of your documents. You can configure this process to run on a recurring basis, ensuring that New Relic AI always has access to the most up-to-date information as your documents evolve.
23-
- **Retrieval:** When a user asks a question in New Relic AI, the system searches the indexed content for information relevant to the user's query. This step ensures that the context is pulled directly from your trusted, internal documentation.
24-
- **Generation:** Finally, the system combines the retrieved information with the powerful generative capabilities of the underlying LLM. This synthesis produces a comprehensive and context-aware answer, grounded in your specific data and best practices.
2521

26-
This RAG approach significantly improves the accuracy and relevance of the responses, reducing the likelihood of generic or hallucinated answers.
22+
<img
23+
title="High-level visual of Knowledge connector"
24+
alt="High-level visual of Knowledge connector"
25+
src="/images/High-Level Visual Overview of the New Relic AI Knowledge Connector.webp"
26+
/>
27+
28+
Your content and knowledge bases, such as Confluence, are uploaded to the New Relic AI platform. The system follows a three-step process to provide a context-aware answer:
29+
30+
- **Index:** Once your knowledge bases are connected to the New Relic AI platform, the knowledge connector performs an initial indexing of your documents. You can configure this process to run on a recurring basis, ensuring that New Relic AI always has access to the most up-to-date information as your documents evolve.
31+
32+
- **Retrieval:** When you ask a question in New Relic AI, the system searches the indexed content for information relevant to your query. This step ensures that the context is pulled directly from your trusted, internal documentation.
33+
34+
- **Generation:** The system combines the retrieved information with the powerful generative capabilities of the underlying LLM. This synthesis produces a comprehensive and context-aware answer, grounded in your specific data and best practices.
35+
36+
If a query does not require your organizational knowledge, New Relic AI will generate an answer using the underlying LLM's vast general knowledge. In both cases, the goal is to provide you with the most relevant and accurate information possible.
2737

2838
## Key features
2939
With New Relic AI knowledge connector, you can:
@@ -34,30 +44,41 @@ With New Relic AI knowledge connector, you can:
3444
- "What are the standard triage steps for this type of alert?"
3545
- "Show me the runbook for a `database connection limit exceeded` error."
3646

47+
## Data security and privacy
48+
3749
<Callout variant="important">
38-
39-
At this time, all indexed documents can be retrieved by all users within your organization's New Relic account. Before you begin indexing, ensure that the documents you intend to connect comply with your internal data security and privacy policies for use of the services.
40-
50+
51+
At this time, all indexed documents can be retrieved by all users within your organization's New Relic account. Please verify that only appropriate content is indexed, as there's currently no option to restrict access or redact information after indexing.
52+
4153
</Callout>
4254

55+
Before you begin indexing, ensure that:
56+
57+
* Only documents suitable for organization-wide access are indexed.
58+
* Sensitive information is redacted.
59+
* All the documents to be indexed comply with your organization's internal data security and privacy policies.
60+
4361
## Use cases and value
4462

4563
Here are some New Relic AI tools and a brief overview of how the knowledge connector integration adds value to each:
4664

4765
<CollapserGroup>
4866
<Collapser id="retro-docsearch-tool" title="Retro DocSearch">
4967

50-
When a critical incident occurs, you face a time-consuming investigation because historical context is fragmented across multiple sources like Confluence, Jira, and runbooks. The knowledge connector integrates all of these disparate sources, transforming the Retro DocSearch tool into a powerful historical intelligence engine that provides all the context in one place. This allows the tool to:
68+
When a critical incident occurs, you face a time-consuming investigation because historical context is fragmented across multiple sources like Confluence and runbooks.
69+
70+
The knowledge connector integrates all of these disparate sources, transforming the Retro DocSearch tool into a powerful historical intelligence engine that provides all the context in one place. This allows the tool to:
5171

5272
* Provide an immediate summary of an original incident's root cause.
5373
* Present specific actionable steps from the runbook that resolved the issue.
5474
* Identify the names of the experts or teams who solved it before.
55-
* Fetch the status of the long-term fix from a Jira ticket.
5675

5776
</Collapser>
5877
<Collapser id="dashboard-analysis-tool" title="Dashboard Analysis">
5978

60-
While the Dashboard Analysis tool provides key insights, its analysis is limited to the data received by the dashboard. It lacks crucial business context, making it difficult to understand the true impact of an issue. The knowledge connector integration grounds the Dashboard Analysis tool in your company's unique knowledge, acting as a bridge between raw telemetry and your internal documentation. This allows the tool to:
79+
While the Dashboard Analysis tool provides key insights, its analysis is limited to the data received by the dashboard. It lacks crucial business context, making it difficult to understand the true impact of an issue.
80+
81+
The knowledge connector integration grounds the Dashboard Analysis tool in your company's unique knowledge, acting as a bridge between raw telemetry and your internal documentation. This allows the tool to:
6182

6283
* Explain the business impact using indexed documents that define key business metrics.
6384
* Curate suggestions based on internal runbooks to provide context-specific actionable steps.
@@ -67,7 +88,9 @@ While the Dashboard Analysis tool provides key insights, its analysis is limited
6788

6889
<Collapser id="synthetic-monitor-creation" title="Create Synthetic Monitoring">
6990

70-
This tool generates a basic synthetic monitor creation script, but it lacks an understanding of your organization's unique standards and proprietary information. This creates manual work to ensure compliance and inject authentication tokens. The knowledge connector integration elevates the tool by giving it access to your company's internal documents. This allows the tool to:
91+
This tool generates a basic synthetic monitor creation script, but it lacks an understanding of your organization's unique standards and proprietary information. This creates manual work to ensure compliance and inject authentication tokens.
92+
93+
The knowledge connector integration elevates the tool by giving it access to your company's internal documents. This allows the tool to:
7194

7295
* Automate standardization by applying your company’s rules to the generated script.
7396
* Inject specific non-public information from an indexed runbook or wiki into the monitor's configuration.

src/content/docs/apis/nerdgraph/examples/nerdgraph-rag.mdx

Lines changed: 42 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,21 @@ redirects:
66
freshnessValidatedDate: never
77
---
88

9-
With New Relic, you can enhance New Relic AI agents with RAG. This means that you can associate documentation, runbooks, incident retros and even source code with your services, giving New Relic AI better insight into issues with your system.
9+
<Callout title="preview">
10+
We're still working on this feature, but we'd love for you to try it out!
1011

11-
## Get Started with RAG [#get-started]
12+
This feature is currently provided as part of a preview program pursuant to our [pre-release policies](/docs/licenses/license-information/referenced-policies/new-relic-pre-release-policy).
13+
</Callout>
14+
15+
With New Relic, you can enhance New Relic AI agents with RAG. This means that you can associate documentation, runbooks, incident retros, and even source code with your services, giving New Relic AI better insight into issues with your system.
16+
17+
To learn more about the knowledge connector, refer to [New Relic AI Knowledge connector](/docs/agentic-ai/knowledge-integration/overview).
18+
19+
## Get started with RAG [#get-started]
1220

13-
### Obtain your organization ID [#get-org-id]
21+
<Collapser id ="get-org-id" title ="Obtain your organization ID">
22+
23+
Before you begin, you'll need your organization ID to use with the following mutations and queries.
1424

1525
```graphql
1626
{
@@ -21,10 +31,12 @@ With New Relic, you can enhance New Relic AI agents with RAG. This means that yo
2131
}
2232
}
2333
```
34+
</Collapser>
35+
## Configure your RAG tool
36+
<CollapserGroup>
37+
<Collapser id = "create-rag-tool" title = "Create a RAG tool">
2438

25-
### Create a RAG Tool [#create-rag-tool]
26-
27-
It should be noted - the name and description of your RAG Tool are extremely important! The LLM will choose to leverage a tool when responding to a prompt based on the accuracy of a tool's name and description.
39+
The name and description of your RAG tool help the LLM understand when and how to use it. Provide a clear name and accurate description so that the LLM is more likely to select the right tool for a given prompt and provide relevant, context-aware responses.
2840

2941
```graphql
3042
mutation {
@@ -41,14 +53,16 @@ mutation {
4153
}
4254
}
4355
```
44-
45-
### Upload a document to the Blob API [#upload-document]
56+
</Collapser>
57+
<Collapser id = "upload-document" title = "Upload a document to the Blob API">
4658

4759
<Callout variant="important">
4860
All indexed documents are visible to all users within your organization. Make sure the documents you index comply with your internal policies for use of the services.
4961
</Callout>
5062

51-
* Note that this specific step is not through NerdGraph. This is because NerdGraph does support file uploads through it's APIs.
63+
NerdGraph is optimized for structured data queries and mutations and not for the efficient transfer of files. In order to upload documents, you will use the Blob API.
64+
65+
Here's an example of how to upload a document using a `curl` `bash` command:
5266

5367
```shell
5468
curl -X POST https://blob-api.one-service.newrelic.com/v1/e/organizations/$ORGANIZATION_ID/RagDocuments \
@@ -66,8 +80,10 @@ The response will look like this:
6680
"blobVersionEntity": null
6781
}
6882
```
83+
</Collapser>
84+
<Collapser id = "view-the-rag-document-entity-represented-in-nerdgraph" title = "View the RAG document entity represented in NerdGraph">
6985

70-
### View the RAG Document entity represented in NerdGraph
86+
You can view the RAG document entity in NerdGraph.
7187

7288
```graphql
7389
{
@@ -89,10 +105,9 @@ The response will look like this:
89105
}
90106
}
91107
```
92-
93-
Now that we have a RAG Tool and a RAG Document, we need to associate them with each other. This is done via the Entity Management APIs in NerdGraph.
94-
95-
### Create a relationship between the RAG Document and the RAG Tool
108+
</Collapser>
109+
<Collapser id = "create-a-relationship-between-the-rag-document-and-the-rag-tool" title = "Create a relationship between the RAG document and the RAG tool">
110+
Now that you have a RAG tool and a RAG document, you need to associate them with each other. This is done via the Entity Management APIs in NerdGraph.
96111

97112
```graphql
98113
mutation {
@@ -123,8 +138,15 @@ mutation {
123138
}
124139
}
125140
```
141+
</Collapser>
142+
</CollapserGroup>
126143

127-
### Query to see relationships between RAG Documents and RAG Tools
144+
## Verify your configuration
145+
146+
<CollapserGroup>
147+
<Collapser id="query-to-see-relationships-between-rag-documents-and-rag-tools" title="Query to see relationships between RAG documents and RAG tools">
148+
149+
You can query relationships between RAG documents and RAG tools.
128150

129151
```graphql
130152
{
@@ -145,10 +167,10 @@ mutation {
145167
}
146168
}
147169
```
170+
</Collapser>
171+
<Collapser id="query-the-rag-tool" title="Query the RAG tool">
148172

149-
### Query the RAG Tool
150-
151-
You can query your RAG Tool and receive chunked matches based on the documents indexed for a given tool. You may use New Relic AI to summarize the returned chunk matches, or you may use the NerdGraph APIs to retrieve the match and use your own AI on your own systems.
173+
You can query your RAG tool and receive chunked matches based on the documents indexed for a given tool. You may use New Relic AI to summarize the returned chunk matches, or you may use the NerdGraph APIs to retrieve the match and use your own AI on your own systems.
152174

153175
```graphql
154176
{
@@ -168,3 +190,5 @@ You can query your RAG Tool and receive chunked matches based on the documents i
168190
}
169191
}
170192
```
193+
</Collapser>
194+
</CollapserGroup>

0 commit comments

Comments
 (0)