release: 0.7.0 (#56)

Co-authored-by: stainless-app[bot] <142633134+stainless-app[bot]@users.noreply.github.com>

Author: stainless-app[bot]

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.6.0"
+  ".": "0.7.0"
 }

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 52
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/contextual-ai%2Fsunrise-17bdb8a33fb4fcade827bba868bd65cd30c64b1d09b4a6d83c3e37a8439ed37f.yml
-openapi_spec_hash: bc325b52f3b20d8c56e0be5de88f2dc3
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/contextual-ai%2Fsunrise-8d75c58c83d13f67b6a125c3eb4639d213c91aec7dbb6e06f0cd5bdfc074d54e.yml
+openapi_spec_hash: 47795284631814d0f8eb42f6a0d5a3b3
 config_hash: 1ecef0ff4fd125bbc00eec65e3dd4798

CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## 0.7.0 (2025-05-13)
+
+Full Changelog: [v0.6.0...v0.7.0](https://github.com/ContextualAI/contextual-client-node/compare/v0.6.0...v0.7.0)
+
+### Features
+
+* **api:** update via SDK Studio ([7496061](https://github.com/ContextualAI/contextual-client-node/commit/7496061442c1753d889f8948d1b08f19eae50621))
+
+
+### Bug Fixes
+
+* **tests:** correct number examples ([56e8f9d](https://github.com/ContextualAI/contextual-client-node/commit/56e8f9d78074216bd5a4ab1b124e309eedce2e4e))
+
 ## 0.6.0 (2025-05-08)
 
 Full Changelog: [v0.5.0...v0.6.0](https://github.com/ContextualAI/contextual-client-node/compare/v0.5.0...v0.6.0)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "contextual-client",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "The official TypeScript library for the Contextual AI API",
   "author": "Contextual AI <support@contextual.ai>",
   "types": "dist/index.d.ts",

src/resources/parse.ts

@@ -6,9 +6,12 @@ import * as Core from '../core';
 
 export class Parse extends APIResource {
   /**
-   * Parse a file into a structured Markdown representation. The file size must be
-   * less than 100MB and the number of pages must be less than 400.
+   * Parse a file into a structured Markdown and/or JSON. Files must be less than
+   * 100MB and 400 pages. We use LibreOffice to convert DOC(X) and PPT(X) files to
+   * PDF, which may affect page count.
    *
+   * See our [blog post](https://contextual.ai/blog/document-parser-for-rag) and
+   * [code examples](https://github.com/ContextualAI/examples/blob/main/03-standalone-api/04-parse/parse.ipynb).
    * Email [parse-feedback@contextual.ai](mailto:parse-feedback@contextual.ai) with
    * any feedback or questions.
    */
@@ -92,6 +95,11 @@ export interface ParseJobResultsResponse {
    */
   status: 'pending' | 'processing' | 'retrying' | 'completed' | 'failed' | 'cancelled';
 
+  /**
+   * Document-level metadata parsed from the document
+   */
+  document_metadata?: ParseJobResultsResponse.DocumentMetadata;
+
   /**
    * The parsed, structured Markdown of the input file. Only present if
    * `markdown-document` was among the requested output types.
@@ -103,137 +111,143 @@ export interface ParseJobResultsResponse {
    * requested) and/or per-page `ParsedBlock`s (if `blocks-per-page` was requested).
    */
   pages?: Array<ParseJobResultsResponse.Page>;
-
-  /**
-   * The table of contents representing the document's heading hierarchy. Only
-   * present if `enable_document_hierarchy` was set to true in the parse request.
-   */
-  table_of_contents?: ParseJobResultsResponse.TableOfContents;
 }
 
 export namespace ParseJobResultsResponse {
   /**
-   * Per-page parse results.
+   * Document-level metadata parsed from the document
    */
-  export interface Page {
+  export interface DocumentMetadata {
     /**
-     * The index of the parsed page (zero-indexed)
+     * Hierarchy of the document, as both heading blocks and a markdown table of
+     * contents
      */
-    index: number;
-
-    /**
-     * The parsed, structured blocks of this page. Present if `blocks-per-page` was
-     * among the requested output types.
-     */
-    blocks?: Array<Page.Block>;
-
-    /**
-     * The parsed, structured Markdown of this page. Present if `markdown-per-page` was
-     * among the requested output types.
-     */
-    markdown?: string;
+    hierarchy?: DocumentMetadata.Hierarchy;
   }
 
-  export namespace Page {
+  export namespace DocumentMetadata {
     /**
-     * One logical block of content from a parsed page.
+     * Hierarchy of the document, as both heading blocks and a markdown table of
+     * contents
      */
-    export interface Block {
+    export interface Hierarchy {
       /**
-       * Unique ID of the block
+       * Heading blocks which define the hierarchy of the document
        */
-      id: string;
+      blocks?: Array<Hierarchy.Block>;
 
       /**
-       * The normalized bounding box of the block, as relative percentages of the page
-       * width and height
+       * Markdown representation of the table of contents for this document
        */
-      bounding_box: Block.BoundingBox;
-
-      /**
-       * The Markdown representation of the block
-       */
-      markdown: string;
+      table_of_contents?: string;
+    }
 
+    export namespace Hierarchy {
       /**
-       * The type of the block
+       * One logical block of content from a parsed page.
        */
-      type: 'heading' | 'text' | 'table' | 'figure';
+      export interface Block {
+        /**
+         * Unique ID of the block
+         */
+        id: string;
 
-      /**
-       * The confidence level of this block categorized as 'low', 'medium', or 'high'.
-       * Only available for blocks of type 'table' currently.
-       */
-      confidence_level?: 'low' | 'medium' | 'high';
+        /**
+         * The normalized bounding box of the block, as relative percentages of the page
+         * width and height
+         */
+        bounding_box: Block.BoundingBox;
 
-      /**
-       * The level of the block in the document hierarchy, starting at 0 for the
-       * root-level title block. Only present if `enable_document_hierarchy` was set to
-       * true in the request.
-       */
-      hierarchy_level?: number;
+        /**
+         * The Markdown representation of the block
+         */
+        markdown: string;
 
-      /**
-       * The page (0-indexed) that this block belongs to. Only set for heading blocks
-       * that are returned in the table of contents.
-       */
-      page_index?: number;
+        /**
+         * The type of the block
+         */
+        type: 'heading' | 'text' | 'table' | 'figure';
 
-      /**
-       * The IDs of the parent in the document hierarchy, sorted from root-level to
-       * bottom. For root-level heading blocks, this will be an empty list. Only present
-       * if `enable_document_hierarchy` was set to true in the request.
-       */
-      parent_ids?: Array<string>;
-    }
+        /**
+         * The confidence level of this block categorized as 'low', 'medium', or 'high'.
+         * Only available for blocks of type 'table' currently.
+         */
+        confidence_level?: 'low' | 'medium' | 'high';
 
-    export namespace Block {
-      /**
-       * The normalized bounding box of the block, as relative percentages of the page
-       * width and height
-       */
-      export interface BoundingBox {
         /**
-         * The x-coordinate of the top-left corner of the bounding box
+         * The level of the block in the document hierarchy, starting at 0 for the
+         * root-level title block. Only present if `enable_document_hierarchy` was set to
+         * true in the request.
          */
-        x0: number;
+        hierarchy_level?: number;
 
         /**
-         * The x-coordinate of the bottom-right corner of the bounding box
+         * The page (0-indexed) that this block belongs to. Only set for heading blocks
+         * that are returned in the table of contents.
          */
-        x1: number;
+        page_index?: number;
 
         /**
-         * The y-coordinate of the top-left corner of the bounding box
+         * The IDs of the parent in the document hierarchy, sorted from root-level to
+         * bottom. For root-level heading blocks, this will be an empty list. Only present
+         * if `enable_document_hierarchy` was set to true in the request.
          */
-        y0: number;
+        parent_ids?: Array<string>;
+      }
 
+      export namespace Block {
         /**
-         * The y-coordinate of the bottom-right corner of the bounding box
+         * The normalized bounding box of the block, as relative percentages of the page
+         * width and height
          */
-        y1: number;
+        export interface BoundingBox {
+          /**
+           * The x-coordinate of the top-left corner of the bounding box
+           */
+          x0: number;
+
+          /**
+           * The x-coordinate of the bottom-right corner of the bounding box
+           */
+          x1: number;
+
+          /**
+           * The y-coordinate of the top-left corner of the bounding box
+           */
+          y0: number;
+
+          /**
+           * The y-coordinate of the bottom-right corner of the bounding box
+           */
+          y1: number;
+        }
       }
     }
   }
 
   /**
-   * The table of contents representing the document's heading hierarchy. Only
-   * present if `enable_document_hierarchy` was set to true in the parse request.
+   * Per-page parse results.
    */
-  export interface TableOfContents {
+  export interface Page {
+    /**
+     * The index of the parsed page (zero-indexed)
+     */
+    index: number;
+
     /**
-     * Heading blocks that define the hierarchy of the document
+     * The parsed, structured blocks of this page. Present if `blocks-per-page` was
+     * among the requested output types.
      */
-    blocks?: Array<TableOfContents.Block>;
+    blocks?: Array<Page.Block>;
 
     /**
-     * Markdown representation of the table of contents that can be pre-pended to the
-     * markdown document.
+     * The parsed, structured Markdown of this page. Present if `markdown-per-page` was
+     * among the requested output types.
      */
     markdown?: string;
   }
 
-  export namespace TableOfContents {
+  export namespace Page {
     /**
      * One logical block of content from a parsed page.
      */
@@ -372,43 +386,43 @@ export interface ParseCreateParams {
   raw_file: Core.Uploadable;
 
   /**
-   * Controls parsing heading levels (e.g. H1, H2, H3) at higher quality. Adds a
-   * table of contents to the output with the structure of the entire parsed
-   * document. Not permitted in 'basic' parsing_mode, or if page_range is not
-   * continuous and/or does not start from page zero.
+   * Adds a table of contents to the output with the structure of the entire parsed
+   * document. This feature is in beta. Controls parsing heading levels (e.g. H1, H2,
+   * H3) at higher quality. Not permitted in `basic` parsing_mode, or if page_range
+   * is not continuous and/or does not start from page zero.
    */
   enable_document_hierarchy?: boolean;
 
   /**
    * Controls whether tables are split into multiple tables by row with the headers
    * propagated. Use for improving LLM comprehension of very large tables. Not
-   * permitted in 'basic' parsing_mode.
+   * permitted in `basic` parsing_mode.
    */
   enable_split_tables?: boolean;
 
   /**
-   * Controls how thorough figure captions are. 'concise' is short and minimizes
-   * chances of hallucinations. 'detailed' is more thorough and can include
-   * commentary. Not permitted in 'basic' parsing_mode.
+   * Controls how thorough figure captions are. `concise` is short and minimizes
+   * chances of hallucinations. `detailed` is more thorough and can include
+   * commentary; this mode is in beta. Not permitted in `basic` parsing_mode.
    */
   figure_caption_mode?: 'concise' | 'detailed';
 
   /**
    * Threshold number of table cells beyond which large tables are split if
-   * `enable_split_tables` is True. Not permitted in 'basic' parsing_mode.
+   * `enable_split_tables` is True. Not permitted in `basic` parsing_mode.
    */
   max_split_table_cells?: number;
 
   /**
    * Optional string representing page range to be parsed. Format: comma-separated
-   * indexes (0-based) e.g. '0,1,2,5,6' or ranges (inclusive of both ends) e.g.
-   * '0-2,5,6'
+   * indexes (0-based, e.g. `0,1,2,5,6`), or ranges inclusive of both ends (e.g.
+   * `0-2,5,6`)
    */
   page_range?: string;
 
   /**
-   * The settings to use for parsing. 'basic' is for simple, text-only documents.
-   * 'standard' is for complex documents with images, complex hierarchy, and/or no
+   * The settings to use for parsing. `basic` is for simple, text-only documents.
+   * `standard` is for complex documents with images, complex hierarchy, and/or no
    * natively encoded textual data (e.g. for scanned documents).
    */
   parse_mode?: 'basic' | 'standard';
@@ -417,11 +431,11 @@ export interface ParseCreateParams {
 export interface ParseJobResultsParams {
   /**
    * The desired output format(s) of the parsed file. Must be `markdown-document`,
-   * `markdown-per-page`, and/or `blocks-per-page`. `markdown-document` parses the
-   * whole document into a single concatenated markdown output. `markdown-per-page`
-   * provides markdown output per page. `blocks-per-page` provides a structured JSON
+   * `markdown-per-page`, and/or `blocks-per-page`. Specify multiple values to get
+   * multiple formats in the response. `markdown-document` parses the whole document
+   * into a single concatenated markdown output. `markdown-per-page` provides
+   * markdown output per page. `blocks-per-page` provides a structured JSON
    * representation of the content blocks on each page, sorted by reading order.
-   * Specify multiple values to get multiple formats in the response.
    */
   output_types?: Array<'markdown-document' | 'markdown-per-page' | 'blocks-per-page'>;
 }

src/resources/users.ts

@@ -81,8 +81,7 @@ export interface ListUsersResponse {
 
 export namespace ListUsersResponse {
   /**
-   * The schema used for listing existing (activated / deactivated) users. Need to
-   * keep in sync with `frontend/src/types/admin.ts`.
+   * The schema used for listing existing (activated / deactivated) users.
    */
   export interface User {
     id: string;
@@ -128,8 +127,7 @@ export namespace ListUsersResponse {
 }
 
 /**
- * The schema used for creating new users or updating existing users. Need to keep
- * in sync with `frontend/src/types/admin.ts`.
+ * The schema used for creating new users or updating existing users.
  */
 export interface NewUser {
   /**

src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.6.0'; // x-release-please-version
+export const VERSION = '0.7.0'; // x-release-please-version

tests/api-resources/agents/tune/tune.test.ts

@@ -33,7 +33,7 @@ describe('resource tune', () => {
       client.agents.tune.create(
         '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
         {
-          'hyperparams[learning_rate]': 1,
+          'hyperparams[learning_rate]': 0.05,
           'hyperparams[lora_alpha]': 8,
           'hyperparams[lora_dropout]': 0,
           'hyperparams[lora_rank]': 8,