Struct google_api_proto::google::cloud::discoveryengine::v1beta::RankRequest
source · pub struct RankRequest {
pub ranking_config: String,
pub model: String,
pub top_n: i32,
pub query: String,
pub records: Vec<RankingRecord>,
pub ignore_record_details_in_response: bool,
}
Expand description
Request message for [RankService.Rank][google.cloud.discoveryengine.v1beta.RankService.Rank] method.
Fields§
§ranking_config: String
Required. The resource name of the rank service config, such as
projects/{project_num}/locations/{location_id}/rankingConfigs/default_ranking_config
.
model: String
The identifier of the model to use. It is one of:
semantic-ranker-512@latest
: Semantic ranking model with maxiumn input token size 512.
It is set to semantic-ranker-512@latest
by default if unspecified.
top_n: i32
The number of results to return. If this is unset or no bigger than zero, returns all results.
query: String
The query to use.
records: Vec<RankingRecord>
Required. A list of records to rank. At most 200 records to rank.
ignore_record_details_in_response: bool
If true, the response will contain only record ID and score. By default, it is false, the response will contain record details.
Trait Implementations§
source§impl Clone for RankRequest
impl Clone for RankRequest
source§fn clone(&self) -> RankRequest
fn clone(&self) -> RankRequest
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl Debug for RankRequest
impl Debug for RankRequest
source§impl Default for RankRequest
impl Default for RankRequest
source§impl Message for RankRequest
impl Message for RankRequest
source§fn encoded_len(&self) -> usize
fn encoded_len(&self) -> usize
Returns the encoded length of the message without a length delimiter.
source§fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>where
B: BufMut,
Self: Sized,
fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>where
B: BufMut,
Self: Sized,
Encodes the message to a buffer. Read more
source§fn encode_to_vec(&self) -> Vec<u8>where
Self: Sized,
fn encode_to_vec(&self) -> Vec<u8>where
Self: Sized,
Encodes the message to a newly allocated buffer.
source§fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>where
B: BufMut,
Self: Sized,
fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>where
B: BufMut,
Self: Sized,
Encodes the message with a length-delimiter to a buffer. Read more
source§fn encode_length_delimited_to_vec(&self) -> Vec<u8>where
Self: Sized,
fn encode_length_delimited_to_vec(&self) -> Vec<u8>where
Self: Sized,
Encodes the message with a length-delimiter to a newly allocated buffer.
source§fn decode<B>(buf: B) -> Result<Self, DecodeError>where
B: Buf,
Self: Default,
fn decode<B>(buf: B) -> Result<Self, DecodeError>where
B: Buf,
Self: Default,
Decodes an instance of the message from a buffer. Read more
source§fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>where
B: Buf,
Self: Default,
fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>where
B: Buf,
Self: Default,
Decodes a length-delimited instance of the message from the buffer.
source§fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>where
B: Buf,
Self: Sized,
fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>where
B: Buf,
Self: Sized,
Decodes an instance of the message from a buffer, and merges it into
self
. Read moresource§fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>where
B: Buf,
Self: Sized,
fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>where
B: Buf,
Self: Sized,
Decodes a length-delimited instance of the message from buffer, and
merges it into
self
.source§impl PartialEq for RankRequest
impl PartialEq for RankRequest
source§fn eq(&self, other: &RankRequest) -> bool
fn eq(&self, other: &RankRequest) -> bool
This method tests for
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for RankRequest
Auto Trait Implementations§
impl Freeze for RankRequest
impl RefUnwindSafe for RankRequest
impl Send for RankRequest
impl Sync for RankRequest
impl Unpin for RankRequest
impl UnwindSafe for RankRequest
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
Wrap the input message
T
in a tonic::Request