Class WatsonxRerank

constructor

• new WatsonxRerank(fields): WatsonxRerank

• Parameters

  • fields: WatsonxInputRerank & WatsonxAuth

  Returns WatsonxRerank

OptionalmaxConcurrency

maxRetries

model

OptionalprojectId

OptionalreturnOptions

service

serviceUrl

OptionalspaceId

OptionaltruncateInputTokens

version

compressDocuments

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

• Abstract method that must be implemented by any class that extends BaseDocumentCompressor. This method takes an array of Document objects and a query string as parameters and returns a Promise that resolves with an array of compressed Document objects.

  Parameters

  • documents: DocumentInterface<Record<string, any>>[]

    An array of Document objects to be compressed.
  • query: string

    A query string.

  Returns Promise<DocumentInterface<Record<string, any>>[]>

  A Promise that resolves with an array of compressed Document objects.

invocationParams

• invocationParams(options?): {
      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;
  }

  • return_options: {
        inputs: undefined | boolean;
        top_n: undefined | number;
    }

    • inputs: undefined | boolean

    • top_n: undefined | number

  • truncate_input_tokens: undefined | number

rerank

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

• Parameters

  • documents: (string | DocumentInterface<Record<string, any>> | Record<"pageContent", string>)[]
  • 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;
  }