작업에서 세션 변수 사용하기

작업을 정의할 때 봇 플랫폼이 제공하는 세션 변수 또는 정의한 사용자 정의 변수, 변수의 범위를 정의하는 컨텍스트에 액세스할 수 있습니다. 예를 들어, 일부 API 요청에서는 작업을 실행하기 전에 세션 변수를 설정해야 합니다. 또는 다음 노드로 전환하려면 세션 변수 액세스를 위한 대화 작업 구성 요소가 필요합니다. 또한 대화 작업은 추가적인 시스템 변수를 사용하여 context 개체에 액세스할 수 있습니다. 자세한 내용은 컨텍스트 개체를 참조하세요. 세션 변수를 사용하여 작업에 대해 JavaScript를 정의할 수 있으며 JavaScript 탭에서 사용자 프롬프트 편집기를 사용할 수 있습니다.

세션 변수

이 세션에서는 컨텍스트 변수, 사용자 정의 JavaScript 코드에서 작업에 대해 사용할 수 있는 컨텍스트 변수의 범위를 설명합니다. 각 컨텍스트 유형에 따라 키/값 쌍을 GET 또는 PUT하는 JavaScript 구문은 다음과 같습니다.

   "EnterpriseContext" : {
       "get" : function(key){...},//get the specified key
       "put" : function(key, value, ttl){...} //put the value at the key for the specified ttl, ttl is in minutes
   },
   "BotContext" : {
       "get" : function(key){...},//get the specified key
       "put" : function(key, value, ttl){...} //put the value at the key for the specified ttl, ttl is in minutes
   },
   "UserContext" : {
       "get" : function(key){...},//get the specified key
   },
   "UserSession" : {
       "get" : function(key){...},//get the specified key
       "put" : function(key, value, ttl){...} //put the value at the key for the specified ttl, ttl is in minutes
   },
   "BotUserSession" : {
       "get" : function(key){...},//get the specified key
       "put" : function(key, value, ttl){...} //put the value at the key for the specified ttl, ttl is in minutes
   }

예:

    BotContext.put("topicSessionVariable","music",2000);
    UserSession.put("firstName","Mary",20000);
    UserContext.get("firstName");

세션 변수 유형

다음 유형의 세션 변수를 봇 플랫폼에서 사용할 수 있습니다.

EnterpriseContext – 엔터프라이즈 내 모든 봇과 사용자가 사용할 수 있는 키-값 쌍입니다. 예: GitHub 봇을 사용하면 사용자는 하나 이상의 엔터프라이즈 저장소에 액세스해야 합니다. 다음 JavaScript 코드를 사용하여 저장소 데이터를 Gitrepository (엔터프라이즈 컨텍스트)로 유지할 수 있습니다.
```
var userRepository = {
"title": _labels_[repository],
"value": repository
};
EnterpriseContext.put('Gitrepository', userRepository, 200000);
```
BotContext – 특정 봇의 모든 사용자가 사용할 수 있는 키/값 쌍입니다. 예: 사용자의 위치에 따라 세션에서 금융 거래에 대한 기본 통화를 설정할 수 있습니다. 다음 JavaScript 코드를 사용하여 기본 통화 데이터를 currency (봇 컨텍스트)로 유지할 수 있습니다.
```
var defaultCurrency = { TODO Custom JavaScript for location-based currency }
BotContext.put('currency', defaultCurrency, 200000);
```
UserContext – 사용자의 모든 봇이 사용할 수 있는 키-값 쌍입니다. 이 키는 읽기 전용이며 시스템에서 다음과 같은 사용자 데이터로 제공됩니다.
- - UserContext.get("_id") – Kore.ai 사용자 ID입니다.
  - UserContext.get("emailId") – 사용자 ID와 연결된 이메일 주소입니다.
  - UserContext.get("lastName") – 사용자의 성입니다.
  - UserContext.get("firstName") – 사용자의 이름입니다.
  - UserContext.get("profImage") – 사용자의 이미지 또는 아바타 파일 이름입니다.
  - UserContext.get("profColor") – 사용자의 계정 색상입니다.
  - UserContext.get("activationStatus") – 사용자의 계정 상태입니다. 다음과 같을 수 있습니다.
    - active – 사용자는 활성 상태이며 다른 Kore.ai 사용자와 상호 작용할 수 있습니다.
    - inactive – 사용자는 비활성 상태이지만 시스템에 사용자 데이터가 유지됩니다.
    - suspended – 관리자가 일시 중단한 사용자입니다. 사용자는 Kore.ai에 로그인할 수 없지만 메시지는 일시 중단된 사용자에게 계속 보낼 수 있습니다.
    - locked – 사용자가 최대 로그인 시도 횟수를 초과했습니다.
  - UserContext.get("jTitle") – 정의된 경우 사용자의 직함입니다.
  - UserContext.get("orgId") – 정의된 경우 사용자 계정의 조직 ID입니다.
  - UserContext.get("customData") – 사용자 정보를 웹 채널에 전달하는 데 사용합니다. 현재는 webSDK 전용입니다.자세한 내용은 여기를 참조하세요.
  - UserContext.get("identities") – 정의된 경우 대체 사용자 ID입니다.
    - val – 대체 ID
    - type – 대체 ID의 유형입니다.
