Configurer l'intégration RAG

Avec New Relic, vous pouvez améliorer les agents New Relic AI avec la génération augmentée de récupération (RAG) en associant votre documentation, vos runbooks, vos rétroactions incident et même votre source de code à vos services. Ce processus donne à New Relic AI des informations plus détaillées sur les problèmes liés à votre système. Le didacticiel explique comment obtenir l'ID de votre organisation, créer un outil RAG et ajouter vos documents à la plateforme à l'aide de l'API Blob.

Après avoir ajouté vos documents, vous créerez une relation pour les associer à l'outil RAG. Vous pouvez ensuite vérifier votre configuration en interrogeant les relations entre les documents RAG et l’outil RAG. L’étape finale consiste à interroger l’outil RAG lui-même pour récupérer des informations pertinentes et indexées.

Pour en savoir plus sur le connecteur de connaissances, reportez-vous à New Relic AI Connecteur de connaissances.

Important

Avant d'effectuer les étapes suivantes, assurez-vous que vous disposez des autorisations « Administrateur de produit d'organisation ».

Pour commencer à indexer votre contenu et bénéficier du connecteur de connaissances avec New Relic AI, suivez les étapes mentionnées :

Tâche 1 : Créez votre outil RAG

L'ID d'organisation identifie de manière unique votre compte et garantit que tout outil RAG que vous créez, les documents que vous téléchargez ou les relations que vous établissez sont associés à votre organisation dans New Relic.

L'ID d'organisation est requis pour effectuer des mutations et des requêtes dans NerdGraph lors de la configuration et de la gestion des outils et documents RAG. Exécutez la requête suivante et conservez l’ID de l’organisation à portée de main pour les étapes ultérieures.

Exemple de requête

{
  actor {
    organization {
      id
    }
  }
}

Un outil RAG agit comme un conteneur spécialisé pour organiser les documents et ressources associés dans New Relic. Un nom clair et une description précise de vos outils RAG aident le LLM à sélectionner le bon outil pour chaque prompt, garantissant des réponses pertinentes et contextuelles.

Pour créer un nouvel outil RAG dans votre compte New Relic, exécutez la mutation entityManagementCreateRagTool suivante :

Assurez-vous de remplacer ${ORGANIZATION_ID} par votre identifiant d’organisation réel obtenu à l’étape précédente.

En cas de succès, vous recevrez un id pour votre outil RAG.

Paramètres d'entrée

Nom du paramètre	Type de données	Est-ce obligatoire ?	Description
`ragToolEntity`	Objet	Oui	L'objet d'entrée qui contient la configuration du nouvel outil RAG.
`description`	Chaîne	Oui	Une description claire et précise de l’objectif de l’outil RAG.
`name`	Chaîne	Oui	Le nom unique de votre outil RAG.
`scope`	Objet	Oui	Un objet définissant le contexte dans lequel l'outil sera créé.
`scope.id`	Chaîne	Oui	L'ID unique de votre organisation ( `${ORGANIZATION_ID}` ).
`scope.type`	Chaîne	Oui	Le type de portée, qui doit être `ORGANIZATION` .

Mutation d'échantillon

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

Vous devez enregistrer le id renvoyé car vous en aurez besoin dans les étapes ultérieures pour lier des documents à l'outil, vérifier les relations et interroger l'outil pour obtenir des informations pertinentes dans New Relic.

Tâche 2

Vous disposez de deux options pour fournir du contexte à votre outil RAG. Vous pouvez importer manuellement des fichiers statiques ou configurer un connecteur automatisé pour la documentation vivante.

Option A : Indexez vos documents

Si vous disposez de documents statiques tels que des PDF, des fichiers Word ou des CSV locaux qui ne sont pas hébergés dans une base de connaissances cloud, utilisez le Document Knowledge Connector. Cette méthode utilise l'API Blob pour télécharger des fichiers individuels directement vers New Relic. Utilisez cette option pour :

**Contexte ponctuel :** Téléchargement de runbooks spécifiques ou de diagrammes d'architecture qui changent rarement.
Données locales : Indexation de fichiers propriétaires ou internes résidant sur votre machine locale plutôt que sur un wiki.
Tests agentiques : Fournir rapidement un ensemble spécifique de documents à un agent IA pour un workflow ciblé.

Important

Tous les documents indexés sont visibles par tous les utilisateurs de votre organisation. Assurez-vous que les documents que vous indexez sont conformes à vos politiques internes et ne téléchargez pas de données sensibles ou privées.

