カスタムエイリアス

カスタムエイリアスは、設定パラメーター、機能フラグ、環境固有の設定などの文字列値を保存する名前付きの参照です。値をハードコードする代わりにカスタムエイリアスを使うと、関数のロジックを特定の設定から切り離し、異なる環境でも関数を使えるようにできます。関数内で言語モデルを名前で参照する方法については、モデルエイリアスを参照してください。

カスタムエイリアスを定義する

カスタムエイリアスを定義するには、TypeScript v2 または Python のコードリポジトリを開き、次の手順に沿って進めます。

1. リソースのインポートサイドパネルを開き、プラットフォーム SDK タブを選択します。カスタムエイリアスのセクションが表示されます。

2. 新規エイリアスを選択して、エイリアス作成ダイアログを開きます。エイリアス名のキーと、それに関連付ける値を入力し、作成するを選択します。エイリアスのキーは、リポジトリ内で一意である必要があります。

3. カスタムエイリアスがカスタムエイリアスセクションに表示されます。

カスタムエイリアスを編集する

既存のカスタムエイリアスを編集するには、プラットフォーム SDK タブのカスタムエイリアスセクションに移動します。エイリアスの横にあるペンアイコンを選択して、その値をインラインで編集します。また、3点アイコンをクリックして、エイリアスのキーを編集したり、エイリアス自体を削除したりすることもできます。

コードでカスタムエイリアスを使う

関数でカスタムエイリアスを使うには、エイリアスユーティリティをインポートし、キーでエイリアスを参照します。

Copied!
1
2
3
4
5
import { Aliases } from "@osdk/functions";

export default function getCustomValue(): string {
    return Aliases.custom("myAlias");
}

Copied!
1
2
3
4
5
6
from functions.aliases import custom
from functions.api import function

@function
def get_custom_value() -> str:
    return custom("myAlias")

Marketplace でカスタムエイリアスを使う

カスタムエイリアスを使う関数を Marketplace 製品に追加すると、エイリアスは入力の下に設定可能なパラメーターとして自動的に表示されます。インストール担当者は、関数のソースコードを変更せずに、自身の環境に適したエイリアス値を設定できます。

説明を設定する

インストール担当者がエイリアスの設定方法を理解しやすいように、エイリアスパラメーターに説明を追加できます。入力の下にあるエイリアスを選択して詳細パネルを開き、全般タブで説明を入力します。

プリセットを追加する

インストール時にインストール担当者が選択できる、エイリアスのプリセット値を定義できます。詳細パネルで条件タブを選択し、手動オーバーライドを選択して、許可する値を定義します。

インストール時の操作

インストール時には、エイリアスの説明がインストール担当者に表示され、プリセット値から選択するか、エイリアスを手動で設定できます。インストール後、関数はエイリアスをインストール担当者が設定した値に解決します。