Class WatsonxBaseService

WatsonxBaseService class extends BaseService and provides common functionalities for Watsonx services.

Hierarchy (view full)

BaseService
- WatsonxBaseService
  - WatsonXAI
  - APIBaseService

Index

Constructors - Constructor

Properties

httpsAgentMap projectId? serviceUrl spaceId? version wxServiceUrl PLATFORM_URLS_MAP

Methods

resolveContextId

Constructors - Constructor

constructor

new WatsonxBaseService(options?): WatsonxBaseService
Constructs an instance of WatsonxBaseService with passed in options and external configuration.
Parameters
- Optional options: UserOptions & WatsonXAI.Certificates & WatsonXAI.TokenAuthenticationOptions = {}
  The parameters to send to the service.
Returns WatsonxBaseService
Overrides BaseService.constructor
- Defined in base/base.ts:87

Properties

httpsAgentMap

httpsAgentMap: WatsonXAI.HttpsAgentMap = ...

`Optional` projectId

projectId?: string

serviceUrl

serviceUrl: string

URL required for watsonx inference endpoints

`Optional` spaceId

spaceId?: string

version

version: string

The version date for the API of the form YYYY-MM-DD.

wxServiceUrl

wxServiceUrl: string

URL required for dataplatform endpoints

`Static` PLATFORM_URLS_MAP

PLATFORM_URLS_MAP: Record<string, string> = PLATFORM_URL_MAPPINGS

Methods

`Private` resolveContextId

resolveContextId(params): {
projectId?: string;
spaceId?: string;
}
Private
Resolves projectId and spaceId with fallback to instance values.

This method implements a priority-based resolution strategy:
1. If both instance values (this.projectId/this.spaceId) AND parameter values exist, parameter values take absolute precedence and instance values are ignored
2. Otherwise, parameter values are used if provided, falling back to instance values
This ensures that explicitly passed parameters always override instance configuration when both are present, preventing unintended mixing of project and space contexts.
Parameters
- params: {
  projectId?: string;
  spaceId?: string;
  }
  Object containing optional projectId and spaceId
  - Optional projectId?: string
    The project ID to use for the request
  - Optional spaceId?: string
    The space ID to use for the request
Returns {
projectId?: string;
spaceId?: string;
}
Resolved projectId and spaceId values
- Optional projectId?: string
- Optional spaceId?: string
- Defined in base/base.ts:206