Class Gateway

Main gateway class that extends APIBaseService.

Hierarchy (view full)

Constructors - Constructor

constructor

Properties

chat completion embeddings httpsAgentMap models policies projectId? providers rateLimit serviceUrl spaceId? version wxServiceUrl PLATFORM_URLS_MAP

Methods

_delete _formContainerIdHeaders _get _post _postStream _put appendContainerIdToHeaders appendDataToHeaders resolveContextId

Constructors - Constructor

constructor

Properties

chat

chat: Chat

Chat instance.

completion

completion: GenerateTextCompletions

GenerateTextCompletions instance.

embeddings

embeddings: Embeddings

Embeddings instance.

httpsAgentMap

httpsAgentMap: WatsonXAI.HttpsAgentMap = ...

models

models: Models

Models instance.

policies

policies: Policies

Optional projectId

projectId?: string

providers

providers: Providers

Providers instance.

rateLimit

rateLimit: RateLimits

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

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

_get

_post

_postStream

_put

Private appendContainerIdToHeaders

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

    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

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

Settings

Member Visibility

Theme

On This Page

constructorchatcompletionembeddingshttpsAgentMapmodelspoliciesprojectIdprovidersrateLimitserviceUrlspaceIdversionwxServiceUrlPLATFORM_URLS_MAP_delete_formContainerIdHeaders_get_post_postStream_putappendContainerIdToHeadersappendDataToHeadersresolveContextId