L'API Blob et son objectif

L'API Blob est un service New Relic conçu pour télécharger des fichiers, tels que de la documentation et des runbooks, sur votre compte. NerdGraph est optimisé pour les requêtes de données structurées et les mutations et non pour le transfert efficace de fichiers, donc l'API Blob est requise pour le téléchargement de documents.

Exigences d'authentification

Vous avez besoin d’une clé API New Relic valide avec des autorisations pour télécharger des documents. Pour obtenir la clé API permettant de télécharger un document sur New Relic à l'aide de l'API Blob :

Connectez-vous à votre compte New Relic.
Créez et gérez votre clé API à partir de la page d'interface utilisateur de la clé API.
Cliquez sur Create a key et remplissez les détails requis (ou utilisez une clé existante avec les autorisations requises).

Cliquez sur Create a key et copiez la clé générée (elle ressemblera à NRAK-XXXXXXXXXX).

Voici un exemple de la manière de télécharger un document à l'aide d'une commande curl bash :

Paramètres d'entrée

Nom du paramètre	Type de données	Est-ce obligatoire ?	Description
`Api-Key`	Chaîne	Oui	Votre clé API New Relic pour l'authentification.
`NewRelic-Entity`	Objet JSON	Oui	métadonnées sur le document, comme son nom.
`Content-Type`	Chaîne	Oui	Le format du fichier en cours de téléchargement (par exemple, `application/json` ).
`payload` ( `@incidents.json` )	Déposer	Oui	Le fichier de document que vous téléchargez, spécifié par son chemin de fichier.

Exemple de requête

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

Exemple de réponse

Réponse	Type de données	Description
`entityGuid`	Chaîne	L'identifiant unique du document RAG téléchargé.
`blobVersionEntity`	Objet	Représente la version du blob téléchargé.

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

Prochaines étapes

Après avoir téléchargé votre document, il est indexé et devient disponible pour que New Relic AI puisse le rechercher et le récupérer. Vous devez enregistrer le entityGuid de la réponse pour créer une relation avec votre outil RAG ou pour interroger le document dans NerdGraph.

Une fois qu'un document est téléchargé via l'API Blob, l'exécution de cette requête confirme que le téléchargement a réussi et que le document a été correctement enregistré en tant qu'entité de document RAG avec son propre identifiant et ses propres propriétés uniques.

Paramètres d'entrée

Nom du paramètre	Type de données	Est-ce obligatoire ?	Description
`id`	Chaîne	Oui	Le GUID unique du document RAG à récupérer.

Exemple de requête

Dans la requête ci-dessous, remplacez l'espace réservé ${RAG_DOCUMENT_GUID} par le entityGuid que vous avez reçu à l'étape précédente.

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

Cette requête renverra les détails suivants sur votre document RAG :

id: L'ID unique du document RAG.
name: Le nom du document RAG.
blob { url }: L'URL pour accéder au document téléchargé.
type: Le type de l'entité, qui dans ce cas est EntityManagementRagDocumentEntity.

Maintenant que vous avez créé un outil RAG, téléchargé votre document et vérifié que le téléchargement a réussi, l'étape suivante consiste à associer l'outil RAG et le document RAG, rendant ainsi votre document consultable et utilisable par New Relic AI. Pour ce faire, exécutez la mutation entityManagementCreateRelationship :

Remplacez ${RAG_DOCUMENT_GUID} par le entityGuid de la réponse du téléchargement du document via l'API Blob.

Remplacez ${RAG_TOOL_GUID} par le id de la réponse de la mutation de création de l'outil RAG.

Paramètres d'entrée

Nom du paramètre	Type de données	Est-ce obligatoire ?	Description
`relationship`	Objet	Oui	L'objet d'entrée qui contient les détails de la relation.
`source`	Objet	Oui	L'entité source de la relation, qui est le document RAG.
`source.scope`	Chaîne	Oui	La portée de l'entité source, qui doit être `ORGANIZATION` .
`source.id`	Chaîne	Oui	Le GUID unique du document RAG ( `${RAG_DOCUMENT_GUID}` ).
`target`	Objet	Oui	L'entité cible de la relation, qui est l'outil RAG.
`target.scope`	Chaîne	Oui	La portée de l'entité cible, qui doit être `ORGANIZATION` .
`target.id`	Chaîne	Oui	Le GUID unique de l'outil RAG ( `${RAG_TOOL_GUID}` ).
`type`	Chaîne	Oui	Le type de relation, qui doit être `"INDEXED_FOR"` .