예: UserSession 변수를 사용하여 값을 세션에 PUT할 수 있습니다. 두 가지 UserContext 변수를 통한 GET을 기반으로 키를 fullName으로 정의합니다.
```
var name = UserContext.get("firstName")+UserContext.get("lastName");
UserSession.put("fullName") = name;
```
UserSession – 엔터프라이즈 내 모든 봇의 특정 사용자에 대해 정의할 수 있는 키/값 쌍입니다. 예: 상거래, 운송 및 가정 배달 서비스를 위한 사용자 집 주소와 같이 사용자 위치를 저장하여 모든 봇이 사용할 수 있도록 해야 합니다. 예: 다음 JavaScript 코드를 사용하여 기본 위치 데이터를 HomeLocation (사용자 세션)으로 유지할 수 있습니다.
```
var location = {
 "title": labels[location],
 "value": {
 "latitude": location.latitude,
 "longitude": request.location.longitude
 }
};
UserSession.put('HomeLocation', location, '20000');
```
BotUserSession – 특정 사용자가 입력한 값에 따라 특정 봇에 정의할 수 있는 키/값 쌍입니다. 예: 봇에 하나 이상의 작업에 대해 사용자 위치를 유지해야 합니다. 여행 봇의 경우 같은 집 주소와 목적지 주소를 기준으로 항공편과 호텔을 예약할 수 있습니다. 예: 다음 JavaScript 코드를 사용하여 기본 집 및 목적지 데이터를 HomeLocation (봇 사용자 세션) 및 DestinationLocation (봇 사용자 세션)으로 유지할 수 있습니다.
```
var homelocation = {
 "title": labels[request.sourceLocation],
 "value": {
 "latitude": request.sourceLocation.latitude,
 "longitude": request.sourceLocation.longitude
 }
};
BotUserSession.put('HomeLocation', homelocation, '20000');
var destlocation = {
 "title": labels[request.destLocation],
 "value": {
 "latitude": request.destLocation.latitude,
 "longitude": request.destLocation.longitude
 }
};
BotUserSession.put('DestinationLocation', destlocation, '20000’);
```

표준 키

세션 키 및 컨텍스트 키 외에도 재사용 가능한 데이터를 위한 Kore.ai 변수 플레이스 홀더가 있습니다. 다음 중 하나를 선택합니다.

