Reference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SessionSpec.
Session specification.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#query_id
def query_id() -> ::String-
(::String) — If set, the search result gets stored to the "turn" specified by this
query ID.
Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } }
The user can call /search API with a request like this:
session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" }
Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID.
#query_id=
def query_id=(value) -> ::String-
value (::String) — If set, the search result gets stored to the "turn" specified by this
query ID.
Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } }
The user can call /search API with a request like this:
session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" }
Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID.
-
(::String) — If set, the search result gets stored to the "turn" specified by this
query ID.
Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } }
The user can call /search API with a request like this:
session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" }
Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID.
#search_result_persistence_count
def search_result_persistence_count() -> ::Integer-
(::Integer) — The number of top search results to persist. The persisted search results
can be used for the subsequent /answer api call.
This field is similar to the
summary_result_countfield in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count.At most 10 results for documents mode, or 50 for chunks mode.
#search_result_persistence_count=
def search_result_persistence_count=(value) -> ::Integer-
value (::Integer) — The number of top search results to persist. The persisted search results
can be used for the subsequent /answer api call.
This field is similar to the
summary_result_countfield in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count.At most 10 results for documents mode, or 50 for chunks mode.
-
(::Integer) — The number of top search results to persist. The persisted search results
can be used for the subsequent /answer api call.
This field is similar to the
summary_result_countfield in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count.At most 10 results for documents mode, or 50 for chunks mode.