Tutorial de NerdGraph: Configurar la integración de RAG

El ID de organización identifica de forma única su cuenta y garantiza que cualquier herramienta RAG que usted cree, documentos que cargue o relaciones que establezca estén asociados con su organización en New Relic.

Se requiere la identificación de la organización para realizar mutaciones y consultas en NerdGraph al configurar y gestionar herramientas y documentos de RAG. Ejecute la siguiente consulta y conserve el ID de la organización a mano para los pasos posteriores.

Consulta de muestra

{
  actor {
    organization {
      id
    }
  }
}

Una herramienta RAG actúa como un contenedor especializado para organizar documentos y recursos relacionados en New Relic. Un nombre claro y una descripción precisa de sus herramientas RAG ayudan al LLM a seleccionar la herramienta adecuada para cada símbolo, lo que garantiza respuestas relevantes y conscientes del contexto.

Para crear una nueva herramienta RAG en su cuenta de New Relic, ejecute la siguiente mutación entityManagementCreateRagTool :

1. Cerciorar de reemplazar ${ORGANIZATION_ID} con su ID de organización real obtenida en el paso anterior.

2. Si tiene éxito, recibirá un id para su herramienta RAG.

   parámetro de entrada

   Nombre del parámetro	Tipo de datos	¿Es obligatorio?	Descripción
   ragToolEntity	Objeto	Sí	El objeto de entrada que contiene la configuración de la nueva herramienta RAG.
   description	Cadena	Sí	Una descripción clara y precisa del propósito de la herramienta RAG.
   name	Cadena	Sí	El nombre único para su herramienta RAG.
   scope	Objeto	Sí	Un objeto que define el contexto en el que se creará la herramienta.
   scope.id	Cadena	Sí	El ID único de su organización ( ${ORGANIZATION_ID} ).
   scope.type	Cadena	Sí	El tipo del ámbito, que debe ser ORGANIZATION .

   Mutación de muestra

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

   Copia

   Debe almacenar el id devuelto ya que lo necesitará en pasos posteriores para vincular documentos a la herramienta, verificar relaciones y consultar la herramienta para obtener información relevante en New Relic.

La API de Blob y su propósito

Blob API es un servicio de New Relic diseñado para cargar archivos, como documentación y libros de ejecución, a su cuenta. NerdGraph está optimizado para la consulta y mutación de datos estructurados y no para la transferencia eficiente de archivos, por lo que se requiere la API Blob para cargar documentos.

Requisitos de autenticación

Necesita una clave de API de New Relic válida con licencias para cargar documentos. Para obtener la clave de API para cargar un documento en New Relic usando la API Blob:

1. Inicie sesión en su cuenta de New Relic.

2. Crea y gestiona tu clave de API desde la página UI de clave de API .

3. Haga clic en Create a key y complete los detalles requeridos (o emplee una existente con las licencias necesarias).

4. Haga clic en Create a key y copie la clave generada (se verá como NRAK-XXXXXXXXXX).

   A continuación se muestra un ejemplo de cómo cargar un documento mediante el comando curl bash :

   parámetro de entrada

   Nombre del parámetro	Tipo de datos	¿Es obligatorio?	Descripción
   Api-Key	Cadena	Sí	Su clave de API de New Relic para autenticación.
   NewRelic-Entity	Objeto JSON	Sí	metadatos sobre el documento, como su nombre.
   Content-Type	Cadena	Sí	El formato del archivo que se va a cargar (por ejemplo, application/json ).
   payload ( @incidents.json )	Archivo	Sí	El archivo del documento que estás cargando, especificado por su ruta de archivo.

   Consulta de muestra

   bash

   Copia

   $
   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

   Ejemplo de respuesta

   Respuesta	Tipo de datos	Descripción
   entityGuid	Cadena	El identificador único del documento RAG cargado.
   blobVersionEntity	Objeto	Representa la versión del blob cargado.

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

   Copia

   Próximos pasos

   Luego de cargar su documento, este se indexa y queda disponible para que New Relic AI lo busque y lo recupere. Debes almacenar el entityGuid de la respuesta para crear una relación con tu herramienta RAG o para consultar el documento en NerdGraph.

Luego de cargar un documento a través de la API Blob, ejecutar esta consulta confirma que la carga fue exitosa y que el documento se registró correctamente como una entidad de documento RAG con su propio identificador y propiedades únicos.

parámetro de entrada

Consulta de muestra

En la consulta a continuación, reemplace el marcador de posición ${RAG_DOCUMENT_GUID} con el entityGuid que recibió en el paso anterior.

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

Esta consulta devolverá los siguientes detalles sobre su documento RAG:

• id:El ID único del documento RAG.
• name:El nombre del documento RAG.
• blob { url }:La URL para acceder al documento cargado.
• type:El tipo de entidad, que en este caso es EntityManagementRagDocumentEntity.

Ahora que creó una herramienta RAG, cargó su documento y verificó que la carga se realizó correctamente, el siguiente paso es asociar la herramienta RAG y el documento RAG, lo que hará que New Relic AI pueda buscar y emplear su documento. Para ello, ejecute la mutación entityManagementCreateRelationship :

1. Reemplace ${RAG_DOCUMENT_GUID} con entityGuid de la respuesta de la carga del documento a través de la API Blob.

2. Reemplace ${RAG_TOOL_GUID} con id de la respuesta de la mutación de creación de la herramienta RAG.

   parámetro de entrada

   Nombre del parámetro	Tipo de datos	¿Es obligatorio?	Descripción
   relationship	Objeto	Sí	El objeto de entrada que contiene los detalles de la relación.
   source	Objeto	Sí	La entidad de origen de la relación, que es el documento RAG.
   source.scope	Cadena	Sí	El alcance de la entidad de origen, que debe ser ORGANIZATION .
   source.id	Cadena	Sí	El GUID único del documento RAG ( ${RAG_DOCUMENT_GUID} ).
   target	Objeto	Sí	La entidad objetivo de la relación, que es la herramienta RAG.
   target.scope	Cadena	Sí	El alcance de la entidad objetivo, que debe ser ORGANIZATION .
   target.id	Cadena	Sí	El GUID único de la herramienta RAG ( ${RAG_TOOL_GUID} ).
   type	Cadena	Sí	El tipo de relación, que debe ser "INDEXED_FOR" .

   Mutación de muestra

   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
         }
       }
     }
   }

   Copia

Luego de crear una relación entre su documento RAG y la herramienta RAG, puede verificar la asociación consultando las relaciones en NerdGraph. Esto ayuda a garantizar que su documento esté correctamente vinculado y disponible para que New Relic AI lo use.

• Reemplace ${RAG_DOCUMENT_ID} con el entityGuid de su documento cargado.

  parámetro de entrada

  Nombre del parámetro	Tipo de datos	¿Es obligatorio?	Descripción
  relationships	Consultar	Sí	La consulta para recuperar relaciones entre entidades.
  filter	Objeto	No	Un objeto empleado para filtrar las relaciones según el atributo.
  filter.sourceId	Objeto	No	Un objeto para filtrar por el identificador único de la entidad de origen.
  filter.sourceId.eq	Cadena	No	El GUID único del documento RAG que debe coincidir.

  Consulta de muestra

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

  Copia

Luego de configurar su herramienta RAG e indexar los documentos, puede consultar la herramienta RAG para recuperar información relevante en función de su símbolo. Esto permite que New Relic AI muestre respuestas sensibles al contexto empleando la documentación de su organización.

parámetro de entrada

Consulta de muestra

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

La respuesta incluirá coincidencias fragmentadas de sus documentos indexados, que puede usar directamente o resumir con New Relic AI.