Configurar la integración de RAG

Con New Relic, puede mejorar el agente New Relic AI con generación aumentada por recuperación (RAG) asociando su documentación, runbooks, retrospectivas de incidentes e incluso código fuente con sus servicios. Este proceso proporciona a New Relic AI información mejor y más valiosa sobre los problemas con su sistema. El tutorial describe cómo obtener el ID de su organización, crear una herramienta RAG y agregar sus documentos a la plataforma mediante la API Blob.

Luego de agregar sus documentos, creará una relación para asociarlos con la herramienta RAG. Luego puede verificar su configuración consultando las relaciones entre los documentos RAG y la herramienta RAG. El paso final es consultar la propia herramienta RAG para recuperar información relevante e indexada.

Para obtener más información sobre el conector de conocimiento, consulte Conector de conocimiento de New Relic AI.

Importante

Antes de realizar los siguientes pasos, cerciorar de tener licencias de "Administrador de producto de la organización".

Para comenzar a indexar su contenido y beneficiarse del conector de conocimiento con New Relic AI, siga estos pasos mencionados:

Tarea 1: Crea tu herramienta 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 :

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

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

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.

Tarea 2

Tiene dos opciones para proporcionar contexto a su herramienta RAG. Puede cargar archivos estáticos manualmente o configurar un conector automatizado para la documentación viva.

Opción A: Indexar sus documentos

Si tiene documentos estáticos como archivos PDF, Word o CSV locales que no están alojados en una base de conocimientos en la nube, utilice el Document Knowledge Connector. Este método utiliza la API Blob para cargar archivos individuales directamente a New Relic. Use esta opción para:

**Contexto de una sola vez:** Carga de runbooks específicos o diagramas de arquitectura que rara vez cambian.
Datos locales: Indexación de archivos propietarios o internos que residen en su máquina local en lugar de una wiki.
Pruebas agénticas: Proporcionar rápidamente un conjunto específico de documentos a un agente de IA para un flujo de trabajo enfocado.

Importante

Todos los documentos indexados son visibles para todos los usuarios dentro de su organización. Cerciorar de que los documentos que indexe cumplan con sus políticas internas y no carguen datos confidenciales o privados.

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:

Inicie sesión en su cuenta de New Relic.
Crea y gestiona tu clave de API desde la página UI de clave de API .
Haga clic en Create a key y complete los detalles requeridos (o emplee una existente con las licencias necesarias).

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

$curl -X POST https://blob-api.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
}

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

Nombre del parámetro	Tipo de datos	¿Es obligatorio?	Descripción
`id`	Cadena	Sí	El GUID único del documento RAG que se recuperará.

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 :

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

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

Opción B: Indexe sus documentos de Confluence

Si su organización utiliza Confluence para la documentación, puede indexar sus documentos de Confluence en New Relic sin necesidad de utilizar la API Blob. Esta opción le permite conectar su instancia de Confluence y seleccionar documentos o espacios específicos para ser indexados y asociados con su herramienta RAG. Use esta opción para garantizar que New Relic AI siempre tenga la versión más reciente de sus páginas de Confluence.

El conector requiere un token de API de Atlassian para obtener sus páginas. Almacena esto de forma segura en el gestor de secretos de New Relic.

parámetro de entrada

Nombre del parámetro	Tipo de datos	¿Obligatorio?	Descripción
descripción	Cadena	No	Un breve resumen de para qué se utiliza el secreto.
llave	Cadena	Sí	El nombre único utilizado para hacer referencia a este secreto (por ejemplo, `CONFLUENCE_API_TOKEN` ).
namespace	Cadena	Sí	Debe establecerse en rag-datafetching para que el servicio de indexación RAG pueda acceder a él.
valor	Cadena	Sí	El valor real del token de API de Confluence o la contraseña.
alcance	Objeto	Sí	Define el contexto organizacional; el tipo debe ser ORGANIZATION .

Mutación de muestra

mutation createSecretKey {
  secretsManagementCreateSecret(
    description: "Confluence API token for RAG indexing"
    key: "CONFLUENCE_API_TOKEN"
    namespace: "rag-datafetching"
    scope: { id: "YOUR_ORGANIZATION_ID", type: ORGANIZATION }
    value: "YOUR_CONFLUENCE_API_TOKEN"
  ) {
    key
  }
}

