Show / Hide Table of Contents

Class GoogleCloudAiplatformV1beta1ExternalApi

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.

Inheritance
object
GoogleCloudAiplatformV1beta1ExternalApi
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.FirebaseML.v2beta.Data
Assembly: Google.Apis.FirebaseML.v2beta.dll
Syntax
public class GoogleCloudAiplatformV1beta1ExternalApi : IDirectResponseSchema

Properties

ApiAuth

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

Declaration
[JsonProperty("apiAuth")]
public virtual GoogleCloudAiplatformV1beta1ApiAuth ApiAuth { get; set; }
Property Value
Type Description
GoogleCloudAiplatformV1beta1ApiAuth

ApiSpec

The API spec that the external API implements.

Declaration
[JsonProperty("apiSpec")]
public virtual string ApiSpec { get; set; }
Property Value
Type Description
string

AuthConfig

The authentication config to access the API.

Declaration
[JsonProperty("authConfig")]
public virtual GoogleCloudAiplatformV1beta1AuthConfig AuthConfig { get; set; }
Property Value
Type Description
GoogleCloudAiplatformV1beta1AuthConfig

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

ElasticSearchParams

Parameters for the elastic search API.

Declaration
[JsonProperty("elasticSearchParams")]
public virtual GoogleCloudAiplatformV1beta1ExternalApiElasticSearchParams ElasticSearchParams { get; set; }
Property Value
Type Description
GoogleCloudAiplatformV1beta1ExternalApiElasticSearchParams

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

Declaration
[JsonProperty("endpoint")]
public virtual string Endpoint { get; set; }
Property Value
Type Description
string

SimpleSearchParams

Parameters for the simple search API.

Declaration
[JsonProperty("simpleSearchParams")]
public virtual GoogleCloudAiplatformV1beta1ExternalApiSimpleSearchParams SimpleSearchParams { get; set; }
Property Value
Type Description
GoogleCloudAiplatformV1beta1ExternalApiSimpleSearchParams

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX