@llamaindex/llama-cloud 0.14.1

package/resources/retrievers/retriever.d.mts

@@ -0,0 +1,41 @@
+import { APIResource } from "../../core/resource.mjs";
+import * as RetrieversAPI from "./retrievers.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+export declare class Retriever extends APIResource {
+    /**
+     * Retrieve data using a Retriever.
+     */
+    search(retrieverID: string, params: RetrieverSearchParams, options?: RequestOptions): APIPromise<RetrieversAPI.CompositeRetrievalResult>;
+}
+export interface RetrieverSearchParams {
+    /**
+     * Body param: The query to retrieve against.
+     */
+    query: string;
+    /**
+     * Query param
+     */
+    organization_id?: string | null;
+    /**
+     * Query param
+     */
+    project_id?: string | null;
+    /**
+     * Body param: The mode of composite retrieval.
+     */
+    mode?: RetrieversAPI.CompositeRetrievalMode;
+    /**
+     * Body param: The rerank configuration for composite retrieval.
+     */
+    rerank_config?: RetrieversAPI.ReRankConfig;
+    /**
+     * @deprecated Body param: (use rerank_config.top_n instead) The number of nodes to
+     * retrieve after reranking over retrieved nodes from all retrieval tools.
+     */
+    rerank_top_n?: number | null;
+}
+export declare namespace Retriever {
+    export { type RetrieverSearchParams as RetrieverSearchParams };
+}
+//# sourceMappingURL=retriever.d.mts.map

package/resources/retrievers/retriever.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"retriever.d.mts","sourceRoot":"","sources":["../../src/resources/retrievers/retriever.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,aAAa;OAClB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;OAEG;IACH,MAAM,CACJ,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,aAAa,CAAC,wBAAwB,CAAC;CAQtD;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,IAAI,CAAC,EAAE,aAAa,CAAC,sBAAsB,CAAC;IAE5C;;OAEG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC,YAAY,CAAC;IAE3C;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EAAE,KAAK,qBAAqB,IAAI,qBAAqB,EAAE,CAAC;CAChE"}

package/resources/retrievers/retriever.d.ts

@@ -0,0 +1,41 @@
+import { APIResource } from "../../core/resource.js";
+import * as RetrieversAPI from "./retrievers.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { RequestOptions } from "../../internal/request-options.js";
+export declare class Retriever extends APIResource {
+    /**
+     * Retrieve data using a Retriever.
+     */
+    search(retrieverID: string, params: RetrieverSearchParams, options?: RequestOptions): APIPromise<RetrieversAPI.CompositeRetrievalResult>;
+}
+export interface RetrieverSearchParams {
+    /**
+     * Body param: The query to retrieve against.
+     */
+    query: string;
+    /**
+     * Query param
+     */
+    organization_id?: string | null;
+    /**
+     * Query param
+     */
+    project_id?: string | null;
+    /**
+     * Body param: The mode of composite retrieval.
+     */
+    mode?: RetrieversAPI.CompositeRetrievalMode;
+    /**
+     * Body param: The rerank configuration for composite retrieval.
+     */
+    rerank_config?: RetrieversAPI.ReRankConfig;
+    /**
+     * @deprecated Body param: (use rerank_config.top_n instead) The number of nodes to
+     * retrieve after reranking over retrieved nodes from all retrieval tools.
+     */
+    rerank_top_n?: number | null;
+}
+export declare namespace Retriever {
+    export { type RetrieverSearchParams as RetrieverSearchParams };
+}
+//# sourceMappingURL=retriever.d.ts.map

package/resources/retrievers/retriever.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"retriever.d.ts","sourceRoot":"","sources":["../../src/resources/retrievers/retriever.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,aAAa;OAClB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;OAEG;IACH,MAAM,CACJ,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,aAAa,CAAC,wBAAwB,CAAC;CAQtD;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,IAAI,CAAC,EAAE,aAAa,CAAC,sBAAsB,CAAC;IAE5C;;OAEG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC,YAAY,CAAC;IAE3C;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EAAE,KAAK,qBAAqB,IAAI,qBAAqB,EAAE,CAAC;CAChE"}

package/resources/retrievers/retriever.js

