Package com.google.genai.types

Class ExternalApiElasticSearchParams

java.lang.Object
com.google.genai.JsonSerializable
com.google.genai.types.ExternalApiElasticSearchParams
public abstract class ExternalApiElasticSearchParams extends JsonSerializable
The search parameters to use for the ELASTIC_SEARCH spec.

  • Constructor Details

    • ExternalApiElasticSearchParams

      public ExternalApiElasticSearchParams()

  • Method Details

    • index

      public abstract Optional<String> index()
      The ElasticSearch index to use.

    • numHits

      public abstract Optional<Integer> numHits()
      Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param.

    • searchTemplate

      public abstract Optional<String> searchTemplate()
      The ElasticSearch search template to use.

    • builder

      public static ExternalApiElasticSearchParams.Builder builder()
      Instantiates a builder for ExternalApiElasticSearchParams.

    • toBuilder

      public abstract ExternalApiElasticSearchParams.Builder toBuilder()
      Creates a builder with the same values as this instance.

    • fromJson

      public static ExternalApiElasticSearchParams fromJson(String jsonString)
      Deserializes a JSON string to a ExternalApiElasticSearchParams object.