개발의 일부로 특정 개발 단계를 버전으로 표시하려는 경우가 매우 자주 있습니다. 그 이유는 다음과 같이 다양할 수 있습니다.

• 후속 변경 사항으로 진행하기 전에 봇의 버전 생성
• 개선 작업을 계속하면서 완전한 테스트를 거친 버전을 운영 릴리스까지 보존
• 수행된 모든 변경 사항 추적.

새로운 변경 사항이 적용되지 않은 경우, 어떠한 이유로든 이전 상태로 되돌리고 싶을 것입니다.

개요

Kore.ai의 봇 버전 옵션은 위의 요구 사항을 충족하도록 특별히 설계되었습니다. 이 옵션을 사용하면, 봇 개발자는 다음을 수행할 수 있습니다.

• 여러 버전의 봇 정의 생성
• 봇에 대해 사용 가능한 모든 버전 확인 및 관리, 및
• 봇을 이전 버전으로 복원.

버전 관리는 표준 봇과 범용 봇에서 지원됩니다. 이 옵션은 상단 메뉴의 배포 탭에서 왼쪽 메뉴 옵션 봇 관리 -> 봇 버전을 통해 접근할 수 있습니다.

유형

버전 유형은 봇 버전이 생성되는 방법을 기반으로 합니다.

• 사용자가 생성됨: 이 버전은 봇 개발자가 생성한 것입니다.
  • 과정은 여기를 참조하세요.
  • 생성될 사용자가 생성한 버전의 최대 수는 20개로 설정됩니다. 이 제한에 도달하면 새 버전이 생성되고 가장 오래된 버전이 삭제됩니다.
• 자동 생성됨: 이 버전은 봇 게시 주기의 일부로 생성됩니다.
  • 봇을 게시할 때마다, 플랫폼은 자동으로 버전을 생성합니다.
  • 이 자동 버전에는 현재 게시 요청이 수락된 후 봇의 복사본의 정의가 포함됩니다.
  • 게시 요청이 거부된 경우, 버전이 생성되지 않습니다.
  • 이 버전은 삭제할 수 없습니다.
  • 자동 버전 생성이 진행 중인 동안에는, 후속 게시 요청을 제기할 수 없습니다.
  • 생성될 자동 버전의 최대 수는 20개로 설정됩니다. 이 제한에 도달하면 새 버전이 생성되고 가장 오래된 버전이 삭제됩니다.

생성

다음은 버전을 생성하는 단계입니다.

1. 봇 버전 페이지에서, 버전 생성 버튼을 클릭합니다.
2. 다음을 입력하라는 메시지가 표시됩니다.
   • 버전 이름 – 봇의 주요 기능을 이상적으로 파악할 수 있는 고유한 이름을 입력합니다.
   • 설명 – 이 버전에 적용된 변경 사항을 간략하게 추가합니다.
3. 완료되면 버전 생성을 클릭합니다. 봇 버전이 생성되었습니다.

조치

봇 버전 목록 페이지에서 수행할 수 있는 조치는 다음과 같습니다.

1. 봇 버전 페이지에는, 봇의 모든 버전 목록이 표시됩니다.
2. 각 버전에 대해 다음을 볼 수 있습니다.
   • 버전의 이름
   • 버전의 설명
   • 봇이 생성된 플랫폼 버전
   • 생성일 – 봇 생성 타임 스탬프
   • 생성자 – 봇을 생성한 사용자.
3. 각 버전에서 다음 조치를 수행할 수 있습니다.
   • 특정 버전으로 복원
   • 특정 버전으로 내보내기
   • 특정 버전 삭제(자동 버전에는 적용되지 않음).
4. 버전을 비교하여 변경 사항을 추적할 수 있습니다.

버전 복원

모든 버전에 대해 복원 옵션을 사용하면, 봇의 ‘개발 중’ 버전을 해당 버전에 존재하는 정의로 대체할 수 있습니다. 복원은 봇 호환성 버전을 준수하며 호환되지 않는 버전 복원은 거부합니다.

복원 작동 방식

각 봇 구성 요소에 대한 버전 복원을 처리하는 방법은 다음과 같습니다. 작업: 다음 규칙은 대화 작업, 조치 / 알림 / 정보 작업, 스몰 토크(언어별), UI 양식, 패널 및 위젯에 적용됩니다

