Humanloop Documentation and API Reference

Deserialize a model config from a .prompt file format.

Request

This endpoint expects an object.

configstringRequired

Response

This endpoint returns an object

idstring

String ID of config. Starts with config_.

modelstring

The model instance used. E.g. text-davinci-002.

othermap from strings to anyOptional

Other parameter values to be passed to the provider call.

namestringOptional

A friendly display name for the model config. If not provided, a name will be generated.

descriptionstringOptional

A description of the model config.

providerenumOptional

The company providing the underlying model service.

max_tokensintegerOptionalDefaults to -1

The maximum number of tokens to generate. Provide max_tokens=-1 to dynamically calculate the maximum number of tokens to generate given the length of the prompt

temperaturedoubleOptionalDefaults to 1

What sampling temperature to use when making a generation. Higher values means the model will be more creative.

top_pdoubleOptionalDefaults to 1

An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass.

stopstring or list of stringsOptional

The string (or list of strings) after which the model will stop generating. The returned text will not contain the stop sequence.

presence_penaltydoubleOptionalDefaults to 0

Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the generation so far.

frequency_penaltydoubleOptionalDefaults to 0

Number between -2.0 and 2.0. Positive values penalize new tokens based on how frequently they appear in the generation so far.

seedintegerOptional

If specified, model will make a best effort to sample deterministically, but it is not guaranteed.

response_formatobjectOptional

The format of the response. Only type json_object is currently supported for chat.

prompt_templatestringOptional

Prompt template that will take your specified inputs to form your final request to the model. NB: Input variables within the prompt template should be specified with syntax: {{INPUT_NAME}}.

chat_templatelist of objectsOptional

Messages prepended to the list of messages sent to the provider. These messages that will take your specified inputs to form your final request to the provider model. NB: Input variables within the template should be specified with syntax: {{INPUT_NAME}}.

toolslist of objectsOptional

Tools shown to the model.

endpointenumOptional

Allowed values: completechatedit

The provider model endpoint used.

tool_configslist of objectsOptionalDeprecated

NB: Deprecated with tools field. Definition of tools shown to the model.

Errors

1 curl -X POST https://api.humanloop.com/v4/model-configs/deserialize \ 2 -H "X-API-KEY: <apiKey>" \ 3 -H "Content-Type: application/json" \ 4 -d '{ 5 "config": "config" 6 }'

1 { 2 "id": "id", 3 "other": { 4 "key": "value" 5 }, 6 "name": "name", 7 "description": "description", 8 "provider": "openai", 9 "model": "model", 10 "max_tokens": 1, 11 "temperature": 1.1, 12 "top_p": 1.1, 13 "stop": "stop", 14 "presence_penalty": 1.1, 15 "frequency_penalty": 1.1, 16 "seed": 1, 17 "response_format": { 18 "type": "json_object", 19 "json_schema": { 20 "key": "value" 21 } 22 }, 23 "prompt_template": "prompt_template", 24 "chat_template": [ 25 { 26 "content": "content", 27 "name": "name", 28 "tool_call_id": "tool_call_id", 29 "role": "user", 30 "tool_calls": [ 31 { 32 "id": "id", 33 "type": "function", 34 "function": { 35 "name": "name" 36 } 37 } 38 ], 39 "tool_call": { 40 "name": "name" 41 } 42 } 43 ], 44 "tool_configs": [ 45 { 46 "id": "id", 47 "other": { 48 "key": "value" 49 }, 50 "created_by": { 51 "id": "id", 52 "email_address": "email_address", 53 "verified": true 54 }, 55 "status": "status", 56 "name": "name", 57 "description": "description", 58 "source": "organization", 59 "source_code": "source_code", 60 "setup_schema": { 61 "key": "value" 62 }, 63 "parameters": { 64 "key": "value" 65 }, 66 "signature": "signature", 67 "is_preset": true, 68 "preset_name": "preset_name" 69 } 70 ], 71 "tools": [ 72 { 73 "id": "id", 74 "name": "name", 75 "description": "description", 76 "parameters": { 77 "key": "value" 78 }, 79 "source": "source" 80 } 81 ], 82 "endpoint": "complete" 83 }

1	curl -X POST https://api.humanloop.com/v4/model-configs/deserialize \
2	-H "X-API-KEY: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"config": "config"
6	}'

1	{
2	"id": "id",
3	"other": {
4	"key": "value"
5	},
6	"name": "name",
7	"description": "description",
8	"provider": "openai",
9	"model": "model",
10	"max_tokens": 1,
11	"temperature": 1.1,
12	"top_p": 1.1,
13	"stop": "stop",
14	"presence_penalty": 1.1,
15	"frequency_penalty": 1.1,
16	"seed": 1,
17	"response_format": {
18	"type": "json_object",
19	"json_schema": {
20	"key": "value"
21	}
22	},
23	"prompt_template": "prompt_template",
24	"chat_template": [
25	{
26	"content": "content",
27	"name": "name",
28	"tool_call_id": "tool_call_id",
29	"role": "user",
30	"tool_calls": [
31	{
32	"id": "id",
33	"type": "function",
34	"function": {
35	"name": "name"
36	}
37	}
38	],
39	"tool_call": {
40	"name": "name"
41	}
42	}
43	],
44	"tool_configs": [
45	{
46	"id": "id",
47	"other": {
48	"key": "value"
49	},
50	"created_by": {
51	"id": "id",
52	"email_address": "email_address",
53	"verified": true
54	},
55	"status": "status",
56	"name": "name",
57	"description": "description",
58	"source": "organization",
59	"source_code": "source_code",
60	"setup_schema": {
61	"key": "value"
62	},
63	"parameters": {
64	"key": "value"
65	},
66	"signature": "signature",
67	"is_preset": true,
68	"preset_name": "preset_name"
69	}
70	],
71	"tools": [
72	{
73	"id": "id",
74	"name": "name",
75	"description": "description",
76	"parameters": {
77	"key": "value"
78	},
79	"source": "source"
80	}
81	],
82	"endpoint": "complete"
83	}