Package org.opensearch.index.rankeval

Class RatedDocument

java.lang.Object
org.opensearch.index.rankeval.RatedDocument
All Implemented Interfaces:
Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentObject
public class RatedDocument extends Object implements Writeable, org.opensearch.core.xcontent.ToXContentObject
Represents a document (specified by its _index/_id) and its corresponding rating with respect to a specific search query.

The json structure of this element in a request: 

 {
   "_index": "my_index",
   "_id": "doc1",
   "rating": 0
 }

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.opensearch.core.xcontent.ToXContent

    org.opensearch.core.xcontent.ToXContent.DelegatingMapParams, org.opensearch.core.xcontent.ToXContent.MapParams, org.opensearch.core.xcontent.ToXContent.Params

    Nested classes/interfaces inherited from interface org.opensearch.common.io.stream.Writeable

    Writeable.Reader<V extends Object>, Writeable.WriteableRegistry, Writeable.Writer<V extends Object>

  • Field Summary

    Fields inherited from interface org.opensearch.core.xcontent.ToXContent

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Constructor
    Description
    RatedDocument(String index, String id, int rating)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object obj)
     
    String
    getDocID()
     
    String
    getIndex()
     
    org.opensearch.index.rankeval.RatedDocument.DocumentKey
    getKey()
     
    int
    getRating()
     
    final int
    hashCode()
     
    String
    toString()
     
    org.opensearch.core.xcontent.XContentBuilder
    toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
     
    void
    writeTo(StreamOutput out)
     

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface org.opensearch.core.xcontent.ToXContentObject

    isFragment

  • Constructor Details

    • RatedDocument

      public RatedDocument(String index, String id, int rating)

  • Method Details

    • getKey

      public org.opensearch.index.rankeval.RatedDocument.DocumentKey getKey()

    • getIndex

      public String getIndex()

    • getDocID

      public String getDocID()

    • getRating

      public int getRating()

    • writeTo

      public void writeTo(StreamOutput out) throws IOException
      Specified by:
      writeTo in interface Writeable
      Throws:
      IOException

    • toXContent

      public org.opensearch.core.xcontent.XContentBuilder toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params) throws IOException
      Specified by:
      toXContent in interface org.opensearch.core.xcontent.ToXContent
      Throws:
      IOException

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object