Skip to content

Commit e9a6b38

Browse files
fix(wa-v2): add environmentId param to more functions
This commit adds a required environmentId param to the deleteSession function. It also adds the `environments` path parameter to the /message api calls
1 parent e93e650 commit e9a6b38

File tree

2 files changed

+22
-8
lines changed

2 files changed

+22
-8
lines changed

assistant/v2.ts

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -600,6 +600,9 @@ class AssistantV2 extends BaseService {
600600
* **Note:** If you are using the classic Watson Assistant experience, always use the assistant ID.
601601
*
602602
* To find the **assistant ID** in the user interface, open the **Assistant settings** and click **API Details**.
603+
* @param {string} params.environmentId - Unique identifier of the environment. To find the environment ID in the
604+
* watsonx Assistant user interface, open the environment settings and click **API Details**. **Note:** Currently, the
605+
* API does not support creating environments.
603606
* @param {string} params.sessionId - Unique identifier of the session.
604607
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
605608
* @returns {Promise<AssistantV2.Response<AssistantV2.EmptyObject>>}
@@ -608,8 +611,8 @@ class AssistantV2 extends BaseService {
608611
params: AssistantV2.DeleteSessionParams
609612
): Promise<AssistantV2.Response<AssistantV2.EmptyObject>> {
610613
const _params = { ...params };
611-
const _requiredParams = ['assistantId', 'sessionId'];
612-
const _validParams = ['assistantId', 'sessionId', 'signal', 'headers'];
614+
const _requiredParams = ['assistantId', 'environmentId', 'sessionId'];
615+
const _validParams = ['assistantId', 'environmentId', 'sessionId', 'signal', 'headers'];
613616
const _validationErrors = validateParams(_params, _requiredParams, _validParams);
614617
if (_validationErrors) {
615618
return Promise.reject(_validationErrors);
@@ -621,14 +624,15 @@ class AssistantV2 extends BaseService {
621624

622625
const path = {
623626
'assistant_id': _params.assistantId,
627+
'environment_id': _params.environmentId,
624628
'session_id': _params.sessionId,
625629
};
626630

627631
const sdkHeaders = getSdkHeaders(AssistantV2.DEFAULT_SERVICE_NAME, 'v2', 'deleteSession');
628632

629633
const parameters = {
630634
options: {
631-
url: '/v2/assistants/{assistant_id}/sessions/{session_id}',
635+
url: '/v2/assistants/{assistant_id}/environments/{environment_id}/sessions/{session_id}',
632636
method: 'DELETE',
633637
qs: query,
634638
path,
@@ -729,7 +733,7 @@ class AssistantV2 extends BaseService {
729733

730734
const parameters = {
731735
options: {
732-
url: '/v2/assistants/{assistant_id}/sessions/{session_id}/message',
736+
url: '/v2/assistants/{assistant_id}/environments/{environment_id}/sessions/{session_id}/message',
733737
method: 'POST',
734738
body,
735739
qs: query,
@@ -827,7 +831,7 @@ class AssistantV2 extends BaseService {
827831

828832
const parameters = {
829833
options: {
830-
url: '/v2/assistants/{assistant_id}/message',
834+
url: '/v2/assistants/{assistant_id}/environments/{environment_id}/message',
831835
method: 'POST',
832836
body,
833837
qs: query,
@@ -2996,6 +3000,11 @@ namespace AssistantV2 {
29963000
* To find the **assistant ID** in the user interface, open the **Assistant settings** and click **API Details**.
29973001
*/
29983002
assistantId: string;
3003+
/** Unique identifier of the environment. To find the environment ID in the watsonx Assistant user interface,
3004+
* open the environment settings and click **API Details**. **Note:** Currently, the API does not support creating
3005+
* environments.
3006+
*/
3007+
environmentId: string;
29993008
/** Unique identifier of the session. */
30003009
sessionId: string;
30013010
}

test/unit/assistant.v2.test.js

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -892,9 +892,11 @@ describe('AssistantV2', () => {
892892
function __deleteSessionTest() {
893893
// Construct the params object for operation deleteSession
894894
const assistantId = 'testString';
895+
const environmentId = 'testString';
895896
const sessionId = 'testString';
896897
const deleteSessionParams = {
897898
assistantId,
899+
environmentId,
898900
sessionId,
899901
};
900902

@@ -908,12 +910,13 @@ describe('AssistantV2', () => {
908910

909911
const mockRequestOptions = getOptions(createRequestMock);
910912

911-
checkUrlAndMethod(mockRequestOptions, '/v2/assistants/{assistant_id}/sessions/{session_id}', 'DELETE');
913+
checkUrlAndMethod(mockRequestOptions, '/v2/assistants/{assistant_id}/environments/{environment_id}/sessions/{session_id}', 'DELETE');
912914
const expectedAccept = 'application/json';
913915
const expectedContentType = undefined;
914916
checkMediaHeaders(createRequestMock, expectedAccept, expectedContentType);
915917
expect(mockRequestOptions.qs.version).toEqual(assistantServiceOptions.version);
916918
expect(mockRequestOptions.path.assistant_id).toEqual(assistantId);
919+
expect(mockRequestOptions.path.environment_id).toEqual(environmentId);
917920
expect(mockRequestOptions.path.session_id).toEqual(sessionId);
918921
}
919922

@@ -935,11 +938,13 @@ describe('AssistantV2', () => {
935938
test('should prioritize user-given headers', () => {
936939
// parameters
937940
const assistantId = 'testString';
941+
const environmentId = 'testString';
938942
const sessionId = 'testString';
939943
const userAccept = 'fake/accept';
940944
const userContentType = 'fake/contentType';
941945
const deleteSessionParams = {
942946
assistantId,
947+
environmentId,
943948
sessionId,
944949
headers: {
945950
Accept: userAccept,
@@ -1167,7 +1172,7 @@ describe('AssistantV2', () => {
11671172

11681173
const mockRequestOptions = getOptions(createRequestMock);
11691174

1170-
checkUrlAndMethod(mockRequestOptions, '/v2/assistants/{assistant_id}/sessions/{session_id}/message', 'POST');
1175+
checkUrlAndMethod(mockRequestOptions, '/v2/assistants/{assistant_id}/environments/{environment_id}/sessions/{session_id}/message', 'POST');
11711176
const expectedAccept = 'application/json';
11721177
const expectedContentType = 'application/json';
11731178
checkMediaHeaders(createRequestMock, expectedAccept, expectedContentType);
@@ -1431,7 +1436,7 @@ describe('AssistantV2', () => {
14311436

14321437
const mockRequestOptions = getOptions(createRequestMock);
14331438

1434-
checkUrlAndMethod(mockRequestOptions, '/v2/assistants/{assistant_id}/message', 'POST');
1439+
checkUrlAndMethod(mockRequestOptions, '/v2/assistants/{assistant_id}/environments/{environment_id}/message', 'POST');
14351440
const expectedAccept = 'application/json';
14361441
const expectedContentType = 'application/json';
14371442
checkMediaHeaders(createRequestMock, expectedAccept, expectedContentType);

0 commit comments

Comments
 (0)