Update Deployment

Python

import os
from scale_gp import SGPClient

client = SGPClient(
    api_key=os.environ.get("SGP_API_KEY"),  # This is the default and can be omitted
)
model_deployment = client.models.deployments.update(
    deployment_id="deployment_id",
    model_instance_id="model_instance_id",
)
print(model_deployment.id)

package main

import (
	"context"
	"fmt"

	"github.com/stainless-sdks/sgp-go"
	"github.com/stainless-sdks/sgp-go/option"
)

func main() {
	client := sgp.NewClient(
		option.WithAPIKey("My API Key"),
	)
	modelDeployment, err := client.Models.Deployments.Update(
		context.TODO(),
		"model_instance_id",
		"deployment_id",
		sgp.ModelDeploymentUpdateParams{},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", modelDeployment.ID)
}

curl --request PATCH \
  --url https://api.egp.scale.com/v4/models/{model_instance_id}/deployments/{deployment_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "model_creation_parameters": {},
  "vendor_configuration": {
    "min_workers": 0,
    "max_workers": 1,
    "per_worker": 10,
    "vendor": "LAUNCH"
  },
  "deployment_metadata": {},
  "wait_for_ready": true
}
'

const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    model_creation_parameters: {},
    vendor_configuration: {min_workers: 0, max_workers: 1, per_worker: 10, vendor: 'LAUNCH'},
    deployment_metadata: {},
    wait_for_ready: true
  })
};

fetch('https://api.egp.scale.com/v4/models/{model_instance_id}/deployments/{deployment_id}', 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/{model_instance_id}/deployments/{deployment_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'model_creation_parameters' => [
        
    ],
    'vendor_configuration' => [
        'min_workers' => 0,
        'max_workers' => 1,
        'per_worker' => 10,
        'vendor' => 'LAUNCH'
    ],
    'deployment_metadata' => [
        
    ],
    'wait_for_ready' => true
  ]),
  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;
}

HttpResponse<String> response = Unirest.patch("https://api.egp.scale.com/v4/models/{model_instance_id}/deployments/{deployment_id}")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"model_creation_parameters\": {},\n  \"vendor_configuration\": {\n    \"min_workers\": 0,\n    \"max_workers\": 1,\n    \"per_worker\": 10,\n    \"vendor\": \"LAUNCH\"\n  },\n  \"deployment_metadata\": {},\n  \"wait_for_ready\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.egp.scale.com/v4/models/{model_instance_id}/deployments/{deployment_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"model_creation_parameters\": {},\n  \"vendor_configuration\": {\n    \"min_workers\": 0,\n    \"max_workers\": 1,\n    \"per_worker\": 10,\n    \"vendor\": \"LAUNCH\"\n  },\n  \"deployment_metadata\": {},\n  \"wait_for_ready\": true\n}"

response = http.request(request)
puts response.read_body

{
  "name": "<string>",
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "account_id": "<string>",
  "created_by_user_id": "<string>",
  "created_by_identity_type": "user",
  "status": "<string>",
  "model_creation_parameters": {},
  "model_endpoint_id": "<string>",
  "model_instance_id": "<string>",
  "vendor_configuration": {
    "min_workers": 0,
    "max_workers": 1,
    "per_worker": 10,
    "vendor": "LAUNCH"
  },
  "deployment_metadata": {}
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

PATCH

models

{model_instance_id}

deployments

{deployment_id}

Python

import os
from scale_gp import SGPClient

client = SGPClient(
    api_key=os.environ.get("SGP_API_KEY"),  # This is the default and can be omitted
)
model_deployment = client.models.deployments.update(
    deployment_id="deployment_id",
    model_instance_id="model_instance_id",
)
print(model_deployment.id)

package main

import (
	"context"
	"fmt"

	"github.com/stainless-sdks/sgp-go"
	"github.com/stainless-sdks/sgp-go/option"
)

func main() {
	client := sgp.NewClient(
		option.WithAPIKey("My API Key"),
	)
	modelDeployment, err := client.Models.Deployments.Update(
		context.TODO(),
		"model_instance_id",
		"deployment_id",
		sgp.ModelDeploymentUpdateParams{},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", modelDeployment.ID)
}

curl --request PATCH \
  --url https://api.egp.scale.com/v4/models/{model_instance_id}/deployments/{deployment_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "model_creation_parameters": {},
  "vendor_configuration": {
    "min_workers": 0,
    "max_workers": 1,
    "per_worker": 10,
    "vendor": "LAUNCH"
  },
  "deployment_metadata": {},
  "wait_for_ready": true
}
'

const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    model_creation_parameters: {},
    vendor_configuration: {min_workers: 0, max_workers: 1, per_worker: 10, vendor: 'LAUNCH'},
    deployment_metadata: {},
    wait_for_ready: true
  })
};

