Package com.google.cloud.discoveryengine.v1beta

Interface SearchRequest.SessionSpecOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
SearchRequest.SessionSpec, SearchRequest.SessionSpec.Builder
Enclosing class:
SearchRequest
public static interface SearchRequest.SessionSpecOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getQueryId()
    If set, the search result gets stored to the "turn" specified by this query ID.
    com.google.protobuf.ByteString
    getQueryIdBytes()
    If set, the search result gets stored to the "turn" specified by this query ID.
    int
    getSearchResultPersistenceCount()
    The number of top search results to persist.
    boolean
    hasSearchResultPersistenceCount()
    The number of top search results to persist.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getQueryId

      String getQueryId()
       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 query_id = 1;
      Returns:
      The queryId.

    • getQueryIdBytes

      com.google.protobuf.ByteString getQueryIdBytes()
       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 query_id = 1;
      Returns:
      The bytes for queryId.

    • hasSearchResultPersistenceCount

      boolean hasSearchResultPersistenceCount()
       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][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count].

 At most 10 results for documents mode, or 50 for chunks mode.
      optional int32 search_result_persistence_count = 2;
      Returns:
      Whether the searchResultPersistenceCount field is set.

    • getSearchResultPersistenceCount

      int getSearchResultPersistenceCount()
       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][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count].

 At most 10 results for documents mode, or 50 for chunks mode.
      optional int32 search_result_persistence_count = 2;
      Returns:
      The searchResultPersistenceCount.