Mutation d'échantillon

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

Option B : Indexez vos documents Confluence

Si votre organisation utilise Confluence pour la documentation, vous pouvez indexer vos documents Confluence dans New Relic sans avoir à utiliser l'API Blob. Cette option vous permet de connecter votre instance Confluence et de sélectionner des documents ou des espaces spécifiques à indexer et à associer à votre outil RAG. Utilisez cette option pour garantir que New Relic AI dispose toujours de la dernière version de vos pages Confluence.

Le connecteur nécessite un jeton d'API Atlassian pour récupérer vos pages. Stockez ceci en toute sécurité dans le gestionnaire de secrets New Relic.

Paramètres d'entrée

Nom du paramètre	Type de données	Requis ?	Description
description	Chaîne	Non	Un bref résumé de l'utilisation du secret.
clé	Chaîne	Oui	Le nom unique utilisé pour référencer ce secret (par exemple, `CONFLUENCE_API_TOKEN` ).
espace de nommage	Chaîne	Oui	Doit être défini sur rag-datafetching pour que le service d'indexation RAG puisse y accéder.
valeur	Chaîne	Oui	La valeur réelle du jeton d'API Confluence ou le mot de passe.
portée	Objet	Oui	Définit le contexte organisationnel ; le type doit être ORGANIZATION .

Mutation d'échantillon

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

Définissez la connexion à votre instance Confluence. Ceci sert de passerelle entre New Relic et Atlassian.

Paramètres d'entrée

