@llamaindex/llama-cloud 2.8.0 → 2.9.1

package/src/resources/pipelines/data-sources.ts

@@ -9,8 +9,33 @@ import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
 export class DataSources extends APIResource {
+  /**
+   * Get data sources for a pipeline.
+   *
+   * @deprecated
+   */
+  getDataSources(pipelineID: string, options?: RequestOptions): APIPromise<DataSourceGetDataSourcesResponse> {
+    return this._client.get(path`/api/v1/pipelines/${pipelineID}/data-sources`, options);
+  }
+
+  /**
+   * Add data sources to a pipeline.
+   *
+   * @deprecated
+   */
+  updateDataSources(
+    pipelineID: string,
+    params: DataSourceUpdateDataSourcesParams,
+    options?: RequestOptions,
+  ): APIPromise<DataSourceUpdateDataSourcesResponse> {
+    const { body } = params;
+    return this._client.put(path`/api/v1/pipelines/${pipelineID}/data-sources`, { body: body, ...options });
+  }
+
   /**
    * Update the configuration of a data source in a pipeline.
+   *
+   * @deprecated
    */
   update(
     dataSourceID: string,
@@ -24,15 +49,10 @@ export class DataSources extends APIResource {
     });
   }
 
-  /**
-   * Get data sources for a pipeline.
-   */
-  getDataSources(pipelineID: string, options?: RequestOptions): APIPromise<DataSourceGetDataSourcesResponse> {
-    return this._client.get(path`/api/v1/pipelines/${pipelineID}/data-sources`, options);
-  }
-
   /**
    * Get the status of a data source for a pipeline.
+   *
+   * @deprecated
    */
   getStatus(
     dataSourceID: string,
@@ -49,6 +69,8 @@ export class DataSources extends APIResource {
   /**
    * Run incremental ingestion: pull upstream changes from the data source into the
    * data sink.
+   *
+   * @deprecated
    */
   sync(
     dataSourceID: string,
@@ -61,18 +83,6 @@ export class DataSources extends APIResource {
       ...options,
     });
   }
-
-  /**
-   * Add data sources to a pipeline.
-   */
-  updateDataSources(
-    pipelineID: string,
-    params: DataSourceUpdateDataSourcesParams,
-    options?: RequestOptions,
-  ): APIPromise<DataSourceUpdateDataSourcesResponse> {
-    const { body } = params;
-    return this._client.put(path`/api/v1/pipelines/${pipelineID}/data-sources`, { body: body, ...options });
-  }
 }
 
 /**
@@ -124,17 +134,17 @@ export interface PipelineDataSource {
   project_id: string;
 
   source_type:
-    | 'S3'
     | 'AZURE_STORAGE_BLOB'
+    | 'BOX'
+    | 'CONFLUENCE'
     | 'GOOGLE_DRIVE'
+    | 'JIRA'
+    | 'JIRA_V2'
     | 'MICROSOFT_ONEDRIVE'
     | 'MICROSOFT_SHAREPOINT'
-    | 'SLACK'
     | 'NOTION_PAGE'
-    | 'CONFLUENCE'
-    | 'JIRA'
-    | 'JIRA_V2'
-    | 'BOX';
+    | 'S3'
+    | 'SLACK';
 
   /**
    * Creation datetime
@@ -151,7 +161,7 @@ export interface PipelineDataSource {
   /**
    * The status of the data source in the pipeline.
    */