_labels_ – GUID 대신 친숙한 레이블을 반환하는 데 사용됩니다. 예: 웹 서비스 API에서 사용자 데이터를 요청할 때 반환되는 프로젝트 또는 워크스페이스의 ID는 GUID입니다. _labels_ 키를 사용하여 GUID 대신 최종 사용자에게 GUID의 친숙한 이름을 알려줄 수 있습니다. Kore.ai에서 드롭다운 컨트롤은 _labels_ 키의 응답을 다음과 같이 저장합니다. 예:
```
{
    "_labels_": {
        "15379386734832": "roadlabs.com",
        "26377329985341": "Test Project",
        "workspace": "roadlabs.com",
        "project": "Test Project"
    },
    "_fields_": {
        "workspace": "15379386734832",
        "project": "26377329985341"
    }
}
```
응답에 _labels_ 키를 사용하는 방법:
```
print('<a href="https://app.asana.com/0/' + workspace.id + '/' + id + '/f" target="_blank">' + title + '</a> in workspace '+_labels_[workspace.id]);
```
_tenant_ – 정의된 경우 엔터프라이즈에 대한 테넌트를 반환하는 데 사용됩니다. 예: JIRA는 https://koreteam.atlassian.net/browse/BBF-3265에서 koreteam과 같은 URL에 대한 테넌트가 필요합니다. _tenant_ 키를 사용하여 다음과 같은 작업 응답에서 링크를 작성할 수 있습니다.
```
var title = request.fields.issuetype.name + ' <a href ="https://' + _tenant_ + '/browse/' + response.key + '" target = "_blank">' + request.fields.summary + '</a>  has been created.';
```
_fields_ – 페이로드 응답의 일부가 아닌, 사용자가 제공한 조치 작업 필드 입력을 반환하는 데 사용됩니다. 예: JIRA 조치 작업에서 최종 사용자에게 워크스페이스 이름을 입력하라는 메시지가 표시됩니다. _fields_ 키를 사용하여 최종 사용자 입력을 다음과 같이 저장할 수 있습니다.
```
_fields_["workspace"]
```
_last_run – 웹 서비스 풀의 UTC 날짜 타임스탬프를 ISO 8601 형식을 사용하여 반환하는 데 사용됩니다. 예: 2016-03-05T12:44:38+00:00. 예: 웹 서비스 요청이 페이로드 응답에서 모든 활동을 반환하는 경우 _last_run 키를 사용하여 다음 _last_run 값의 앞 또는 뒤에 표시되는 결과를 필터링할 수 있습니다.

セッション変数

このセクションでは、タスク用のカスタムJavaScriptコードにおいて使用できるコンテキスト変数とそのスコープについて説明します。各コンテキストタイプのキー／値ペアをGETまたはPUTするJavaScriptの構文は次のとおりです。

   "EnterpriseContext" : {
       "get" : function(key){...},//get the specified key
       "put" : function(key, value, ttl){...} //put the value at the key for the specified ttl, ttl is in minutes
   },
   "BotContext" : {
       "get" : function(key){...},//get the specified key
       "put" : function(key, value, ttl){...} //put the value at the key for the specified ttl, ttl is in minutes
   },
   "UserContext" : {
       "get" : function(key){...},//get the specified key
   },
   "UserSession" : {
       "get" : function(key){...},//get the specified key
       "put" : function(key, value, ttl){...} //put the value at the key for the specified ttl, ttl is in minutes
   },
   "BotUserSession" : {
       "get" : function(key){...},//get the specified key
       "put" : function(key, value, ttl){...} //put the value at the key for the specified ttl, ttl is in minutes
   }

例：

    BotContext.put("topicSessionVariable","music",2000);
    UserSession.put("firstName","Mary",20000);
    UserContext.get("firstName");

セッション変数のタイプ

ボットプラットフォームでは、以下のタイプのセッション変数が利用できます。