Nom du paramètre	Type de données	Requis ?	Description
name	Chaîne	Oui	Un nom descriptif pour l'intégration (par exemple, "Engineering Confluence").
url	Chaîne	Oui	Votre URL de base Confluence (par exemple, https://example.atlassian.net/wiki ).
confluenceUserId	Chaîne	Oui	L'adresse e-mail ou l'identifiant associé à votre jeton d'API Atlassian.
secretKey	Chaîne	Oui	Le nom de la clé que vous avez défini à l'étape précédente ( `CONFLUENCE_API_TOKEN` ).
portée	Objet	Oui	Définit le contexte de l'intégration. Le type doit être défini sur ORGANIZATION .
tags	Objet	Non	Métadonnées facultatives utilisées pour catégoriser l'intégration par département ou équipe.

Mutation d'échantillon

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

Créez une entité de paramètres RAG pour définir quel contenu récupérer et comment il doit être segmenté.

Paramètres d'entrée

Nom du paramètre	Type de données	Requis ?	Description
confluenceIntegrationId	Chaîne	Oui	L'identifiant unique de l'intégration Confluence créée à l'étape précédente.
confluenceQuery	Chaîne	Oui	Un filtre CQL (Confluence Query Language) (par exemple, space = 'ENG')..
intervalSeconds	Int	Oui	Le nombre de secondes entre les exécutions d'indexation (par exemple, 3600 pour toutes les heures).
chunkSize	Int	Oui	Le nombre maximum de caractères dans chaque segment de texte (par exemple, 4000).
Chevauchement des fragments	Int	Oui	Le nombre de caractères de chevauchement entre les segments de texte (par exemple, 100) pour préserver le contexte.
Type de séparateur de texte	Énumération	Oui	Le type de découpeur de texte à utiliser (par exemple, `MARKDOWN_TEXT_SPLITTER` ).
markdownTextSplitterOptions	Objet	Non	Configuration pour le découpage Markdown, telle que les niveaux de titre (#, ##) sur lesquels effectuer le découpage.
Options du séparateur de texte par jetons	Objet	Non	Configuration du découpage en jetons, y compris le modèle d'encodage (par exemple, `O200K_BASE` ).
tags	Objet	Non	Métadonnées facultatives pour catégoriser les paramètres (par exemple, clé : `knowledge_category` , valeurs : `documentation` ).

Types de séparateurs de texte

Utilisez ces types pour définir le paramètre textSplitterType :

TOKEN_TEXT_SPLITTER: Découpage précis basé sur des jetons.
MARKDOWN_TEXT_SPLITTER: Diviser par en-têtes Markdown.
CHARACTER_TEXT_SPLITTER: Diviser par nombre de caractères.
JSON_TEXT_SPLITTER: Diviser le JSON récursivement.
Si vous utilisez TOKEN_TEXT_SPLITTER, définissez l'encodage dans tokenTextSplitterOptions:
O200K_BASE: Pour GPT-4o et les modèles plus récents (recommandé).

CL100K_BASE: Pour GPT-4 et GPT-3.5.

Mutation d'échantillon

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

Lier vos paramètres RAG à votre outil RAG via une relation APPLY_TO active l'indexation automatisée.

Paramètres d'entrée

Nom du paramètre	Type de données	Requis ?	Description
source.id	Chaîne	Oui	L'identifiant des paramètres RAG créés à l'étape précédente.
target.id	Chaîne	Oui	L'identifiant de l'outil RAG créé dans la tâche 1.
type	Chaîne	Oui	Doit être défini sur `APPLY_TO` pour les connexions paramètres-outil.
tags	Chaîne	Oui	Métadonnées facultatives utilisées pour étiqueter la relation (par exemple, clé : " `auto_created` ", valeurs : " `true` ")

Mutation d'échantillon

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

Résultat : Indexation automatique déclenchée

L'indexation se fera désormais automatiquement !

Lorsque la relation APPLY_TO est créée entre vos paramètres RAG et votre outil RAG, le service d'indexation RAG New Relic lance le processus d'arrière-plan suivant :

Le service utilise votre confluenceQuery pour rechercher du contenu correspondant dans votre instance Confluence.
Il récupère toutes les pages correspondantes et les transforme dans un format exploitable.
Le contenu est divisé en segments plus petits en fonction de votre configuration chunkSize, chunkOverlap et textSplitterType.
Le service génère des embeddings denses et clairsemés pour chaque fragment et les indexe dans la base de données vectorielle (Pinecone).
Le connecteur réindexera votre contenu périodiquement en fonction de l'intervalSeconds que vous avez défini pour garantir que l'IA ait accès à la documentation la plus à jour.

Tâche 3 : Récupérer les informations pertinentes

Une fois la relation établie (soit en liant un document RAG spécifique via INDEXED_FOR, soit en appliquant une configuration Confluence via APPLY_TO), vous pouvez vérifier l'association et interroger l'outil. Cela garantit que vos connaissances internes sont correctement indexées et disponibles pour que New Relic AI puisse faire remonter des réponses contextuelles.

Remplacez ${RAG_DOCUMENT_ID} par le entityGuid de votre document téléchargé.

Paramètres d'entrée

Nom du paramètre	Type de données	Est-ce obligatoire ?	Description
`relationships`	Qequête	Oui	La requête pour récupérer les relations entre entités.
`filter`	Objet	Non	Un objet utilisé pour filtrer les relations en fonction de l'attribut.
`filter.sourceId`	Objet	Non	Un objet à filtrer par l'identifiant unique de l'entité source.
`filter.sourceId.eq`	Chaîne	Non	Le GUID unique du document RAG à faire correspondre.

Exemple de requête

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

Après avoir configuré votre outil RAG et indexé les documents, vous pouvez interroger l'outil RAG pour récupérer les informations pertinentes en fonction de votre prompt. Cela permet à New Relic AI de faire apparaître des réponses contextuelles à l'aide de la documentation de votre organisation.

Paramètres d'entrée

Nom du paramètre	Type de données	Est-ce obligatoire ?	Description
`prompt`	Chaîne	Oui	La requête en langage naturel que vous souhaitez que l’outil RAG traite.
`toolId`	Chaîne	Oui	Le GUID unique de l'outil RAG à interroger.

Exemple de requête

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

La réponse inclura des correspondances fragmentées à partir de vos documents indexés, que vous pouvez utiliser directement ou résumer avec New Relic AI.

Cette traduction automatique est fournie pour votre commodité.

Important

Tâche 1 : Créez votre outil RAG .css-21sua1{background:none;border:none;width:0;padding:0;}

Créer un outil RAG

Tâche 2

Option A : Indexez vos documents

Télécharger un document via l'API Blob

Afficher l'entité de document RAG représentée dans NerdGraph

Créer une relation entre l'outil RAG et le document RAG

Option B : Indexez vos documents Confluence

Enregistrez votre jeton API Confluence

Créer l'intégration Confluence

Configurer la logique d'indexation (paramètres RAG)

Créer une relation

Résultat : Indexation automatique déclenchée

Tâche 3 : Récupérer les informations pertinentes

requête pour voir les relations entre les documents RAG et les outils RAG

interroger l'outil RAG

Tâche 1 : Créez votre outil RAG