Class WatsonxEmbeddings

Hierarchy (View Summary)

Toolkit
- WatsonxEmbeddings

Implements

Index

Constructors

Properties

gateway? maxConcurrency maxRetries? model modelGateway modelGatewayKwargs? projectId? returnOptions? service? serviceUrl spaceId? truncateInputTokens? version

Methods

embedDocuments embedQuery invocationParams listModels scopeId

Constructors

constructor

new WatsonxEmbeddings(fields: WatsonxEmbeddingsConstructor): WatsonxEmbeddings
Parameters
- fields: WatsonxEmbeddingsConstructor
Returns WatsonxEmbeddings
Overrides Embeddings.constructor
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-community/src/embeddings/ibm.ts:150

Properties

`Protected` `Optional`gateway

gateway?: Gateway

maxConcurrency

maxConcurrency: number = 1

`Optional`maxRetries

maxRetries?: number

model

model: string

The id of the model to be used for this request. Please refer to the list of models.

modelGateway

modelGateway: boolean = false

`Optional`modelGatewayKwargs

modelGatewayKwargs?: WatsonxEmbeddingsGatewayKwargs

`Optional`projectId

projectId?: string

The project that contains the resource. Either space_id or project_id has to be given.

`Optional`returnOptions

returnOptions?: EmbeddingReturnOptions

The return options for text embeddings.

`Protected` `Optional`service

service?: WatsonxAiMlVml_v1

serviceUrl

serviceUrl: string

`Optional`spaceId

spaceId?: string

The space that contains the resource. Either space_id or project_id has to be given.

`Optional`truncateInputTokens

truncateInputTokens?: number

Represents the maximum number of input tokens accepted. This can be used to avoid requests failing due to input being longer than configured limits. If the text is truncated, then it truncates the end of the input (on the right), so the start of the input will remain the same. If this value exceeds the maximum sequence length (refer to the documentation to find this value for the model) then the call will fail if the total number of tokens exceeds the maximum sequence length.

version

version: string

Methods

embedDocuments

embedDocuments(documents: string[]): Promise<number[][]>
Parameters
- documents: string[]
Returns Promise<number[][]>
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-community/src/embeddings/ibm.ts:277

embedQuery

embedQuery(document: string): Promise<number[]>
Parameters
- document: string
Returns Promise<number[]>
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-community/src/embeddings/ibm.ts:282

invocationParams

invocationParams(): {
    return_options: undefined
    | EmbeddingReturnOptions;
    truncate_input_tokens: undefined | number;
}
Returns {
return_options: undefined | EmbeddingReturnOptions;
truncate_input_tokens: undefined | number;
}
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-community/src/embeddings/ibm.ts:217

listModels

listModels(): Promise<any>
Returns Promise<any>
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-community/src/embeddings/ibm.ts:224

scopeId

scopeId(): | { modelId: string; projectId: string }
| { modelId: string; spaceId: string }
| { model: string }
Returns
    | { modelId: string; projectId: string }
    | { modelId: string; spaceId: string }
    | { model: string }
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-community/src/embeddings/ibm.ts:203

Class WatsonxEmbeddings

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns WatsonxEmbeddings

Properties

`Protected` `Optional`gateway

maxConcurrency

`Optional`maxRetries

model

modelGateway

`Optional`modelGatewayKwargs

`Optional`projectId

`Optional`returnOptions

`Protected` `Optional`service

serviceUrl

`Optional`spaceId

`Optional`truncateInputTokens

version

Methods

embedDocuments

Parameters

Returns Promise<number[][]>

embedQuery

Parameters

Returns Promise<number[]>

invocationParams

Returns {
return_options: undefined | EmbeddingReturnOptions;
truncate_input_tokens: undefined | number;
}

listModels

Returns Promise<any>

scopeId

Returns
    | { modelId: string; projectId: string }
    | { modelId: string; spaceId: string }
    | { model: string }

Settings

On This Page

Class WatsonxEmbeddings

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns WatsonxEmbeddings

Properties

Protected Optionalgateway

maxConcurrency

OptionalmaxRetries

model

modelGateway

OptionalmodelGatewayKwargs

OptionalprojectId

OptionalreturnOptions

Protected Optionalservice

serviceUrl

OptionalspaceId

OptionaltruncateInputTokens

version

Methods

embedDocuments

Parameters

Returns Promise<number[][]>

embedQuery

Parameters

Returns Promise<number[]>

invocationParams

Returns { return_options: undefined | EmbeddingReturnOptions; truncate_input_tokens: undefined | number;}

listModels

Returns Promise<any>

scopeId

Returns | { modelId: string; projectId: string } | { modelId: string; spaceId: string } | { model: string }

Settings

On This Page

`Protected` `Optional`gateway

`Optional`maxRetries

`Optional`modelGatewayKwargs

`Optional`projectId

`Optional`returnOptions

`Protected` `Optional`service

`Optional`spaceId

`Optional`truncateInputTokens

Returns {
return_options: undefined | EmbeddingReturnOptions;
truncate_input_tokens: undefined | number;
}

Returns
| { modelId: string; projectId: string }
| { modelId: string; spaceId: string }
| { model: string }