Skip to content

Commit 58464c2

Browse files
spotter-coaching terminology udpate
1 parent 4e645be commit 58464c2

6 files changed

Lines changed: 30 additions & 26 deletions

File tree

modules/ROOT/pages/api-changelog.adoc

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -328,13 +328,13 @@ For more information, see xref:embed-spotter.adoc[Embedding Spotter] and xref:em
328328

329329
Events::
330330

331-
* `EmbedEvent.AddToCoaching` for the *Add to coaching* workflow in a Spotter conversation session
332-
* `HostEvent.AddToCoaching` to trigger the *Add to coaching* action in a Spotter conversation session.
331+
* `EmbedEvent.AddToCoaching` for the *Add to Coaching* workflow in a Spotter conversation session
332+
* `HostEvent.AddToCoaching` to trigger the *Add to Coaching* action in a Spotter conversation session.
333333
* `HostEvent.StartNewSpotterConversation` to trigger the action to start a new chat session with Spotter.
334334

335335
[NOTE]
336336
====
337-
On Spotter embed deployments running version 26.2.0.cl or later, the *Add to Coaching* feature is enabled by default. To disable or hide the **Add to Coaching** button, use the xref:Action.adoc#_inconversationtraining[InConversationTraining] action ID.
337+
On Spotter embed deployments running version 26.2.0.cl or later, the *Add to Coaching* feature is enabled by default. To disable or hide the *Add to Coaching* button, use the xref:Action.adoc#_inconversationtraining[InConversationTraining] action ID.
338338
====
339339

340340
|[tag greenBackground]#NEW FEATURE# a| **Liveboard experience enhancements** +
@@ -596,11 +596,12 @@ Replaced with `SpotterAgentEmbed`
596596
Replaced with `SpotterAgentEmbedViewConfig`
597597

598598
The deprecated components with old names in the existing Spotter embed implementations will continue to function until further notice. For code samples with new component names, see xref:embed-spotter.adoc[Spotter embed documentation].
599-
|[tag greenBackground]#NEW FEATURE# a| *Action ID of Spotter coaching* +
600-
For ThoughtSpot instances that have the new Spotter feedback and coaching workflow enabled, SDK provides the action ID `Action.InConversationTraining` to manage the visibility of the *Add to coaching* button on Answer generated from Spotter prompts.
599+
600+
|[tag greenBackground]#NEW FEATURE# a| *Action ID for Spotter in-conversation training* +
601+
For ThoughtSpot instances that have the new Spotter in-conversation training workflow enabled, the SDK provides the action ID `Action.InConversationTraining` to manage the visibility of the *Add to Coaching* button on Answers generated from Spotter prompts.
601602

602603
[NOTE]
603-
The **Add to Coaching** feature is currently in beta and is turned off by default on embed deployments. To enable this feature on your instance, contact ThoughtSpot Support.
604+
The *Add to Coaching* feature is currently in beta and is turned off by default on embed deployments. To enable this feature on your instance, contact ThoughtSpot Support.
604605

605606
|[tag greenBackground]#NEW FEATURE# a|*Events support for Spotter embed*
606607

modules/ROOT/pages/common/nav-rest-api.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ REST APIs
2222
* link:{{navprefix}}/spotter-api[Spotter APIs]
2323
** link:{{navprefix}}/spotter-agent-apis[AI APIs (Spotter Agent and Spotter 3)]
2424
** link:{{navprefix}}/spotter-apis-classic[AI APIs (Spotter Classic) ^BETA^]
25-
** link:{{navprefix}}/spotter-coaching-apis[Spotter coaching APIs ^BETA^]
25+
** link:{{navprefix}}/spotter-nl-instructions[Spotter instructions APIs ^BETA^]
2626
* link:{{navprefix}}/audit-logs[Audit logs]
2727
* link:{{navprefix}}/tml[TML]
2828
* link:{{navprefix}}/collections[Collections ^BETA^]

modules/ROOT/pages/rest-apiv2-changelog.adoc

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -241,11 +241,12 @@ Allows modifying storage configuration for a webhook.
241241
Retrieves storage configuration details.
242242

