创建工具 - Hume AI

curl --location --request POST 'http://dev-cn.your-api-server.com/v0/evi/tools' \ --header 'X-Hume-Api-Key: <apiKey>' \ --header 'Content-Type: application/json' \ --data-raw '{ "name": "get_current_weather", "parameters": "{ \"type\": \"object\", \"properties\": { \"location\": { \"type\": \"string\", \"description\": \"The city and state, e.g. San Francisco, CA\" }, \"format\": { \"type\": \"string\", \"enum\": [\"celsius\", \"fahrenheit\"], \"description\": \"The temperature unit to use. Infer this from the users location.\" } }, \"required\": [\"location\", \"format\"] }", "version_description": "Fetches current weather and uses celsius or fahrenheit based on location of user.", "description": "This tool is for getting the current weather.", "fallback_content": "Unable to fetch current weather." }'

{ "tool_type": "FUNCTION", "id": "aa9b71c4-723c-47ff-9f83-1a1829e74376", "version": 0, "version_type": "FIXED", "name": "get_current_weather", "created_on": 1715275452390, "modified_on": 1715275452390, "parameters": "{ \"type\": \"object\", \"properties\": { \"location\": { \"type\": \"string\", \"description\": \"The city and state, e.g. San Francisco, CA\" }, \"format\": { \"type\": \"string\", \"enum\": [\"celsius\", \"fahrenheit\"], \"description\": \"The temperature unit to use. Infer this from the users location.\" } }, \"required\": [\"location\", \"format\"] }", "version_description": "Fetches current weather and uses celsius or fahrenheit based on location of user.", "fallback_content": "Unable to fetch current weather.", "description": "This tool is for getting the current weather." }

请求参数

Header 参数

X-Hume-Api-Key

string

必需

示例值:

Content-Type

string

必需

示例值:

application/json

Body 参数application/json

name

string

必需

适用于特定工具的所有版本的名称。

parameters

string

必需

字符串化的 JSON 定义此版本的工具所使用的参数。

version_description

string

可选

附加到工具特定版本的描述。

description

string

可选

描述该工具功能的文本。

fallback_content

string

可选

如果工具无法生成内容则使用的文本。

示例

返回响应

🟢200成功

application/json

Body

tool_type

string

必需

工具类型。值来自 ToolType 枚举。

string

必需

工具标识符。格式为 UUID。

version

integer

必需

工具的版本号。版本号应为整数。configId 和版本号的组合是唯一的。

version_type

string

必需

指示此工具是使用固定版本号还是自动更新到最新版本。值来自 VersionType 枚举。

name

string

必需

适用于特定工具的所有版本的名称。

created_on

integer

必需

创建此工具第一个版本的时间戳。

modified_on

integer

必需

此版本工具的创建时间戳。

parameters

string

必需

字符串化的 JSON 定义此版本的工具所使用的参数。

version_description

string

必需

附加到工具特定版本的描述。

fallback_content

string

必需

如果工具无法生成内容则使用的文本。

description

string

必需

描述该工具功能的文本。