hume 0.8.4 → 0.8.6

package/.mock/definition/empathic-voice/tools.yml

@@ -8,19 +8,40 @@ service:
       path: /v0/evi/tools
       method: GET
       auth: true
+      pagination:
+        offset: $request.page_number
+        results: $response.tools_page
       display-name: List tools
       request:
         name: ToolsListToolsRequest
         query-parameters:
           page_number:
             type: optional<integer>
-            docs: The page number of the results to return.
+            docs: >-
+              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.
           page_size:
             type: optional<integer>
-            docs: The maximum number of results to include per page.
+            docs: >-
+              Specifies the maximum number of results to include per page,
+              enabling pagination. The value must be between 1 and 100,
+              inclusive.
+
+
+              For example, if `page_size` is set to 10, each page will include
+              up to 10 items. Defaults to 10.
           restrict_to_most_recent:
             type: optional<boolean>
-            docs: Only include the most recent version of each tool in the list.
+            docs: >-
+              By default, `restrict_to_most_recent` is set to true, returning
+              only the latest version of each tool. To include all versions of
+              each tool in the list, set `restrict_to_most_recent` to false.
           name:
             type: optional<string>
             docs: Filter to only include tools with this name.
@@ -86,18 +107,30 @@ service:
               docs: Name applied to all versions of a particular Tool.
             version_description:
               type: optional<string>
-              docs: Description that is appended to a specific version of a Tool.
+              docs: An optional description of the Tool version.
             description:
               type: optional<string>
-              docs: Text describing what the tool does.
+              docs: >-
+                An optional description of what the Tool does, used by the
+                supplemental LLM to choose when and how to call the function.
             parameters:
               type: string
               docs: >-
                 Stringified JSON defining the parameters used by this version of
                 the Tool.
+
+
+                These parameters define the inputs needed for the Tool’s
+                execution, including the expected data type and description for
+                each input field. Structured as a stringified JSON schema, this
+                format ensures the Tool receives data in the expected format.
             fallback_content:
               type: optional<string>
-              docs: Text to use if the tool fails to generate content.
+              docs: >-
+                Optional text passed to the supplemental LLM in place of the
+                tool call result. The LLM then uses this text to generate a
+                response back to the user, ensuring continuity in the
+                conversation if the Tool errors.
       response:
         docs: Created
         type: optional<root.ReturnUserDefinedTool>
@@ -144,20 +177,38 @@ service:
       path-parameters:
         id:
           type: string
-          docs: Identifier for a tool. Formatted as a UUID.
+          docs: Identifier for a Tool. Formatted as a UUID.
       display-name: List tool versions
       request:
         name: ToolsListToolVersionsRequest
         query-parameters:
           page_number:
             type: optional<integer>
-            docs: The page number of the results to return.
+            docs: >-
+              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.
           page_size:
             type: optional<integer>
-            docs: The maximum number of results to include per page.
+            docs: >-
+              Specifies the maximum number of results to include per page,
+              enabling pagination. The value must be between 1 and 100,
+              inclusive.
+
+
+              For example, if `page_size` is set to 10, each page will include
+              up to 10 items. Defaults to 10.
           restrict_to_most_recent:
             type: optional<boolean>
-            docs: Only include the most recent version of each tool in the list.
+            docs: >-
+              By default, `restrict_to_most_recent` is set to true, returning
+              only the latest version of each tool. To include all versions of
+              each tool in the list, set `restrict_to_most_recent` to false.
       response:
         docs: Success
         type: root.ReturnPagedUserDefinedTools
@@ -196,7 +247,7 @@ service:
       path-parameters:
         id:
           type: string
-          docs: Identifier for a tool. Formatted as a UUID.
+          docs: Identifier for a Tool. Formatted as a UUID.
       display-name: Create tool version
       request:
         name: PostedUserDefinedToolVersion
@@ -204,18 +255,30 @@ service:
           properties:
             version_description:
               type: optional<string>
-              docs: Description that is appended to a specific version of a Tool.
+              docs: An optional description of the Tool version.
             description:
               type: optional<string>
-              docs: Text describing what the tool does.
+              docs: >-
+                An optional description of what the Tool does, used by the
+                supplemental LLM to choose when and how to call the function.
             parameters:
               type: string
               docs: >-
                 Stringified JSON defining the parameters used by this version of
                 the Tool.
+
+
+                These parameters define the inputs needed for the Tool’s
+                execution, including the expected data type and description for
+                each input field. Structured as a stringified JSON schema, this
+                format ensures the Tool receives data in the expected format.
             fallback_content:
               type: optional<string>
-              docs: Text to use if the tool fails to generate content.
+              docs: >-
+                Optional text passed to the supplemental LLM in place of the
+                tool call result. The LLM then uses this text to generate a
+                response back to the user, ensuring continuity in the
+                conversation if the Tool errors.
       response:
         docs: Created
         type: optional<root.ReturnUserDefinedTool>
@@ -263,7 +326,7 @@ service:
       path-parameters:
         id:
           type: string
-          docs: Identifier for a tool. Formatted as a UUID.
+          docs: Identifier for a Tool. Formatted as a UUID.
       display-name: Delete tool
       examples:
         - path-parameters:
@@ -275,7 +338,7 @@ service:
       path-parameters:
         id:
           type: string
-          docs: Identifier for a tool. Formatted as a UUID.
+          docs: Identifier for a Tool. Formatted as a UUID.
       display-name: Update tool name
       request:
         name: PostedUserDefinedToolName
@@ -299,10 +362,21 @@ service:
       path-parameters:
         id:
           type: string
-          docs: Identifier for a tool. Formatted as a UUID.
+          docs: Identifier for a Tool. Formatted as a UUID.
         version:
           type: integer
-          docs: Version number for a tool. Version numbers should be integers.
+          docs: >-
+            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.
       display-name: Get tool version
       response:
         docs: Success
@@ -339,10 +413,21 @@ service:
       path-parameters:
         id:
           type: string
-          docs: Identifier for a tool. Formatted as a UUID.
+          docs: Identifier for a Tool. Formatted as a UUID.
         version:
           type: integer
-          docs: Version number for a tool. Version numbers should be integers.
+          docs: >-
+            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.
       display-name: Delete tool version
       examples:
         - path-parameters:
@@ -355,10 +440,21 @@ service:
       path-parameters:
         id:
           type: string
-          docs: Identifier for a tool. Formatted as a UUID.
+          docs: Identifier for a Tool. Formatted as a UUID.
         version:
           type: integer
-          docs: Version number for a tool. Version numbers should be integers.
+          docs: >-
+            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.
       display-name: Update tool description
       request:
         name: PostedUserDefinedToolVersionDescription
@@ -366,7 +462,7 @@ service:
           properties:
             version_description:
               type: optional<string>
-              docs: Description that is appended to a specific version of a Tool.
+              docs: An optional description of the Tool version.
       response:
         docs: Success
         type: optional<root.ReturnUserDefinedTool>