Class APIBaseService

APIBaseService class extends WatsonxBaseService and provides common API request functionalities.

Hierarchy (view full)

WatsonxBaseService
- APIBaseService
  - Gateway

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:90

Properties

httpsAgentMap

httpsAgentMap: WatsonXAI.HttpsAgentMap = ...

serviceUrl

serviceUrl: string

URL required for watsonx inference endpoints

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: {
    https://ca-tor.ml.cloud.ibm.com: string;
    https://eu-de.ml.cloud.ibm.com: string;
    https://eu-gb.ml.cloud.ibm.com: string;
    https://jp-tok.ml.cloud.ibm.com: string;
    https://private.ca-tor.ml.cloud.ibm.com: string;
    https://private.eu-de.ml.cloud.ibm.com: string;
    https://private.eu-gb.ml.cloud.ibm.com: string;
    https://private.jp-tok.ml.cloud.ibm.com: string;
    https://private.us-south.ml.cloud.ibm.com: string;
    https://us-south.ml.cloud.ibm.com: string;
} = ...

Type declaration

https://ca-tor.ml.cloud.ibm.com: string
https://eu-de.ml.cloud.ibm.com: string
https://eu-gb.ml.cloud.ibm.com: string
https://jp-tok.ml.cloud.ibm.com: string
https://private.ca-tor.ml.cloud.ibm.com: string
https://private.eu-de.ml.cloud.ibm.com: string
https://private.eu-gb.ml.cloud.ibm.com: string
https://private.jp-tok.ml.cloud.ibm.com: string
https://private.us-south.ml.cloud.ibm.com: string
https://us-south.ml.cloud.ibm.com: string

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:298

_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:252

_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:207

_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:396

_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:346

Class APIBaseService

Hierarchy (view full)

Index

Constructors - constructor

Properties

Methods

Constructors - constructor

constructor

Parameters

Returns APIBaseService

Properties

httpsAgentMap

serviceUrl

version

wxServiceUrl

Static PLATFORM_URLS_MAP

Type declaration

https://ca-tor.ml.cloud.ibm.com: string

https://eu-de.ml.cloud.ibm.com: string

https://eu-gb.ml.cloud.ibm.com: string

https://jp-tok.ml.cloud.ibm.com: string

https://private.ca-tor.ml.cloud.ibm.com: string

https://private.eu-de.ml.cloud.ibm.com: string

https://private.eu-gb.ml.cloud.ibm.com: string

https://private.jp-tok.ml.cloud.ibm.com: string

https://private.us-south.ml.cloud.ibm.com: string

https://us-south.ml.cloud.ibm.com: string

Methods

_delete

Type Parameters

Parameters

Returns Promise<WatsonXAI.Response<T>>

_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>>

Settings

Member Visibility

Theme

On This Page

`Static` PLATFORM_URLS_MAP