EnterpriseContext – 企業の中のあらゆるボットとあらゆるユーザーが使用できるキー／値ペア。例として、GitHubボットの場合、ユーザーは1つ以上の企業リポジトリにアクセスする必要があります。以下のJavaScriptコードによって、リポジトリデータをGitrepository (企業コンテキスト) として存続させることができます。
```
var userRepository = {
"title": _labels_[repository],
"value": repository
};
EnterpriseContext.put('Gitrepository', userRepository, 200000);
```
BotContext – この特定のボットのすべてのユーザーが利用できるキー/値のペアです。例として、ユーザーの所在地に基づいて、セッションの金融取引のデフォルト通貨を設定することができます。以下のJavaScriptコードによって、デフォルトの通貨データを通貨（ボットコンテキスト） として存続させることができます。
```
var defaultCurrency = { TODO Custom JavaScript for location-based currency }
BotContext.put('currency', defaultCurrency, 200000);
```
UserContext – ユーザーのすべてのボットが利用できるキー／値のペア。これらのキーは読み取り専用で、ユーザーデータとしてシステムが提供します。
- - UserContext.get(“_id”) –Kore.aiのユーザーID。
  - UserContext.get(“emailId”) –ユーザーIDと関連するメールアドレス。
  - UserContext.get(“lastName”) –ユーザーの姓。
  - UserContext.get(“firstName”) –ユーザーの名。
  - UserContext.get(“profImage”) –ユーザーの画像またはアバターのファイル名。
  - UserContext.get(“profColor”) –ユーザーのアカウントの色。
  - UserContext.get(“activationStatus”) –ユーザーのアカウントステータス。以下のようになります。
    - active – ユーザーはアクティブであり、他のKore.aiユーザーと対話できます。
    - inactive – ユーザーはアクティブではありませんが、ユーザーデータはシステムに保持されます。
    - suspended – ユーザーは管理者によって停止されています。ユーザーはKore.aiにログインできなくなりますが、停止中のユーザーにメッセージを送ることはできます。
    - locked – ユーザーがログイン試行回数の上限を超えてしまいました。
  - UserContext.get(“jTitle”) –ユーザーのタイトル（定義されている場合）。
  - UserContext.get(“orgId”) –ユーザーアカウントの組織ID（定義されている場合）。
  - UserContext.Get(“customData”) – ユーザー情報をWebチャネルに渡すために使用します。現在はwebSDKのみです。詳細については、ここを参照してください。
  - UserContext.get(“identities”) – ユーザーの代替ID(定義されている場合) 。
    - val – 代替ID
    - type – 代替IDのタイプ。
例として、2つのUserContext変数からのGETに基づいてfullNameというキーが定義されているUserSession変数を使用して、セッションに値をPUTすることができます。
```
var name = UserContext.get("firstName")+UserContext.get("lastName");
UserSession.put("fullName") = name;
```
UserSession – 企業の中のあらゆるボットのために、この特定ユーザーを定義できるキー/値のペア。例として、商取引、輸送、宅配便サービスのためのユーザーの自宅住所など、ユーザーの位置を保存して全ボットにも利用できるようにしたい場合もあります。例として、以下のJavaScriptコードによって、デフォルトの位置情報データをHomeLocation（UserSession）として存続させることができます。
```
var location = {
 "title": labels[location],
 "value": {
 "latitude": location.latitude,
 "longitude": request.location.longitude
 }
};
UserSession.put('HomeLocation', location, '20000');
```
BotUserSession – 特定ユーザーの入力を基にして特定ボットに定義できるキー／値のペア。例として、ボットの複数のタスクに対して、ユーザーの位置情報を存続させたい場合があります。旅行ボットの場合、ユーザーは同じ自宅と目的地の住所に基づいてフライトとホテルを予約できる場合があります。例として、以下のJavaScriptコードによって、デフォルトの自宅と宛先のデータを、HomeLocation（BotUserSession ）およびDestinationLocation（BotUserSession ）として存続させるることができます。
```
var homelocation = {
 "title": labels[request.sourceLocation],
 "value": {
 "latitude": request.sourceLocation.latitude,
 "longitude": request.sourceLocation.longitude
 }
};
BotUserSession.put('HomeLocation', homelocation, '20000');
var destlocation = {
 "title": labels[request.destLocation],
 "value": {
 "latitude": request.destLocation.latitude,
 "longitude": request.destLocation.longitude
 }
};
BotUserSession.put('DestinationLocation', destlocation, '20000’);
```

標準キー

セッションキーとコンテキストキーに加えて、再利用可能なデータのためのKore.ai変数プレースホルダーがあります。以下のいずれかを選択します。

