Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

9 8 0 docs #100

Merged
merged 32 commits into from
Jan 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
6cd1523
transfer ownership api update
ShashiSubramanya Nov 24, 2023
81ee5dc
broken link fix
ShashiSubramanya Nov 21, 2023
a62d502
api doc fixes
ShashiSubramanya Nov 27, 2023
b39dd11
9-8-0-updates
ShashiSubramanya Dec 11, 2023
5fee78b
9-8-0-updates
ShashiSubramanya Dec 12, 2023
913a9c6
playground edits
ShashiSubramanya Dec 13, 2023
d0d9c28
sage playground
ShashiSubramanya Dec 13, 2023
9ddbe02
whats new fix
ShashiSubramanya Dec 13, 2023
3eb2c29
formatting fix
ShashiSubramanya Dec 14, 2023
99b872a
data API updates
ShashiSubramanya Dec 18, 2023
75f773f
search data api and other changes
ShashiSubramanya Dec 19, 2023
e3ecb6c
git repo example and other updates
ShashiSubramanya Dec 20, 2023
6995ab7
example fix and auth updates
ShashiSubramanya Dec 22, 2023
fa99dae
url update
ShashiSubramanya Dec 22, 2023
c07a61c
updated search data info
ShashiSubramanya Dec 22, 2023
1ec70ab
data api edits
ShashiSubramanya Dec 22, 2023
a8bb695
updated logs list
ShashiSubramanya Dec 22, 2023
0eb943c
typo fix
ShashiSubramanya Dec 23, 2023
8c6dc73
link fixes
ShashiSubramanya Dec 23, 2023
993ce4c
SCAL-187304 fix
ShashiSubramanya Jan 1, 2024
6dc205b
SCAL-187304 fix and sage css variables update
ShashiSubramanya Jan 2, 2024
b3b6c0a
text edits
ShashiSubramanya Jan 2, 2024
19e70f0
SCAL-162000 fix
ShashiSubramanya Jan 5, 2024
dc58f4f
9-8-0-updates
ShashiSubramanya Jan 11, 2024
034a12a
org updates
ShashiSubramanya Jan 11, 2024
7fecf47
actions update
ShashiSubramanya Jan 15, 2024
c006916
edits
ShashiSubramanya Jan 15, 2024
3f784db
git ref update
ShashiSubramanya Jan 15, 2024
1dd55dc
answer action edits
ShashiSubramanya Jan 15, 2024
bda6ec1
9-8-0-updates
ShashiSubramanya Jan 23, 2024
8a0a7eb
image addition
ShashiSubramanya Jan 23, 2024
a714473
text edits
ShashiSubramanya Jan 23, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 0 additions & 13 deletions modules/ROOT/pages/admin-api.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -852,13 +852,6 @@ POST /tspublic/v1/admin/embed/actions
|====

=== Example request

Make sure the API request has the following headers:

* the `Accept` header is set as `Accept: application/json`
* the `X-requested-by` header is set as `X-Requested-By: ThoughtSpot`
* the `Content-Type` is set as `application/x-www-form-urlencoded`

.cURL

[source,curl]
Expand Down Expand Up @@ -994,12 +987,6 @@ PUT /tspublic/v1/admin/embed/actions/{actionid}

=== Example request

Make sure the API request has the following headers:

