google-genai/com.google.genai.types/ExternalApi

ExternalApi

public abstract class ExternalApi extends JsonSerializable

Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. This data type is not supported in Gemini API.

Constructors

Link copied to clipboard
public void ExternalApi()

Types

Link copied to clipboard
public abstract class Builder
Builder for ExternalApi.

Properties

Link copied to clipboard
public final static String MAX_READ_LENGTH_PROPERTY
System property to override the default max JSON string length (20MB) in read constraints.

Functions

Link copied to clipboard
public abstract Optional<ApiAuth> apiAuth()
The authentication config to access the API.
Link copied to clipboard
public abstract Optional<ApiSpec> apiSpec()
The API spec that the external API implements.
Link copied to clipboard
public abstract Optional<AuthConfig> authConfig()
The authentication config to access the API.
Link copied to clipboard
public static ExternalApi.Builder builder()
Instantiates a builder for ExternalApi.
Link copied to clipboard
public abstract Optional<ExternalApiElasticSearchParams> elasticSearchParams()
Parameters for the elastic search API.
Link copied to clipboard
public abstract Optional<String> endpoint()
The endpoint of the external API.
Link copied to clipboard
public static ExternalApi fromJson(String jsonString)
Deserializes a JSON string to a ExternalApi object.
Link copied to clipboard
@InternalApi()
public static T fromJsonNode<T extends JsonSerializable>(JsonNode jsonNode, Class<T> clazz)
Deserializes a JsonNode to an object of the given type.
Link copied to clipboard
@InternalApi()
public static T fromJsonString<T extends JsonSerializable>(String jsonString, Class<T> clazz)
Deserializes a Json string to an object of the given type.
Link copied to clipboard
public static ObjectMapper objectMapper()
Link copied to clipboard
public static void setMaxReadLength(int maxReadLength)
Overrides the default maximum JSON string length (20MB) for the JSON parser.
Link copied to clipboard
public abstract Optional<ExternalApiSimpleSearchParams> simpleSearchParams()
Parameters for the simple search API.
Link copied to clipboard
public static JsonNode stringToJsonNode(String string)
Converts a Json string to a JsonNode.
Link copied to clipboard
public abstract ExternalApi.Builder toBuilder()
Creates a builder with the same values as this instance.
Link copied to clipboard
public String toJson()
Serializes the instance to a Json string.
Link copied to clipboard
public static JsonNode toJsonNode(Object object)
Serializes an object to a JsonNode.
Link copied to clipboard
public static String toJsonString(Object object)
Serializes an object to a Json string.