_labels_ –GUIDの代わりにフレンドリーなラベルを返すために使用します。例として、WebサービスAPIからユーザーデータを要求された場合、返されるプロジェクトやワークスペースのIDはGUIDとなります。_labels_ キーを使用して、GUID ではなく、ユーザーフレンドリーのGUID名をエンドユーザーに表示することができます。Kore.aiでは、次の例に示すように、ドロップダウンコントロールが_labels_キー応答を格納します。
```
{
    "_labels_": {
        "15379386734832": "roadlabs.com",
        "26377329985341": "Test Project",
        "workspace": "roadlabs.com",
        "project": "Test Project"
    },
    "_fields_": {
        "workspace": "15379386734832",
        "project": "26377329985341"
    }
}
```
応答で_labels_キーを使用するには、：
```
print('<a href="https://app.asana.com/0/' + workspace.id + '/' + id + '/f" target="_blank">' + title + '</a> in workspace '+_labels_[workspace.id]);
```
_tenant_ –企業のテナントが定義されている場合、そのテナントを返すために使用されます。例として、“JIRA”には、URL が https://koreteam.atlassian.net/browse/BBF-3265 となるよう、テナント koreteam が必要です。以下のように、_tenant_キーを使用して、タスク応答へのリンクを作成することができます。
```
var title = request.fields.issuetype.name + ' <a href ="https://' + _tenant_ + '/browse/' + response.key + '" target = "_blank">' + request.fields.summary + '</a>  has been created.';
```
_fields_ –ペイロードレスポンスの一部ではない、エンドユーザーが入力した[アクションタスク]フィールド入力を返すために使用されます。例として、“JIRA”のアクションタスクでは、エンドユーザーはワークスペース名の入力を求められます。_fields_ キーを使用して、エンドユーザーの入力を格納します。
```
_fields_["workspace"]
```
_last_run – ISO 8601形式を使用して、WebサービスのポールのUTC日付のタイムスタンプを返すために使用されます。例：2016-03-05T12:44:38+00:00。例として、Webサービスリクエストがペイロードレスポンスであらゆるアクティビティを返すとすれば、_last_runキーを用いて、_last_run値の前後に表示される結果をフィルタリングすることができます。

Session Variables

This section describes the context variables and the scope of the context variables that you can use in your custom JavaScript code for your tasks.

The JavaScript syntax to GET or PUT a key/value pair for each context type is:

   "EnterpriseContext" : {
       "get" : function(key){...},//get the specified key
       "put" : function(key, value, ttl){...} //put the value at the key for the specified ttl, ttl is in minutes
   },
   "BotContext" : {
       "get" : function(key){...},//get the specified key
       "put" : function(key, value, ttl){...} //put the value at the key for the specified ttl, ttl is in minutes
   },
   "UserContext" : {
       "get" : function(key){...},//get the specified key
   },
   "UserSession" : {
       "get" : function(key){...},//get the specified key
       "put" : function(key, value, ttl){...} //put the value at the key for the specified ttl, ttl is in minutes
   },
   "BotUserSession" : {
       "get" : function(key){...},//get the specified key
       "put" : function(key, value, ttl){...} //put the value at the key for the specified ttl, ttl is in minutes
   }

For example:

    BotContext.put("topicSessionVariable","music",2000);
    UserSession.put("firstName","Mary",20000);
    UserContext.get("firstName");

Session Variable Types

The following types of session variables are available on the Bots Platform:

EnterpriseContext – A key/value pair available to all bots and all users in an enterprise. For example, with the GitHub bot, a user will need to access one or more enterprise repositories. You can persist the repository data as Gitrepository (Enterprise Context) with the following JavaScript code:
```
var userRepository = {
"title": _labels_[repository],
"value": repository
};
EnterpriseContext.put('Gitrepository', userRepository, 200000);
```
BotContext – A key/value pair available to all users of this specific bot. For example, you may want to set up a default currency for financial transactions for a session based on the location of a user. You can persist the default currency data as currency (Bot Context) with the following JavaScript code:
```
var defaultCurrency = { TODO Custom JavaScript for location-based currency }
BotContext.put('currency', defaultCurrency, 200000);
```
UserContext – A key/value pair available to all bots for a user. These keys are read-only and provided by the system as user data for:
- - UserContext.get(“_id”) – The Kore.ai user ID.
  - UserContext.get(“emailId”) – The email address associated with the user ID.
  - UserContext.get(“lastName”) – The last name of the user.
  - UserContext.get(“firstName”) – The first name of the user.
  - UserContext.get(“profImage”) – The image or avatar filename of the user.
  - UserContext.get(“profColor”) – The account color for the user.
  - UserContext.get(“activationStatus”) – The account status of the user. Can be:
    - active – The user is active and can interact with other Kore.ai users.
    - inactive – The user is not active, but user data is retained in the system.
    - suspended – The user is suspended by an administrator. The user cannot log on to Kore.ai, however, messages can still be sent to the suspended user.
    - locked – The user exceeded the maximum number of login attempts.
  - UserContext.get(“jTitle”) – The title of the user, if defined.
  - UserContext.get(“orgId”) – The organizational ID of the user account, if defined.
  - UserContext.get(“customData”) – Use this to pass user information to web channels, currently only for webSDK, see here for more.
  - UserContext.get(“identities”) – Alternate user IDs, if defined.
    - val – The alternate ID
    - type – The type of alternate ID.