@@ -0,0 +1,21 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Retriever = void 0;
+const resource_1 = require("../../core/resource.js");
+const path_1 = require("../../internal/utils/path.js");
+class Retriever extends resource_1.APIResource {
+    /**
+     * Retrieve data using a Retriever.
+     */
+    search(retrieverID, params, options) {
+        const { organization_id, project_id, ...body } = params;
+        return this._client.post((0, path_1.path) `/api/v1/retrievers/${retrieverID}/retrieve`, {
+            query: { organization_id, project_id },
+            body,
+            ...options,
+        });
+    }
+}
+exports.Retriever = Retriever;
+//# sourceMappingURL=retriever.js.map

package/resources/retrievers/retriever.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"retriever.js","sourceRoot":"","sources":["../../src/resources/retrievers/retriever.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAIlD,uDAAiD;AAEjD,MAAa,SAAU,SAAQ,sBAAW;IACxC;;OAEG;IACH,MAAM,CACJ,WAAmB,EACnB,MAA6B,EAC7B,OAAwB;QAExB,MAAM,EAAE,eAAe,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,sBAAsB,WAAW,WAAW,EAAE;YACzE,KAAK,EAAE,EAAE,eAAe,EAAE,UAAU,EAAE;YACtC,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAhBD,8BAgBC"}

package/resources/retrievers/retriever.mjs

@@ -0,0 +1,17 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../core/resource.mjs";
+import { path } from "../../internal/utils/path.mjs";
+export class Retriever extends APIResource {
+    /**
+     * Retrieve data using a Retriever.
+     */
+    search(retrieverID, params, options) {
+        const { organization_id, project_id, ...body } = params;
+        return this._client.post(path `/api/v1/retrievers/${retrieverID}/retrieve`, {
+            query: { organization_id, project_id },
+            body,
+            ...options,
+        });
+    }
+}
+//# sourceMappingURL=retriever.mjs.map

package/resources/retrievers/retriever.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"retriever.mjs","sourceRoot":"","sources":["../../src/resources/retrievers/retriever.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAIf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;OAEG;IACH,MAAM,CACJ,WAAmB,EACnB,MAA6B,EAC7B,OAAwB;QAExB,MAAM,EAAE,eAAe,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,sBAAsB,WAAW,WAAW,EAAE;YACzE,KAAK,EAAE,EAAE,eAAe,EAAE,UAAU,EAAE;YACtC,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF"}

package/resources/retrievers/retrievers.d.mts