243243
=== Object privilege APIs
244-
Administrators and users with edit access to data models can now use `/api/rest/2.0/security/metadata/manage-object-privilege` to assign object-level permissions to users and groups and allow access to Spotter coaching information.
244+
Administrators and users with edit access to data models can now use `/api/rest/2.0/security/metadata/manage-object-privilege` to assign object-level permissions to users and groups and control access to Spotter data model instructions.
245245

246246
To fetch object privileges for a data model, user, or group, use the `/api/rest/2.0/security/metadata/fetch-object-privileges` API endpoint.
247247

248-
For more information, see xref:spotter-apis.adoc#_spotter_coaching_access[Spotter coaching access].
248+
For more information, see xref:spotter-nl-instructions.adoc#_spotter_data_model_instructions_access[Spotter data model instructions access].
249+
249250

250251
=== User API enhancements
251252

@@ -321,7 +322,7 @@ The `include_variable_values` parameter in the API request allows including vari
321322
This release introduces the following Spotter APIs:
322323

323324
* `POST /api/rest/2.0/ai/instructions/set` +
324-
Allows configuring natural language (NL) instructions on a model to coach Spotter on how to interpret queries, handle data nuances, and improve responses.
325+
Allows configuring natural language (NL) instructions on a data model to define how Spotter interprets queries, handles data nuances, and improves responses.
325326
* `POST /api/rest/2.0/ai/instructions/get` +
326327
Gets NL instructions that are currently assigned to a model.
327328
* `POST /api/rest/2.0/ai/data-source-suggestions` +

modules/ROOT/pages/spotter-agent-instructions.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
Administrators and developers can configure persistent behavioral instructions for the Spotter agent using the agent instructions APIs. These instructions guide how Spotter responds within a conversation context. For example, to focus on specific business domains, enforce response formats, or apply analytical constraints.
1010

11-
Unlike xref:spotter-nl-instructions.adoc[NL coaching instructions], which operate at the data model level, agent instructions operate at the agent level and do not require a data source identifier.
11+
Unlike xref:spotter-nl-instructions.adoc[data model instructions], which operate at the data model level, agent instructions operate at the agent level and do not require a data source identifier.
1212

