Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestSessionSpec
- Inherits:
-
Object
- Object
- Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestSessionSpec
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/discoveryengine_v1/classes.rb,
lib/google/apis/discoveryengine_v1/representations.rb,
lib/google/apis/discoveryengine_v1/representations.rb
Overview
Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.
Instance Attribute Summary collapse
-
#query_id ⇒ String
If set, the search result gets stored to the "turn" specified by this query ID.
-
#search_result_persistence_count ⇒ Fixnum
The number of top search results to persist.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1SearchRequestSessionSpec
constructor
A new instance of GoogleCloudDiscoveryengineV1SearchRequestSessionSpec.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1SearchRequestSessionSpec
Returns a new instance of GoogleCloudDiscoveryengineV1SearchRequestSessionSpec.
7524 7525 7526 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 7524 def initialize(**args) update!(**args) end |
Instance Attribute Details
#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.
Corresponds to the JSON property queryId
7513 7514 7515 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 7513 def query_id @query_id end |
#search_result_persistence_count ⇒ Fixnum
The number of top search results to persist. The persisted search results can
be used for the subsequent /answer api call. This field is simliar to the
summary_result_count
field in SearchRequest.ContentSearchSpec.SummarySpec.
summary_result_count. At most 10 results for documents mode, or 50 for chunks
mode.
Corresponds to the JSON property searchResultPersistenceCount
7522 7523 7524 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 7522 def search_result_persistence_count @search_result_persistence_count end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
7529 7530 7531 7532 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 7529 def update!(**args) @query_id = args[:query_id] if args.key?(:query_id) @search_result_persistence_count = args[:search_result_persistence_count] if args.key?(:search_result_persistence_count) end |