Update Application Variant

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
)
response = client.application_variants.patch(
    application_variant_id="application_variant_id",
)
print(response)

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"),
	)
	response, err := client.ApplicationVariants.Patch(
		context.TODO(),
		"application_variant_id",
		sgp.ApplicationVariantPatchParams{},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", response)
}

curl --request PATCH \
  --url https://api.egp.scale.com/v4/application-variants/{application_variant_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "configuration": {
    "metadata": {},
    "params": "<unknown>",
    "raw_configuration": "<string>"
  }
}
'

const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    configuration: {metadata: {}, params: '<unknown>', raw_configuration: '<string>'}
  })
};

fetch('https://api.egp.scale.com/v4/application-variants/{application_variant_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/application-variants/{application_variant_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>',
    'description' => '<string>',
    'configuration' => [
        'metadata' => [
                
        ],
        'params' => '<unknown>',
        'raw_configuration' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$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/application-variants/{application_variant_id}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"configuration\": {\n    \"metadata\": {},\n    \"params\": \"<unknown>\",\n    \"raw_configuration\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.egp.scale.com/v4/application-variants/{application_variant_id}")

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

request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"configuration\": {\n    \"metadata\": {},\n    \"params\": \"<unknown>\",\n    \"raw_configuration\": \"<string>\"\n  }\n}"

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

{
  "id": "<string>",
  "name": "<string>",
  "configuration": {
    "nodes": [
      {
        "id": "<string>",
        "application_node_schema_id": "text_input_schema",
        "configuration": {}
      }
    ],
    "edges": [
      {
        "from_node": "<string>",
        "to_node": "<string>",
        "from_field": "<string>",
        "to_field": "<string>"
      }
    ],
    "metadata": {}
  },
  "version": "V0",
  "application_spec_id": "<string>",
  "draft": true,
  "account_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "published_at": "2023-11-07T05:31:56Z",
  "created_by_user_id": "<string>",
  "created_by_identity_type": "user"
}

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

PATCH

application-variants

{application_variant_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
)
response = client.application_variants.patch(
    application_variant_id="application_variant_id",
)
print(response)

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"),
	)
	response, err := client.ApplicationVariants.Patch(
		context.TODO(),
		"application_variant_id",
		sgp.ApplicationVariantPatchParams{},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", response)
}

curl --request PATCH \
  --url https://api.egp.scale.com/v4/application-variants/{application_variant_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "configuration": {
    "metadata": {},
    "params": "<unknown>",
    "raw_configuration": "<string>"
  }
}
'

const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    configuration: {metadata: {}, params: '<unknown>', raw_configuration: '<string>'}
  })
};

fetch('https://api.egp.scale.com/v4/application-variants/{application_variant_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/application-variants/{application_variant_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>',
    'description' => '<string>',
    'configuration' => [
        'metadata' => [
                
        ],
        'params' => '<unknown>',
        'raw_configuration' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$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/application-variants/{application_variant_id}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"configuration\": {\n    \"metadata\": {},\n    \"params\": \"<unknown>\",\n    \"raw_configuration\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.egp.scale.com/v4/application-variants/{application_variant_id}")

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

request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"configuration\": {\n    \"metadata\": {},\n    \"params\": \"<unknown>\",\n    \"raw_configuration\": \"<string>\"\n  }\n}"

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

{
  "id": "<string>",
  "name": "<string>",
  "configuration": {
    "nodes": [
      {
        "id": "<string>",
        "application_node_schema_id": "text_input_schema",
        "configuration": {}
      }
    ],
    "edges": [
      {
        "from_node": "<string>",
        "to_node": "<string>",
        "from_field": "<string>",
        "to_field": "<string>"
      }
    ],
    "metadata": {}
  },
  "version": "V0",
  "application_spec_id": "<string>",
  "draft": true,
  "account_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "published_at": "2023-11-07T05:31:56Z",
  "created_by_user_id": "<string>",
  "created_by_identity_type": "user"
}

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

Authorizations

x-api-key

string

header

required

Path Parameters

application_variant_id

string

required

Body

application/json

name

string

description

string

configuration

PatchApplicationVariantConfiguration · object

Show child attributes

Response

Successful Response

ApplicationVariantV0Response
ApplicationVariantAgentsServiceResponse
OfflineApplicationVariantResponse

string

required

name

string

required

configuration

ApplicationConfigurationV0 · object

required

Show child attributes

version

string

required

Allowed value: "V0"

application_spec_id

string

required

draft

boolean

required

Boolean to indicate whether the variant is in draft mode

account_id

string

required

The ID of the account that owns the given entity.

created_at

string<date-time>

required

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

updated_at

string<date-time>

required

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

description

string

Optional description of the application variant

published_at

string<date-time>

The date and time that the variant was published.

created_by_user_id

string

The user who originally created the entity.

created_by_identity_type

enum<string>

The type of identity that created the entity.

Available options:

user,

service_account

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 Application Variant

Description

Details

Authorizations

Path Parameters

Body

Response