@@ -0,0 +1,264 @@
+import { APIResource } from "../../core/resource.mjs";
+import * as PipelinesAPI from "../pipelines/pipelines.mjs";
+import * as RetrieverAPI from "./retriever.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+export declare class Retrievers extends APIResource {
+    retriever: RetrieverAPI.Retriever;
+    /**
+     * Create a new Retriever.
+     */
+    create(params: RetrieverCreateParams, options?: RequestOptions): APIPromise<Retriever>;
+    /**
+     * Update an existing Retriever.
+     */
+    update(retrieverID: string, body: RetrieverUpdateParams, options?: RequestOptions): APIPromise<Retriever>;
+    /**
+     * List Retrievers for a project.
+     */
+    list(query?: RetrieverListParams | null | undefined, options?: RequestOptions): APIPromise<RetrieverListResponse>;
+    /**
+     * Delete a Retriever by ID.
+     */
+    delete(retrieverID: string, options?: RequestOptions): APIPromise<void>;
+    /**
+     * Get a Retriever by ID.
+     */
+    get(retrieverID: string, query?: RetrieverGetParams | null | undefined, options?: RequestOptions): APIPromise<Retriever>;
+    /**
+     * Retrieve data using specified pipelines without creating a persistent retriever.
+     */
+    search(params: RetrieverSearchParams, options?: RequestOptions): APIPromise<CompositeRetrievalResult>;
+    /**
+     * Upsert a new Retriever.
+     */
+    upsert(params: RetrieverUpsertParams, options?: RequestOptions): APIPromise<Retriever>;
+}
+/**
+ * Enum for the mode of composite retrieval.
+ */
+export type CompositeRetrievalMode = 'routing' | 'full';
+export interface CompositeRetrievalResult {
+    /**
+     * @deprecated The image nodes retrieved by the pipeline for the given query.
+     * Deprecated - will soon be replaced with 'page_screenshot_nodes'.
+     */
+    image_nodes?: Array<PipelinesAPI.PageScreenshotNodeWithScore>;
+    /**
+     * The retrieved nodes from the composite retrieval.
+     */
+    nodes?: Array<CompositeRetrievalResult.Node>;
+    /**
+     * The page figure nodes retrieved by the pipeline for the given query.
+     */
+    page_figure_nodes?: Array<PipelinesAPI.PageFigureNodeWithScore>;
+}
+export declare namespace CompositeRetrievalResult {
+    interface Node {
+        node: Node.Node;
+        class_name?: string;
+        score?: number | null;
+    }
+    namespace Node {
+        interface Node {
+            /**
+             * The ID of the retrieved node.
+             */
+            id: string;
+            /**
+             * The end character index of the retrieved node in the document
+             */
+            end_char_idx: number | null;
+            /**
+             * The ID of the pipeline this node was retrieved from.
+             */
+            pipeline_id: string;
+            /**
+             * The ID of the retriever this node was retrieved from.
+             */
+            retriever_id: string;
+            /**
+             * The name of the retrieval pipeline this node was retrieved from.
+             */
+            retriever_pipeline_name: string;
+            /**
+             * The start character index of the retrieved node in the document
+             */
+            start_char_idx: number | null;
+            /**
+             * The text of the retrieved node.
+             */
+            text: string;
+            /**
+             * Metadata associated with the retrieved node.
+             */
+            metadata?: {
+                [key: string]: unknown;
+            };
+        }
+    }
+}
+export interface ReRankConfig {
+    /**
+     * The number of nodes to retrieve after reranking over retrieved nodes from all
+     * retrieval tools.
+     */
+    top_n?: number;
+    /**
+     * The type of reranker to use.
+     */
+    type?: 'system_default' | 'llm' | 'cohere' | 'bedrock' | 'score' | 'disabled';
+}
+/**
+ * An entity that retrieves context nodes from several sub RetrieverTools.
+ */
+export interface Retriever {
+    /**
+     * Unique identifier
+     */
+    id: string;
+    /**
+     * A name for the retriever tool. Will default to the pipeline name if not
+     * provided.
+     */
+    name: string;
+    /**
+     * The ID of the project this retriever resides in.
+     */
+    project_id: string;
+    /**
+     * Creation datetime
+     */
+    created_at?: string | null;
+    /**
+     * The pipelines this retriever uses.
+     */
+    pipelines?: Array<RetrieverPipeline>;
+    /**
+     * Update datetime
+     */
+    updated_at?: string | null;
+}
+export interface RetrieverCreate {
+    /**
+     * A name for the retriever tool. Will default to the pipeline name if not
+     * provided.
+     */
+    name: string;
+    /**
+     * The pipelines this retriever uses.
+     */
+    pipelines?: Array<RetrieverPipeline>;
+}
+export interface RetrieverPipeline {
+    /**
+     * A description of the retriever tool.
+     */
+    description: string | null;
+    /**
+     * A name for the retriever tool. Will default to the pipeline name if not
+     * provided.
+     */
+    name: string | null;
+    /**
+     * The ID of the pipeline this tool uses.
+     */
+    pipeline_id: string;
+    /**
+     * Parameters for retrieval configuration.
+     */
+    preset_retrieval_parameters?: PipelinesAPI.PresetRetrievalParams;
+}
+export type RetrieverListResponse = Array<Retriever>;
+export interface RetrieverCreateParams {
+    /**
+     * Body param: A name for the retriever tool. Will default to the pipeline name if
+     * not provided.
+     */
+    name: string;
+    /**
+     * Query param
+     */
+    organization_id?: string | null;
+    /**
+     * Query param
+     */
+    project_id?: string | null;
+    /**
+     * Body param: The pipelines this retriever uses.
+     */
+    pipelines?: Array<RetrieverPipeline>;
+}
+export interface RetrieverUpdateParams {
+    /**
+     * The pipelines this retriever uses.
+     */
+    pipelines: Array<RetrieverPipeline> | null;
+    /**
+     * A name for the retriever.
+     */
+    name?: string | null;
+}
+export interface RetrieverListParams {
+    name?: string | null;
+    organization_id?: string | null;
+    project_id?: string | null;
+}
+export interface RetrieverGetParams {
+    organization_id?: string | null;
+    project_id?: string | null;
+}
+export interface RetrieverSearchParams {
+    /**
+     * Body param: The query to retrieve against.
+     */
+    query: string;
+    /**
+     * Query param
+     */
+    organization_id?: string | null;
+    /**
+     * Query param
+     */
+    project_id?: string | null;
+    /**
+     * Body param: The mode of composite retrieval.
+     */
+    mode?: CompositeRetrievalMode;
+    /**
+     * Body param: The pipelines to use for retrieval.
+     */
+    pipelines?: Array<RetrieverPipeline>;
+    /**
+     * Body param: The rerank configuration for composite retrieval.
+     */
+    rerank_config?: ReRankConfig;
+    /**
+     * @deprecated Body param: (use rerank_config.top_n instead) The number of nodes to
+     * retrieve after reranking over retrieved nodes from all retrieval tools.
+     */
+    rerank_top_n?: number | null;
+}
+export interface RetrieverUpsertParams {
+    /**
+     * Body param: A name for the retriever tool. Will default to the pipeline name if
+     * not provided.
+     */
+    name: string;
+    /**
+     * Query param
+     */
+    organization_id?: string | null;
+    /**
+     * Query param
+     */
+    project_id?: string | null;
+    /**
+     * Body param: The pipelines this retriever uses.
+     */
+    pipelines?: Array<RetrieverPipeline>;
+}
+export declare namespace Retrievers {
+    export { type CompositeRetrievalMode as CompositeRetrievalMode, type CompositeRetrievalResult as CompositeRetrievalResult, type ReRankConfig as ReRankConfig, type Retriever as Retriever, type RetrieverCreate as RetrieverCreate, type RetrieverPipeline as RetrieverPipeline, type RetrieverListResponse as RetrieverListResponse, type RetrieverCreateParams as RetrieverCreateParams, type RetrieverUpdateParams as RetrieverUpdateParams, type RetrieverListParams as RetrieverListParams, type RetrieverGetParams as RetrieverGetParams, type RetrieverSearchParams as RetrieverSearchParams, type RetrieverUpsertParams as RetrieverUpsertParams, };
+}
+//# sourceMappingURL=retrievers.d.mts.map

