Class ExternalApi
- Namespace
- GenerativeAI.Types
- Assembly
- GenerativeAI.dll
Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but needs to follow the pre-defined API spec.
public class ExternalApi
- Inheritance
-
ExternalApi
- Inherited Members
- Extension Methods
Properties
ApiAuth
The authentication config to access the API. Deprecated. Please use AuthConfig instead.
[JsonPropertyName("apiAuth")]
public ApiAuth? ApiAuth { get; set; }
Property Value
ApiSpec
The API spec that the external API implements.
[JsonPropertyName("apiSpec")]
public ApiSpec? ApiSpec { get; set; }
Property Value
AuthConfig
The authentication config to access the API.
[JsonPropertyName("authConfig")]
public AuthConfig? AuthConfig { get; set; }
Property Value
ElasticSearchParams
Parameters for the elastic search API.
[JsonPropertyName("elasticSearchParams")]
public ExternalApiElasticSearchParams? ElasticSearchParams { get; set; }
Property Value
Endpoint
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
[JsonPropertyName("endpoint")]
public string? Endpoint { get; set; }
Property Value
SimpleSearchParams
Parameters for the simple search API.
[JsonPropertyName("simpleSearchParams")]
public ExternalApiSimpleSearchParams? SimpleSearchParams { get; set; }