• 봇에 하나 이상의 추가 작업이 있고, 복원 버전 정의에 이러한 작업이 없는 경우, 이 작업은 플랫폼에서 암시적으로 '삭제됨'으로 표시됩니다.
• 이러한 ‘삭제된’ 작업은 봇 개발에 사용할 수 없으며 복원 후 첫 번째 게시 요청 중에 봇의 게시된 사본에서 자동으로 삭제됩니다. 게시 요청에서 이러한 삭제 요청을 제외할 수 없습니다.
• 작업이 삭제된 후 이러한 삭제된 작업이 포함된 버전을 복원하는 경우, 작업은 같은 이름의 새 작업으로 포함되며 원래(삭제된) 작업은 게시 로그에서 계속 삭제된 것으로 표시됩니다.
• 게시된 봇을 미게시된 상태로 복원한 경우 봇 가져오기가 제한될 수 있습니다.

지식 그래프: 다음 규칙은 지식 작업(언어별)에 적용됩니다

• 봇에 하나 이상의 추가 FAQ가 있고, 복원 버전 정의에 이러한 작업이 없는 경우, 이 작업은 플랫폼에서 암시적으로 '삭제됨'으로 표시됩니다.
• 이러한 ‘삭제된’ 작업은 봇 개발에 사용할 수 없습니다
• 이러한 FAQ는 게시 요청 중 해당 부모 노드가 게시를 위해 선택된 경우에만 게시된 사본에서 삭제됩니다
• 해당 상위 노드가 게시를 위해 선택되지 않은 경우, 이러한 FAQ는 게시된 사본에 존재하지만 개발 중인 사본에서는 삭제된 것으로 간주됩니다
• 작업이 삭제된 후 이러한 삭제된 작업이 포함된 버전을 복원하는 경우, 작업은 같은 이름의 새 작업으로 포함되며 원래(삭제된) 작업은 게시 로그에서 계속 삭제된 것으로 표시됩니다.

스몰 토크: 다음 규칙은 스몰 토크(언어별)에 적용됩니다

• 봇에 하나 이상의 추가 Q&A가 있고, 복원 버전 정의에 이러한 작업이 없는 경우, 이 작업은 플랫폼에서 암시적으로 '삭제됨'으로 표시됩니다.
• 이러한 ‘삭제된’ 작업은 봇 개발에 사용할 수 없습니다
• 이러한 Q&A는 게시 요청 중 스몰 토크가 게시를 위해 선택된 경우에만 게시된 사본에서 삭제됩니다

언어

• 복원 버전 정의에 존재하지 않는 하나 이상의 추가 언어가 봇 정의에 있는 경우, 이러한 언어는 봇의 설정된 버전에서 ‘삭제된’ 것으로 간주됩니다.
• 이러한 ‘삭제된’ 언어는 봇 개발에 사용할 수 없습니다
• 언어 삭제는 복원 후 봇의 후속 게시 후 게시된 사본에 반영됩니다

채널

• 채널은 봇 정의에 포함되지 않으므로 봇은 버전 관리의 일부입니다. 즉, 현재 채널 활성화는 버전 복원 시 변경되지 않습니다.
• 한 가지 예외는 Webhook 채널입니다. 현재 버전의 웹 채널 설정은 복원된 버전의 웹 채널 설정으로 대체됩니다.

봇 관리

• 봇 가져오기는 복원된 버전이 게시될 때까지 허용되지 않습니다.

버전 비교

버전 비교 기능을 사용하면 동일한 봇의 다른 버전 간 차이점을 이해할 수 있습니다. 다음에 도움이 됩니다.

• 게시된 버전을 이전 버전과 비교하여 최근에 게시된 버전에서 이슈를 디버그합니다.
• 게시 전에 변경 사항을 분석합니다. 개발자는 봇의 개발 중인 버전과 게시된 버전을 비교하여 변경 사항의 스냅샷을 찍을 수 있습니다.
• 버전 복원 이전(또는 이후)에 영향 분석을 수행합니다. 개발자는 두 버전을 비교하여 버전 복원의 영향을 더 잘 이해할 수 있습니다.
• NLP/NLU의 변경 사항을 분석합니다. NLP 트레이너는 두 가지 버전으로 제시되는 학습을 비교하여 봇의 NLP 성능 변화를 분석할 수 있습니다.

