NerdGraph tutorial: Set up RAG integration

Organization ID uniquely identifies your account and ensures that any RAG tool you create, documents you upload, or relationships you establish are associated with your organization in New Relic.

Organization ID is required to perform mutations and queries in NerdGraph when setting up and managing RAG tools and documents. Run the following query and keep the organization ID handy for later steps.

Sample query

{
  actor {
    organization {
      id
    }
  }
}

A RAG tool acts as a specialized container for organizing related documents and resources in New Relic. A clear name and accurate description for your RAG tools helps the LLM select the right tool for each prompt, ensuring relevant and context-aware responses.

To create a new RAG tool in your New Relic account, run the following entityManagementCreateRagTool mutation:

1. Make sure to replace ${ORGANIZATION_ID} with your actual organization ID obtained in the previous step.
2. If successful, you'll receive an id for your RAG tool.

Input parameters

Sample mutation

mutation {
  entityManagementCreateRagTool(
    ragToolEntity: {
      description: "Runbooks for resolving incidents with APIs",
      name: "API Runbooks",
      scope: {id: `${ORGANIZATION_ID}`, type: ORGANIZATION}
    }
  ) {
    entity {
      id
    }
  }
}

You should save the id returned as you'll need it in later steps to link documents to the tool, verify relationships, and query the tool for relevant information in New Relic.

The Blob API and its purpose

The Blob API is a New Relic service designed for uploading files, such as documentation and runbooks, to your account. NerdGraph is optimized for structured data queries and mutations and not for efficient transfer of files, so the Blob API is required for uploading documents.

Authentication requirements

You need a valid New Relic API key with permissions to upload documents. To get the API key for uploading a document to New Relic using the Blob API:

1. Log in to your New Relic account.
2. Create and manage your API keys from the API keys UI page.
3. Click Create a key, and fill the required details (or use an existing one with the required permissions).
4. Click Create a key and copy the generated key (it'll look like NRAK-XXXXXXXXXX).

Here's an example of how to upload a document using a curl bash command:

Input parameters

Sample query

$
curl -X POST https://blob-api.one-service.newrelic.com/v1/e/organizations/$ORGANIZATION_ID/RagDocuments \
>
     -H 'Api-Key: NRAK-XXXXXXXXXX' \
>
     -H 'NewRelic-Entity: {"name": "Runbooks for API service" }' \
>
     -H 'Content-Type: application/json' \
>
     -d @incidents.json

Sample response

{
  "entityGuid": "MTIyODU0NTN8TkdFUHxSQUdfRE9DVU1FTlR8MDE5NGUyOTgtYmQzMS03NzA4LWI3NzItYzQ4MTZlYjNhYThk",
  "blobVersionEntity": null
}

Next steps

After uploading your document, it is indexed and becomes available for New Relic AI to search and retrieve. You must save the entityGuid from the response to create a relationship with your RAG tool or to query the document in NerdGraph.

After a document is uploaded via the Blob API, running this query confirms that the upload was successful and that the document has been properly registered as a RAG document entity with its own unique identifier and properties.

Input parameters

Sample query

In the query below, replace the ${RAG_DOCUMENT_GUID} placeholder with the entityGuid you received in the previous step.

{
  actor {
    entityManagement {
      entity(
        id: `${RAG_DOCUMENT_GUID}`
      ) {
        ... on EntityManagementRagDocumentEntity {
          id
          name
          blob {
            url
          }
          type
        }
      }
    }
  }
}

This query will return the following details about your RAG document:

• id: The unique ID of the RAG document.
• name: The name of the RAG document.
• blob { url }: The URL to access the uploaded document.
• type: The type of the entity, which in this case is EntityManagementRagDocumentEntity.

Now that you've created a RAG tool, uploaded your document, and verified that the upload was successful, the next step is to associate the RAG tool and the RAG document thereby making your document searchable and usable by New Relic AI. To do this, run the entityManagementCreateRelationship mutation:

1. Replace ${RAG_DOCUMENT_GUID} with the entityGuid from the response of the document upload via the Blob API.
2. Replace ${RAG_TOOL_GUID} with the id from the response of the RAG tool creation mutation.

Input parameters

Sample mutation

mutation {
  entityManagementCreateRelationship(
    relationship: {
      source: {
        scope: ORGANIZATION,
        id: `${RAG_DOCUMENT_GUID}`
      },
      target: {
        scope: ORGANIZATION,
        id: `${RAG_TOOL_GUID}`
      },
      type: "INDEXED_FOR"
    }
  ) {
    relationship {
      type
      target {
        id
        type
      }
      source {
        id
        type
      }
    }
  }
}

After creating a relationship between your RAG document and RAG tool, you can verify the association by querying relationships in NerdGraph. This helps ensure your document is properly linked and available for New Relic AI to use.

• Replace ${RAG_DOCUMENT_ID} with the entityGuid of your uploaded document.

Input parameters

Sample query

{
  actor {
    entityManagement {
      relationships(
        filter: {sourceId: {eq: `${RAG_DOCUMENT_ID}`}}
      ) {
        items {
          type
          target {
            id
            type
          }
        }
      }
    }
  }
}

After you've set up your RAG tool and indexed documents, you can query the RAG tool to retrieve relevant information based on your prompt. This allows New Relic AI to surface context-aware answers using your organization's documentation.

Input parameters

Sample query

{
  actor {
    machineLearning {
      ragQueryData(
        prompt: "tell me about the incident", 
        toolId: `${RAG_TOOL_GUID}`
      ) {
        blobId
        chunk
        documentId
        score
        toolId
      }
    }
  }
}

The response will include chunked matches from your indexed documents, which you can use directly or summarize with New Relic AI.