package/resources/retrievers/retrievers.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"retrievers.d.mts","sourceRoot":"","sources":["../../src/resources/retrievers/retrievers.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,YAAY;OACjB,KAAK,YAAY;OACjB,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,UAAW,SAAQ,WAAW;IACzC,SAAS,EAAE,YAAY,CAAC,SAAS,CAA4C;IAE7E;;OAEG;IACH,MAAM,CAAC,MAAM,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,SAAS,CAAC;IAStF;;OAEG;IACH,MAAM,CAAC,WAAW,EAAE,MAAM,EAAE,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,SAAS,CAAC;IAIzG;;OAEG;IACH,IAAI,CACF,KAAK,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;IAIpC;;OAEG;IACH,MAAM,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOvE;;OAEG;IACH,GAAG,CACD,WAAW,EAAE,MAAM,EACnB,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,SAAS,CAAC;IAIxB;;OAEG;IACH,MAAM,CAAC,MAAM,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;IASrG;;OAEG;IACH,MAAM,CAAC,MAAM,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,SAAS,CAAC;CAQvF;AAED;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,SAAS,GAAG,MAAM,CAAC;AAExD,MAAM,WAAW,wBAAwB;IACvC;;;OAGG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,2BAA2B,CAAC,CAAC;IAE9D;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC;IAE7C;;OAEG;IACH,iBAAiB,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,uBAAuB,CAAC,CAAC;CACjE;AAED,yBAAiB,wBAAwB,CAAC;IACxC,UAAiB,IAAI;QACnB,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC;QAEhB,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACvB;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,IAAI;YACnB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;YAE5B;;eAEG;YACH,WAAW,EAAE,MAAM,CAAC;YAEpB;;eAEG;YACH,YAAY,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,uBAAuB,EAAE,MAAM,CAAC;YAEhC;;eAEG;YACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;YAE9B;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,QAAQ,CAAC,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;aAAE,CAAC;SACvC;KACF;CACF;AAED,MAAM,WAAW,YAAY;IAC3B;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,gBAAgB,GAAG,KAAK,GAAG,QAAQ,GAAG,SAAS,GAAG,OAAO,GAAG,UAAU,CAAC;CAC/E;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAErC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;CACtC;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,2BAA2B,CAAC,EAAE,YAAY,CAAC,qBAAqB,CAAC;CAClE;AAED,MAAM,MAAM,qBAAqB,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC;AAErD,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;CACtC;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,SAAS,EAAE,KAAK,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC;IAE3C;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,kBAAkB;IACjC,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,IAAI,CAAC,EAAE,sBAAsB,CAAC;IAE9B;;OAEG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAErC;;OAEG;IACH,aAAa,CAAC,EAAE,YAAY,CAAC;IAE7B;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;CACtC;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}

package/resources/retrievers/retrievers.d.ts

@@ -0,0 +1,264 @@
+import { APIResource } from "../../core/resource.js";
+import * as PipelinesAPI from "../pipelines/pipelines.js";
+import * as RetrieverAPI from "./retriever.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { RequestOptions } from "../../internal/request-options.js";
+export declare class Retrievers extends APIResource {
+    retriever: RetrieverAPI.Retriever;
+    /**
+     * Create a new Retriever.
+     */
+    create(params: RetrieverCreateParams, options?: RequestOptions): APIPromise<Retriever>;
+    /**
+     * Update an existing Retriever.
+     */
+    update(retrieverID: string, body: RetrieverUpdateParams, options?: RequestOptions): APIPromise<Retriever>;
+    /**
+     * List Retrievers for a project.
+     */
+    list(query?: RetrieverListParams | null | undefined, options?: RequestOptions): APIPromise<RetrieverListResponse>;
+    /**
+     * Delete a Retriever by ID.
+     */
+    delete(retrieverID: string, options?: RequestOptions): APIPromise<void>;
+    /**
+     * Get a Retriever by ID.
+     */
+    get(retrieverID: string, query?: RetrieverGetParams | null | undefined, options?: RequestOptions): APIPromise<Retriever>;
+    /**
+     * Retrieve data using specified pipelines without creating a persistent retriever.
+     */
+    search(params: RetrieverSearchParams, options?: RequestOptions): APIPromise<CompositeRetrievalResult>;
+    /**
+     * Upsert a new Retriever.
+     */
+    upsert(params: RetrieverUpsertParams, options?: RequestOptions): APIPromise<Retriever>;
+}
+/**
+ * Enum for the mode of composite retrieval.
+ */
+export type CompositeRetrievalMode = 'routing' | 'full';
+export interface CompositeRetrievalResult {
+    /**
+     * @deprecated The image nodes retrieved by the pipeline for the given query.
+     * Deprecated - will soon be replaced with 'page_screenshot_nodes'.
+     */
+    image_nodes?: Array<PipelinesAPI.PageScreenshotNodeWithScore>;
+    /**
+     * The retrieved nodes from the composite retrieval.
+     */
+    nodes?: Array<CompositeRetrievalResult.Node>;
+    /**
+     * The page figure nodes retrieved by the pipeline for the given query.
+     */
+    page_figure_nodes?: Array<PipelinesAPI.PageFigureNodeWithScore>;
+}
+export declare namespace CompositeRetrievalResult {
+    interface Node {
+        node: Node.Node;
+        class_name?: string;
+        score?: number | null;
+    }
+    namespace Node {
+        interface Node {
+            /**
+             * The ID of the retrieved node.
+             */
+            id: string;
+            /**
+             * The end character index of the retrieved node in the document
+             */
+            end_char_idx: number | null;
+            /**
+             * The ID of the pipeline this node was retrieved from.
+             */
+            pipeline_id: string;
+            /**
+             * The ID of the retriever this node was retrieved from.
+             */
+            retriever_id: string;
+            /**
+             * The name of the retrieval pipeline this node was retrieved from.
+             */
+            retriever_pipeline_name: string;
+            /**
+             * The start character index of the retrieved node in the document
+             */
+            start_char_idx: number | null;
+            /**
+             * The text of the retrieved node.
+             */
+            text: string;
+            /**
+             * Metadata associated with the retrieved node.
+             */
+            metadata?: {
+                [key: string]: unknown;
+            };
+        }
+    }
+}
+export interface ReRankConfig {
+    /**
+     * The number of nodes to retrieve after reranking over retrieved nodes from all
+     * retrieval tools.
+     */
+    top_n?: number;
+    /**
+     * The type of reranker to use.
+     */
+    type?: 'system_default' | 'llm' | 'cohere' | 'bedrock' | 'score' | 'disabled';
+}
+/**
+ * An entity that retrieves context nodes from several sub RetrieverTools.
+ */
+export interface Retriever {
+    /**
+     * Unique identifier
+     */
+    id: string;
+    /**
+     * A name for the retriever tool. Will default to the pipeline name if not
+     * provided.
+     */
+    name: string;
+    /**
+     * The ID of the project this retriever resides in.
+     */
+    project_id: string;
+    /**
+     * Creation datetime
+     */
+    created_at?: string | null;
+    /**
+     * The pipelines this retriever uses.
+     */
+    pipelines?: Array<RetrieverPipeline>;
+    /**
+     * Update datetime
+     */
+    updated_at?: string | null;
+}
+export interface RetrieverCreate {
+    /**
+     * A name for the retriever tool. Will default to the pipeline name if not
+     * provided.
+     */
+    name: string;
+    /**
+     * The pipelines this retriever uses.
+     */
+    pipelines?: Array<RetrieverPipeline>;
+}
+export interface RetrieverPipeline {
+    /**
+     * A description of the retriever tool.
+     */
+    description: string | null;
+    /**
+     * A name for the retriever tool. Will default to the pipeline name if not
+     * provided.
+     */
+    name: string | null;
+    /**
+     * The ID of the pipeline this tool uses.
+     */
+    pipeline_id: string;
+    /**
+     * Parameters for retrieval configuration.
+     */
+    preset_retrieval_parameters?: PipelinesAPI.PresetRetrievalParams;
+}
+export type RetrieverListResponse = Array<Retriever>;
+export interface RetrieverCreateParams {
+    /**
+     * Body param: A name for the retriever tool. Will default to the pipeline name if
+     * not provided.
+     */
+    name: string;
+    /**
+     * Query param
+     */
+    organization_id?: string | null;
+    /**
+     * Query param
+     */
+    project_id?: string | null;
+    /**
+     * Body param: The pipelines this retriever uses.
+     */
+    pipelines?: Array<RetrieverPipeline>;
+}
+export interface RetrieverUpdateParams {
+    /**
+     * The pipelines this retriever uses.
+     */
+    pipelines: Array<RetrieverPipeline> | null;
+    /**
+     * A name for the retriever.
+     */
+    name?: string | null;
+}
+export interface RetrieverListParams {
+    name?: string | null;
+    organization_id?: string | null;
+    project_id?: string | null;
+}
+export interface RetrieverGetParams {
+    organization_id?: string | null;
+    project_id?: string | null;
+}
+export interface RetrieverSearchParams {
+    /**
+     * Body param: The query to retrieve against.
+     */
+    query: string;
+    /**
+     * Query param
+     */
+    organization_id?: string | null;
+    /**
+     * Query param
+     */
+    project_id?: string | null;
+    /**
+     * Body param: The mode of composite retrieval.
+     */
+    mode?: CompositeRetrievalMode;
+    /**
+     * Body param: The pipelines to use for retrieval.
+     */
+    pipelines?: Array<RetrieverPipeline>;
+    /**
+     * Body param: The rerank configuration for composite retrieval.
+     */
+    rerank_config?: ReRankConfig;
+    /**
+     * @deprecated Body param: (use rerank_config.top_n instead) The number of nodes to
+     * retrieve after reranking over retrieved nodes from all retrieval tools.
+     */
+    rerank_top_n?: number | null;
+}
+export interface RetrieverUpsertParams {
+    /**
+     * Body param: A name for the retriever tool. Will default to the pipeline name if
+     * not provided.
+     */
+    name: string;
+    /**
+     * Query param
+     */
+    organization_id?: string | null;
+    /**
+     * Query param
+     */
+    project_id?: string | null;
+    /**
+     * Body param: The pipelines this retriever uses.
+     */
+    pipelines?: Array<RetrieverPipeline>;
+}
+export declare namespace Retrievers {
+    export { type CompositeRetrievalMode as CompositeRetrievalMode, type CompositeRetrievalResult as CompositeRetrievalResult, type ReRankConfig as ReRankConfig, type Retriever as Retriever, type RetrieverCreate as RetrieverCreate, type RetrieverPipeline as RetrieverPipeline, type RetrieverListResponse as RetrieverListResponse, type RetrieverCreateParams as RetrieverCreateParams, type RetrieverUpdateParams as RetrieverUpdateParams, type RetrieverListParams as RetrieverListParams, type RetrieverGetParams as RetrieverGetParams, type RetrieverSearchParams as RetrieverSearchParams, type RetrieverUpsertParams as RetrieverUpsertParams, };
+}
+//# sourceMappingURL=retrievers.d.ts.map