Defina la conexión a su instancia de Confluence. Esto actúa como el puente entre New Relic y Atlassian.

parámetro de entrada

Nombre del parámetro	Tipo de datos	¿Obligatorio?	Descripción
nombre	Cadena	Sí	Un nombre descriptivo para la integración (por ejemplo, "Engineering Confluence").
url	Cadena	Sí	Su URL base de Confluence (por ejemplo, https://example.atlassian.net/wiki ).
confluenceUserId	Cadena	Sí	La dirección de correo electrónico o el ID asociado a su token de API de Atlassian.
secretKey	Cadena	Sí	El nombre de la clave que definió en el paso anterior ( `CONFLUENCE_API_TOKEN` ).
alcance	Objeto	Sí	Define el contexto para la integración. El tipo debe establecerse en ORGANIZATION .
etiquetas	Objeto	No	Metadatos opcionales utilizados para categorizar la integración por departamento o equipo.

Mutación de muestra

mutation {
  entityManagementCreateConfluenceIntegration(
    confluenceIntegration: {
      name: "Engineering Confluence Integration"
      url: "https://your-company.atlassian.net/wiki"
      confluenceUserId: "your-confluence-user-id"
      secretKey: "CONFLUENCE_API_TOKEN" # From Step 2
      scope: { id: "YOUR_ORGANIZATION_ID", type: ORGANIZATION }
      tags: { key: "department", values: "engineering" }
    }
  ) {
    entity {
      id
    }
  }
}

Cree una entidad de configuración de RAG para definir qué contenido recuperar y cómo debe fragmentarse.

parámetro de entrada

Nombre del parámetro	Tipo de datos	¿Obligatorio?	Descripción
confluenceIntegrationId	Cadena	Sí	El ID único de la integración de Confluence creada en el paso anterior.
confluenceQuery	Cadena	Sí	Un filtro CQL (Confluence Query Language) (por ejemplo, space = 'ENG')..
Intervalo en segundos	En t	Sí	El número de segundos entre ejecuciones de indexación (por ejemplo, 3600 por cada hora).
chunkSize	En t	Sí	El número máximo de caracteres en cada segmento de texto (por ejemplo, 4000).
Superposición de fragmentos	En t	Sí	El número de caracteres que se superpondrán entre segmentos de texto (por ejemplo, 100) para mantener el contexto.
textSplitterType	Enumeración	Sí	El tipo de divisor de texto a utilizar (por ejemplo, `MARKDOWN_TEXT_SPLITTER` ).
Opciones del divisor de texto Markdown	Objeto	No	Configuración para la división de markdown, como en qué niveles de encabezado (#, ##) dividir.
Opciones del divisor de texto por tokens	Objeto	No	Configuración para la división de tokens, incluido el modelo de codificación (por ejemplo, `O200K_BASE` ).
etiquetas	Objeto	No	Metadatos opcionales para categorizar configuraciones (por ejemplo, clave: `knowledge_category` , valores: `documentation` ).

Tipos de separadores de texto

Utilice estos tipos para definir el parámetro textSplitterType:

TOKEN_TEXT_SPLITTER: División precisa basada en tokens.
MARKDOWN_TEXT_SPLITTER: Dividir por encabezados de markdown.
CHARACTER_TEXT_SPLITTER: Dividir por recuento de caracteres.
JSON_TEXT_SPLITTER: Dividir JSON recursivamente.
Si utiliza TOKEN_TEXT_SPLITTER, defina la codificación en tokenTextSplitterOptions:
O200K_BASE: Para GPT-4o y modelos más recientes (recomendado).

CL100K_BASE: Para GPT-4 y GPT-3.5.

Mutación de muestra

mutation {
  entityManagementCreateConfluenceRagSettings(
    confluenceRagSettingsEntity: {
      name: "Engineering Docs RAG Settings"
      scope: { id: "YOUR_ORGANIZATION_ID", type: ORGANIZATION }
      confluenceIntegrationId: "INTEGRATION_ID_FROM_STEP_3"
      confluenceQuery: "space = ENG AND type = page"
      intervalSeconds: 3600 # Re-index every hour
      # Chunking Configuration
      chunkSize: 4000
      chunkOverlap: 100
      textSplitterType: MARKDOWN_TEXT_SPLITTER
      # Optional: Markdown-specific options
      markdownTextSplitterOptions: {
        headersToSplitOn: "#,##,###"
        returnEachLine: false
      }
      # Optional: Token splitter options (if using TOKEN_TEXT_SPLITTER)
      # tokenTextSplitterOptions: {
      #   encodingName: O200K_BASE
      # }

      # Optional: Character splitter options (if using CHARACTER_TEXT_SPLITTER)
      # characterTextSplitterOptions: {
      #   separator: "\n\n"
      #   isSeparatorRegex: false
      # }

      tags: { key: "knowledge_category", values: "documentation" }
    }
  ) {
    entity {
      id
    }
  }
}

Vincular su configuración de RAG con su herramienta RAG mediante una relación APPLY_TO activa la indexación automatizada.

parámetro de entrada

Nombre del parámetro	Tipo de datos	¿Obligatorio?	Descripción
source.id	Cadena	Sí	El ID de la configuración de RAG creada en el paso anterior.
target.id	Cadena	Sí	El ID de la herramienta RAG creada en la Tarea 1.
tipo	Cadena	Sí	Debe establecerse en `APPLY_TO` para las conexiones de configuración a herramienta.
etiquetas	Cadena	Sí	Metadatos opcionales utilizados para etiquetar la relación (por ejemplo, clave: " `auto_created` ", valores: " `true` ")

Mutación de muestra

mutation {
  entityManagementCreateRelationship(
    relationship: {
      source: { id: "RAG_SETTINGS_ID_FROM_STEP_4", scope: ORGANIZATION }
      target: { id: "RAG_TOOL_ID_FROM_STEP_1", scope: ORGANIZATION }
      type: "APPLY_TO"
      tags: { key: "auto_created", values: "true" }
    }
  ) {
    relationship {
      type
    }
  }
}

Resultado: Indexación automática activada

¡La indexación ahora se realizará automáticamente!

Cuando se crea la relación APPLY_TO entre su configuración de RAG y su herramienta de RAG, el servicio de indexador RAG de New Relic inicia el siguiente proceso en segundo plano:

El servicio utiliza su confluenceQuery para buscar contenido coincidente en su instancia de Confluence.
Recupera todas las páginas coincidentes y las transforma en un formato procesable.
El contenido se divide en segmentos más pequeños según su configuración de chunkSize, chunkOverlap y textSplitterType.
El servicio genera embeddings densos y dispersos para cada fragmento y los indexa en la base de datos vectorial (Pinecone).
El conector reindexará su contenido periódicamente según el intervalSeconds que definió para garantizar que la IA tenga acceso a la documentación más actualizada.

Tarea 3: Recuperar información relevante

Después de establecer una relación (ya sea vinculando un documento RAG específico mediante INDEXED_FOR o aplicando una configuración de Confluence mediante APPLY_TO), puede verificar la asociación y consultar la herramienta. Esto garantiza que su conocimiento interno esté correctamente indexado y disponible para que New Relic AI proporcione respuestas basadas en el contexto.

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

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

Nombre del parámetro	Tipo de datos	¿Es obligatorio?	Descripción
`prompt`	Cadena	Sí	La consulta en lenguaje natural que desea que la herramienta RAG procese.
`toolId`	Cadena	Sí	El GUID único de la herramienta RAG a consultar.

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.

Te ofrecemos esta traducción automática para facilitar la lectura.

Importante

Tarea 1: Crea tu herramienta RAG .css-21sua1{background:none;border:none;width:0;padding:0;}

Crear una herramienta RAG

Tarea 2

Opción A: Indexar sus documentos

Subir un documento a través de la API de Blob

Ver la entidad del documento RAG representada en NerdGraph

Crear una relación entre la herramienta RAG y el documento RAG

Opción B: Indexe sus documentos de Confluence

Guarde su token de API de Confluence

Crear la integración de Confluence

Configurar la lógica de indexación (configuración de RAG)

Crear relación

Resultado: Indexación automática activada

Tarea 3: Recuperar información relevante

Consulta para ver las relaciones entre los documentos RAG y las herramientas RAG

Consulta la herramienta RAG

Tarea 1: Crea tu herramienta RAG