hume 0.8.3 → 0.8.5

package/api/resources/empathicVoice/resources/prompts/client/requests/PromptsListPromptVersionsRequest.d.ts

@@ -7,15 +7,19 @@
  */
 export interface PromptsListPromptVersionsRequest {
     /**
-     * The page number of the results to return.
+     * Specifies the page number to retrieve, enabling pagination.
+     *
+     * This parameter uses zero-based indexing. For example, setting `page_number` to 0 retrieves the first page of results (items 0-9 if `page_size` is 10), setting `page_number` to 1 retrieves the second page (items 10-19), and so on. Defaults to 0, which retrieves the first page.
      */
     pageNumber?: number;
     /**
-     * The maximum number of results to include per page.
+     * Specifies the maximum number of results to include per page, enabling pagination.
+     *
+     * The value must be greater than or equal to 1. For example, if `page_size` is set to 10, each page will include up to 10 items. Defaults to 10.
      */
     pageSize?: number;
     /**
-     * Only include the most recent version of each prompt in the list.
+     * By default, `restrict_to_most_recent` is set to true, returning only the latest version of each prompt. To include all versions of each prompt in the list, set `restrict_to_most_recent` to false.
      */
     restrictToMostRecent?: boolean;
 }

package/api/resources/empathicVoice/resources/prompts/client/requests/PromptsListPromptsRequest.d.ts

