@llamaindex/llama-cloud 2.9.0 → 2.10.0

package/src/resources/pipelines/sync.ts

@@ -12,6 +12,8 @@ export class Sync extends APIResource {
    *
    * Processes new and updated documents from data sources and files, then updates
    * the index for retrieval.
+   *
+   * @deprecated
    */
   create(pipelineID: string, options?: RequestOptions): APIPromise<PipelinesAPI.Pipeline> {
     return this._client.post(path`/api/v1/pipelines/${pipelineID}/sync`, options);
@@ -19,6 +21,8 @@ export class Sync extends APIResource {
 
   /**
    * Cancel all running sync jobs for a pipeline.
+   *
+   * @deprecated
    */
   cancel(pipelineID: string, options?: RequestOptions): APIPromise<PipelinesAPI.Pipeline> {
     return this._client.post(path`/api/v1/pipelines/${pipelineID}/sync/cancel`, options);

package/src/resources/retrievers/index.ts

@@ -10,10 +10,10 @@ export {
   type RetrieverPipeline,
   type RetrieverListResponse,
   type RetrieverCreateParams,
-  type RetrieverUpdateParams,
+  type RetrieverUpsertParams,
   type RetrieverListParams,
-  type RetrieverDeleteParams,
   type RetrieverGetParams,
+  type RetrieverUpdateParams,
+  type RetrieverDeleteParams,
   type RetrieverSearchParams,
-  type RetrieverUpsertParams,
 } from './retrievers';

package/src/resources/retrievers/retrievers.ts

@@ -24,15 +24,11 @@ export class Retrievers extends APIResource {
   }
 
   /**
-   * Update an existing Retriever.
+   * Upsert a new Retriever.
    */
-  update(
-    retrieverID: string,
-    params: RetrieverUpdateParams,
-    options?: RequestOptions,
-  ): APIPromise<Retriever> {
+  upsert(params: RetrieverUpsertParams, options?: RequestOptions): APIPromise<Retriever> {
     const { organization_id, project_id, ...body } = params;
-    return this._client.put(path`/api/v1/retrievers/${retrieverID}`, {
+    return this._client.put('/api/v1/retrievers', {
       query: { organization_id, project_id },
       body,
       ...options,
@@ -49,22 +45,6 @@ export class Retrievers extends APIResource {
     return this._client.get('/api/v1/retrievers', { query, ...options });
   }
 
-  /**
-   * Delete a Retriever by ID.
-   */
-  delete(
-    retrieverID: string,
-    params: RetrieverDeleteParams | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<void> {
-    const { organization_id, project_id } = params ?? {};
-    return this._client.delete(path`/api/v1/retrievers/${retrieverID}`, {
-      query: { organization_id, project_id },
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
-  }
-
   /**
    * Get a Retriever by ID.
    */
@@ -77,11 +57,15 @@ export class Retrievers extends APIResource {
   }
 
   /**
-   * Retrieve data using specified pipelines without creating a persistent retriever.
+   * Update an existing Retriever.
    */
-  search(params: RetrieverSearchParams, options?: RequestOptions): APIPromise<CompositeRetrievalResult> {
+  update(
+    retrieverID: string,
+    params: RetrieverUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<Retriever> {
     const { organization_id, project_id, ...body } = params;
-    return this._client.post('/api/v1/retrievers/retrieve', {
+    return this._client.put(path`/api/v1/retrievers/${retrieverID}`, {
       query: { organization_id, project_id },
       body,
       ...options,
@@ -89,11 +73,27 @@ export class Retrievers extends APIResource {
   }
 
   /**
-   * Upsert a new Retriever.
+   * Delete a Retriever by ID.
    */
-  upsert(params: RetrieverUpsertParams, options?: RequestOptions): APIPromise<Retriever> {
+  delete(
+    retrieverID: string,
+    params: RetrieverDeleteParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<void> {
+    const { organization_id, project_id } = params ?? {};
+    return this._client.delete(path`/api/v1/retrievers/${retrieverID}`, {
+      query: { organization_id, project_id },
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * 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.put('/api/v1/retrievers', {
+    return this._client.post('/api/v1/retrievers/retrieve', {
       query: { organization_id, project_id },
       body,
       ...options,
@@ -104,7 +104,7 @@ export class Retrievers extends APIResource {
 /**
  * Enum for the mode of composite retrieval.
  */
-export type CompositeRetrievalMode = 'routing' | 'full';
+export type CompositeRetrievalMode = 'full' | 'routing';
 
 export interface CompositeRetrievalResult {
   /**
@@ -188,7 +188,7 @@ export interface ReRankConfig {
   /**
    * The type of reranker to use.
    */
-  type?: 'system_default' | 'llm' | 'cohere' | 'bedrock' | 'score' | 'disabled';
+  type?: 'bedrock' | 'cohere' | 'disabled' | 'llm' | 'score' | 'system_default';
 }
 
 /**
@@ -288,11 +288,12 @@ export interface RetrieverCreateParams {
   pipelines?: Array<RetrieverPipeline>;
 }
 
-export interface RetrieverUpdateParams {
+export interface RetrieverUpsertParams {
   /**
-   * Body param: The pipelines this retriever uses.
+   * Body param: A name for the retriever tool. Will default to the pipeline name if
+   * not provided.
    */
-  pipelines: Array<RetrieverPipeline> | null;
+  name: string;
 
   /**
    * Query param
@@ -305,9 +306,9 @@ export interface RetrieverUpdateParams {
   project_id?: string | null;
 
   /**
-   * Body param: A name for the retriever.
+   * Body param: The pipelines this retriever uses.
    */
-  name?: string | null;
+  pipelines?: Array<RetrieverPipeline>;
 }
 
 export interface RetrieverListParams {
@@ -318,13 +319,35 @@ export interface RetrieverListParams {
   project_id?: string | null;
 }
 
-export interface RetrieverDeleteParams {
+export interface RetrieverGetParams {
   organization_id?: string | null;
 
   project_id?: string | null;
 }
 
-export interface RetrieverGetParams {
+export interface RetrieverUpdateParams {
+  /**
+   * Body param: The pipelines this retriever uses.
+   */
+  pipelines: Array<RetrieverPipeline> | null;
+
+  /**
+   * Query param
+   */
+  organization_id?: string | null;
+
+  /**
+   * Query param
+   */
+  project_id?: string | null;
+
+  /**
+   * Body param: A name for the retriever.
+   */
+  name?: string | null;
+}
+
+export interface RetrieverDeleteParams {
   organization_id?: string | null;
 
   project_id?: string | null;
@@ -368,29 +391,6 @@ export interface RetrieverSearchParams {
   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,
@@ -401,11 +401,11 @@ export declare namespace Retrievers {
     type RetrieverPipeline as RetrieverPipeline,
     type RetrieverListResponse as RetrieverListResponse,
     type RetrieverCreateParams as RetrieverCreateParams,
-    type RetrieverUpdateParams as RetrieverUpdateParams,
+    type RetrieverUpsertParams as RetrieverUpsertParams,
     type RetrieverListParams as RetrieverListParams,
-    type RetrieverDeleteParams as RetrieverDeleteParams,
     type RetrieverGetParams as RetrieverGetParams,
+    type RetrieverUpdateParams as RetrieverUpdateParams,
+    type RetrieverDeleteParams as RetrieverDeleteParams,
     type RetrieverSearchParams as RetrieverSearchParams,
-    type RetrieverUpsertParams as RetrieverUpsertParams,
   };
 }

package/src/resources/shared.ts

@@ -106,7 +106,7 @@ export interface CloudBoxDataSource {
   /**
    * The type of authentication to use (Developer Token or CCG)
    */
-  authentication_mechanism: 'developer_token' | 'ccg';
+  authentication_mechanism: 'ccg' | 'developer_token';
 
   class_name?: string;
 
@@ -190,6 +190,15 @@ export interface CloudConfluenceDataSource {
 
   supports_access_control?: boolean;
 
+  /**
+   * Whether to fetch space-level permissions (allowed users/groups) and attach them
+   * to document metadata for access control. Disable for Confluence Server/Data
+   * Center versions whose permission APIs are unavailable (e.g. the JSON-RPC API
+   * removed in Data Center 9.2.6+), which otherwise surface as 401 errors during
+   * sync.
+   */
+  sync_permissions?: boolean;
+
   /**
    * The username to use for authentication.
    */
@@ -627,7 +636,7 @@ export interface PgVectorHnswSettings {
   /**
    * The distance method to use.
    */
-  distance_method?: 'l2' | 'ip' | 'cosine' | 'l1' | 'hamming' | 'jaccard';
+  distance_method?: 'cosine' | 'hamming' | 'ip' | 'jaccard' | 'l1' | 'l2';
 
   /**
    * The number of edges to use during the construction phase.
@@ -647,5 +656,5 @@ export interface PgVectorHnswSettings {
   /**
    * The type of vector to use.
    */
-  vector_type?: 'vector' | 'half_vec' | 'bit' | 'sparse_vec';
+  vector_type?: 'bit' | 'half_vec' | 'sparse_vec' | 'vector';
 }

package/src/resources/sheets.ts

@@ -0,0 +1,322 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as FilesAPI from './files';
+import * as BetaSheetsAPI from './beta/sheets';
+import { SheetsJobsPaginatedCursor } from './beta/sheets';
+import { APIPromise } from '../core/api-promise';
+import { PagePromise, PaginatedCursor, type PaginatedCursorParams } from '../core/pagination';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class Sheets extends APIResource {
+  /**
+   * Create a spreadsheet parsing job.
+   *
+   * Provide at most one of `configuration` (an inline parsing configuration) or
+   * `configuration_id` (a saved configuration preset). If neither is provided, a
+   * default configuration is used. Optionally include `webhook_configurations` to
+   * receive `sheets.*` status notifications.
+   *
+   * @example
+   * ```ts
+   * const sheetsJob = await client.sheets.create({
+   *   file_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * });
+   * ```
+   */
+  create(params: SheetCreateParams, options?: RequestOptions): APIPromise<BetaSheetsAPI.SheetsJob> {
+    const { organization_id, project_id, ...body } = params;
+    return this._client.post('/api/v1/sheets/jobs', {
+      query: { organization_id, project_id },
+      body,
+      ...options,
+    });
+  }
+
+  /**
+   * List spreadsheet parsing jobs.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const sheetsJob of client.sheets.list()) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    query: SheetListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<SheetsJobsPaginatedCursor, BetaSheetsAPI.SheetsJob> {
+    return this._client.getAPIList('/api/v1/sheets/jobs', PaginatedCursor<BetaSheetsAPI.SheetsJob>, {
+      query,
+      ...options,
+    });
+  }
+
+  /**
+   * Get a spreadsheet parsing job. When `include_results=True` (default), embeds
+   * extracted regions and results if complete, skipping the separate `/results`
+   * call.
+   *
+   * @example
+   * ```ts
+   * const sheetsJob = await client.sheets.get(
+   *   'spreadsheet_job_id',
+   * );
+   * ```
+   */
+  get(
+    spreadsheetJobID: string,
+    query: SheetGetParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<BetaSheetsAPI.SheetsJob> {
+    return this._client.get(path`/api/v1/sheets/jobs/${spreadsheetJobID}`, { query, ...options });
+  }
+
+  /**
+   * Generate a presigned URL to download a specific extracted region.
+   *
+   * @example
+   * ```ts
+   * const presignedURL = await client.sheets.getResultTable(
+   *   'cell_metadata',
+   *   {
+   *     spreadsheet_job_id: 'spreadsheet_job_id',
+   *     region_id: 'region_id',
+   *   },
+   * );
+   * ```
+   */
+  getResultTable(
+    regionType: 'cell_metadata' | 'extra' | 'table',
+    params: SheetGetResultTableParams,
+    options?: RequestOptions,
+  ): APIPromise<FilesAPI.PresignedURL> {
+    const { spreadsheet_job_id, region_id, ...query } = params;
+    return this._client.get(
+      path`/api/v1/sheets/jobs/${spreadsheet_job_id}/regions/${region_id}/result/${regionType}`,
+      { query, ...options },
+    );
+  }
+
+  /**
+   * Delete a spreadsheet parsing job and its associated data.
+   *
+   * @example
+   * ```ts
+   * const response = await client.sheets.deleteJob(
+   *   'spreadsheet_job_id',
+   * );
+   * ```
+   */
+  deleteJob(
+    spreadsheetJobID: string,
+    params: SheetDeleteJobParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<unknown> {
+    const { organization_id, project_id } = params ?? {};
+    return this._client.delete(path`/api/v1/sheets/jobs/${spreadsheetJobID}`, {
+      query: { organization_id, project_id },
+      ...options,
+    });
+  }
+}
+
+export type SheetDeleteJobResponse = unknown;
+
+export interface SheetCreateParams {
+  /**
+   * Body param: The ID of the file to parse
+   */
+  file_id: string;
+
+  /**
+   * Query param
+   */
+  organization_id?: string | null;
+
+  /**
+   * Query param
+   */
+  project_id?: string | null;
+
+  /**
+   * Body param: Configuration for spreadsheet parsing and region extraction
+   */
+  config?: BetaSheetsAPI.SheetsParsingConfig | null;
+
+  /**
+   * Body param: Configuration for spreadsheet parsing and region extraction
+   */
+  configuration?: BetaSheetsAPI.SheetsParsingConfig | null;
+
+  /**
+   * Body param: Saved configuration ID
+   */
+  configuration_id?: string | null;
+
+  /**
+   * Body param: Outbound webhook endpoints to notify on job status changes
+   */
+  webhook_configurations?: Array<SheetCreateParams.WebhookConfiguration> | null;
+}
+
+export namespace SheetCreateParams {
+  /**
+   * Configuration for a single outbound webhook endpoint.
+   */
+  export interface WebhookConfiguration {
+    /**
+     * Events to subscribe to (e.g. 'parse.success', 'extract.error'). If null, all
+     * events are delivered.
+     */
+    webhook_events?: Array<
+      | 'classify.cancelled'
+      | 'classify.error'
+      | 'classify.partial_success'
+      | 'classify.pending'
+      | 'classify.running'
+      | 'classify.success'
+      | 'extract.cancelled'
+      | 'extract.error'
+      | 'extract.partial_success'
+      | 'extract.pending'
+      | 'extract.success'
+      | 'parse.cancelled'
+      | 'parse.error'
+      | 'parse.partial_success'
+      | 'parse.pending'
+      | 'parse.running'
+      | 'parse.success'
+      | 'sheets.cancelled'
+      | 'sheets.error'
+      | 'sheets.partial_success'
+      | 'sheets.pending'
+      | 'sheets.success'
+      | 'split.cancelled'
+      | 'split.error'
+      | 'split.pending'
+      | 'split.processing'
+      | 'split.success'
+      | 'unmapped_event'
+    > | null;
+
+    /**
+     * Custom HTTP headers sent with each webhook request (e.g. auth tokens)
+     */
+    webhook_headers?: { [key: string]: string } | null;
+
+    /**
+     * Response format sent to the webhook: 'string' (default) or 'json'
+     */
+    webhook_output_format?: string | null;
+
+    /**
+     * Shared signing secret used to sign webhook deliveries. When set, each request
+     * includes an HMAC-SHA256 signature of the request body in the 'LC-Signature'
+     * header (value 'sha256=<hex>'). Recompute the HMAC over the raw request body with
+     * this secret to verify the delivery is authentic.
+     */
+    webhook_signing_secret?: string | null;
+
+    /**
+     * URL to receive webhook POST notifications
+     */
+    webhook_url?: string | null;
+  }
+}
+
+export interface SheetListParams extends PaginatedCursorParams {
+  /**
+   * Filter by saved configuration ID
+   */
+  configuration_id?: string | null;
+
+  /**
+   * Include items created at or after this timestamp (inclusive)
+   */
+  created_at_on_or_after?: string | null;
+
+  /**
+   * Include items created at or before this timestamp (inclusive)
+   */
+  created_at_on_or_before?: string | null;
+
+  include_results?: boolean;
+
+  /**
+   * Filter by specific job IDs
+   */
+  job_ids?: Array<string> | null;
+
+  organization_id?: string | null;
+
+  project_id?: string | null;
+
+  /**
+   * Filter by job status
+   */
+  status?: 'CANCELLED' | 'ERROR' | 'PARTIAL_SUCCESS' | 'PENDING' | 'SUCCESS' | null;
+}
+
+export interface SheetGetParams {
+  /**
+   * Optional fields to populate on the response. Valid values:
+   * metadata_state_transitions.
+   */
+  expand?: Array<string>;
+
+  include_results?: boolean;
+
+  organization_id?: string | null;
+
+  project_id?: string | null;
+}
+
+export interface SheetGetResultTableParams {
+  /**
+   * Path param
+   */
+  spreadsheet_job_id: string;
+
+  /**
+   * Path param
+   */
+  region_id: string;
+
+  /**
+   * Query param
+   */
+  expires_at_seconds?: number | null;
+
+  /**
+   * Query param
+   */
+  organization_id?: string | null;
+
+  /**
+   * Query param
+   */
+  project_id?: string | null;
+}
+
+export interface SheetDeleteJobParams {
+  organization_id?: string | null;
+
+  project_id?: string | null;
+}
+
+export declare namespace Sheets {
+  export {
+    type SheetDeleteJobResponse as SheetDeleteJobResponse,
+    type SheetCreateParams as SheetCreateParams,
+    type SheetListParams as SheetListParams,
+    type SheetGetParams as SheetGetParams,
+    type SheetGetResultTableParams as SheetGetResultTableParams,
+    type SheetDeleteJobParams as SheetDeleteJobParams,
+  };
+}
+
+export { type SheetsJobsPaginatedCursor };

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '2.9.0'; // x-release-please-version
+export const VERSION = '2.10.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "2.9.0";
+export declare const VERSION = "2.10.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"version.d.mts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC"}
+{"version":3,"file":"version.d.mts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,WAAW,CAAC"}

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "2.9.0";
+export declare const VERSION = "2.10.0";
 //# sourceMappingURL=version.d.ts.map

package/version.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC"}
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,WAAW,CAAC"}

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '2.9.0'; // x-release-please-version
+exports.VERSION = '2.10.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.js.map

@@ -1 +1 @@
-{"version":3,"file":"version.js","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,OAAO,CAAC,CAAC,2BAA2B"}
+{"version":3,"file":"version.js","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,QAAQ,CAAC,CAAC,2BAA2B"}

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '2.9.0'; // x-release-please-version
+export const VERSION = '2.10.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map

package/version.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"version.mjs","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,2BAA2B"}
+{"version":3,"file":"version.mjs","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,QAAQ,CAAC,CAAC,2BAA2B"}