10.15.0.cl

sdks/java/README.md

@@ -14,7 +14,7 @@ Add this dependency to your project's POM:
 <dependency>
   <groupId>com.thoughtspot</groupId>
   <artifactId>rest-api-sdk</artifactId>
-  <version>2.19.0</version>
+  <version>2.20.0</version>
   <scope>compile</scope>
 </dependency>
 ```
@@ -29,7 +29,7 @@ Add this dependency to your project's build file:
   }
 
   dependencies {
-     implementation "com.thoughtspot:rest-api-sdk:2.19.0"
+     implementation "com.thoughtspot:rest-api-sdk:2.20.0"
   }
 ```
 

sdks/java/build.gradle

@@ -4,7 +4,7 @@ apply plugin: 'java'
 apply plugin: 'com.diffplug.spotless'
 
 group = 'com.thoughtspot'
-version = '2.19.0'
+version = '2.20.0'
 
 buildscript {
     repositories {

sdks/java/build.sbt

@@ -2,7 +2,7 @@ lazy val root = (project in file(".")).
   settings(
     organization := "com.thoughtspot",
     name := "rest-api-sdk",
-    version := "2.19.0",
+    version := "2.20.0",
     scalaVersion := "2.11.4",
     scalacOptions ++= Seq("-feature"),
     javacOptions in compile ++= Seq("-Xlint:deprecation"),

sdks/java/docs/AiApi.md

@@ -7,11 +7,13 @@ All URIs are relative to *CLUSTER_URL*
 | [**createAgentConversation**](AiApi.md#createAgentConversation) | **POST** /api/rest/2.0/ai/agent/conversation/create |
 | [**createConversation**](AiApi.md#createConversation) | **POST** /api/rest/2.0/ai/conversation/create |
 | [**getDataSourceSuggestions**](AiApi.md#getDataSourceSuggestions) | **POST** /api/rest/2.0/ai/data-source-suggestions |
+| [**getNLInstructions**](AiApi.md#getNLInstructions) | **POST** /api/rest/2.0/ai/instructions/get |
 | [**getRelevantQuestions**](AiApi.md#getRelevantQuestions) | **POST** /api/rest/2.0/ai/relevant-questions/ |
 | [**queryGetDecomposedQuery**](AiApi.md#queryGetDecomposedQuery) | **POST** /api/rest/2.0/ai/analytical-questions |
 | [**sendAgentMessage**](AiApi.md#sendAgentMessage) | **POST** /api/rest/2.0/ai/agent/{conversation_identifier}/converse |
 | [**sendAgentMessageStreaming**](AiApi.md#sendAgentMessageStreaming) | **POST** /api/rest/2.0/ai/agent/converse/sse |
 | [**sendMessage**](AiApi.md#sendMessage) | **POST** /api/rest/2.0/ai/conversation/{conversation_identifier}/converse |
+| [**setNLInstructions**](AiApi.md#setNLInstructions) | **POST** /api/rest/2.0/ai/instructions/set |
 | [**singleAnswer**](AiApi.md#singleAnswer) | **POST** /api/rest/2.0/ai/answer/create |
 
 
@@ -120,6 +122,41 @@ Version: 10.13.0.cl or later
 | **400** | Operation failed |  -  |
 | **500** | Operation failed |  -  |
 
+<a id="getNLInstructions"></a>
+# **getNLInstructions**
+> EurekaGetNLInstructionsResponse getNLInstructions(getNLInstructionsRequest)
+
+
+
+ Version: 10.15.0.cl or later   This API allows users to retrieve existing natural language (NL) instructions for a specific data-model. These instructions guide the AI system in understanding data context and generating more accurate responses when processing natural language queries.  #### Usage guidelines  To retrieve NL instructions for a data-model, the request must include: - &#x60;data_source_identifier&#x60;: The unique ID or name of the data-model to retrieve NL instructions  The API returns a response object with: - &#x60;nl_instructions_info&#x60;: An array of instruction objects, each containing:   - &#x60;instructions&#x60;: Array of text instructions for natural language processing   - &#x60;scope&#x60;: The scope of the instruction (&#x60;GLOBAL&#x60;). It can be extended to data-model-user scope in future.  #### Instructions Scope  - **GLOBAL**: Instructions that apply globally across the system on the given data-model (currently only global instructions are supported)  &gt; ###### Note: &gt; * To use this API, the user needs atleast view access on the data-model and they must use corresponding org related bearerToken where the data-model exists. &gt; * This endpoint is currently in Beta. Breaking changes may be introduced before the endpoint is made Generally Available. &gt; * Available from version 10.15.0.cl and later. &gt; * This endpoint requires Spotter — please contact ThoughtSpot Support to enable Spotter on your cluster. &gt; * Use this API to view currently configured instructions before modifying them with &#x60;setNLInstructions&#x60;.     
+
+### Parameters
+
+| Name | Type |
+|------------- | ------------- |
+| **getNLInstructionsRequest** | [**GetNLInstructionsRequest**](GetNLInstructionsRequest.md)
+
+### Return type
+
+[**EurekaGetNLInstructionsResponse**](EurekaGetNLInstructionsResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Common successful response |  -  |
+| **201** | Common error response |  -  |
+| **400** | Operation failed |  -  |
+| **500** | Operation failed |  -  |
+
 <a id="getRelevantQuestions"></a>
 # **getRelevantQuestions**
 > EurekaGetRelevantQuestionsResponse getRelevantQuestions(getRelevantQuestionsRequest)
@@ -297,6 +334,41 @@ Version: 10.7.0.cl or later
 | **400** | Operation failed |  -  |
 | **500** | Operation failed |  -  |
 
+<a id="setNLInstructions"></a>
+# **setNLInstructions**
+> EurekaSetNLInstructionsResponse setNLInstructions(setNLInstructionsRequest)
+
+
+
+ Version: 10.15.0.cl or later   This API allows users to set natural language (NL) instructions for a specific data-model to improve AI-generated answers and query processing. These instructions help guide the AI system to better understand the data context and provide more accurate responses.  #### Usage guidelines  To set NL instructions for a data-model, the request must include: - &#x60;data_source_identifier&#x60;: The unique ID or name of the data-model for which to set NL instructions - &#x60;nl_instructions_info&#x60;: An array of instruction objects, each containing:   - &#x60;instructions&#x60;: Array of text instructions for the LLM   - &#x60;scope&#x60;: The scope of the instruction (&#x60;GLOBAL&#x60;). Currently only &#x60;GLOBAL&#x60; is supported. It can be extended to data-model-user scope in future.  The API returns a response object with: - &#x60;success&#x60;: Boolean indicating whether the operation was successful  #### Instructions Scope  - **GLOBAL**: Instructions that apply globally for that data-model across the system  &gt; ###### Note: &gt; * To use this API, the user needs either edit access or SPOTTER_COACHING_PRIVILEGE on the data-model and they must use corresponding org related bearerToken where the data-model exists. &gt; * This endpoint is currently in Beta. Breaking changes may be introduced before the endpoint is made Generally Available. &gt; * Available from version 10.15.0.cl and later. &gt; * This endpoint requires Spotter — please contact ThoughtSpot Support to enable Spotter on your cluster. &gt; * Instructions help improve the accuracy and relevance of AI-generated responses for the specified data-model.      
+
+### Parameters
+
+| Name | Type |
+|------------- | ------------- |
+| **setNLInstructionsRequest** | [**SetNLInstructionsRequest**](SetNLInstructionsRequest.md)
+
+### Return type
+
+[**EurekaSetNLInstructionsResponse**](EurekaSetNLInstructionsResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Common successful response |  -  |
+| **201** | Common error response |  -  |
+| **400** | Operation failed |  -  |
+| **500** | Operation failed |  -  |
+
 <a id="singleAnswer"></a>
 # **singleAnswer**
 > ResponseMessage singleAnswer(singleAnswerRequest)

sdks/java/docs/ConnectionConfigurationsApi.md

@@ -52,7 +52,7 @@ All URIs are relative to *CLUSTER_URL*
 
 
 
-  Version: 10.12.0.cl or later   Creates an additional configuration to an existing connection to a data warehouse.    Requires `DATAMANAGEMENT` (**Can manage data**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.  If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) privilege is required.  #### Usage guidelines   * A JSON map of configuration attributes in `configuration`. The following example shows the configuration attributes:   ```    {      \"user\":\"DEV_USER\",      \"password\":\"TestConn123\",      \"role\":\"DEV\",      \"warehouse\":\"DEV_WH\"     }   ```  * If the `policy_type` is `PRINCIPALS`, then `policy_principals` is a required field. * If the `policy_type` is `PROCESSES`, then `policy_processes` is a required field. * If the `policy_type` is `NO_POLICY`, then `policy_principals` and `policy_processes` are not required fields.      
+  Version: 10.12.0.cl or later   Creates an additional configuration to an existing connection to a data warehouse.    Requires `DATAMANAGEMENT` (**Can manage data**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.  If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) privilege is required.  #### Usage guidelines   * A JSON map of configuration attributes in `configuration`. The following example shows the configuration attributes:   ```    {      \"user\":\"DEV_USER\",      \"password\":\"TestConn123\",      \"role\":\"DEV\",      \"warehouse\":\"DEV_WH\"     }   ```  * If the `policy_type` is `PRINCIPALS`, then `policy_principals` is a required field. * If the `policy_type` is `PROCESSES`, then `policy_processes` is a required field. * If the `policy_type` is `NO_POLICY`, then `policy_principals` and `policy_processes` are not required fields.  #### Parameterized Connection Support For parameterized connections that use OAuth authentication, only the same_as_parent and policy_process_options  attributes are allowed in the API request. These attributes are not applicable to connections that are not parameterized.       
 
 ### Parameters
 
@@ -124,7 +124,7 @@ null (empty response body)
 
 
 
-  Version: 10.12.0.cl or later   Updates a connection configuration object.  Requires `DATAMANAGEMENT` (**Can manage data**) and edit permissions to the connection object, or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.  If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) privilege is required.  #### Supported operations This API endpoint lets you perform the following operations in a single API request:   * Edit the name or description of the configuration  * Edit the configuration properties  * Edit the `policy_type`  * Edit the type of authentication  * Enable or disable a configuration   **NOTE**: When updating a configuration where `disabled` is `true`, you must reset `disabled` to `true` in your update request payload. If not explicitly set again, the API will default `disabled` to `false`.       
+  Version: 10.12.0.cl or later   Updates a connection configuration object.  Requires `DATAMANAGEMENT` (**Can manage data**) and edit permissions to the connection object, or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.  If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) privilege is required.  #### Supported operations This API endpoint lets you perform the following operations in a single API request:   * Edit the name or description of the configuration  * Edit the configuration properties  * Edit the `policy_type`  * Edit the type of authentication  * Enable or disable a configuration  #### Parameterized Connection Support For parameterized oauth based connections, only the `same_as_parent` and `policy_process_options` attributes are allowed. These attributes are not applicable to connections that are not parameterized.   **NOTE**: When updating a configuration where `disabled` is `true`, you must reset `disabled` to `true` in your update request payload. If not explicitly set again, the API will default `disabled` to `false`.      
 
 ### Parameters
 

sdks/java/docs/CreateRoleRequest.md

@@ -49,6 +49,7 @@
 | CAN_ACCESS_ANALYST_STUDIO | "CAN_ACCESS_ANALYST_STUDIO" |
 | CAN_MANAGE_ANALYST_STUDIO | "CAN_MANAGE_ANALYST_STUDIO" |
 | PREVIEW_DOCUMENT_SEARCH | "PREVIEW_DOCUMENT_SEARCH" |
+| CAN_MANAGE_VARIABLES | "CAN_MANAGE_VARIABLES" |
 | CAN_MODIFY_FOLDERS | "CAN_MODIFY_FOLDERS" |
 | CAN_VIEW_FOLDERS | "CAN_VIEW_FOLDERS" |
 | CAN_SETUP_VERSION_CONTROL | "CAN_SETUP_VERSION_CONTROL" |

sdks/java/docs/CreateUserGroupRequest.md

@@ -50,6 +50,7 @@
 | CAN_ACCESS_ANALYST_STUDIO | "CAN_ACCESS_ANALYST_STUDIO" |
 | CAN_MANAGE_ANALYST_STUDIO | "CAN_MANAGE_ANALYST_STUDIO" |
 | CAN_MODIFY_FOLDERS | "CAN_MODIFY_FOLDERS" |
+| CAN_MANAGE_VARIABLES | "CAN_MANAGE_VARIABLES" |
 | CAN_VIEW_FOLDERS | "CAN_VIEW_FOLDERS" |
 | PREVIEW_DOCUMENT_SEARCH | "PREVIEW_DOCUMENT_SEARCH" |
 | CAN_SETUP_VERSION_CONTROL | "CAN_SETUP_VERSION_CONTROL" |

sdks/java/docs/CreateVariableRequest.md

@@ -21,6 +21,7 @@
 | CONNECTION_PROPERTY | "CONNECTION_PROPERTY" |
 | TABLE_MAPPING | "TABLE_MAPPING" |
 | CONNECTION_PROPERTY_PER_PRINCIPAL | "CONNECTION_PROPERTY_PER_PRINCIPAL" |
+| FORMULA_VARIABLE | "FORMULA_VARIABLE" |