Interface ExternalApi

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.

interface ExternalApi {
    apiAuth?: ApiAuth;
    apiSpec?: ApiSpec;
    authConfig?: AuthConfig;
    elasticSearchParams?: ExternalApiElasticSearchParams;
    endpoint?: string;
    simpleSearchParams?: ExternalApiSimpleSearchParams;
}

Properties

apiAuth? apiSpec? authConfig? elasticSearchParams? endpoint? simpleSearchParams?

Properties

OptionalapiAuth

apiAuth?: ApiAuth

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

OptionalapiSpec

apiSpec?: ApiSpec

The API spec that the external API implements.

OptionalauthConfig

authConfig?: AuthConfig

The authentication config to access the API.

OptionalelasticSearchParams

elasticSearchParams?: ExternalApiElasticSearchParams

Parameters for the elastic search API.

Optionalendpoint

endpoint?: string

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

OptionalsimpleSearchParams

simpleSearchParams?: ExternalApiSimpleSearchParams

Parameters for the simple search API.

Settings

On This Page

Properties