github.com/weaviate/weaviate@v1.24.6/usecases/modulecomponents/additional/provider_ranker.go (about)

     1  //                           _       _
     2  // __      _____  __ ___   ___  __ _| |_ ___
     3  // \ \ /\ / / _ \/ _` \ \ / / |/ _` | __/ _ \
     4  //  \ V  V /  __/ (_| |\ V /| | (_| | ||  __/
     5  //   \_/\_/ \___|\__,_| \_/ |_|\__,_|\__\___|
     6  //
     7  //  Copyright © 2016 - 2024 Weaviate B.V. All rights reserved.
     8  //
     9  //  CONTACT: hello@weaviate.io
    10  //
    11  
    12  package additional
    13  
    14  import (
    15  	"context"
    16  
    17  	"github.com/weaviate/weaviate/entities/modulecapabilities"
    18  	"github.com/weaviate/weaviate/entities/moduletools"
    19  	rankerrank "github.com/weaviate/weaviate/usecases/modulecomponents/additional/rank"
    20  	"github.com/weaviate/weaviate/usecases/modulecomponents/ent"
    21  )
    22  
    23  type reRankerClient interface {
    24  	Rank(ctx context.Context, query string, documents []string, cfg moduletools.ClassConfig) (*ent.RankResult, error)
    25  }
    26  
    27  type GraphQLAdditionalRankerProvider struct {
    28  	ReRankerProvider AdditionalProperty
    29  }
    30  
    31  func NewRankerProvider(client reRankerClient) *GraphQLAdditionalRankerProvider {
    32  	return &GraphQLAdditionalRankerProvider{rankerrank.New(client)}
    33  }
    34  
    35  func (p *GraphQLAdditionalRankerProvider) AdditionalProperties() map[string]modulecapabilities.AdditionalProperty {
    36  	additionalProperties := map[string]modulecapabilities.AdditionalProperty{}
    37  	additionalProperties["rerank"] = p.getReRanker()
    38  	return additionalProperties
    39  }
    40  
    41  func (p *GraphQLAdditionalRankerProvider) getReRanker() modulecapabilities.AdditionalProperty {
    42  	return modulecapabilities.AdditionalProperty{
    43  		GraphQLNames:           []string{"rerank"},
    44  		GraphQLFieldFunction:   p.ReRankerProvider.AdditionalFieldFn,
    45  		GraphQLExtractFunction: p.ReRankerProvider.ExtractAdditionalFn,
    46  		SearchFunctions: modulecapabilities.AdditionalSearch{
    47  			ExploreGet:  p.ReRankerProvider.AdditionalPropertyFn,
    48  			ExploreList: p.ReRankerProvider.AdditionalPropertyFn,
    49  		},
    50  	}
    51  }