curl --request POST \
--url https://api.egp.scale.com/v4/models \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"account_id": "<string>",
"display_name": "<string>",
"base_model_id": "<string>",
"base_model_metadata": {
"model_developer": "<string>",
"model_license_url": "<string>",
"delivery_date": "<string>",
"modelDetails": {
"number_of_parameters": 123,
"token_context_window": 123,
"languages": 123,
"alignments": 123
}
},
"model_creation_parameters": {},
"model_card": "<string>",
"training_data_card": "<string>",
"description": "<string>",
"model_template_id": "<string>",
"model_group_id": "<string>"
}
'import requests
url = "https://api.egp.scale.com/v4/models"
payload = {
"name": "<string>",
"account_id": "<string>",
"display_name": "<string>",
"base_model_id": "<string>",
"base_model_metadata": {
"model_developer": "<string>",
"model_license_url": "<string>",
"delivery_date": "<string>",
"modelDetails": {
"number_of_parameters": 123,
"token_context_window": 123,
"languages": 123,
"alignments": 123
}
},
"model_creation_parameters": {},
"model_card": "<string>",
"training_data_card": "<string>",
"description": "<string>",
"model_template_id": "<string>",
"model_group_id": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
account_id: '<string>',
display_name: '<string>',
base_model_id: '<string>',
base_model_metadata: {
model_developer: '<string>',
model_license_url: '<string>',
delivery_date: '<string>',
modelDetails: {
number_of_parameters: 123,
token_context_window: 123,
languages: 123,
alignments: 123
}
},
model_creation_parameters: {},
model_card: '<string>',
training_data_card: '<string>',
description: '<string>',
model_template_id: '<string>',
model_group_id: '<string>'
})
};
fetch('https://api.egp.scale.com/v4/models', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.egp.scale.com/v4/models",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'account_id' => '<string>',
'display_name' => '<string>',
'base_model_id' => '<string>',
'base_model_metadata' => [
'model_developer' => '<string>',
'model_license_url' => '<string>',
'delivery_date' => '<string>',
'modelDetails' => [
'number_of_parameters' => 123,
'token_context_window' => 123,
'languages' => 123,
'alignments' => 123
]
],
'model_creation_parameters' => [
],
'model_card' => '<string>',
'training_data_card' => '<string>',
'description' => '<string>',
'model_template_id' => '<string>',
'model_group_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.egp.scale.com/v4/models"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"account_id\": \"<string>\",\n \"display_name\": \"<string>\",\n \"base_model_id\": \"<string>\",\n \"base_model_metadata\": {\n \"model_developer\": \"<string>\",\n \"model_license_url\": \"<string>\",\n \"delivery_date\": \"<string>\",\n \"modelDetails\": {\n \"number_of_parameters\": 123,\n \"token_context_window\": 123,\n \"languages\": 123,\n \"alignments\": 123\n }\n },\n \"model_creation_parameters\": {},\n \"model_card\": \"<string>\",\n \"training_data_card\": \"<string>\",\n \"description\": \"<string>\",\n \"model_template_id\": \"<string>\",\n \"model_group_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.egp.scale.com/v4/models")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"account_id\": \"<string>\",\n \"display_name\": \"<string>\",\n \"base_model_id\": \"<string>\",\n \"base_model_metadata\": {\n \"model_developer\": \"<string>\",\n \"model_license_url\": \"<string>\",\n \"delivery_date\": \"<string>\",\n \"modelDetails\": {\n \"number_of_parameters\": 123,\n \"token_context_window\": 123,\n \"languages\": 123,\n \"alignments\": 123\n }\n },\n \"model_creation_parameters\": {},\n \"model_card\": \"<string>\",\n \"training_data_card\": \"<string>\",\n \"description\": \"<string>\",\n \"model_template_id\": \"<string>\",\n \"model_group_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.egp.scale.com/v4/models")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"account_id\": \"<string>\",\n \"display_name\": \"<string>\",\n \"base_model_id\": \"<string>\",\n \"base_model_metadata\": {\n \"model_developer\": \"<string>\",\n \"model_license_url\": \"<string>\",\n \"delivery_date\": \"<string>\",\n \"modelDetails\": {\n \"number_of_parameters\": 123,\n \"token_context_window\": 123,\n \"languages\": 123,\n \"alignments\": 123\n }\n },\n \"model_creation_parameters\": {},\n \"model_card\": \"<string>\",\n \"training_data_card\": \"<string>\",\n \"description\": \"<string>\",\n \"model_template_id\": \"<string>\",\n \"model_group_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"model_type": "COMPLETION",
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"account_id": "<string>",
"created_by_user_id": "<string>",
"created_by_identity_type": "user",
"request_schema": {},
"response_schema": {},
"deployment_count": 123,
"supports_multi_turn": true,
"display_name": "<string>",
"model_vendor": "OPENAI",
"base_model_id": "<string>",
"base_model_metadata": {
"ui_model_section_type": "PARTNER",
"model_developer": "<string>",
"model_license_url": "<string>",
"delivery_date": "<string>",
"modelDetails": {
"number_of_parameters": 123,
"token_context_window": 123,
"languages": 123,
"alignments": 123
}
},
"model_creation_parameters": {},
"model_card": "<string>",
"training_data_card": "<string>",
"description": "<string>",
"model_template_id": "<string>",
"model_group_id": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Create Model
Description
Creates and hosts a model based on a model template.
Base embedding models, chunk ranking functions, and LLMs are often not sufficient for customer use cases. We have shown in various blogs that fine-tuning these models on customer data can lead to significant improvements in performance.
- We Fine-Tuned GPT-4 to Beat the Industry Standard for Text2SQL
- OpenAI Names Scale as Preferred Partner to Fine-Tune GPT-3.5
- How to Fine-Tune GPT-3.5 Turbo With OpenAI API
Details
Before creating a model, you must first create a model template. A model template serves 2 purposes. First, it provides common scaffolding that is static across multiple models. Second, it exposes several variables that can be injected at model creation time to customize the model.
For example, a model template can define a docker image that contains code to run a HuggingFace or SentenceTransformers model. This docker image code also accepts environment variables that can be set to swap out the model weights or model name. Refer to the Create Model Template API for more details.
To create a new model, users must refer to an existing model template and provide the necessary parameters the the model template requires in its model_creation_parameters_schema field. The combination of the model template and the model creation parameters will be used to create and deploy a new model.
Once a model has been created, it can be executed by calling the Execute Model API.
Coming Soon
Some of our EGP APIs depend on models, for example Knowledge Base APIs depend on embedding models, Chunk Ranking APIs depend on ranking models, and Completion APIs depend on LLMs.
In the near future, if a model is created from a model template that is compatible with one of these APIs (based on the model template’s model_type field), the model will automatically be registered with the API. This will allow users to immediately start using the model with those API without any additional setup.
curl --request POST \
--url https://api.egp.scale.com/v4/models \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"account_id": "<string>",
"display_name": "<string>",
"base_model_id": "<string>",
"base_model_metadata": {
"model_developer": "<string>",
"model_license_url": "<string>",
"delivery_date": "<string>",
"modelDetails": {
"number_of_parameters": 123,
"token_context_window": 123,
"languages": 123,
"alignments": 123
}
},
"model_creation_parameters": {},
"model_card": "<string>",
"training_data_card": "<string>",
"description": "<string>",
"model_template_id": "<string>",
"model_group_id": "<string>"
}
'import requests
url = "https://api.egp.scale.com/v4/models"
payload = {
"name": "<string>",
"account_id": "<string>",
"display_name": "<string>",
"base_model_id": "<string>",
"base_model_metadata": {
"model_developer": "<string>",
"model_license_url": "<string>",
"delivery_date": "<string>",
"modelDetails": {
"number_of_parameters": 123,
"token_context_window": 123,
"languages": 123,
"alignments": 123
}
},
"model_creation_parameters": {},
"model_card": "<string>",
"training_data_card": "<string>",
"description": "<string>",
"model_template_id": "<string>",
"model_group_id": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
account_id: '<string>',
display_name: '<string>',
base_model_id: '<string>',
base_model_metadata: {
model_developer: '<string>',
model_license_url: '<string>',
delivery_date: '<string>',
modelDetails: {
number_of_parameters: 123,
token_context_window: 123,
languages: 123,
alignments: 123
}
},
model_creation_parameters: {},
model_card: '<string>',
training_data_card: '<string>',
description: '<string>',
model_template_id: '<string>',
model_group_id: '<string>'
})
};
fetch('https://api.egp.scale.com/v4/models', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.egp.scale.com/v4/models",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'account_id' => '<string>',
'display_name' => '<string>',
'base_model_id' => '<string>',
'base_model_metadata' => [
'model_developer' => '<string>',
'model_license_url' => '<string>',
'delivery_date' => '<string>',
'modelDetails' => [
'number_of_parameters' => 123,
'token_context_window' => 123,
'languages' => 123,
'alignments' => 123
]
],
'model_creation_parameters' => [
],
'model_card' => '<string>',
'training_data_card' => '<string>',
'description' => '<string>',
'model_template_id' => '<string>',
'model_group_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.egp.scale.com/v4/models"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"account_id\": \"<string>\",\n \"display_name\": \"<string>\",\n \"base_model_id\": \"<string>\",\n \"base_model_metadata\": {\n \"model_developer\": \"<string>\",\n \"model_license_url\": \"<string>\",\n \"delivery_date\": \"<string>\",\n \"modelDetails\": {\n \"number_of_parameters\": 123,\n \"token_context_window\": 123,\n \"languages\": 123,\n \"alignments\": 123\n }\n },\n \"model_creation_parameters\": {},\n \"model_card\": \"<string>\",\n \"training_data_card\": \"<string>\",\n \"description\": \"<string>\",\n \"model_template_id\": \"<string>\",\n \"model_group_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.egp.scale.com/v4/models")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"account_id\": \"<string>\",\n \"display_name\": \"<string>\",\n \"base_model_id\": \"<string>\",\n \"base_model_metadata\": {\n \"model_developer\": \"<string>\",\n \"model_license_url\": \"<string>\",\n \"delivery_date\": \"<string>\",\n \"modelDetails\": {\n \"number_of_parameters\": 123,\n \"token_context_window\": 123,\n \"languages\": 123,\n \"alignments\": 123\n }\n },\n \"model_creation_parameters\": {},\n \"model_card\": \"<string>\",\n \"training_data_card\": \"<string>\",\n \"description\": \"<string>\",\n \"model_template_id\": \"<string>\",\n \"model_group_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.egp.scale.com/v4/models")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"account_id\": \"<string>\",\n \"display_name\": \"<string>\",\n \"base_model_id\": \"<string>\",\n \"base_model_metadata\": {\n \"model_developer\": \"<string>\",\n \"model_license_url\": \"<string>\",\n \"delivery_date\": \"<string>\",\n \"modelDetails\": {\n \"number_of_parameters\": 123,\n \"token_context_window\": 123,\n \"languages\": 123,\n \"alignments\": 123\n }\n },\n \"model_creation_parameters\": {},\n \"model_card\": \"<string>\",\n \"training_data_card\": \"<string>\",\n \"description\": \"<string>\",\n \"model_template_id\": \"<string>\",\n \"model_group_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"model_type": "COMPLETION",
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"account_id": "<string>",
"created_by_user_id": "<string>",
"created_by_identity_type": "user",
"request_schema": {},
"response_schema": {},
"deployment_count": 123,
"supports_multi_turn": true,
"display_name": "<string>",
"model_vendor": "OPENAI",
"base_model_id": "<string>",
"base_model_metadata": {
"ui_model_section_type": "PARTNER",
"model_developer": "<string>",
"model_license_url": "<string>",
"delivery_date": "<string>",
"modelDetails": {
"number_of_parameters": 123,
"token_context_window": 123,
"languages": 123,
"alignments": 123
}
},
"model_creation_parameters": {},
"model_card": "<string>",
"training_data_card": "<string>",
"description": "<string>",
"model_template_id": "<string>",
"model_group_id": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Body
An enum representing the different types of models supported.
Attributes: COMPLETION: Denotes that the model type is completion. CHAT_COMPLETION: Denotes that the model type is chat completion. AGENT: Denotes that the model type is agent. EMBEDDING: Denotes that the model type is embedding. RERANKING: Denotes that the model type is reranking. GENERIC: Denotes that the model type is generic. BUNDLE: "Not to be used directly - type to surface a model bundle in the UI - TODO: Explicitly type a bundle
COMPLETION, CHAT_COMPLETION, AGENT, EMBEDDING, RERANKING, GENERIC, BUNDLE The ID of the account that owns the given entity.
An enum representing the different types of model vendors supported.
Attributes: OPENAI: Denotes that the model vendor is OpenAI. COHERE: Denotes that the model vendor is Cohere. GOOGLE: Denotes that the model vendor is Google. ANTHROPIC: Denotes that the model vendor is Anthropic. LLMENGINE: Denotes that the model vendor is LLM Engine. OTHER: Denotes that the model vendor is Other.
OPENAI, COHERE, GOOGLE, VERTEX_AI, ANTHROPIC, LAUNCH, LLMENGINE, BEDROCK, FIREWORKS_AI, OTHER Show child attributes
Show child attributes
Response
Successful Response
An enum representing the different types of models supported.
Attributes: COMPLETION: Denotes that the model type is completion. CHAT_COMPLETION: Denotes that the model type is chat completion. AGENT: Denotes that the model type is agent. EMBEDDING: Denotes that the model type is embedding. RERANKING: Denotes that the model type is reranking. GENERIC: Denotes that the model type is generic. BUNDLE: "Not to be used directly - type to surface a model bundle in the UI - TODO: Explicitly type a bundle
COMPLETION, CHAT_COMPLETION, AGENT, EMBEDDING, RERANKING, GENERIC, BUNDLE The unique identifier of the entity.
The date and time when the entity was created in ISO format.
The ID of the account that owns the given entity.
The user who originally created the entity.
The type of identity that created the entity.
user, service_account JSON schema for the requests to the model instance
JSON schema for the response to the model
Number of deployments of this model instance
True if a model supports multi-turn conversations natively
An enum representing the different types of model vendors supported.
Attributes: OPENAI: Denotes that the model vendor is OpenAI. COHERE: Denotes that the model vendor is Cohere. GOOGLE: Denotes that the model vendor is Google. ANTHROPIC: Denotes that the model vendor is Anthropic. LLMENGINE: Denotes that the model vendor is LLM Engine. OTHER: Denotes that the model vendor is Other.
OPENAI, COHERE, GOOGLE, VERTEX_AI, ANTHROPIC, LAUNCH, LLMENGINE, BEDROCK, FIREWORKS_AI, OTHER Show child attributes
Show child attributes