Skip to content

fix(wa-v2): add environmentId param to more functions #1246

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.

Sign up for GitHub

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

Merged
apaparazzi0329 merged 1 commit into from
Oct 7, 2025
+22 −8
Merged

fix(wa-v2): add environmentId param to more functions #1246

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 14 additions & 5 deletions assistant/v2.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -600,6 +600,9 @@ class AssistantV2 extends BaseService {
* **Note:** If you are using the classic Watson Assistant experience, always use the assistant ID.
*
* To find the **assistant ID** in the user interface, open the **Assistant settings** and click **API Details**.
* @param {string} params.environmentId - Unique identifier of the environment. To find the environment ID in the
* watsonx Assistant user interface, open the environment settings and click **API Details**. **Note:** Currently, the
* API does not support creating environments.
* @param {string} params.sessionId - Unique identifier of the session.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<AssistantV2.Response<AssistantV2.EmptyObject>>}
Expand All @@ -608,8 +611,8 @@ class AssistantV2 extends BaseService {
params: AssistantV2.DeleteSessionParams
): Promise<AssistantV2.Response<AssistantV2.EmptyObject>> {
const _params = { ...params };
const _requiredParams = ['assistantId', 'sessionId'];
const _validParams = ['assistantId', 'sessionId', 'signal', 'headers'];
const _requiredParams = ['assistantId', 'environmentId', 'sessionId'];
const _validParams = ['assistantId', 'environmentId', 'sessionId', 'signal', 'headers'];
const _validationErrors = validateParams(_params, _requiredParams, _validParams);
if (_validationErrors) {
return Promise.reject(_validationErrors);
Expand All @@ -621,14 +624,15 @@ class AssistantV2 extends BaseService {

const path = {
'assistant_id': _params.assistantId,
'environment_id': _params.environmentId,
'session_id': _params.sessionId,
};

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

const parameters = {
options: {
url: '/v2/assistants/{assistant_id}/sessions/{session_id}',
url: '/v2/assistants/{assistant_id}/environments/{environment_id}/sessions/{session_id}',
method: 'DELETE',
qs: query,
path,
Expand Down Expand Up @@ -729,7 +733,7 @@ class AssistantV2 extends BaseService {

const parameters = {
options: {
url: '/v2/assistants/{assistant_id}/sessions/{session_id}/message',
url: '/v2/assistants/{assistant_id}/environments/{environment_id}/sessions/{session_id}/message',
method: 'POST',
body,
qs: query,
Expand Down Expand Up @@ -827,7 +831,7 @@ class AssistantV2 extends BaseService {

const parameters = {
options: {
url: '/v2/assistants/{assistant_id}/message',
url: '/v2/assistants/{assistant_id}/environments/{environment_id}/message',
method: 'POST',
body,
qs: query,
Expand Down Expand Up @@ -2996,6 +3000,11 @@ namespace AssistantV2 {
* To find the **assistant ID** in the user interface, open the **Assistant settings** and click **API Details**.
*/
assistantId: string;
/** Unique identifier of the environment. To find the environment ID in the watsonx Assistant user interface,
* open the environment settings and click **API Details**. **Note:** Currently, the API does not support creating
* environments.
*/
environmentId: string;
/** Unique identifier of the session. */
sessionId: string;
}
Expand Down
11 changes: 8 additions & 3 deletions test/unit/assistant.v2.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -892,9 +892,11 @@ describe('AssistantV2', () => {
function __deleteSessionTest() {
// Construct the params object for operation deleteSession
const assistantId = 'testString';
const environmentId = 'testString';
const sessionId = 'testString';
const deleteSessionParams = {
assistantId,
environmentId,
sessionId,
};

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

const mockRequestOptions = getOptions(createRequestMock);

checkUrlAndMethod(mockRequestOptions, '/v2/assistants/{assistant_id}/sessions/{session_id}', 'DELETE');
checkUrlAndMethod(mockRequestOptions, '/v2/assistants/{assistant_id}/environments/{environment_id}/sessions/{session_id}', 'DELETE');
const expectedAccept = 'application/json';
const expectedContentType = undefined;
checkMediaHeaders(createRequestMock, expectedAccept, expectedContentType);
expect(mockRequestOptions.qs.version).toEqual(assistantServiceOptions.version);
expect(mockRequestOptions.path.assistant_id).toEqual(assistantId);
expect(mockRequestOptions.path.environment_id).toEqual(environmentId);
expect(mockRequestOptions.path.session_id).toEqual(sessionId);
}

Expand All @@ -935,11 +938,13 @@ describe('AssistantV2', () => {
test('should prioritize user-given headers', () => {
// parameters
const assistantId = 'testString';
const environmentId = 'testString';
const sessionId = 'testString';
const userAccept = 'fake/accept';
const userContentType = 'fake/contentType';
const deleteSessionParams = {
assistantId,
environmentId,
sessionId,
headers: {
Accept: userAccept,
Expand Down Expand Up @@ -1167,7 +1172,7 @@ describe('AssistantV2', () => {

const mockRequestOptions = getOptions(createRequestMock);

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

const mockRequestOptions = getOptions(createRequestMock);

checkUrlAndMethod(mockRequestOptions, '/v2/assistants/{assistant_id}/message', 'POST');
checkUrlAndMethod(mockRequestOptions, '/v2/assistants/{assistant_id}/environments/{environment_id}/message', 'POST');
const expectedAccept = 'application/json';
const expectedContentType = 'application/json';
checkMediaHeaders(createRequestMock, expectedAccept, expectedContentType);
Expand Down