@llamaindex/llama-cloud 0.14.1

package/src/resources/pipelines/sync.ts

@@ -0,0 +1,24 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as PipelinesAPI from './pipelines';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Sync extends APIResource {
+  /**
+   * Run ingestion for the pipeline by incrementally updating the data-sink with
+   * upstream changes from data-sources & files.
+   */
+  create(pipelineID: string, options?: RequestOptions): APIPromise<PipelinesAPI.Pipeline> {
+    return this._client.post(path`/api/v1/pipelines/${pipelineID}/sync`, options);
+  }
+
+  /**
+   * Cancel Pipeline Sync
+   */
+  cancel(pipelineID: string, options?: RequestOptions): APIPromise<PipelinesAPI.Pipeline> {
+    return this._client.post(path`/api/v1/pipelines/${pipelineID}/sync/cancel`, options);
+  }
+}

package/src/resources/pipelines.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './pipelines/index';

package/src/resources/projects.ts

@@ -0,0 +1,84 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class Projects extends APIResource {
+  /**
+   * List projects or get one by name
+   */
+  list(
+    query: ProjectListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ProjectListResponse> {
+    return this._client.get('/api/v1/projects', { query, ...options });
+  }
+
+  /**
+   * Get a project by ID.
+   */
+  get(
+    projectID: string,
+    query: ProjectGetParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<Project> {
+    return this._client.get(path`/api/v1/projects/${projectID}`, { query, ...options });
+  }
+}
+
+/**
+ * Schema for a project.
+ */
+export interface Project {
+  /**
+   * Unique identifier
+   */
+  id: string;
+
+  name: string;
+
+  /**
+   * The Organization ID the project is under.
+   */
+  organization_id: string;
+
+  ad_hoc_eval_dataset_id?: string | null;
+
+  /**
+   * Creation datetime
+   */
+  created_at?: string | null;
+
+  /**
+   * Whether this project is the default project for the user.
+   */
+  is_default?: boolean;
+
+  /**
+   * Update datetime
+   */
+  updated_at?: string | null;
+}
+
+export type ProjectListResponse = Array<Project>;
+
+export interface ProjectListParams {
+  organization_id?: string | null;
+
+  project_name?: string | null;
+}
+
+export interface ProjectGetParams {
+  organization_id?: string | null;
+}
+
+export declare namespace Projects {
+  export {
+    type Project as Project,
+    type ProjectListResponse as ProjectListResponse,
+    type ProjectListParams as ProjectListParams,
+    type ProjectGetParams as ProjectGetParams,
+  };
+}

package/src/resources/retrievers/index.ts

@@ -0,0 +1,18 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Retrievers,
+  type CompositeRetrievalMode,
+  type CompositeRetrievalResult,
+  type ReRankConfig,
+  type Retriever,
+  type RetrieverCreate,
+  type RetrieverPipeline,
+  type RetrieverListResponse,
+  type RetrieverCreateParams,
+  type RetrieverUpdateParams,
+  type RetrieverListParams,
+  type RetrieverGetParams,
+  type RetrieverSearchParams,
+  type RetrieverUpsertParams,
+} from './retrievers';

package/src/resources/retrievers/retriever.ts

@@ -0,0 +1,62 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as RetrieversAPI from './retrievers';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Retriever extends APIResource {
+  /**
+   * Retrieve data using a Retriever.
+   */
+  search(
+    retrieverID: string,
+    params: RetrieverSearchParams,
+    options?: RequestOptions,
+  ): APIPromise<RetrieversAPI.CompositeRetrievalResult> {
+    const { organization_id, project_id, ...body } = params;
+    return this._client.post(path`/api/v1/retrievers/${retrieverID}/retrieve`, {
+      query: { organization_id, project_id },
+      body,
+      ...options,
+    });
+  }
+}
+
+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 };
+}

package/src/resources/retrievers/retrievers.ts

@@ -0,0 +1,379 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as PipelinesAPI from '../pipelines/pipelines';
+import * as RetrieverAPI from './retriever';
+import { APIPromise } from '../../core/api-promise';
+import { buildHeaders } from '../../internal/headers';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Retrievers extends APIResource {
+  retriever: RetrieverAPI.Retriever = new RetrieverAPI.Retriever(this._client);
+
+  /**
+   * Create a new Retriever.
+   */
+  create(params: RetrieverCreateParams, options?: RequestOptions): APIPromise<Retriever> {
+    const { organization_id, project_id, ...body } = params;
+    return this._client.post('/api/v1/retrievers', {
+      query: { organization_id, project_id },
+      body,
+      ...options,
+    });
+  }
+
+  /**
+   * Update an existing Retriever.
+   */
+  update(retrieverID: string, body: RetrieverUpdateParams, options?: RequestOptions): APIPromise<Retriever> {
+    return this._client.put(path`/api/v1/retrievers/${retrieverID}`, { body, ...options });
+  }
+
+  /**
+   * List Retrievers for a project.
+   */
+  list(
+    query: RetrieverListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<RetrieverListResponse> {
+    return this._client.get('/api/v1/retrievers', { query, ...options });
+  }
+
+  /**
+   * Delete a Retriever by ID.
+   */
+  delete(retrieverID: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/api/v1/retrievers/${retrieverID}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Get a Retriever by ID.
+   */
+  get(
+    retrieverID: string,
+    query: RetrieverGetParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<Retriever> {
+    return this._client.get(path`/api/v1/retrievers/${retrieverID}`, { query, ...options });
+  }
+
+  /**
+   * Retrieve data using specified pipelines without creating a persistent retriever.
+   */
+  search(params: RetrieverSearchParams, options?: RequestOptions): APIPromise<CompositeRetrievalResult> {
+    const { organization_id, project_id, ...body } = params;
+    return this._client.post('/api/v1/retrievers/retrieve', {
+      query: { organization_id, project_id },
+      body,
+      ...options,
+    });
+  }
+
+  /**
+   * Upsert a new Retriever.
+   */
+  upsert(params: RetrieverUpsertParams, options?: RequestOptions): APIPromise<Retriever> {
+    const { organization_id, project_id, ...body } = params;
+    return this._client.put('/api/v1/retrievers', {
+      query: { organization_id, project_id },
+      body,
+      ...options,
+    });
+  }
+}
+
+/**
+ * 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 namespace CompositeRetrievalResult {
+  export interface Node {
+    node: Node.Node;
+
+    class_name?: string;
+
+    score?: number | null;
+  }
+
+  export namespace Node {
+    export 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,
+  };
+}

package/src/resources/retrievers.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './retrievers/index';