모든 버전에 대해 비교 옵션을 사용하면, 두 버전의 봇을 비교하여 봇 정의에 적용된 변경 사항 목록을 두 버전 사이에서 검토할 수 있습니다. 봇 버전을 비교하려면, 아래 단계를 따르세요.

1. 봇 버전페이지에서, 봇 버전 목록을 확인할 수 있습니다.
2. 비교하려는 봇 버전 위로 마우스를 올린 다음 비교를 클릭합니다.
3. 비교할 다른 버전 선택 창에서, 선택한 봇 버전(기본)과 다른 버전(대상)이 포함된 목록을 확인할 수 있습니다. 비교할 봇 버전을 목록에서 선택합니다.
4. 진행을 클릭합니다.
5. 버전 비교 페이지에서, 다음과 같이 분류된 비교 세부 정보를 확인할 수 있습니다.
   • 작업
   • 교육 
   • 인텔리전스
   • 설정
   • 변경 로그
6. 다음 정보는 개발자에게 JSON 형식으로 강조 표시됩니다.
   • 데이터 추가 – 주 버전에 새로 추가된 데이터는 강조 표시되지만, 기본 버전에서는 강조 표시되지 않습니다.
   • 데이터 삭제 – 기본 버전에서 삭제된 데이터는 강조 표시되지만, 보조 버전에서는 강조 표시되지 않습니다.
   • 데이터 업데이트 – 키-값 쌍의 경우, 값이 다른 두 버전에서 동일한 키는 강조 표시됩니다. 
   • 데이터 추가 및 삭제의 경우, 새로운 줄의 위치를 파악하기 위해 해당 세부 정부가 누락된 버전에 빈 줄이 표시됩니다.

   

7. 전체 변경 사항의 요약 개수가 표시되며 검색이 지원됩니다.

多くの場合開発の一環として、開発の特定の段階をバージョンとしてマークしたい場合があります。理由は次のようにさまざまです。

• 次の変更に進む前に、ボットのバージョンを作成する。
• 拡張作業を継続しながら、完全にテストされたバージョンを製品リリースまで保持する。
• 行われたすべての変更を追跡する。

何らかの理由で新しい変更が機能しない場合は、以前の状態に戻したい場合があります。

概要

Kore.aiのボットバージョンオプションは、上記の要件を満たすように特別に設計されています。このオプションを使用すると、ボット開発者は次のことができます。

• ボット定義の複数のバージョンを作成する。
• ボットで利用可能なすべてのバージョンを表示および管理する。
• ボットを以前のバージョンに復元する。

バージョン管理は、標準ボットとユニバーサルボットでサポートされています。このオプションには、トップメニューのデプロイタブの左側のメニューオプションボット管理->ボットバージョンからアクセスできます。

タイプ

バージョンタイプは、ボットバージョンの作成方法に基づいています。

• ユーザーが作成：これらのバージョンは、ボット開発者としてあなたが作成したものです
  • プロセスについては、以下を参照してください。
  • ユーザーによって作成されるバージョンの最大数は20に設定されています。この制限に達すると、新しいバージョンが作成された場合、最も古いバージョンが削除されます
• 自動で作成：これらのバージョンは、ボットの公開サイクルの一部として作成されます。
  • プラットフォームはボットを公開するたびにバージョンを自動的に作成します。
  • この自動バージョンには、現在の公開リクエストが受け入れられた後のボットの公開コピーの定義が含まれています。
  • 公開リクエストが拒否された場合、バージョンは作成されません。
  • これらのバージョンは削除できません。
  • 自動バージョンの作成が進行中の間は、後続の公開リクエストを発行することはできません。
  • 自動で作成されるバージョンの最大数は20に設定されています。この制限に達すると、新しいバージョンが作成された場合、最も古いバージョンが削除されます

作成

以下は、バージョンを設定するステップです。

1. ボットバージョンページで、バージョンの作成ボタンをクリックします。
2. 次のように入力するように求められます。
   • バージョン名―ボットの主要な機能のアイデアを分かり易く与える一意の名前を入力します。
   • 説明―このバージョンに加えられた変更を簡単に追加します。
