Interface TextRerankParams

Parameters for the textRerank operation.

interface TextRerankParams {
    headers?: OutgoingHttpHeaders;
    inputs: WatsonXAI.RerankInput[];
    modelId: string;
    parameters?: WatsonXAI.RerankParameters;
    projectId?: string;
    query: string;
    spaceId?: string;
}

Properties

headers? inputs modelId parameters? projectId? query spaceId?

Properties

Optional headers

headers?: OutgoingHttpHeaders

inputs

inputs: WatsonXAI.RerankInput[]

The rank input strings.

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.RerankParameters

The properties used for reranking.

Optional projectId

projectId?: string

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

query

query: string

The rank query.

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

headersinputsmodelIdparametersprojectIdqueryspaceId