feat: add scores to source nodes

.changeset/nasty-feet-sparkle.md

@@ -0,0 +1,5 @@
+---
+"llamaindex": patch
+---
+
+Add score to source nodes response

packages/core/src/Response.ts

@@ -1,14 +1,14 @@
-import type { BaseNode } from "./Node.js";
+import type { NodeWithScore } from "./Node.js";
 
 /**
  * Response is the output of a LLM
  */
 export class Response {
   response: string;
-  sourceNodes?: BaseNode[];
+  sourceNodes?: NodeWithScore[];
   metadata: Record<string, unknown> = {};
 
-  constructor(response: string, sourceNodes?: BaseNode[]) {
+  constructor(response: string, sourceNodes?: NodeWithScore[]) {
     this.response = response;
     this.sourceNodes = sourceNodes || [];
   }

packages/core/src/engines/chat/ContextChatEngine.ts

@@ -113,10 +113,9 @@ export class ContextChatEngine extends PromptMixin implements ChatEngine {
     });
     const textOnly = extractText(message);
     const context = await this.contextGenerator.generate(textOnly);
-    const nodes = context.nodes.map((r) => r.node);
     const messages = await chatHistory.requestMessages(
       context ? [context.message] : undefined,
     );
-    return { nodes, messages };
+    return { nodes: context.nodes, messages };
   }
 }

packages/core/src/engines/chat/types.ts

@@ -1,5 +1,5 @@
 import type { ChatHistory } from "../../ChatHistory.js";
-import type { BaseNode, NodeWithScore } from "../../Node.js";
+import type { NodeWithScore } from "../../Node.js";
 import type { Response } from "../../Response.js";
 import type { ChatMessage } from "../../llm/index.js";
 import type { MessageContent } from "../../llm/types.js";
@@ -66,12 +66,12 @@ export enum ChatResponseMode {
 export class AgentChatResponse {
   response: string;
   sources: ToolOutput[];
-  sourceNodes?: BaseNode[];
+  sourceNodes?: NodeWithScore[];
 
   constructor(
     response: string,
     sources?: ToolOutput[],
-    sourceNodes?: BaseNode[],
+    sourceNodes?: NodeWithScore[],
   ) {
     this.response = response;
     this.sources = sources || [];
@@ -91,12 +91,12 @@ export class StreamingAgentChatResponse {
   response: AsyncIterable<Response>;
 
   sources: ToolOutput[];
-  sourceNodes?: BaseNode[];
+  sourceNodes?: NodeWithScore[];
 
   constructor(
     response: AsyncIterable<Response>,
     sources?: ToolOutput[],
-    sourceNodes?: BaseNode[],
+    sourceNodes?: NodeWithScore[],
   ) {
     this.response = response;
     this.sources = sources ?? [];

packages/core/src/engines/query/RouterQueryEngine.ts

@@ -1,4 +1,4 @@
-import type { BaseNode } from "../../Node.js";
+import type { NodeWithScore } from "../../Node.js";
 import { Response } from "../../Response.js";
 import type { ServiceContext } from "../../ServiceContext.js";
 import { llmFromSettingsOrContext } from "../../Settings.js";
@@ -33,7 +33,7 @@ async function combineResponses(
   }
 
   const responseStrs: string[] = [];
-  const sourceNodes: BaseNode[] = [];
+  const sourceNodes: NodeWithScore[] = [];
 
   for (const response of responses) {
     if (response?.sourceNodes) {

packages/core/src/evaluation/Correctness.ts

@@ -111,7 +111,7 @@ export class CorrectnessEvaluator extends PromptMixin implements BaseEvaluator {
 
     if (response) {
       for (const node of response.sourceNodes || []) {
-        contexts.push(node.getContent(MetadataMode.ALL));
+        contexts.push(node.node.getContent(MetadataMode.ALL));
       }
     }
 

packages/core/src/evaluation/Faithfulness.ts

@@ -137,7 +137,7 @@ export class FaithfulnessEvaluator
 
     if (response) {
       for (const node of response.sourceNodes || []) {
-        contexts.push(node.getContent(MetadataMode.ALL));
+        contexts.push(node.node.getContent(MetadataMode.ALL));
       }
     }
 

packages/core/src/evaluation/Relevancy.ts

@@ -126,7 +126,7 @@ export class RelevancyEvaluator extends PromptMixin implements BaseEvaluator {
 
     if (response) {
       for (const node of response.sourceNodes || []) {
-        contexts.push(node.getContent(MetadataMode.ALL));
+        contexts.push(node.node.getContent(MetadataMode.ALL));
       }
     }
 

packages/core/src/synthesizers/MultiModalResponseSynthesizer.ts

@@ -91,6 +91,6 @@ export class MultiModalResponseSynthesizer
       prompt,
     });
 
-    return new Response(response.text, nodes);
+    return new Response(response.text, nodesWithScore);
   }
 }

packages/core/src/synthesizers/ResponseSynthesizer.ts

@@ -69,19 +69,21 @@ export class ResponseSynthesizer
     const textChunks: string[] = nodesWithScore.map(({ node }) =>
       node.getContent(this.metadataMode),
     );
-    const nodes = nodesWithScore.map(({ node }) => node);
     if (stream) {
       const response = await this.responseBuilder.getResponse({
         query,
         textChunks,
         stream,
       });
-      return streamConverter(response, (chunk) => new Response(chunk, nodes));
+      return streamConverter(
+        response,
+        (chunk) => new Response(chunk, nodesWithScore),
+      );
     }
     const response = await this.responseBuilder.getResponse({
       query,
       textChunks,
     });
-    return new Response(response, nodes);
+    return new Response(response, nodesWithScore);
   }
 }