-  status?: 'NOT_STARTED' | 'IN_PROGRESS' | 'SUCCESS' | 'ERROR' | 'CANCELLED' | null;
+  status?: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'SUCCESS' | null;
 
   /**
    * The last time the status was updated.
@@ -183,6 +193,28 @@ export type DataSourceGetDataSourcesResponse = Array<PipelineDataSource>;
 
 export type DataSourceUpdateDataSourcesResponse = Array<PipelineDataSource>;
 
+export interface DataSourceUpdateDataSourcesParams {
+  body: Array<DataSourceUpdateDataSourcesParams.Body>;
+}
+
+export namespace DataSourceUpdateDataSourcesParams {
+  /**
+   * Schema for creating an association between a data source and a pipeline.
+   */
+  export interface Body {
+    /**
+     * The ID of the data source.
+     */
+    data_source_id: string;
+
+    /**
+     * The interval at which the data source should be synced. Valid values are: 21600,
+     * 43200, 86400
+     */
+    sync_interval?: number | null;
+  }
+}
+
 export interface DataSourceUpdateParams {
   /**
    * Path param
@@ -211,36 +243,14 @@ export interface DataSourceSyncParams {
   pipeline_file_ids?: Array<string> | null;
 }
 
-export interface DataSourceUpdateDataSourcesParams {
-  body: Array<DataSourceUpdateDataSourcesParams.Body>;
-}
-
-export namespace DataSourceUpdateDataSourcesParams {
-  /**
-   * Schema for creating an association between a data source and a pipeline.
-   */
-  export interface Body {
-    /**
-     * The ID of the data source.
-     */
-    data_source_id: string;
-
-    /**
-     * The interval at which the data source should be synced. Valid values are: 21600,
-     * 43200, 86400
-     */
-    sync_interval?: number | null;
-  }
-}
-
 export declare namespace DataSources {
   export {
     type PipelineDataSource as PipelineDataSource,
     type DataSourceGetDataSourcesResponse as DataSourceGetDataSourcesResponse,
     type DataSourceUpdateDataSourcesResponse as DataSourceUpdateDataSourcesResponse,
+    type DataSourceUpdateDataSourcesParams as DataSourceUpdateDataSourcesParams,
     type DataSourceUpdateParams as DataSourceUpdateParams,
     type DataSourceGetStatusParams as DataSourceGetStatusParams,
     type DataSourceSyncParams as DataSourceSyncParams,
-    type DataSourceUpdateDataSourcesParams as DataSourceUpdateDataSourcesParams,
   };
 }

package/src/resources/pipelines/documents.ts