fetch('https://api.egp.scale.com/v4/models/{model_instance_id}/deployments/{deployment_id}', 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/{model_instance_id}/deployments/{deployment_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'model_creation_parameters' => [
        
    ],
    'vendor_configuration' => [
        'min_workers' => 0,
        'max_workers' => 1,
        'per_worker' => 10,
        'vendor' => 'LAUNCH'
    ],
    'deployment_metadata' => [
        
    ],
    'wait_for_ready' => true
  ]),
  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;
}

HttpResponse<String> response = Unirest.patch("https://api.egp.scale.com/v4/models/{model_instance_id}/deployments/{deployment_id}")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"model_creation_parameters\": {},\n  \"vendor_configuration\": {\n    \"min_workers\": 0,\n    \"max_workers\": 1,\n    \"per_worker\": 10,\n    \"vendor\": \"LAUNCH\"\n  },\n  \"deployment_metadata\": {},\n  \"wait_for_ready\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.egp.scale.com/v4/models/{model_instance_id}/deployments/{deployment_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"model_creation_parameters\": {},\n  \"vendor_configuration\": {\n    \"min_workers\": 0,\n    \"max_workers\": 1,\n    \"per_worker\": 10,\n    \"vendor\": \"LAUNCH\"\n  },\n  \"deployment_metadata\": {},\n  \"wait_for_ready\": true\n}"

response = http.request(request)
puts response.read_body

{
  "name": "<string>",
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "account_id": "<string>",
  "created_by_user_id": "<string>",
  "created_by_identity_type": "user",
  "status": "<string>",
  "model_creation_parameters": {},
  "model_endpoint_id": "<string>",
  "model_instance_id": "<string>",
  "vendor_configuration": {
    "min_workers": 0,
    "max_workers": 1,
    "per_worker": 10,
    "vendor": "LAUNCH"
  },
  "deployment_metadata": {}
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Path Parameters

model_instance_id

string

required

deployment_id

string

required

Body

application/json

name

string

model_creation_parameters

Model Creation Parameters · object

vendor_configuration

LaunchDeploymentVendorConfiguration · object

LaunchDeploymentVendorConfiguration
LLMEngineDeploymentVendorConfiguration

Show child attributes

deployment_metadata

Deployment Metadata · object

wait_for_ready

boolean

If true, the request will block until the Launch endpoint is READY. Defaults to true.

Response

Successful Response

name

string

required

string

required

The unique identifier of the entity.

created_at

string<date-time>

required

The date and time when the entity was created in ISO format.

account_id

string

required

The ID of the account that owns the given entity.

created_by_user_id

string

required

The user who originally created the entity.

created_by_identity_type

enum<string>

required

The type of identity that created the entity.

Available options:

user,

service_account

status

string

required

Status of the model's deployment.

model_creation_parameters

Model Creation Parameters · object

model_endpoint_id

string

model_instance_id

string

vendor_configuration

LaunchDeploymentVendorConfiguration · object

LaunchDeploymentVendorConfiguration
LLMEngineDeploymentVendorConfiguration

Show child attributes

deployment_metadata

Deployment Metadata · object

Knowledge Bases

Chunks

Agents

Completions

Chat Completions

Models

Users

Accounts

Organizations

Question Sets

Evaluations

Evaluation Configs

Evaluation Datasets

Studio Projects

Application Specs

Questions

Knowledge Base Data Sources

Model Templates V3 (Beta)

Model server

API Reference

Fine Tuning Jobs V3 (Beta)

Training Datasets V3 (Beta)

package deployments

Beta

Applications

ChatThreads

Interactions

MonitoringDashboard

Chat Themes

Sessions

account groups

Update Deployment

Description

Details

Path Parameters

Body

Response