@llamaindex/llama-cloud 0.14.1

package/src/resources/pipelines/files.ts

@@ -0,0 +1,306 @@
+// 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 {
+  PagePromise,
+  PaginatedPipelineFiles,
+  type PaginatedPipelineFilesParams,
+} from '../../core/pagination';
+import { buildHeaders } from '../../internal/headers';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Files extends APIResource {
+  /**
+   * Add files to a pipeline.
+   */
+  create(
+    pipelineID: string,
+    params: FileCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<FileCreateResponse> {
+    const { body } = params;
+    return this._client.put(path`/api/v1/pipelines/${pipelineID}/files`, { body: body, ...options });
+  }
+
+  /**
+   * Update a file for a pipeline.
+   */
+  update(fileID: string, params: FileUpdateParams, options?: RequestOptions): APIPromise<PipelineFile> {
+    const { pipeline_id, ...body } = params;
+    return this._client.put(path`/api/v1/pipelines/${pipeline_id}/files/${fileID}`, { body, ...options });
+  }
+
+  /**
+   * Get files for a pipeline.
+   *
+   * Args: pipeline_id: ID of the pipeline data_source_id: Optional filter by data
+   * source ID only_manually_uploaded: Filter for only manually uploaded files
+   * file_name_contains: Optional filter by file name (substring match) limit: Limit
+   * number of results offset: Offset for pagination order_by: Field to order by
+   *
+   * @deprecated
+   */
+  list(
+    pipelineID: string,
+    query: FileListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<PipelineFilesPaginatedPipelineFiles, PipelineFile> {
+    return this._client.getAPIList(
+      path`/api/v1/pipelines/${pipelineID}/files2`,
+      PaginatedPipelineFiles<PipelineFile>,
+      { query, ...options },
+    );
+  }
+
+  /**
+   * Delete a file from a pipeline.
+   */
+  delete(fileID: string, params: FileDeleteParams, options?: RequestOptions): APIPromise<void> {
+    const { pipeline_id } = params;
+    return this._client.delete(path`/api/v1/pipelines/${pipeline_id}/files/${fileID}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Get status of a file for a pipeline.
+   */
+  getStatus(
+    fileID: string,
+    params: FileGetStatusParams,
+    options?: RequestOptions,
+  ): APIPromise<PipelinesAPI.ManagedIngestionStatusResponse> {
+    const { pipeline_id } = params;
+    return this._client.get(path`/api/v1/pipelines/${pipeline_id}/files/${fileID}/status`, options);
+  }
+
+  /**
+   * Get files for a pipeline.
+   */
+  getStatusCounts(
+    pipelineID: string,
+    query: FileGetStatusCountsParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<FileGetStatusCountsResponse> {
+    return this._client.get(path`/api/v1/pipelines/${pipelineID}/files/status-counts`, { query, ...options });
+  }
+}
+
+export type PipelineFilesPaginatedPipelineFiles = PaginatedPipelineFiles<PipelineFile>;
+
+/**
+ * Schema for a file that is associated with a pipeline.
+ */
+export interface PipelineFile {
+  /**
+   * Unique identifier
+   */
+  id: string;
+
+  /**
+   * The ID of the pipeline that the file is associated with
+   */
+  pipeline_id: string;
+
+  /**
+   * Hashes for the configuration of the pipeline.
+   */
+  config_hash?: {
+    [key: string]: { [key: string]: unknown } | Array<unknown> | string | number | boolean | null;
+  } | null;
+
+  /**
+   * Creation datetime
+   */
+  created_at?: string | null;
+
+  /**
+   * Custom metadata for the file
+   */
+  custom_metadata?: {
+    [key: string]: { [key: string]: unknown } | Array<unknown> | string | number | boolean | null;
+  } | null;
+
+  /**
+   * The ID of the data source that the file belongs to
+   */
+  data_source_id?: string | null;
+
+  /**
+   * The ID of the file in the external system
+   */
+  external_file_id?: string | null;
+
+  /**
+   * The ID of the file
+   */
+  file_id?: string | null;
+
+  /**
+   * Size of the file in bytes
+   */
+  file_size?: number | null;
+
+  /**
+   * File type (e.g. pdf, docx, etc.)
+   */
+  file_type?: string | null;
+
+  /**
+   * The number of pages that have been indexed for this file
+   */
+  indexed_page_count?: number | null;
+
+  /**
+   * The last modified time of the file
+   */
+  last_modified_at?: string | null;
+
+  /**
+   * Name of the file
+   */
+  name?: string | null;
+
+  /**
+   * Permission information for the file
+   */
+  permission_info?: {
+    [key: string]: { [key: string]: unknown } | Array<unknown> | string | number | boolean | null;
+  } | null;
+
+  /**
+   * The ID of the project that the file belongs to
+   */
+  project_id?: string | null;
+
+  /**
+   * Resource information for the file
+   */
+  resource_info?: {
+    [key: string]: { [key: string]: unknown } | Array<unknown> | string | number | boolean | null;
+  } | null;
+
+  /**
+   * Status of the pipeline file
+   */
+  status?: 'NOT_STARTED' | 'IN_PROGRESS' | 'SUCCESS' | 'ERROR' | 'CANCELLED' | null;
+
+  /**
+   * The last time the status was updated
+   */
+  status_updated_at?: string | null;
+
+  /**
+   * Update datetime
+   */
+  updated_at?: string | null;
+}
+
+export type FileCreateResponse = Array<PipelineFile>;
+
+export interface FileGetStatusCountsResponse {
+  /**
+   * The counts of files by status
+   */
+  counts: { [key: string]: number };
+
+  /**
+   * The total number of files
+   */
+  total_count: number;
+
+  /**
+   * The ID of the data source that the files belong to
+   */
+  data_source_id?: string | null;
+
+  /**
+   * Whether to only count manually uploaded files
+   */
+  only_manually_uploaded?: boolean;
+
+  /**
+   * The ID of the pipeline that the files belong to
+   */
+  pipeline_id?: string | null;
+}
+
+export interface FileCreateParams {
+  body: Array<FileCreateParams.Body>;
+}
+
+export namespace FileCreateParams {
+  /**
+   * Schema for creating a file that is associated with a pipeline.
+   */
+  export interface Body {
+    /**
+     * The ID of the file
+     */
+    file_id: string;
+
+    /**
+     * Custom metadata for the file
+     */
+    custom_metadata?: {
+      [key: string]: { [key: string]: unknown } | Array<unknown> | string | number | boolean | null;
+    } | null;
+  }
+}
+
+export interface FileUpdateParams {
+  /**
+   * Path param
+   */
+  pipeline_id: string;
+
+  /**
+   * Body param: Custom metadata for the file
+   */
+  custom_metadata?: {
+    [key: string]: { [key: string]: unknown } | Array<unknown> | string | number | boolean | null;
+  } | null;
+}
+
+export interface FileListParams extends PaginatedPipelineFilesParams {
+  data_source_id?: string | null;
+
+  file_name_contains?: string | null;
+
+  only_manually_uploaded?: boolean;
+
+  order_by?: string | null;
+}
+
+export interface FileDeleteParams {
+  pipeline_id: string;
+}
+
+export interface FileGetStatusParams {
+  pipeline_id: string;
+}
+
+export interface FileGetStatusCountsParams {
+  data_source_id?: string | null;
+
+  only_manually_uploaded?: boolean;
+}
+
+export declare namespace Files {
+  export {
+    type PipelineFile as PipelineFile,
+    type FileCreateResponse as FileCreateResponse,
+    type FileGetStatusCountsResponse as FileGetStatusCountsResponse,
+    type PipelineFilesPaginatedPipelineFiles as PipelineFilesPaginatedPipelineFiles,
+    type FileCreateParams as FileCreateParams,
+    type FileUpdateParams as FileUpdateParams,
+    type FileListParams as FileListParams,
+    type FileDeleteParams as FileDeleteParams,
+    type FileGetStatusParams as FileGetStatusParams,
+    type FileGetStatusCountsParams as FileGetStatusCountsParams,
+  };
+}

package/src/resources/pipelines/images.ts

@@ -0,0 +1,194 @@
+// 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 Images extends APIResource {
+  /**
+   * Get a specific figure from a page of a file.
+   */
+  getPageFigure(
+    figureName: string,
+    params: ImageGetPageFigureParams,
+    options?: RequestOptions,
+  ): APIPromise<unknown> {
+    const { id, page_index, ...query } = params;
+    return this._client.get(path`/api/v1/files/${id}/page-figures/${page_index}/${figureName}`, {
+      query,
+      ...options,
+    });
+  }
+
+  /**
+   * Get screenshot of a page from a file.
+   */
+  getPageScreenshot(
+    pageIndex: number,
+    params: ImageGetPageScreenshotParams,
+    options?: RequestOptions,
+  ): APIPromise<unknown> {
+    const { id, ...query } = params;
+    return this._client.get(path`/api/v1/files/${id}/page_screenshots/${pageIndex}`, { query, ...options });
+  }
+
+  /**
+   * List metadata for all figures from all pages of a file.
+   */
+  listPageFigures(
+    id: string,
+    query: ImageListPageFiguresParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ImageListPageFiguresResponse> {
+    return this._client.get(path`/api/v1/files/${id}/page-figures`, { query, ...options });
+  }
+
+  /**
+   * List metadata for all screenshots of pages from a file.
+   */
+  listPageScreenshots(
+    id: string,
+    query: ImageListPageScreenshotsParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ImageListPageScreenshotsResponse> {
+    return this._client.get(path`/api/v1/files/${id}/page_screenshots`, { query, ...options });
+  }
+}
+
+export type ImageGetPageFigureResponse = unknown;
+
+export type ImageGetPageScreenshotResponse = unknown;
+
+export type ImageListPageFiguresResponse =
+  Array<ImageListPageFiguresResponse.ImageListPageFiguresResponseItem>;
+
+export namespace ImageListPageFiguresResponse {
+  export interface ImageListPageFiguresResponseItem {
+    /**
+     * The confidence of the figure
+     */
+    confidence: number;
+
+    /**
+     * The name of the figure
+     */
+    figure_name: string;
+
+    /**
+     * The size of the figure in bytes
+     */
+    figure_size: number;
+
+    /**
+     * The ID of the file that the figure was taken from
+     */
+    file_id: string;
+
+    /**
+     * The index of the page for which the figure is taken (0-indexed)
+     */
+    page_index: number;
+
+    /**
+     * Whether the figure is likely to be noise
+     */
+    is_likely_noise?: boolean;
+
+    /**
+     * Metadata for the figure
+     */
+    metadata?: { [key: string]: unknown } | null;
+  }
+}
+
+export type ImageListPageScreenshotsResponse =
+  Array<ImageListPageScreenshotsResponse.ImageListPageScreenshotsResponseItem>;
+
+export namespace ImageListPageScreenshotsResponse {
+  export interface ImageListPageScreenshotsResponseItem {
+    /**
+     * The ID of the file that the page screenshot was taken from
+     */
+    file_id: string;
+
+    /**
+     * The size of the image in bytes
+     */
+    image_size: number;
+
+    /**
+     * The index of the page for which the screenshot is taken (0-indexed)
+     */
+    page_index: number;
+
+    /**
+     * Metadata for the screenshot
+     */
+    metadata?: { [key: string]: unknown } | null;
+  }
+}
+
+export interface ImageGetPageFigureParams {
+  /**
+   * Path param
+   */
+  id: string;
+
+  /**
+   * Path param
+   */
+  page_index: number;
+
+  /**
+   * Query param
+   */
+  organization_id?: string | null;
+
+  /**
+   * Query param
+   */
+  project_id?: string | null;
+}
+
+export interface ImageGetPageScreenshotParams {
+  /**
+   * Path param
+   */
+  id: string;
+
+  /**
+   * Query param
+   */
+  organization_id?: string | null;
+
+  /**
+   * Query param
+   */
+  project_id?: string | null;
+}
+
+export interface ImageListPageFiguresParams {
+  organization_id?: string | null;
+
+  project_id?: string | null;
+}
+
+export interface ImageListPageScreenshotsParams {
+  organization_id?: string | null;
+
+  project_id?: string | null;
+}
+
+export declare namespace Images {
+  export {
+    type ImageGetPageFigureResponse as ImageGetPageFigureResponse,
+    type ImageGetPageScreenshotResponse as ImageGetPageScreenshotResponse,
+    type ImageListPageFiguresResponse as ImageListPageFiguresResponse,
+    type ImageListPageScreenshotsResponse as ImageListPageScreenshotsResponse,
+    type ImageGetPageFigureParams as ImageGetPageFigureParams,
+    type ImageGetPageScreenshotParams as ImageGetPageScreenshotParams,
+    type ImageListPageFiguresParams as ImageListPageFiguresParams,
+    type ImageListPageScreenshotsParams as ImageListPageScreenshotsParams,
+  };
+}

package/src/resources/pipelines/index.ts

@@ -0,0 +1,99 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  DataSources,
+  type PipelineDataSource,
+  type DataSourceGetDataSourcesResponse,
+  type DataSourceUpdateDataSourcesResponse,
+  type DataSourceUpdateParams,
+  type DataSourceGetStatusParams,
+  type DataSourceSyncParams,
+  type DataSourceUpdateDataSourcesParams,
+} from './data-sources';
+export {
+  Documents,
+  type CloudDocument,
+  type CloudDocumentCreate,
+  type TextNode,
+  type DocumentCreateResponse,
+  type DocumentGetChunksResponse,
+  type DocumentSyncResponse,
+  type DocumentUpsertResponse,
+  type DocumentCreateParams,
+  type DocumentListParams,
+  type DocumentDeleteParams,
+  type DocumentGetParams,
+  type DocumentGetChunksParams,
+  type DocumentGetStatusParams,
+  type DocumentSyncParams,
+  type DocumentUpsertParams,
+  type CloudDocumentsPaginatedCloudDocuments,
+} from './documents';
+export {
+  Files,
+  type PipelineFile,
+  type FileCreateResponse,
+  type FileGetStatusCountsResponse,
+  type FileCreateParams,
+  type FileUpdateParams,
+  type FileListParams,
+  type FileDeleteParams,
+  type FileGetStatusParams,
+  type FileGetStatusCountsParams,
+  type PipelineFilesPaginatedPipelineFiles,
+} from './files';
+export {
+  Images,
+  type ImageGetPageFigureResponse,
+  type ImageGetPageScreenshotResponse,
+  type ImageListPageFiguresResponse,
+  type ImageListPageScreenshotsResponse,
+  type ImageGetPageFigureParams,
+  type ImageGetPageScreenshotParams,
+  type ImageListPageFiguresParams,
+  type ImageListPageScreenshotsParams,
+} from './images';
+export { Metadata, type MetadataCreateResponse, type MetadataCreateParams } from './metadata';
+export {
+  Pipelines,
+  type AdvancedModeTransformConfig,
+  type AutoTransformConfig,
+  type AzureOpenAIEmbedding,
+  type AzureOpenAIEmbeddingConfig,
+  type BedrockEmbedding,
+  type BedrockEmbeddingConfig,
+  type CohereEmbedding,
+  type CohereEmbeddingConfig,
+  type DataSinkCreate,
+  type GeminiEmbedding,
+  type GeminiEmbeddingConfig,
+  type HuggingFaceInferenceAPIEmbedding,
+  type HuggingFaceInferenceAPIEmbeddingConfig,
+  type LlamaParseParameters,
+  type LlmParameters,
+  type ManagedIngestionStatusResponse,
+  type MessageRole,
+  type MetadataFilters,
+  type OpenAIEmbedding,
+  type OpenAIEmbeddingConfig,
+  type PageFigureNodeWithScore,
+  type PageScreenshotNodeWithScore,
+  type Pipeline,
+  type PipelineCreate,
+  type PipelineMetadataConfig,
+  type PipelineType,
+  type PresetRetrievalParams,
+  type RetrievalMode,
+  type SparseModelConfig,
+  type VertexAIEmbeddingConfig,
+  type VertexTextEmbedding,
+  type PipelineRetrieveResponse,
+  type PipelineListResponse,
+  type PipelineCreateParams,
+  type PipelineRetrieveParams,
+  type PipelineUpdateParams,
+  type PipelineListParams,
+  type PipelineGetStatusParams,
+  type PipelineUpsertParams,
+} from './pipelines';
+export { Sync } from './sync';

package/src/resources/pipelines/metadata.ts

@@ -0,0 +1,48 @@
+// 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 { type Uploadable } from '../../core/uploads';
+import { buildHeaders } from '../../internal/headers';
+import { RequestOptions } from '../../internal/request-options';
+import { multipartFormRequestOptions } from '../../internal/uploads';
+import { path } from '../../internal/utils/path';
+
+export class Metadata extends APIResource {
+  /**
+   * Import metadata for a pipeline.
+   */
+  create(
+    pipelineID: string,
+    body: MetadataCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<MetadataCreateResponse> {
+    return this._client.put(
+      path`/api/v1/pipelines/${pipelineID}/metadata`,
+      multipartFormRequestOptions({ body, ...options }, this._client),
+    );
+  }
+
+  /**
+   * Delete metadata for all files in a pipeline.
+   */
+  deleteAll(pipelineID: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/api/v1/pipelines/${pipelineID}/metadata`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export type MetadataCreateResponse = { [key: string]: string };
+
+export interface MetadataCreateParams {
+  upload_file: Uploadable;
+}
+
+export declare namespace Metadata {
+  export {
+    type MetadataCreateResponse as MetadataCreateResponse,
+    type MetadataCreateParams as MetadataCreateParams,
+  };
+}