@@ -7,15 +7,19 @@
  */
 export interface PromptsListPromptsRequest {
     /**
-     * The page number of the results to return.
+     * Specifies the page number to retrieve, enabling pagination.
+     *
+     * This parameter uses zero-based indexing. For example, setting `page_number` to 0 retrieves the first page of results (items 0-9 if `page_size` is 10), setting `page_number` to 1 retrieves the second page (items 10-19), and so on. Defaults to 0, which retrieves the first page.
      */
     pageNumber?: number;
     /**
-     * The maximum number of results to include per page.
+     * Specifies the maximum number of results to include per page, enabling pagination.
+     *
+     * The value must be greater than or equal to 1. For example, if `page_size` is set to 10, each page will include up to 10 items. Defaults to 10.
      */
     pageSize?: number;
     /**
-     * Only include the most recent version of each prompt in the list.
+     * By default, `restrict_to_most_recent` is set to true, returning only the latest version of each prompt. To include all versions of each prompt in the list, set `restrict_to_most_recent` to false.
      */
     restrictToMostRecent?: boolean;
     /**

package/api/resources/empathicVoice/resources/prompts/client/requests/index.d.ts

@@ -1,6 +1,6 @@
-export { type PromptsListPromptsRequest } from "./PromptsListPromptsRequest";
-export { type PostedPrompt } from "./PostedPrompt";
-export { type PromptsListPromptVersionsRequest } from "./PromptsListPromptVersionsRequest";
-export { type PostedPromptVersion } from "./PostedPromptVersion";
-export { type PostedPromptName } from "./PostedPromptName";
-export { type PostedPromptVersionDescription } from "./PostedPromptVersionDescription";
+export { type PromptsListPromptsRequest } from './PromptsListPromptsRequest';
+export { type PostedPrompt } from './PostedPrompt';
+export { type PromptsListPromptVersionsRequest } from './PromptsListPromptVersionsRequest';
+export { type PostedPromptVersion } from './PostedPromptVersion';
+export { type PostedPromptName } from './PostedPromptName';
+export { type PostedPromptVersionDescription } from './PostedPromptVersionDescription';

package/api/resources/empathicVoice/resources/prompts/index.d.ts

@@ -1 +1 @@
-export * from "./client";
+export * from './client';

package/api/resources/empathicVoice/resources/tools/client/Client.d.ts

@@ -1,9 +1,9 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as environments from "../../../../../../environments";
-import * as core from "../../../../../../core";
-import * as Hume from "../../../../../index";
+import * as environments from '../../../../../../environments';
+import * as core from '../../../../../../core';
+import * as Hume from '../../../../../index';
 export declare namespace Tools {
     interface Options {
         environment?: core.Supplier<environments.HumeEnvironment | string>;
@@ -48,7 +48,7 @@ export declare class Tools {
      */
     createTool(request: Hume.empathicVoice.PostedUserDefinedTool, requestOptions?: Tools.RequestOptions): Promise<Hume.empathicVoice.ReturnUserDefinedTool | undefined>;
     /**
-     * @param {string} id - Identifier for a tool. Formatted as a UUID.
+     * @param {string} id - Identifier for a Tool. Formatted as a UUID.
      * @param {Hume.empathicVoice.ToolsListToolVersionsRequest} request
      * @param {Tools.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -57,7 +57,7 @@ export declare class Tools {
      */
     listToolVersions(id: string, request?: Hume.empathicVoice.ToolsListToolVersionsRequest, requestOptions?: Tools.RequestOptions): Promise<Hume.empathicVoice.ReturnPagedUserDefinedTools>;
     /**
-     * @param {string} id - Identifier for a tool. Formatted as a UUID.
+     * @param {string} id - Identifier for a Tool. Formatted as a UUID.
      * @param {Hume.empathicVoice.PostedUserDefinedToolVersion} request
      * @param {Tools.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -71,7 +71,7 @@ export declare class Tools {
      */
     createToolVersion(id: string, request: Hume.empathicVoice.PostedUserDefinedToolVersion, requestOptions?: Tools.RequestOptions): Promise<Hume.empathicVoice.ReturnUserDefinedTool | undefined>;
     /**
-     * @param {string} id - Identifier for a tool. Formatted as a UUID.
+     * @param {string} id - Identifier for a Tool. Formatted as a UUID.
      * @param {Tools.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
@@ -79,7 +79,7 @@ export declare class Tools {
      */
     deleteTool(id: string, requestOptions?: Tools.RequestOptions): Promise<void>;
     /**
-     * @param {string} id - Identifier for a tool. Formatted as a UUID.
+     * @param {string} id - Identifier for a Tool. Formatted as a UUID.
      * @param {Hume.empathicVoice.PostedUserDefinedToolName} request
      * @param {Tools.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -90,8 +90,12 @@ export declare class Tools {
      */
     updateToolName(id: string, request: Hume.empathicVoice.PostedUserDefinedToolName, requestOptions?: Tools.RequestOptions): Promise<string>;
     /**
-     * @param {string} id - Identifier for a tool. Formatted as a UUID.
-     * @param {number} version - Version number for a tool. Version numbers should be integers.
+     * @param {string} id - Identifier for a Tool. Formatted as a UUID.
+     * @param {number} version - Version number for a Tool.
+     *
+     *                           Tools, as well as Configs and Prompts, are versioned. This versioning system supports iterative development, allowing you to progressively refine tools and revert to previous versions if needed.
+     *
+     *                           Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
      * @param {Tools.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
@@ -99,8 +103,12 @@ export declare class Tools {
      */
     getToolVersion(id: string, version: number, requestOptions?: Tools.RequestOptions): Promise<Hume.empathicVoice.ReturnUserDefinedTool | undefined>;
     /**
-     * @param {string} id - Identifier for a tool. Formatted as a UUID.
-     * @param {number} version - Version number for a tool. Version numbers should be integers.
+     * @param {string} id - Identifier for a Tool. Formatted as a UUID.
+     * @param {number} version - Version number for a Tool.
+     *
+     *                           Tools, as well as Configs and Prompts, are versioned. This versioning system supports iterative development, allowing you to progressively refine tools and revert to previous versions if needed.
+     *
+     *                           Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
      * @param {Tools.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
@@ -108,8 +116,12 @@ export declare class Tools {
      */
     deleteToolVersion(id: string, version: number, requestOptions?: Tools.RequestOptions): Promise<void>;
     /**
-     * @param {string} id - Identifier for a tool. Formatted as a UUID.
-     * @param {number} version - Version number for a tool. Version numbers should be integers.
+     * @param {string} id - Identifier for a Tool. Formatted as a UUID.
+     * @param {number} version - Version number for a Tool.
+     *
+     *                           Tools, as well as Configs and Prompts, are versioned. This versioning system supports iterative development, allowing you to progressively refine tools and revert to previous versions if needed.
+     *
+     *                           Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
      * @param {Hume.empathicVoice.PostedUserDefinedToolVersionDescription} request
      * @param {Tools.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -120,6 +132,6 @@ export declare class Tools {
      */
     updateToolDescription(id: string, version: number, request?: Hume.empathicVoice.PostedUserDefinedToolVersionDescription, requestOptions?: Tools.RequestOptions): Promise<Hume.empathicVoice.ReturnUserDefinedTool | undefined>;
     protected _getCustomAuthorizationHeaders(): Promise<{
-        "X-Hume-Api-Key": string | undefined;
+        'X-Hume-Api-Key': string | undefined;
     }>;
 }