3. 完了したら、バージョンの作成をクリックします。ボットのバージョンが作成されました。

アクション

ボットのバージョンリストページから実行できるアクションは次のとおりです。

1. ボットバージョンページに、ボットのすべてのバージョンのリストが表示されます。
2. 各バージョンについて、以下を表示できます。
   • バージョンの名前
   • バージョンの説明
   • このボットバージョンが作成されたプラットフォームバージョン
   • 作成日―バージョン作成タイムスタンプ
   • 作成者―バージョンを作成したユーザー。
3. 各バージョンで実行できるのは次のアクションです。
   • 特定のバージョンに復元
   • 特定のバージョンにエクスポート
   • 特定のバージョンを削除（自動バージョンには適用されません）。
4. バージョンを比較して変更を追跡できます。

バージョンの復元

任意のバージョンに対して復元オプションを使用すると、ボットの現在の「開発中」バージョンをそのバージョンに存在する定義に置き換えることができます。復元はボットの互換性のあるバージョンに限定し、互換性のないバージョンの復元を拒否します。

復元の仕組み

以下は、各ボットコンポーネントに対するバージョン復元の処理方法です。タスク：次のルールはダイアログタスク、アクション／アラート／情報タスク、スモールトーク（言語ごと）、UIフォーム、パネル、およびウィジェットに適用されます。

• ボットにいくつかの追加タスクがあり、それらが復元バージョン定義に存在しない場合、これらのタスクはプラットフォームで暗黙的に「削除済み」としてマークされます。
• これらの「削除済み」タスクはボット開発には使用できず、復元後の最初の公開リクエスト中にボットの公開済みコピーから自動的に削除されます。これらの削除リクエストを公開リクエストから除外することはできません。
• これらの削除されたタスクを含むバージョンを復元すると、それらは同じ名前の新しいタスクとして含まれ、元の（削除された）タスクは引き続き公開ログで削除済みとしてマークされます。
• 公開されたボットを未公開の状態に復元した場合、ボットのインポートが制限される場合があります。

ナレッジグラフ：次のルールがナレッジタスクに適用されます（言語ごと）

• ボットにいくつかの追加FAQがあり、それらが復元バージョン定義に存在しない場合、これらのタスクはプラットフォームで暗黙的に「削除済み」としてマークされます。
• これらの「削除された」タスクは、ボット開発では利用できません
• これらのFAQは公開リクエスト中に、対応する親ノードが公開用に選択された場合にのみ、公開されたコピーから削除されます
• 対応する親ノードが公開用に選択されていない場合、それらのFAQは公開済みコピーに表示されますが、開発中のコピーでは削除されたと見なされます
• これらの削除されたタスクを含むバージョンを復元すると、それらは同じ名前の新しいタスクとして含まれ、元の（削除された）タスクは引き続き公開ログで削除済みとしてマークされます。

スモールトーク：次のルールがスモールトークに適用されます（言語ごと）

• ボットにいくつかの追加QnAsがあり、それらが復元バージョン定義に存在しない場合、これらのQnAsはプラットフォームで暗黙的に「削除済み」としてマークされます。
• これらの「削除された」タスクは、ボット開発では利用できません
• これらのQnAsは公開リクエスト中に、スモールトークが公開用に選択された場合にのみ、公開されたコピーから削除されます

言語

• ボット定義にいくつかの追加の言語があり、それらが復元バージョン定義に存在しない場合、これらの言語はボットの構成済バージョンから「削除済み」と見なされます。
• これらの「削除された」言語は、ボット開発では利用できません
• 言語の削除は、復元後のボットの公開後に公開されたコピーに反映されます

チャネル

• チャネルはボット定義の一部ではないため、バージョン管理の一部にはなりません。現在のチャネルの有効化は、バージョンの復元時に変更されません。
• 1つの例外はWebhookチャネルです。現在のバージョンのWebチャネル構成は、復元されたバージョンのWebチャネル構成に置き換えられます。

ボット管理

• 復元されたバージョンが公開されるまで、ボットのインポートは許可されません。

バージョン比較

バージョン比較機能を使用すると、同じボットの異なるバージョン間の違いを理解できます。それは次のことに役立ちます。

