Use parameter object for retrieve function of Retriever (run-llama#616)

.changeset/strange-waves-sit.md

@@ -0,0 +1,5 @@
+---
+"llamaindex": minor
+---
+
+Use parameter object for retrieve function of Retriever (to align usage with query function of QueryEngine)

apps/docs/docs/modules/node_postprocessors/index.md

@@ -100,7 +100,7 @@ const response = await queryEngine.query("<user_query>");
 ```ts
 import { SimilarityPostprocessor } from "llamaindex";
 
-nodes = await index.asRetriever().retrieve("test query str");
+nodes = await index.asRetriever().retrieve({ query: "test query str" });
 
 const processor = new SimilarityPostprocessor({
   similarityCutoff: 0.7,

apps/docs/docs/modules/retriever.md

@@ -11,7 +11,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // Fetch nodes!
-const nodesWithScore = await retriever.retrieve("query string");
+const nodesWithScore = await retriever.retrieve({ query: "query string" });
 ```
 
 ## API Reference

apps/docs/i18n/ar/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // جلب العقد!
-const nodesWithScore = await retriever.retrieve("سلسلة الاستعلام");
+const nodesWithScore = await retriever.retrieve({ query: "سلسلة الاستعلام" });
 ```
 
 ## مرجع الواجهة البرمجية (API Reference)

apps/docs/i18n/bg/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // Извличане на върхове!
-const nodesWithScore = await retriever.retrieve("query string");
+const nodesWithScore = await retriever.retrieve({ query: "query string" });
 ```
 
 ## API Reference (API справка)

apps/docs/i18n/cat/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const recuperador = vector_index.asRetriever();
 recuperador.similarityTopK = 3;
 
 // Obteniu els nodes!
-const nodesAmbPuntuació = await recuperador.retrieve("cadena de consulta");
+const nodesAmbPuntuació = await recuperador.retrieve({ query: "cadena de consulta" });
 ```
 
 ## Referència de l'API

apps/docs/i18n/cs/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // Získání uzlů!
-const nodesWithScore = await retriever.retrieve("dotazovací řetězec");
+const nodesWithScore = await retriever.retrieve({ query: "dotazovací řetězec" });
 ```
 
 ## API Reference (Odkazy na rozhraní)

apps/docs/i18n/da/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // Hent noder!
-const nodesWithScore = await retriever.retrieve("forespørgselsstreng");
+const nodesWithScore = await retriever.retrieve({ query: "forespørgselsstreng" });
 ```
 
 ## API Reference

apps/docs/i18n/de/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // Knoten abrufen!
-const nodesWithScore = await retriever.retrieve("Abfragezeichenfolge");
+const nodesWithScore = await retriever.retrieve({ query: "Abfragezeichenfolge" });
 ```
 
 ## API-Referenz

apps/docs/i18n/el/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // Ανάκτηση κόμβων!
-const nodesWithScore = await retriever.retrieve("συμβολοσειρά ερωτήματος");
+const nodesWithScore = await retriever.retrieve({ query: "συμβολοσειρά ερωτήματος" });
 ```
 
 ## Αναφορά API

apps/docs/i18n/es/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const recuperador = vector_index.asRetriever();
 recuperador.similarityTopK = 3;
 
 // ¡Obtener nodos!
-const nodosConPuntuación = await recuperador.retrieve("cadena de consulta");
+const nodosConPuntuación = await recuperador.retrieve({ query: "cadena de consulta" });
 ```
 
 ## Referencia de la API

apps/docs/i18n/et/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // Too sõlmed!
-const nodesWithScore = await retriever.retrieve("päringu string");
+const nodesWithScore = await retriever.retrieve({ query: "päringu string" });
 ```
 
 ## API viide

apps/docs/i18n/fa/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // بازیابی گره ها!
-const nodesWithScore = await retriever.retrieve("رشته پرس و جو");
+const nodesWithScore = await retriever.retrieve({ query: "رشته پرس و جو" });
 ```
 
 ## مرجع API

apps/docs/i18n/fi/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // Hae solmut!
-const nodesWithScore = await retriever.retrieve("kyselymerkkijono");
+const nodesWithScore = await retriever.retrieve({ query: "kyselymerkkijono" });
 ```
 
 ## API-viite

apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -11,7 +11,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // Récupérer les nœuds !
-const nodesWithScore = await retriever.retrieve("chaîne de requête");
+const nodesWithScore = await retriever.retrieve({ query: "chaîne de requête" });
 ```
 
 ## Référence de l'API

apps/docs/i18n/he/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // אחזור צמתים!
-const nodesWithScore = await retriever.retrieve("מחרוזת שאילתה");
+const nodesWithScore = await retriever.retrieve({ query: "מחרוזת שאילתה" });
 ```
 
 ## מדריך לממשק API

apps/docs/i18n/hi/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // नोड्स प्राप्त करें!
-const nodesWithScore = await retriever.retrieve("क्वेरी स्ट्रिंग");
+const nodesWithScore = await retriever.retrieve({ query: "क्वेरी स्ट्रिंग" });
 ```
 
 ## एपीआई संदर्भ (API Reference)

apps/docs/i18n/hr/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const dohvatnik = vector_index.asRetriever();
 dohvatnik.similarityTopK = 3;
 
 // Dohvati čvorove!
-const čvoroviSaRezultatom = await dohvatnik.retrieve("upitni niz");
+const čvoroviSaRezultatom = await dohvatnik.retrieve({ query: "upitni niz" });
 ```
 
 ## API Referenca

apps/docs/i18n/hu/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // Node-ok lekérése!
-const nodesWithScore = await retriever.retrieve("lekérdezési karakterlánc");
+const nodesWithScore = await retriever.retrieve({ query: "lekérdezési karakterlánc" });
 ```
 
 ## API Referencia

apps/docs/i18n/in/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // Mengambil node!
-const nodesWithScore = await retriever.retrieve("string query");
+const nodesWithScore = await retriever.retrieve({ query: "string query" });
 ```
 
 ## Referensi API

apps/docs/i18n/it/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // Recupera i nodi!
-const nodesWithScore = await retriever.retrieve("stringa di query");
+const nodesWithScore = await retriever.retrieve({ query: "stringa di query" });
 ```
 
 ## Riferimento API

apps/docs/i18n/ja/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // ノードを取得します！
-const nodesWithScore = await retriever.retrieve("クエリ文字列");
+const nodesWithScore = await retriever.retrieve({ query: "クエリ文字列" });
 ```
 
 ## API リファレンス

apps/docs/i18n/ko/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // 노드를 가져옵니다!
-const nodesWithScore = await retriever.retrieve("쿼리 문자열");
+const nodesWithScore = await retriever.retrieve({ query: "쿼리 문자열" });
 ```
 
 ## API 참조

apps/docs/i18n/lt/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const gavėjas = vector_index.asRetriever();
 gavėjas.similarityTopK = 3;
 
 // Išgaunami mazgai!
-const mazgaiSuRezultatu = await gavėjas.retrieve("užklausos eilutė");
+const mazgaiSuRezultatu = await gavėjas.retrieve({ query: "užklausos eilutė" });
 ```
 
 ## API nuorodos (API Reference)

apps/docs/i18n/nl/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // Haal knooppunten op!
-const nodesWithScore = await retriever.retrieve("zoekopdracht");
+const nodesWithScore = await retriever.retrieve({ query: "zoekopdracht" });
 ```
 
 ## API Referentie

apps/docs/i18n/no/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // Hent noder!
-const nodesWithScore = await retriever.retrieve("spørringsstreng");
+const nodesWithScore = await retriever.retrieve({ query: "spørringsstreng" });
 ```
 
 ## API-referanse

apps/docs/i18n/pl/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // Pobierz węzły!
-const nodesWithScore = await retriever.retrieve("ciąg zapytania");
+const nodesWithScore = await retriever.retrieve({ query: "ciąg zapytania" });
 ```
 
 ## Dokumentacja interfejsu API

apps/docs/i18n/pt/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const recuperador = vector_index.asRetriever();
 recuperador.similarityTopK = 3;
 
 // Buscar nós!
-const nósComPontuação = await recuperador.retrieve("string de consulta");
+const nósComPontuação = await recuperador.retrieve({ query: "string de consulta" });
 ```
 
 ## Referência da API

apps/docs/i18n/ro/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const recuperator = vector_index.asRetriever();
 recuperator.similarityTopK = 3;
 
 // Preia nodurile!
-const noduriCuScor = await recuperator.retrieve("șir de interogare");
+const noduriCuScor = await recuperator.retrieve({ query: "șir de interogare" });
 ```
 
 ## Referință API

apps/docs/i18n/ru/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // Получение узлов!
-const nodesWithScore = await retriever.retrieve("строка запроса");
+const nodesWithScore = await retriever.retrieve({ query: "строка запроса" });
 ```
 
 ## Справочник по API

apps/docs/i18n/se/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // Dohvati čvorove!
-const nodesWithScore = await retriever.retrieve("upitni niz");
+const nodesWithScore = await retriever.retrieve({ query: "upitni niz" });
 ```
 
 ## API Referenca

apps/docs/i18n/sk/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const pridobitelj = vector_index.asRetriever();
 pridobitelj.similarityTopK = 3;
 
 // Pridobivanje vozlišč!
-const vozliščaZRezultatom = await pridobitelj.retrieve("poizvedbeni niz");
+const vozliščaZRezultatom = await pridobitelj.retrieve({ query: "poizvedbeni niz" });
 ```
 
 ## API Sklic

apps/docs/i18n/sl/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // Získajte uzly!
-const nodesWithScore = await retriever.retrieve("reťazec dotazu");
+const nodesWithScore = await retriever.retrieve({ query: "reťazec dotazu" });
 ```
 
 ## API Referencia

apps/docs/i18n/sv/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // Hämta noder!
-const nodesWithScore = await retriever.retrieve("frågesträng");
+const nodesWithScore = await retriever.retrieve({ query: "frågesträng" });
 ```
 
 ## API-referens

apps/docs/i18n/th/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // เรียกคืนโหนด!
-const nodesWithScore = await retriever.retrieve("query string");
+const nodesWithScore = await retriever.retrieve({ query: "query string" });
 ```
 
 ## API Reference (การอ้างอิง API)

apps/docs/i18n/tr/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // Düğümleri getir!
-const nodesWithScore = await retriever.retrieve("sorgu dizesi");
+const nodesWithScore = await retriever.retrieve({ query: "sorgu dizesi" });
 ```
 
 ## API Referansı

apps/docs/i18n/uk/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // Отримати вузли!
-const nodesWithScore = await retriever.retrieve("рядок запиту");
+const nodesWithScore = await retriever.retrieve({ query: "рядок запиту" });
 ```
 
 ## Довідник API

apps/docs/i18n/vi/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // Lấy các node!
-const nodesWithScore = await retriever.retrieve("chuỗi truy vấn");
+const nodesWithScore = await retriever.retrieve({ query: "chuỗi truy vấn" });
 ```
 
 ## Tài liệu tham khảo API

apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -11,7 +11,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // 获取节点！
-const nodesWithScore = await retriever.retrieve("查询字符串");
+const nodesWithScore = await retriever.retrieve({ query: "查询字符串" });
 ```
 
 ## API 参考

apps/docs/i18n/zh_tw/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md

@@ -13,7 +13,7 @@ const retriever = vector_index.asRetriever();
 retriever.similarityTopK = 3;
 
 // 提取節點！
-const nodesWithScore = await retriever.retrieve("查詢字串");
+const nodesWithScore = await retriever.retrieve({ query: "查詢字串" });
 ```
 
 ## API 參考

examples/multimodal/retrieve.ts

@@ -27,9 +27,9 @@ async function main() {
   // retrieve documents using the index
   const index = await createIndex();
   const retriever = index.asRetriever({ similarityTopK: 3 });
-  const results = await retriever.retrieve(
-    "what are Vincent van Gogh's famous paintings",
-  );
+  const results = await retriever.retrieve({
+    query: "what are Vincent van Gogh's famous paintings",
+  });
   for (const result of results) {
     const node = result.node;
     if (!node) {

packages/core/src/Retriever.ts

@@ -2,14 +2,16 @@ import type { Event } from "./callbacks/CallbackManager.js";
 import type { NodeWithScore } from "./Node.js";
 import type { ServiceContext } from "./ServiceContext.js";
 
+export type RetrieveParams = {
+  query: string;
+  parentEvent?: Event;
+  preFilters?: unknown;
+};
+
 /**
  * Retrievers retrieve the nodes that most closely match our query in similarity.
  */
 export interface BaseRetriever {
-  retrieve(
-    query: string,
-    parentEvent?: Event,
-    preFilters?: unknown,
-  ): Promise<NodeWithScore[]>;
+  retrieve(params: RetrieveParams): Promise<NodeWithScore[]>;
   getServiceContext(): ServiceContext;
 }