GoogleCloudAiplatformV1ExternalApi
import type { GoogleCloudAiplatformV1ExternalApi } from "https://googleapis.deno.dev/v1/aiplatform:v1.ts";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.
interface GoogleCloudAiplatformV1ExternalApi {
apiAuth?: GoogleCloudAiplatformV1ApiAuth;
apiSpec?: "API_SPEC_UNSPECIFIED" | "SIMPLE_SEARCH" | "ELASTIC_SEARCH";
authConfig?: GoogleCloudAiplatformV1AuthConfig;
elasticSearchParams?: GoogleCloudAiplatformV1ExternalApiElasticSearchParams;
endpoint?: string;
simpleSearchParams?: GoogleCloudAiplatformV1ExternalApiSimpleSearchParams;
}§Properties
§
apiAuth?: GoogleCloudAiplatformV1ApiAuth
[src]The authentication config to access the API. Deprecated. Please use auth_config instead.
§
apiSpec?: "API_SPEC_UNSPECIFIED" | "SIMPLE_SEARCH" | "ELASTIC_SEARCH"
[src]The API spec that the external API implements.
§
authConfig?: GoogleCloudAiplatformV1AuthConfig
[src]The authentication config to access the API.
§
elasticSearchParams?: GoogleCloudAiplatformV1ExternalApiElasticSearchParams
[src]Parameters for the elastic search API.
§
endpoint?: string
[src]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
§
simpleSearchParams?: GoogleCloudAiplatformV1ExternalApiSimpleSearchParams
[src]Parameters for the simple search API.