1313
[NOTE]
1414
====
@@ -126,7 +126,7 @@ If no instructions are configured, ThoughtSpot returns an empty value for the `i
126126

127127
== Related resources
128128

129-
* For information about coaching Spotter at the data model level, see xref:spotter-nl-instructions.adoc[Spotter coaching APIs].
129+
* For information about adding instructions at the data model level, see xref:spotter-nl-instructions.adoc[Data model instruction APIs].
130130
* For information about Spotter agent conversation workflows, see xref:spotter-agent-apis.adoc[AI APIs (Spotter Agent and Spotter 3)].
131131
* Visit the +++<a href="{{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fai%2Fset-agent-instructions" id="preview-in-playground">REST API v2.0 Playground</a>+++ to test the set agent instructions endpoint.
132132
* Visit the +++<a href="{{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fai%2Fget-agent-instructions" id="preview-in-playground">REST API v2.0 Playground</a>+++ to test the get agent instructions endpoint.

modules/ROOT/pages/spotter-nl-instructions.adoc

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1-
= Spotter instructions API
1+
= Data model instructions API
22
:toc: true
33
:toclevels: 2
44

5-
:page-title: Spotter APIs
6-
:page-pageid: spotter-coaching-apis
7-
:page-description: You can use Spotter REST APIs to receive Answers for your analytical queries sent through the conversational experience with ThoughtSpot.
5+
:page-title: Data model instructions APIs
6+
:page-pageid: spotter-nl-instructions
7+
:page-description: Use the data model instructions APIs to set and retrieve natural language instructions at the data model level to guide how Spotter interprets and answers user queries.
88

9-
Administrators and data owners can guide and refine how Spotter interprets and answers user questions. The natural language (NL) instructions API allows you to set instructions at the data model level. The API provides business context and preferred interpretations for specific queries or terminology to coach Spotter, but it does not train or change the underlying LLM.
9+
Administrators and data owners can guide and refine how Spotter interprets and answers user questions. The natural language (NL) instructions API allows you to set instructions at the data model level. The API provides business context and preferred interpretations for specific queries or terminology, but it does not train or change the underlying LLM.
1010

1111
== Set NL instructions
12-
To coach and instruct the Spotter system on how to interpret queries, apply filters, select columns, handle data nuances, and present answers using the data from a specific model, you can set global rules in natural language format. Setting instructions helps Spotter generate precise and consistent responses for user queries.
12+
To define how Spotter interprets queries, applies filters, selects columns, handles data nuances, and presents answers using the data from a specific model, you can set global rules in natural language format. Setting data model instructions helps Spotter generate precise and consistent responses for user queries.
1313

1414
To set instructions for a Model, send a `POST` request to the `/api/rest/2.0/ai/instructions/set` API endpoint.
1515

@@ -35,7 +35,7 @@ Sets the scope for the rules. By default, the rules are applied globally for all
3535

3636
=== Example request
3737

38-
The following example defines instructions to coach Spotter on how to interpret the query:
38+
The following example defines data model instructions that guide Spotter on how to interpret queries:
3939

4040
[source,cURL]
4141
----
@@ -109,13 +109,14 @@ If the instructions are configured on the Model specified in the API request, Th
109109
}
110110
----
111111

112-
== Spotter coaching access
113112

114-
ThoughtSpot supports publishing Spotter coaching information to other Orgs. Coaching changes from the primary Org are synchronized with the data models published in secondary Orgs.
113+
== Spotter data model instructions access
115114

116-
=== Assign Spotter coaching access privilege
115+
ThoughtSpot supports publishing data model instructions to other Orgs. Data model instruction changes from the primary Org are synchronized with the data models published in secondary Orgs.
117116

118-
To allow users and groups to access spotter coaching information in data models, assign the `SPOTTER_COACHING_PRIVILEGE` via `POST` request to the `/api/rest/2.0/security/metadata/manage-object-privilege` API endpoint.
117+
=== Assign the data model instructions privilege
118+
119+
To allow users and groups to access data model instructions, assign the `SPOTTER_COACHING_PRIVILEGE` via `POST` request to the `/api/rest/2.0/security/metadata/manage-object-privilege` API endpoint.
119120

120121
In the API request, specify the data model, user, and group, and ensure that the object privilege is set to `SPOTTER_COACHING_PRIVILEGE`.
121122

@@ -145,9 +146,10 @@ curl -X POST \
145146

146147
If the request is successful, the API returns the 204 response code.
147148

148-
=== Get a list of users or groups with Spotter coaching privilege
149149

150-
To get a list of users and groups with the Spotter coaching privilege for a specific data model or all data models, send a `POST` request to the `/api/rest/2.0/security/metadata/fetch-object-privileges` API endpoint.
150+
=== Get a list of users or groups with the data model instructions privilege
151+
152+
To get a list of users and groups with the data model instructions privilege (`SPOTTER_COACHING_PRIVILEGE`) for a specific data model or all data models, send a `POST` request to the `/api/rest/2.0/security/metadata/fetch-object-privileges` API endpoint.
151153

152154
In the API request, specify the user or the group for which you want to retrieve the object privilege details.
153155

modules/ROOT/pages/whats-new.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -364,7 +364,7 @@ Administrators and users with edit access to data models can programmatically co
364364

365365
Users and groups with `SPOTTER_COACHING_PRIVILEGE` can import and export coaching TML on data models in the source and destination Orgs where the model is published, and can also share these objects with other users and groups.
366366

367-
For more information, see xref:spotter-apis.adoc#_spotter_coaching_access[Spotter coaching access].
367+
For more information, see xref:spotter-nl-instructions.adoc#_spotter_data_model_instructions_access[Spotter data model instructions access].
368368

369369
---
370370

0 commit comments

Comments
 (0)