• 最近公開されたバージョンの問題を、公開済の以前のバージョンのいずれかと比較してデバッグします。
• 公開する前に変更を分析します。開発者は、開発中のボットのバージョンと公開されたバージョンのコピーを比較することで、変更のスナップショットを撮ることができます。
• バージョン復元の前（または後）に影響分析を実行します。開発者は2つのバージョンを比較することで、バージョン復元の影響をよりよく理解できます。
• NLP/NLUの変化を分析します。NLPトレーナーは2つのバージョンに存在するトレーニングを比較することにより、ボットのNLPパフォーマンスの変化を分析できます。

比較オプションを使って任意のバージョンと比較すると、ボットの任意の2つのバージョン間でボット定義に加えられた変更のリストをレビューできます。ボットバージョンの比較には、以下の手順に従います。

1. ボットバージョンページで、ボットバージョンのリストを見つけることができます。
2. 比較するボットのバージョンにカーソルを合わせ、比較をクリックします。
3. 比較する別のバージョンの選択ウィンドウで、ボットの選択されたバージョン（ベース）と、さまざまなバージョン（ターゲット）を含むリストを表示することができます。比較するボットのバージョンをリストから選択します。
4. 続行をクリックします。
   
5. バージョンの比較ページで、次のように分類された比較の詳細を見つけることができます。
   • タスク
   • トレーニング 
   • インテリジェンス
   • 設定
   • 変更ログ
6. 次の情報は、JSON形式で開発者に強調表示されます。
   • データの追加―セカンダリバージョンで新しく追加されたデータは強調表示されますが、プライマリバージョンでは強調表示されません。
   • データの削除―プライマリバージョンから削除されたデータは強調表示されますが、セカンダリバージョンでは強調表示されません。
   • データの更新―キーと値のペアの場合、両方のバージョンに値が異なる同じキーが存在すると強調表示されます。 
   • データの追加と削除の場合、新しい行の位置を明確にするために、対応する詳細が欠落しているバージョンでは空の行が表示されます。

   

7. 合計変更の要約カウントが表示され、検索をサポートします。

Very often, as part of the development, you may want to mark specific stages of development as versions. The reasons could be as varied as:

• creating a version of the bot before proceeding to subsequent changes;
• to preserve a fully tested version till the production release while continuing to work on enhancements;
• to keep track of all the changes made.

If the new changes are not working out, for any reason, then you would want to revert back to the previous state.

Overview

Kore.ai’s Bot Versions option is specifically designed to meet the above requirements.

Using this option, you as a bot developer can:

• create multiple versions of the bot definition;
• view and manage all versions available for the bot; and
• restore the bot to a previous version.

Versioning is supported in Standard and Universal Bots.

This option can be accessed from the Deploy tab from the top menu, under the left menu option Bot Management -> Bot Versions.

Types

The version type is based on the ways in which a Bot version is created:

• User Created: These versions are created by you as Bot Developer
  • See below for the process.
  • The maximum number of user-created versions that will be created is set to 20. Once this limit is reached new version will be created and the oldest versions are deleted.
• Auto Created: These versions are created as part of the bot Publish cycle.
  • Whenever you publish a bot, the platform creates a version automatically.
  • This auto version includes the definition of the published copy of the bot after the current publish request is accepted.
  • In case the publish request is rejected, the version will not be created.
  • You cannot delete these versions.
  • While an auto-version creation is in-progress, you cannot raise any subsequent publish requests.
  • The maximum number of auto-versions that will be created is set to 20. Once this limit is reached new version will be created and the oldest versions are deleted.

Creation

Following are the steps to create a version:

1. From the Bot Versions page, click the Create Version button.
2. You will be prompted to enter:
   • Version Name – enter a unique name that would ideally give an idea of a major feature of the Bot.
   • Description – add in brief the changes that went into this version.
3. Click Create Version when done. Your bot version is created.

Actions

Following are the actions you can perform from the bot version listing page:

1. On the Bot Versions page, you will see a list of all versions of the bot.
2. For each version you can view:
   • Name of the versions
   • Description of the version
   • Platform Version where this bot version was created
   • Created on – the version creation timestamp
   • Created by – the user who created the version.
3. You can perform the following actions on each version:
   • Restore to a specific version;
   • Export a specific version;
   • Delete a specific version (not applicable for auto-versions).
4. You can Compare versions to track changes.

