Interface TextEmbeddingsParams

Parameters for the textEmbeddings operation.

interface TextEmbeddingsParams {
    headers?: OutgoingHttpHeaders;
    inputs: string[];
    modelId: string;
    parameters?: WatsonXAI.EmbeddingParameters;
    projectId?: string;
    signal?: AbortSignal;
    spaceId?: string;
}

Hierarchy (view full)

Properties

headers? inputs modelId parameters? projectId? signal? spaceId?

Properties

Optional headers

headers?: OutgoingHttpHeaders

inputs

inputs: string[]

The input text.

modelId

modelId: string

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

Optional parameters

parameters?: WatsonXAI.EmbeddingParameters

Parameters for text embedding requests.

Optional projectId

projectId?: string

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

Optional signal

signal?: AbortSignal

Optional spaceId

spaceId?: string

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

Settings

Member Visibility

Theme

On This Page

headersinputsmodelIdparametersprojectIdsignalspaceId