Update Tool Version

1 curl -X PATCH https://api.humanloop.com/v5/tools/id/versions/version_id \ 2 -H "X-API-KEY: <apiKey>" \ 3 -H "Content-Type: application/json" \ 4 -d '{}'

1 { 2 "path": "path", 3 "id": "id", 4 "name": "name", 5 "version_id": "version_id", 6 "created_at": "2024-01-15T09:30:00Z", 7 "updated_at": "2024-01-15T09:30:00Z", 8 "last_used_at": "2024-01-15T09:30:00Z", 9 "version_logs_count": 1, 10 "total_logs_count": 1, 11 "inputs": [ 12 { 13 "name": "name" 14 } 15 ], 16 "directory_id": "directory_id", 17 "function": { 18 "name": "name", 19 "description": "description", 20 "strict": true, 21 "parameters": { 22 "key": "value" 23 } 24 }, 25 "source_code": "source_code", 26 "setup_values": { 27 "key": "value" 28 }, 29 "attributes": { 30 "key": "value" 31 }, 32 "tool_type": "pinecone_search", 33 "version_name": "version_name", 34 "version_description": "version_description", 35 "description": "description", 36 "readme": "readme", 37 "tags": [ 38 "tags" 39 ], 40 "type": "tool", 41 "environments": [ 42 { 43 "id": "id", 44 "created_at": "2024-01-15T09:30:00Z", 45 "name": "name", 46 "tag": "default" 47 } 48 ], 49 "created_by": { 50 "id": "id", 51 "email_address": "email_address", 52 "full_name": "full_name" 53 }, 54 "evaluators": [ 55 { 56 "version_reference": { 57 "file": { 58 "path": "path", 59 "id": "id", 60 "model": "model", 61 "name": "name", 62 "version_id": "version_id", 63 "created_at": "2024-01-15T09:30:00Z", 64 "updated_at": "2024-01-15T09:30:00Z", 65 "last_used_at": "2024-01-15T09:30:00Z", 66 "version_logs_count": 1, 67 "total_logs_count": 1, 68 "inputs": [ 69 { 70 "name": "name" 71 } 72 ] 73 }, 74 "environment": { 75 "id": "id", 76 "created_at": "2024-01-15T09:30:00Z", 77 "name": "name", 78 "tag": "default" 79 }, 80 "type": "environment" 81 }, 82 "state": "active", 83 "created_at": "2024-01-15T09:30:00Z", 84 "updated_at": "2024-01-15T09:30:00Z", 85 "version": { 86 "path": "path", 87 "id": "id", 88 "spec": { 89 "arguments_type": "target_free", 90 "return_type": "boolean", 91 "evaluator_type": "llm" 92 }, 93 "name": "name", 94 "version_id": "version_id", 95 "created_at": "2024-01-15T09:30:00Z", 96 "updated_at": "2024-01-15T09:30:00Z", 97 "last_used_at": "2024-01-15T09:30:00Z", 98 "version_logs_count": 1, 99 "total_logs_count": 1, 100 "inputs": [ 101 { 102 "name": "name" 103 } 104 ] 105 } 106 } 107 ], 108 "signature": "signature", 109 "evaluator_aggregates": [ 110 { 111 "value": 1.1, 112 "evaluator_id": "evaluator_id", 113 "evaluator_version_id": "evaluator_version_id", 114 "created_at": "2024-01-15T09:30:00Z", 115 "updated_at": "2024-01-15T09:30:00Z" 116 } 117 ] 118 }

Update the name or description of the Tool version.

Path parameters

idstringRequired

Unique identifier for Tool.

version_idstringRequired

Unique identifier for the specific version of the Tool.

Request

This endpoint expects an object.

namestringOptional

Name of the version.

descriptionstringOptional

Description of the version.

Response

Successful Response

pathstring

Path of the Tool, including the name, which is used as a unique identifier.

idstring

Unique identifier for the Tool.

namestring

Name of the Tool, which is used as a unique identifier.

version_idstring

Unique identifier for the specific Tool Version. If no query params provided, the default deployed Tool Version is returned.

created_atdatetime

updated_atdatetime

last_used_atdatetime

version_logs_countinteger

The number of logs that have been generated for this Tool Version

total_logs_countinteger

The number of logs that have been generated across all Tool Versions

inputslist of objects

Inputs associated to the Prompt. Inputs correspond to any of the variables used within the Tool template.

directory_idstring or null

ID of the directory that the file is in on Humanloop.

functionobject or null

Callable function specification of the Tool shown to the model for tool calling.

source_codestring or null

Code source of the Tool.

setup_valuesmap from strings to any or null

Values needed to setup the Tool, defined in JSON Schema format: https://json-schema.org/

attributesmap from strings to any or null

Additional fields to describe the Tool. Helpful to separate Tool versions from each other with details on how they were created or used.

tool_typeenum or null

Type of Tool.

version_namestring or null

Unique identifier for this Tool version. Each Tool can only have one version with a given name.

version_descriptionstring or null

Description of the Version.

descriptionstring or null

Description of the Tool.

readmestring or null

Long description of the file.

tagslist of strings or null

List of tags associated with the file.

type"tool" or nullDefaults to tool

environmentslist of objects or null

The list of environments the Tool Version is deployed to.

created_byany or null

The user who created the Tool.

evaluatorslist of objects or null

Evaluators that have been attached to this Tool that are used for monitoring logs.

signaturestring or null

Signature of the Tool.

evaluator_aggregateslist of objects or null

Aggregation of Evaluator results for the Tool Version.

Path parameters

Headers

Request

Response

Errors