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

ExternalApi

@Serializable
data class ExternalApi(val apiAuth: ApiAuth? = null, val apiSpec: ApiSpec? = null, val authConfig: AuthConfig? = null, val elasticSearchParams: ExternalApiElasticSearchParams? = null, val endpoint: String? = null, val simpleSearchParams: ExternalApiSimpleSearchParams? = null)

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
constructor(apiAuth: ApiAuth? = null, apiSpec: ApiSpec? = null, authConfig: AuthConfig? = null, elasticSearchParams: ExternalApiElasticSearchParams? = null, endpoint: String? = null, simpleSearchParams: ExternalApiSimpleSearchParams? = null)

Properties

Link copied to clipboard
val apiAuth: ApiAuth? = null

The authentication config to access the API. Deprecated. Please use auth_config instead.

Link copied to clipboard
val apiSpec: ApiSpec? = null

The API spec that the external API implements.

Link copied to clipboard
val authConfig: AuthConfig? = null

The authentication config to access the API.

Link copied to clipboard
val elasticSearchParams: ExternalApiElasticSearchParams? = null

Parameters for the elastic search API.

Link copied to clipboard
val endpoint: String? = null

The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search

Link copied to clipboard
val simpleSearchParams: ExternalApiSimpleSearchParams? = null

Parameters for the simple search API.