Class WatsonxRerank

constructor

• new WatsonxRerank(fields: WatsonxInputRerank & WatsonxAuth): WatsonxRerank

  Parameters

  • fields: WatsonxInputRerank & WatsonxAuth

  Returns WatsonxRerank

OptionalmaxConcurrency

maxRetries

model

OptionalprojectId

OptionalreturnOptions

service

serviceUrl

OptionalspaceId

OptionaltruncateInputTokens

version

compressDocuments

• compressDocuments(
      documents: DocumentInterface[],
      query: string,
  ): Promise<DocumentInterface[]>

  Parameters

  • documents: DocumentInterface[]
  • query: string

  Returns Promise<DocumentInterface[]>

invocationParams

• invocationParams(
      options?: Partial<WatsonxInputRerank>,
  ): {
      return_options: {
          inputs: undefined | boolean;
          top_n: undefined | number;
      };
      truncate_input_tokens: undefined
      | number;
  }

  Parameters

  • Optionaloptions: Partial<WatsonxInputRerank>

  Returns {
      return_options: {
          inputs: undefined | boolean;
          top_n: undefined | number;
      };
      truncate_input_tokens: undefined
      | number;
  }

rerank

• rerank(
      documents: any[],
      query: string,
      options?: Partial<WatsonxInputRerank>,
  ): Promise<{ index: number; input?: string; relevanceScore: number }[]>

  Parameters

  • documents: any[]
  • query: string
  • Optionaloptions: Partial<WatsonxInputRerank>

  Returns Promise<{ index: number; input?: string; relevanceScore: number }[]>

scopeId

• scopeId(): | { modelId: string; projectId: string; spaceId?: undefined }
  | { modelId: string; projectId?: undefined; spaceId: undefined | string }

  Returns
      | { modelId: string; projectId: string; spaceId?: undefined }
      | { modelId: string; projectId?: undefined; spaceId: undefined | string }