Package com.google.cloud.discoveryengine.v1beta

Interface GenerateGroundedContentRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
GenerateGroundedContentRequest, GenerateGroundedContentRequest.Builder
@Generated public interface GenerateGroundedContentRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getLocation

      String getLocation()
       Required. Location resource.

 Format: `projects/{project}/locations/{location}`.
      string location = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The location.

    • getLocationBytes

      com.google.protobuf.ByteString getLocationBytes()
       Required. Location resource.

 Format: `projects/{project}/locations/{location}`.
      string location = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for location.

    • hasSystemInstruction

      boolean hasSystemInstruction()
       Content of the system instruction for the current API.

 These instructions will take priority over any other prompt instructions
 if the selected model is supporting them.
      .google.cloud.discoveryengine.v1beta.GroundedGenerationContent system_instruction = 5;
      Returns:
      Whether the systemInstruction field is set.

    • getSystemInstruction

      GroundedGenerationContent getSystemInstruction()
       Content of the system instruction for the current API.

 These instructions will take priority over any other prompt instructions
 if the selected model is supporting them.
      .google.cloud.discoveryengine.v1beta.GroundedGenerationContent system_instruction = 5;
      Returns:
      The systemInstruction.

    • getSystemInstructionOrBuilder

      GroundedGenerationContentOrBuilder getSystemInstructionOrBuilder()
       Content of the system instruction for the current API.

 These instructions will take priority over any other prompt instructions
 if the selected model is supporting them.
      .google.cloud.discoveryengine.v1beta.GroundedGenerationContent system_instruction = 5;

    • getContentsList

      List<GroundedGenerationContent> getContentsList()
       Content of the current conversation with the model.

 For single-turn queries, this is a single instance. For multi-turn queries,
 this is a repeated field that contains conversation history + latest
 request.
      repeated .google.cloud.discoveryengine.v1beta.GroundedGenerationContent contents = 2;

    • getContents

      GroundedGenerationContent getContents(int index)
       Content of the current conversation with the model.

 For single-turn queries, this is a single instance. For multi-turn queries,
 this is a repeated field that contains conversation history + latest
 request.
      repeated .google.cloud.discoveryengine.v1beta.GroundedGenerationContent contents = 2;

    • getContentsCount

      int getContentsCount()
       Content of the current conversation with the model.

 For single-turn queries, this is a single instance. For multi-turn queries,
 this is a repeated field that contains conversation history + latest
 request.
      repeated .google.cloud.discoveryengine.v1beta.GroundedGenerationContent contents = 2;

    • getContentsOrBuilderList

      List<? extends GroundedGenerationContentOrBuilder> getContentsOrBuilderList()
       Content of the current conversation with the model.

 For single-turn queries, this is a single instance. For multi-turn queries,
 this is a repeated field that contains conversation history + latest
 request.
      repeated .google.cloud.discoveryengine.v1beta.GroundedGenerationContent contents = 2;

    • getContentsOrBuilder

      GroundedGenerationContentOrBuilder getContentsOrBuilder(int index)
       Content of the current conversation with the model.

 For single-turn queries, this is a single instance. For multi-turn queries,
 this is a repeated field that contains conversation history + latest
 request.
      repeated .google.cloud.discoveryengine.v1beta.GroundedGenerationContent contents = 2;

    • hasGenerationSpec

      boolean hasGenerationSpec()
       Content generation specification.
      .google.cloud.discoveryengine.v1beta.GenerateGroundedContentRequest.GenerationSpec generation_spec = 3;
      Returns:
      Whether the generationSpec field is set.

    • getGenerationSpec

      GenerateGroundedContentRequest.GenerationSpec getGenerationSpec()
       Content generation specification.
      .google.cloud.discoveryengine.v1beta.GenerateGroundedContentRequest.GenerationSpec generation_spec = 3;
      Returns:
      The generationSpec.

    • getGenerationSpecOrBuilder

      GenerateGroundedContentRequest.GenerationSpecOrBuilder getGenerationSpecOrBuilder()
       Content generation specification.
      .google.cloud.discoveryengine.v1beta.GenerateGroundedContentRequest.GenerationSpec generation_spec = 3;

    • hasGroundingSpec

      boolean hasGroundingSpec()
       Grounding specification.
      .google.cloud.discoveryengine.v1beta.GenerateGroundedContentRequest.GroundingSpec grounding_spec = 4;
      Returns:
      Whether the groundingSpec field is set.

    • getGroundingSpec

      GenerateGroundedContentRequest.GroundingSpec getGroundingSpec()
       Grounding specification.
      .google.cloud.discoveryengine.v1beta.GenerateGroundedContentRequest.GroundingSpec grounding_spec = 4;
      Returns:
      The groundingSpec.

    • getGroundingSpecOrBuilder

      GenerateGroundedContentRequest.GroundingSpecOrBuilder getGroundingSpecOrBuilder()
       Grounding specification.
      .google.cloud.discoveryengine.v1beta.GenerateGroundedContentRequest.GroundingSpec grounding_spec = 4;

    • getUserLabelsCount

      int getUserLabelsCount()
       The user labels applied to a resource must meet the following requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
 characters and cannot be empty. Values can be empty and have a maximum
 length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
 underscores, and dashes. All characters must use UTF-8 encoding, and
 international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
 key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
      map<string, string> user_labels = 6;

    • containsUserLabels

      boolean containsUserLabels(String key)
       The user labels applied to a resource must meet the following requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
 characters and cannot be empty. Values can be empty and have a maximum
 length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
 underscores, and dashes. All characters must use UTF-8 encoding, and
 international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
 key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
      map<string, string> user_labels = 6;

    • getUserLabels

      @Deprecated Map<String,String> getUserLabels()
      Deprecated.
      Use getUserLabelsMap() instead.

    • getUserLabelsMap

      Map<String,String> getUserLabelsMap()
       The user labels applied to a resource must meet the following requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
 characters and cannot be empty. Values can be empty and have a maximum
 length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
 underscores, and dashes. All characters must use UTF-8 encoding, and
 international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
 key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
      map<string, string> user_labels = 6;

    • getUserLabelsOrDefault

      String getUserLabelsOrDefault(String key, String defaultValue)
       The user labels applied to a resource must meet the following requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
 characters and cannot be empty. Values can be empty and have a maximum
 length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
 underscores, and dashes. All characters must use UTF-8 encoding, and
 international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
 key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
      map<string, string> user_labels = 6;

    • getUserLabelsOrThrow

      String getUserLabelsOrThrow(String key)
       The user labels applied to a resource must meet the following requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
 characters and cannot be empty. Values can be empty and have a maximum
 length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
 underscores, and dashes. All characters must use UTF-8 encoding, and
 international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
 key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
      map<string, string> user_labels = 6;