hume 0.8.10 → 0.9.0

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

@@ -8,6 +8,14 @@ service:
             path: /v0/evi/tools
             method: GET
             auth: true
+            docs: >-
+                Fetches a paginated list of **Tools**.
+
+
+                Refer to our [tool
+                use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide
+                for comprehensive instructions on defining and integrating tools into
+                EVI.
             pagination:
                 offset: $request.page_number
                 results: $response.tools_page
@@ -48,6 +56,8 @@ service:
             response:
                 docs: Success
                 type: root.ReturnPagedUserDefinedTools
+            errors:
+                - root.BadRequestError
             examples:
                 - query-parameters:
                       page_number: 0
@@ -97,6 +107,15 @@ service:
             path: /v0/evi/tools
             method: POST
             auth: true
+            docs: >-
+                Creates a **Tool** that can be added to an [EVI
+                configuration](/reference/empathic-voice-interface-evi/configs/create-config).
+
+
+                Refer to our [tool
+                use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide
+                for comprehensive instructions on defining and integrating tools into
+                EVI.
             display-name: Create tool
             request:
                 name: PostedUserDefinedTool
@@ -131,9 +150,12 @@ service:
                                 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.
+                content-type: application/json
             response:
                 docs: Created
                 type: optional<root.ReturnUserDefinedTool>
+            errors:
+                - root.BadRequestError
             examples:
                 - request:
                       name: get_current_weather
@@ -174,6 +196,14 @@ service:
             path: /v0/evi/tools/{id}
             method: GET
             auth: true
+            docs: >-
+                Fetches a list of a **Tool's** versions.
+
+
+                Refer to our [tool
+                use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide
+                for comprehensive instructions on defining and integrating tools into
+                EVI.
             path-parameters:
                 id:
                     type: string
@@ -212,6 +242,8 @@ service:
             response:
                 docs: Success
                 type: root.ReturnPagedUserDefinedTools
+            errors:
+                - root.BadRequestError
             examples:
                 - path-parameters:
                       id: 00183a3f-79ba-413d-9f3b-609864268bea
@@ -244,6 +276,14 @@ service:
             path: /v0/evi/tools/{id}
             method: POST
             auth: true
+            docs: >-
+                Updates a **Tool** by creating a new version of the **Tool**.
+
+
+                Refer to our [tool
+                use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide
+                for comprehensive instructions on defining and integrating tools into
+                EVI.
             path-parameters:
                 id:
                     type: string
@@ -279,9 +319,12 @@ service:
                                 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.
+                content-type: application/json
             response:
                 docs: Created
                 type: optional<root.ReturnUserDefinedTool>
+            errors:
+                - root.BadRequestError
             examples:
                 - path-parameters:
                       id: 00183a3f-79ba-413d-9f3b-609864268bea
@@ -323,11 +366,21 @@ service:
             path: /v0/evi/tools/{id}
             method: DELETE
             auth: true
+            docs: >-
+                Deletes a **Tool** and its versions.
+
+
+                Refer to our [tool
+                use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide
+                for comprehensive instructions on defining and integrating tools into
+                EVI.
             path-parameters:
                 id:
                     type: string
                     docs: Identifier for a Tool. Formatted as a UUID.
             display-name: Delete tool
+            errors:
+                - root.BadRequestError
             examples:
                 - path-parameters:
                       id: 00183a3f-79ba-413d-9f3b-609864268bea
@@ -335,6 +388,14 @@ service:
             path: /v0/evi/tools/{id}
             method: PATCH
             auth: true
+            docs: >-
+                Updates the name of a **Tool**.
+
+
+                Refer to our [tool
+                use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide
+                for comprehensive instructions on defining and integrating tools into
+                EVI.
             path-parameters:
                 id:
                     type: string
@@ -347,9 +408,12 @@ service:
                         name:
                             type: string
                             docs: Name applied to all versions of a particular Tool.
+                content-type: application/json
             response:
                 docs: Success
                 type: text
+            errors:
+                - root.BadRequestError
             examples:
                 - path-parameters:
                       id: 00183a3f-79ba-413d-9f3b-609864268bea
@@ -359,6 +423,14 @@ service:
             path: /v0/evi/tools/{id}/version/{version}
             method: GET
             auth: true
+            docs: >-
+                Fetches a specified version of a **Tool**.
+
+
+                Refer to our [tool
+                use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide
+                for comprehensive instructions on defining and integrating tools into
+                EVI.
             path-parameters:
                 id:
                     type: string
@@ -369,7 +441,7 @@ service:
                         Version number for a Tool.
 
 
-                        Tools, as well as Configs and Prompts, are versioned. This
+                        Tools, Configs, Custom Voices, and Prompts are versioned. This
                         versioning system supports iterative development, allowing you to
                         progressively refine tools and revert to previous versions if
                         needed.
@@ -381,6 +453,8 @@ service:
             response:
                 docs: Success
                 type: optional<root.ReturnUserDefinedTool>
+            errors:
+                - root.BadRequestError
             examples:
                 - path-parameters:
                       id: 00183a3f-79ba-413d-9f3b-609864268bea
@@ -410,6 +484,14 @@ service:
             path: /v0/evi/tools/{id}/version/{version}
             method: DELETE
             auth: true
+            docs: >-
+                Deletes a specified version of a **Tool**.
+
+
+                Refer to our [tool
+                use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide
+                for comprehensive instructions on defining and integrating tools into
+                EVI.
             path-parameters:
                 id:
                     type: string
@@ -420,7 +502,7 @@ service:
                         Version number for a Tool.
 
 
-                        Tools, as well as Configs and Prompts, are versioned. This
+                        Tools, Configs, Custom Voices, and Prompts are versioned. This
                         versioning system supports iterative development, allowing you to
                         progressively refine tools and revert to previous versions if
                         needed.
@@ -429,6 +511,8 @@ service:
                         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
+            errors:
+                - root.BadRequestError
             examples:
                 - path-parameters:
                       id: 00183a3f-79ba-413d-9f3b-609864268bea
@@ -437,6 +521,14 @@ service:
             path: /v0/evi/tools/{id}/version/{version}
             method: PATCH
             auth: true
+            docs: >-
+                Updates the description of a specified **Tool** version.
+
+
+                Refer to our [tool
+                use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide
+                for comprehensive instructions on defining and integrating tools into
+                EVI.
             path-parameters:
                 id:
                     type: string
@@ -447,7 +539,7 @@ service:
                         Version number for a Tool.
 
 
-                        Tools, as well as Configs and Prompts, are versioned. This
+                        Tools, Configs, Custom Voices, and Prompts are versioned. This
                         versioning system supports iterative development, allowing you to
                         progressively refine tools and revert to previous versions if
                         needed.
@@ -463,9 +555,12 @@ service:
                         version_description:
                             type: optional<string>
                             docs: An optional description of the Tool version.
+                content-type: application/json
             response:
                 docs: Success
                 type: optional<root.ReturnUserDefinedTool>
+            errors:
+                - root.BadRequestError
             examples:
                 - path-parameters:
                       id: 00183a3f-79ba-413d-9f3b-609864268bea
@@ -498,4 +593,4 @@ service:
                               temperature unit to use. Infer this from the users location." }
                               }, "required": ["location", "format"] }
     source:
-        openapi: ../empathic-voice-interface/stenographer-openapi.json
+        openapi: stenographer-openapi.json