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.

샘플 쿼리

{
  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.

   입력스피커, 변수

   Parameter Name	데이터 형식	꼭 필요한가요?	설명
   ragToolEntity	물체	네	The input object that contains the configuration for the new RAG tool.
   description	문자열	네	A clear and accurate description of the RAG tool's purpose.
   name	문자열	네	The unique name for your RAG tool.
   scope	물체	네	An object defining the context in which the tool will be created.
   scope.id	문자열	네	The unique ID of your organization ( ${ORGANIZATION_ID} ).
   scope.type	문자열	네	The type of the scope, which must be ORGANIZATION .

   샘플 돌연변이

   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:

   입력스피커, 변수

   Parameter Name	데이터 형식	꼭 필요한가요?	설명
   Api-Key	문자열	네	Your New Relic API key for authentication.
   NewRelic-Entity	JSON 객체	네	Metadata about the document, such as its name.
   Content-Type	문자열	네	The format of the file being uploaded (e.g., application/json ).
   payload ( @incidents.json )	파일	네	The document file you are uploading, specified by its file path.

   샘플 쿼리

   bash

   카피

   $
   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

   샘플 응답

   응답	데이터 형식	설명
   entityGuid	문자열	The unique identifier for the uploaded RAG document.
   blobVersionEntity	물체	Represents the version of the uploaded blob.

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

   카피

   다음 단계

   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.

입력스피커, 변수

샘플 쿼리

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.

   입력스피커, 변수

   Parameter Name	데이터 형식	꼭 필요한가요?	설명
   relationship	물체	네	The input object that contains the details for the relationship.
   source	물체	네	The source entity of the relationship, which is the RAG document.
   source.scope	문자열	네	The scope of the source entity, which must be ORGANIZATION .
   source.id	문자열	네	The unique GUID of the RAG document ( ${RAG_DOCUMENT_GUID} ).
   target	물체	네	The target entity of the relationship, which is the RAG tool.
   target.scope	문자열	네	The scope of the target entity, which must be ORGANIZATION .
   target.id	문자열	네	The unique GUID of the RAG tool ( ${RAG_TOOL_GUID} ).
   type	문자열	네	The type of the relationship, which must be "INDEXED_FOR" .

   샘플 돌연변이

   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.

  입력스피커, 변수

  Parameter Name	데이터 형식	꼭 필요한가요?	설명
  relationships	질문	네	The query to retrieve relationships between entities.
  filter	물체	아니요	An object used to filter the relationships based on attributes.
  filter.sourceId	물체	아니요	An object to filter by the source entity's unique identifier.
  filter.sourceId.eq	문자열	아니요	The unique GUID of the RAG document to match.

  샘플 쿼리

  {
    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.

입력스피커, 변수

샘플 쿼리

{
  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.