For example, you can PUT a value into the session using the UserSession variable where the key is defined as fullName based on the GET from the two UserContext variables.
```
var name = UserContext.get("firstName")+UserContext.get("lastName");
UserSession.put("fullName") = name;
```
UserSession – A key/value pair that you can define for this specific user for all bots in an enterprise. For example, you may want to store a user location to make it available to all Bots, such as a user home address for commerce, transportation, and home delivery services. For example, you can persist default location data as HomeLocation (UserSession) with the following JavaScript code:
```
var location = {
 "title": labels[location],
 "value": {
 "latitude": location.latitude,
 "longitude": request.location.longitude
 }
};
UserSession.put('HomeLocation', location, '20000');
```
BotUserSession – A key/value pair that you can define to a specific bot based on the inputs by a specific user. For example, you may want to persist a user location for more than one task of a Bot. For a travel bot, the user may be able to book a flight and a hotel based on the same home and destination addresses. For example, you can persist the default home and destination data as HomeLocation (BotUserSession) and DestinationLocation (BotUserSession) with the following JavaScript code:
```
var homelocation = {
 "title": labels[request.sourceLocation],
 "value": {
 "latitude": request.sourceLocation.latitude,
 "longitude": request.sourceLocation.longitude
 }
};
BotUserSession.put('HomeLocation', homelocation, '20000');
var destlocation = {
 "title": labels[request.destLocation],
 "value": {
 "latitude": request.destLocation.latitude,
 "longitude": request.destLocation.longitude
 }
};
BotUserSession.put('DestinationLocation', destlocation, '20000’);
```

Standard Keys

In addition to session and context keys, there are Kore.ai variable placeholders for reusable data. Select one of:

_labels_ – Used to return the friendly label in place of a GUID. For example, when user data is requested from a web service API, the ID of a project or workspace returned is a GUID. You can use the _labels_ key to show the user-friendly name of the GUID to the end-user instead of the GUID. In Kore.ai, a drop-down control stores the response for the _labels_ key as, for example:

{
    "_labels_": {
        "15379386734832": "roadlabs.com",
        "26377329985341": "Test Project",
        "workspace": "roadlabs.com",
        "project": "Test Project"
    },
    "_fields_": {
        "workspace": "15379386734832",
        "project": "26377329985341"
    }
}

To use the _labels_ key in a response:

print('<a href="https://app.asana.com/0/' + workspace.id + '/' + id + '/f" target="_blank">' + title + '</a> in workspace '+_labels_[workspace.id]);

_tenant_ – Used to return the tenant for the enterprise when defined. For example, JIRA requires a tenant for URLs, such as koreteam, in https://koreteam.atlassian.net/browse/BBF-3265. You can use the _tenant_ key to build a link in a task response such as:
```
var title = request.fields.issuetype.name + ' <a href ="https://' + _tenant_ + '/browse/' + response.key + '" target = "_blank">' + request.fields.summary + '</a>  has been created.';
```
_fields_ – Used to return an action task field input provided by the end-user that is not part of a payload response. For example, in a JIRA action task, the end-user is prompted to enter a workspace name. You can use the _fields_ key to store the end-user input as:
```
_fields_["workspace"]
```
_last_run – Used to return the UTC date timestamp of a web service poll using ISO 8601 format, for example, 2016-03-05T12:44:38+00:00. For example, if a web service request returns all activity in a payload response, you can use the _last_run key to filter results displayed before or after the value for _last_run.

세션 변수

세션 변수 유형

표준 키

Leave a Reply Cancel reply

セッション変数

セッション変数のタイプ

標準キー

Leave a Reply Cancel reply

Session Variables

Session Variable Types

Standard Keys

Leave a Reply Cancel reply