* the `Accept` header is set as `Accept: application/json`
* The `X-requested-by` header as `X-Requested-By: ThoughtSpot`
* The `Content-Type' as `application/x-www-form-urlencoded`

.cURL

[source,curl]
Expand Down
58 changes: 51 additions & 7 deletions modules/ROOT/pages/api-changelog.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,32 @@

This changelog lists only the changes introduced in the Visual Embed SDK. For a complete list of ThoughtSpot Everywhere features and enhancements, see xref:whats-new.adoc[What's New].

== Version 1.27.0, January 2024

[width="100%" cols="1,4"]
|====
|[tag greenBackground]#NEW FEATURE# a|The `SageEmbed` package is now available on all clusters. You can use this SDK package to embed Natural Language Search capabilities and assist users with AI-suggested queries and AI-generated answers. This SDK package also allows you to customize the Natural Language Search experience in the embedded view.

For a complete list of methods, functions, interface objects and properties, see the following pages: +

* xref:SageEmbed.adoc[SageEmbed]
* xref:SageViewConfig.adoc[SageViewConfig]

|[tag orangeBackground]#MODIFIED# a| The `HostEvent.DrillDown` now supports the `vizId` parameter to trigger a drill-down action on a specific visualization of a Liveboard.
For more information, see xref:HostEvent.adoc#_drilldown[DrillDown].
|[tag greenBackground]#NEW FEATURE# a| The new version of the SDK introduces the following new enumeration members:

* Host Events
** `HostEvent.UpdateSageQuery` +
Updates the search query string for Natural Language Search operations.
* Embed Events
** `EmbedEvent.CreateConnection` +
Emitted when a user creates a new data connection on the **Data** page.
** `EmbedEvent.CreateWorksheet` +
Emitted when a user creates a new Worksheet.
|====


== Version 1.26.0, November 2023

[width="100%" cols="1,4"]
Expand Down Expand Up @@ -38,24 +64,33 @@ Embed events::
* `EmbedEvent.SavePersonalisedView`
* `EmbedEvent.ResetLiveboard`
* `EmbedEvent.DeletePersonalisedView`
* `EmbedEvent.SageWorksheetUpdated
* `EmbedEvent.SageEmbedQuery`
+
For more information, see xref:EmbedEvent.adoc[EmbedEvent].

Host events::

* `HostEvent.DeletePersonalisedView`
* `HostEvent.GetTabs`
* `HostEvent.SetVisibleTabs`
* `HostEvent.SetHiddenTabs`
* `HostEvent.GetAnswerSession`
* `HostEvent.UpdateSageQuery`
+
For more information, see xref:HostEvent.adoc[HostEvent].

|[tag greenBackground]#NEW FEATURE# a| The SDK introduces the following action enumeration members:

* `Action.AddTab` +
Show, disable, or hide the **Add Tab** action on a Liveboard.
* `Action.PersonalisedViewsDropdown` +
Show or hide the Liveboard views saved by a user.
Show, disable, or hide the Liveboard views saved by a user.
* `Action.LiveboardUsers` +
Show or hide Liveboard users.
Show, disable, or hide Liveboard users.
* `Action.SageAnswerFeedback`
Show, disable, or hide the feedback widget on AI-generated Answer page.
* `Action.EditSageAnswer`
Show, disable, or hide the **Edit** action on the AI-generated Answer page.

For more information, see xref:Action.adoc[Actions].
|====
Expand Down Expand Up @@ -168,16 +203,25 @@ The following events are deprecated from version 1.21.0 onwards.
You can use the `DownloadAsPng`, `DownloadAsXlsx`, `DownloadAsCsv` and `DownloadAsPdf` events for download actions.

For more information, see xref:embed-events.adoc[Events reference].
|[tag orangeBackground]#MODIFIED# a|The SDK supports omitting or executing a search query in xref:xref:HostEvent.adoc#_search[`HostEvent.Search`].

Starting from 9.2.0.cl release, use the following action enumeration members instead of `Action.Download` to show, hide, or disable the *Download* menu action on an embedded Liveboard, visualization, or Answer:
|[tag orangeBackground]#MODIFIED# a|

Events::
The SDK supports omitting or executing a search query in xref:xref:HostEvent.adoc#_search[`HostEvent.Search`].
Actions::
Use the following action enumeration members instead of `Action.Download` to show, hide, or disable the *Download* menu action on an embedded Liveboard, visualization, or Answer:
+
* `Action.DownloadAsCsv`
* `Action.DownloadAsPdf`
* `Action.DownloadAsXlsx`
* `Action.DownloadAsPng`

For more information, see xref:embed-action-ref.adoc[Action reference].
+
To disable or hide download actions, you can use `Action.Download` in the `disabledActions` and `hiddenActions` arrays respectively. However, if you are using the `visibleActions` array to show or hide actions on a visualization or Answer, include the following download action enumerations along with `Action.Download` in the array: +

** `Action.DownloadAsCsv` +
** `Action.DownloadAsPdf` +
** `Action.DownloadAsXlsx` +
** `Action.DownloadAsPng`

|[tag greenBackground]#NEW FEATURE# a| The SDK includes new attributes to customize the experience for embedded app users:

Expand Down
30 changes: 0 additions & 30 deletions modules/ROOT/pages/app-actions.adoc

This file was deleted.

Loading
Loading