Version Restoration

Using the Restore option against any version, you can replace the current ‘in-development’ version of the bot with the definition present in that version. The restoration honors the bot compatibility versions and will reject any non-compatible version restorations.

How restoration works

The following is how version restore is handled for each of the Bot components:

Tasks:

The following rules apply to Dialog Tasks, Action / Alert / Information Tasks, Small Talk (per language), UI Forms, Panels and Widgets

• If there are one or more additional tasks in the bot, and if these are not present in the restoration version definition, then these tasks will be implicitly marked as ‘Deleted’ in the platform.
• These ‘Deleted’ tasks will not be available for the bot development and they will automatically be removed from the Published copy of the bot during the first publish request post-restoration. You will not be allowed to exclude these delete requests from the publish requests.
• Once deleted if you restore a version that contains these deleted tasks they will be included as new tasks with the same name and the original (deleted) tasks will still be marked as deleted in the Publish logs.
• If you have restored a published bot to an unpublished state then bot import might be restricted.

Knowledge Graph:

The following rules apply to Knowledge Tasks (per Language)

• If there are one or more additional FAQs in the bot, and if these are not present in the restoration version definition, then these tasks will be implicitly marked as ‘Deleted’ in the platform.
• These ‘Deleted’ tasks will not be available for the bot development
• These FAQs will be removed from published copy only if the corresponding parent nodes are selected for publishing during the publish request
• If the corresponding parent nodes are not selected for publishing, then those FAQs will be present in the Published copy but considered as deleted in the in-development copy
• Once deleted if you restore a version that contains these deleted tasks they will be included as new tasks with the same name and the original (deleted) tasks will still be marked as deleted in the Publish logs.

Small Talk:

The following rules apply to Small Talk (per Language)

• If there are one or more additional QnAs in the bot, and if these are not present in the restoration version definition, then these tasks will be implicitly marked as ‘Deleted’ in the platform.
• These ‘Deleted’ tasks will not be available for the bot development
• These QnAs will be removed from published copy only if Small Talk is selected for publishing during the publish request

Languages

• If there are one or more additional languages in the bot definition which are not present in the restore version definition, then such languages will be considered as ‘deleted’ from the configured version of the bot.
• These ‘deleted’ languages will not be available for bot development
• The language deletion will get reflected in the published copy after the subsequent publishing of the bot post-restoration

Channels

• Channels are not part of bot definition and as such will bot be part of versioning ie. the current channel enablement will not change on version restoration.
• One exception is the Webhook channel. The web channel configuration of the current version will be replaced by that of the restored version.

Bot Management

• Bot Import will not be allowed until the restored version is published.

Version Compare

The Version Comparison feature allows you to understand the differences between different versions of the same bot. It helps to:

• Debug issues in the recently published version by letting them compare the published version with any of the previous versions.
• Analyze changes before Publish. The developer can take a snapshot of changes by comparing a copy of the in-development version and the published version of the bot.
• Perform Impact Analysis before (or after) Version Restore. The developer can get a better understanding of the impact of version restoration by comparing the two versions.
• Analyze changes in NLP/NLU. NLP trainers can analyze the change in the bot’s NLP performance by comparing the training present in two versions.

Using the Compare option against any version, you can compare any two versions of your bot to review the list of changes made to the bot definition between the two versions.

To compare bot versions, follow the below steps:

1. On the Bot Versions page, you can find the list of your bot versions.
2. Hover over the bot version you want to compare and click Compare.
3. On the Select Another Version to Compare window, you can find the selected version (base) of your bot and a list that contains different versions (target). Select a bot version from the list to compare.
4. Click Proceed.
   
5. On the Version Comparison page, you can find the comparison details categorized into:
   • Tasks
   • Training 
   • Intelligence
   • Settings
   • Change Logs
6. The following information is highlighted to the developer in a JSON format:
   • Data addition – Newly added data in the secondary version is highlighted, but not in the primary version.
   • Data removal – Data deleted from the primary version is highlighted, but not in the secondary version.
   • Data update – In the case of key-value pairs, the same key present in both versions with different values is highlighted. 
   • For data addition and removal, an empty line is shown in the version where the corresponding detail is missing to understand the position of the new line.

   

7. A summary count of the total changes is displayed and supports search.