@@ -15,6 +15,8 @@ import { path } from '../../internal/utils/path';
 export class Documents extends APIResource {
   /**
    * Batch create documents for a pipeline.
+   *
+   * @deprecated
    */
   create(
     pipelineID: string,
@@ -27,6 +29,8 @@ export class Documents extends APIResource {
 
   /**
    * Return a list of documents for a pipeline.
+   *
+   * @deprecated
    */
   list(
     pipelineID: string,
@@ -40,20 +44,10 @@ export class Documents extends APIResource {
     );
   }
 
-  /**
-   * Delete a document from a pipeline; runs async (vectors first, then MongoDB
-   * record).
-   */
-  delete(documentID: string, params: DocumentDeleteParams, options?: RequestOptions): APIPromise<void> {
-    const { pipeline_id } = params;
-    return this._client.delete(path`/api/v1/pipelines/${pipeline_id}/documents/${documentID}`, {
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
-  }
-
   /**
    * Return a single document for a pipeline.
+   *
+   * @deprecated
    */
   get(documentID: string, params: DocumentGetParams, options?: RequestOptions): APIPromise<CloudDocument> {
     const { pipeline_id } = params;
@@ -61,19 +55,23 @@ export class Documents extends APIResource {
   }
 
   /**
-   * Return a list of chunks for a pipeline document.
+   * Delete a document from a pipeline; runs async (vectors first, then MongoDB
+   * record).
+   *
+   * @deprecated
    */
-  getChunks(
-    documentID: string,
-    params: DocumentGetChunksParams,
-    options?: RequestOptions,
-  ): APIPromise<DocumentGetChunksResponse> {
+  delete(documentID: string, params: DocumentDeleteParams, options?: RequestOptions): APIPromise<void> {
     const { pipeline_id } = params;
-    return this._client.get(path`/api/v1/pipelines/${pipeline_id}/documents/${documentID}/chunks`, options);
+    return this._client.delete(path`/api/v1/pipelines/${pipeline_id}/documents/${documentID}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
   }
 
   /**
    * Return a single document for a pipeline.
+   *
+   * @deprecated
    */
   getStatus(
     documentID: string,
@@ -86,14 +84,32 @@ export class Documents extends APIResource {
 
   /**
    * Sync a specific document for a pipeline.
+   *
+   * @deprecated
    */
   sync(documentID: string, params: DocumentSyncParams, options?: RequestOptions): APIPromise<unknown> {
     const { pipeline_id } = params;
     return this._client.post(path`/api/v1/pipelines/${pipeline_id}/documents/${documentID}/sync`, options);
   }
 
+  /**
+   * Return a list of chunks for a pipeline document.
+   *
+   * @deprecated
+   */
+  getChunks(
+    documentID: string,
+    params: DocumentGetChunksParams,
+    options?: RequestOptions,
+  ): APIPromise<DocumentGetChunksResponse> {
+    const { pipeline_id } = params;
+    return this._client.get(path`/api/v1/pipelines/${pipeline_id}/documents/${documentID}/chunks`, options);
+  }
+
   /**
    * Batch create or update a document for a pipeline.
+   *
+   * @deprecated
    */
   upsert(
     pipelineID: string,
@@ -272,15 +288,11 @@ export interface DocumentListParams extends PaginatedCloudDocumentsParams {
   status_refresh_policy?: 'cached' | 'ttl';
 }
 
-export interface DocumentDeleteParams {
-  pipeline_id: string;
-}
-
 export interface DocumentGetParams {
   pipeline_id: string;
 }
 
-export interface DocumentGetChunksParams {
+export interface DocumentDeleteParams {
   pipeline_id: string;
 }
 
@@ -292,6 +304,10 @@ export interface DocumentSyncParams {
   pipeline_id: string;
 }
 
+export interface DocumentGetChunksParams {
+  pipeline_id: string;
+}
+
 export interface DocumentUpsertParams {
   body: Array<CloudDocumentCreate>;
 }
@@ -308,11 +324,11 @@ export declare namespace Documents {
     type CloudDocumentsPaginatedCloudDocuments as CloudDocumentsPaginatedCloudDocuments,
     type DocumentCreateParams as DocumentCreateParams,
     type DocumentListParams as DocumentListParams,
-    type DocumentDeleteParams as DocumentDeleteParams,
     type DocumentGetParams as DocumentGetParams,
-    type DocumentGetChunksParams as DocumentGetChunksParams,
+    type DocumentDeleteParams as DocumentDeleteParams,
     type DocumentGetStatusParams as DocumentGetStatusParams,
     type DocumentSyncParams as DocumentSyncParams,
+    type DocumentGetChunksParams as DocumentGetChunksParams,
     type DocumentUpsertParams as DocumentUpsertParams,
   };
 }

package/src/resources/pipelines/files.ts

@@ -13,8 +13,37 @@ import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
 export class Files extends APIResource {
+  /**
+   * Get files for a pipeline.
+   *
+   * @deprecated
+   */
+  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 });
+  }
+
+  /**
+   * Get status of a file for a pipeline.
+   *
+   * @deprecated
+   */
+  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);
+  }
+
   /**
    * Add files to a pipeline.
+   *
+   * @deprecated
    */
   create(
     pipelineID: string,
@@ -27,6 +56,8 @@ export class Files extends APIResource {
 
   /**
    * Update a file for a pipeline.
+   *
+   * @deprecated
    */
   update(fileID: string, params: FileUpdateParams, options?: RequestOptions): APIPromise<PipelineFile> {
     const { pipeline_id, ...body } = params;
@@ -34,25 +65,10 @@ export class Files extends APIResource {
   }
 
   /**
-   * List files for a pipeline with optional filtering, sorting, and pagination.
+   * Delete a file from a pipeline.
    *
    * @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}`, {
@@ -62,26 +78,20 @@ export class Files extends APIResource {
   }
 
   /**
-   * 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.
+   * List files for a pipeline with optional filtering, sorting, and pagination.
+   *
+   * @deprecated
    */
-  getStatusCounts(
+  list(
     pipelineID: string,
-    query: FileGetStatusCountsParams | null | undefined = {},
+    query: FileListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<FileGetStatusCountsResponse> {
-    return this._client.get(path`/api/v1/pipelines/${pipelineID}/files/status-counts`, { query, ...options });
+  ): PagePromise<PipelineFilesPaginatedPipelineFiles, PipelineFile> {
+    return this._client.getAPIList(
+      path`/api/v1/pipelines/${pipelineID}/files2`,
+      PaginatedPipelineFiles<PipelineFile>,
+      { query, ...options },
+    );
   }
 }
 
@@ -182,7 +192,7 @@ export interface PipelineFile {
   /**
    * Status of the pipeline file.
    */
-  status?: 'NOT_STARTED' | 'IN_PROGRESS' | 'SUCCESS' | 'ERROR' | 'CANCELLED' | null;
+  status?: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'SUCCESS' | null;
 
   /**
    * The last time the status was updated.
@@ -224,6 +234,16 @@ export interface FileGetStatusCountsResponse {
   pipeline_id?: string | null;
 }
 
+export interface FileGetStatusCountsParams {
+  data_source_id?: string | null;
+
+  only_manually_uploaded?: boolean;
+}
+
+export interface FileGetStatusParams {
+  pipeline_id: string;
+}
+
 export interface FileCreateParams {
   body: Array<FileCreateParams.Body>;
 }
@@ -261,6 +281,10 @@ export interface FileUpdateParams {
   } | null;
 }
 
+export interface FileDeleteParams {
+  pipeline_id: string;
+}
+
 export interface FileListParams extends PaginatedPipelineFilesParams {
   data_source_id?: string | null;
 
@@ -273,21 +297,7 @@ export interface FileListParams extends PaginatedPipelineFilesParams {
   /**
    * Filter by file statuses
    */
-  statuses?: Array<'NOT_STARTED' | 'IN_PROGRESS' | 'SUCCESS' | 'ERROR' | 'CANCELLED'> | 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;
+  statuses?: Array<'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'SUCCESS'> | null;
 }
 
 export declare namespace Files {
@@ -296,11 +306,11 @@ export declare namespace Files {
     type FileCreateResponse as FileCreateResponse,
     type FileGetStatusCountsResponse as FileGetStatusCountsResponse,
     type PipelineFilesPaginatedPipelineFiles as PipelineFilesPaginatedPipelineFiles,
+    type FileGetStatusCountsParams as FileGetStatusCountsParams,
+    type FileGetStatusParams as FileGetStatusParams,
     type FileCreateParams as FileCreateParams,
     type FileUpdateParams as FileUpdateParams,
-    type FileListParams as FileListParams,
     type FileDeleteParams as FileDeleteParams,
-    type FileGetStatusParams as FileGetStatusParams,
-    type FileGetStatusCountsParams as FileGetStatusCountsParams,
+    type FileListParams as FileListParams,
   };
 }

package/src/resources/pipelines/images.ts

@@ -7,18 +7,14 @@ import { path } from '../../internal/utils/path';
 
 export class Images extends APIResource {
   /**
-   * Get a specific figure from a page of a file.
+   * List metadata for all screenshots of pages from a file.
    */
-  getPageFigure(
-    figureName: string,
-    params: ImageGetPageFigureParams,
+  listPageScreenshots(
+    id: string,
+    query: ImageListPageScreenshotsParams | null | undefined = {},
     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,
-    });
+  ): APIPromise<ImageListPageScreenshotsResponse> {
+    return this._client.get(path`/api/v1/files/${id}/page_screenshots`, { query, ...options });
   }
 
   /**
@@ -34,25 +30,29 @@ export class Images extends APIResource {
   }
 
   /**
-   * List metadata for all figures from all pages of a file.
+   * Get a specific figure from a page of a file.
    */
-  listPageFigures(
-    id: string,
-    query: ImageListPageFiguresParams | null | undefined = {},
+  getPageFigure(
+    figureName: string,
+    params: ImageGetPageFigureParams,
     options?: RequestOptions,
-  ): APIPromise<ImageListPageFiguresResponse> {
-    return this._client.get(path`/api/v1/files/${id}/page-figures`, { query, ...options });
+  ): APIPromise<unknown> {
+    const { id, page_index, ...query } = params;
+    return this._client.get(path`/api/v1/files/${id}/page-figures/${page_index}/${figureName}`, {
+      query,
+      ...options,
+    });
   }
 
   /**
-   * List metadata for all screenshots of pages from a file.
+   * List metadata for all figures from all pages of a file.
    */
-  listPageScreenshots(
+  listPageFigures(
     id: string,
-    query: ImageListPageScreenshotsParams | null | undefined = {},
+    query: ImageListPageFiguresParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<ImageListPageScreenshotsResponse> {
-    return this._client.get(path`/api/v1/files/${id}/page_screenshots`, { query, ...options });
+  ): APIPromise<ImageListPageFiguresResponse> {
+    return this._client.get(path`/api/v1/files/${id}/page-figures`, { query, ...options });
   }
 }
 
@@ -129,16 +129,17 @@ export namespace ImageListPageScreenshotsResponse {
   }
 }
 
-export interface ImageGetPageFigureParams {
-  /**
-   * Path param
-   */
-  id: string;
+export interface ImageListPageScreenshotsParams {
+  organization_id?: string | null;
 
+  project_id?: string | null;
+}
+
+export interface ImageGetPageScreenshotParams {
   /**
    * Path param
    */
-  page_index: number;
+  id: string;
 
   /**
    * Query param
@@ -151,12 +152,17 @@ export interface ImageGetPageFigureParams {
   project_id?: string | null;
 }
 
-export interface ImageGetPageScreenshotParams {
+export interface ImageGetPageFigureParams {
   /**
    * Path param
    */
   id: string;
 
+  /**
+   * Path param
+   */
+  page_index: number;
+
   /**
    * Query param
    */
@@ -174,21 +180,15 @@ export interface ImageListPageFiguresParams {
   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 ImageListPageScreenshotsParams as ImageListPageScreenshotsParams,
     type ImageGetPageScreenshotParams as ImageGetPageScreenshotParams,
+    type ImageGetPageFigureParams as ImageGetPageFigureParams,
     type ImageListPageFiguresParams as ImageListPageFiguresParams,
-    type ImageListPageScreenshotsParams as ImageListPageScreenshotsParams,
   };
 }