Class APIBaseService

APIBaseService class extends WatsonxBaseService and provides common API request functionalities.

Hierarchy (view full)

WatsonxBaseService
- APIBaseService
  - Gateway
  - BatchInference

Index

Constructors - Constructor

constructor

new APIBaseService(options?): APIBaseService
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 APIBaseService
Inherited from WatsonxBaseService.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

_delete

_delete<T>(params): Promise<WatsonXAI.Response<T>>
Performs a DELETE request to the specified URL.
Type Parameters
- T
Parameters
- params: DeleteParameters
  The parameters for the DELETE request.
Returns Promise<WatsonXAI.Response<T>>
- A promise that resolves to the response from the DELETE request.
- Defined in base/base.ts:397

`Protected` _formContainerIdHeaders

_formContainerIdHeaders(params?, requireContainerId?): {} | {
X-IBM-PROJECT-ID: string;
} | {
X-IBM-SPACE-ID: string;
}
Protected
Forms container ID headers based on project ID or space ID.

This method creates the appropriate IBM-specific headers for identifying the container (project or space) that the API request should operate within. It prioritizes parameters passed in the request over instance-level defaults.
Parameters
- Optional params: ContextIdentifiers = {}
  Container identifiers (projectId or spaceId). Default is {}
- requireContainerId: boolean = false
Returns {} | {
X-IBM-PROJECT-ID: string;
} | {
X-IBM-SPACE-ID: string;
}
An object containing either the project ID header, space ID header, or an empty object if neither is provided
- Defined in base/base.ts:243

_get

_get<T>(params): Promise<WatsonXAI.Response<T>>
Performs a GET request to the specified URL.
Type Parameters
- T
Parameters
- params: GetParameters
  The parameters for the GET request.
Returns Promise<WatsonXAI.Response<T>>
- A promise that resolves to the response from the GET request.
- Defined in base/base.ts:349

_post

_post<T>(params): Promise<WatsonXAI.Response<T>>
Performs a POST request to the specified URL.
Type Parameters
- T
Parameters
- params: PostParameters
  The parameters for the POST request.
Returns Promise<WatsonXAI.Response<T>>
- A promise that resolves to the response from the POST request.
- Defined in base/base.ts:303

_postStream

_postStream<T>(params): Promise<Stream<string | T>>
Performs a POST request to the specified URL and returns a stream.
Type Parameters
- T
Parameters
- params: CreateStreamParameters
  The parameters for the POST request.
Returns Promise<Stream<string | T>>
- A promise that resolves to a stream from the POST request.
- Defined in base/base.ts:498

_put

_put<T>(params): Promise<WatsonXAI.Response<T>>
Performs a PUT request to the specified URL.
Type Parameters
- T
Parameters
- params: PutParameters
  The parameters for the PUT request.
Returns Promise<WatsonXAI.Response<T>>
- A promise that resolves to the response from the PUT request.
- Defined in base/base.ts:446

`Protected` appendDataToHeaders

appendDataToHeaders<T>(params, overrides): T
Protected
Appends additional data to request headers.

This utility method merges override headers with existing headers in the parameters object, ensuring that custom headers are properly combined without losing existing header data.
Type Parameters
- T extends (GetParameters | PostParameters | PutParameters | DeleteParameters) & ContextIdentifiers
  The type of parameters, constrained to request parameter types with container identifiers
Parameters
- params: T
  The request parameters containing existing headers
- overrides: Record<string, any>
  Additional headers to merge into the request
Returns T
A new parameters object with merged headers
- Defined in base/base.ts:276

`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
Inherited from WatsonxBaseService.resolveContextId
- Defined in base/base.ts:206

Class APIBaseService

Hierarchy (view full)

Index

Constructors - Constructor

Properties

Methods

Constructors - Constructor

constructor

Parameters

Returns APIBaseService

Properties

httpsAgentMap

Optional projectId

serviceUrl

Optional spaceId

version

wxServiceUrl

Static PLATFORM_URLS_MAP

Methods

_delete

Type Parameters

Parameters

Returns Promise<WatsonXAI.Response<T>>

Protected _formContainerIdHeaders

Parameters

Returns {} | { X-IBM-PROJECT-ID: string; } | { X-IBM-SPACE-ID: string; }

_get

Type Parameters

Parameters

Returns Promise<WatsonXAI.Response<T>>

_post

Type Parameters

Parameters

Returns Promise<WatsonXAI.Response<T>>

_postStream

Type Parameters

Parameters

Returns Promise<Stream<string | T>>

_put

Type Parameters

Parameters

Returns Promise<WatsonXAI.Response<T>>

Protected appendDataToHeaders

Type Parameters

Parameters

Returns T

Private resolveContextId

Parameters

Optional projectId?: string

Optional spaceId?: string

Returns { projectId?: string; spaceId?: string; }

Optional projectId?: string

Optional spaceId?: string

Settings

Member Visibility

Theme

On This Page

`Optional` projectId

`Optional` spaceId

`Static` PLATFORM_URLS_MAP

`Protected` _formContainerIdHeaders

Returns {} | {
X-IBM-PROJECT-ID: string;
} | {
X-IBM-SPACE-ID: string;
}

`Protected` appendDataToHeaders

`Private` resolveContextId

`Optional` projectId?: string

`Optional` spaceId?: string

Returns {
projectId?: string;
spaceId?: string;
}

`Optional` projectId?: string

`Optional` spaceId?: string