GoogleCloudAiplatformV1Endpoint

import type { GoogleCloudAiplatformV1Endpoint } from "https://googleapis.deno.dev/v1/aiplatform:v1.ts";

Models are deployed into it, and afterwards Endpoint is called to obtain predictions and explanations.

interface GoogleCloudAiplatformV1Endpoint {

clientConnectionConfig?: GoogleCloudAiplatformV1ClientConnectionConfig;

readonly createTime?: Date;

readonly dedicatedEndpointDns?: string;

dedicatedEndpointEnabled?: boolean;

readonly deployedModels?: GoogleCloudAiplatformV1DeployedModel[];

description?: string;

displayName?: string;

enablePrivateServiceConnect?: boolean;

encryptionSpec?: GoogleCloudAiplatformV1EncryptionSpec;

etag?: string;

genAiAdvancedFeaturesConfig?: GoogleCloudAiplatformV1GenAiAdvancedFeaturesConfig;

labels?: {

[key: string]: string;

};

readonly modelDeploymentMonitoringJob?: string;

readonly name?: string;

network?: string;

predictRequestResponseLoggingConfig?: GoogleCloudAiplatformV1PredictRequestResponseLoggingConfig;

privateServiceConnectConfig?: GoogleCloudAiplatformV1PrivateServiceConnectConfig;

readonly satisfiesPzi?: boolean;

readonly satisfiesPzs?: boolean;

trafficSplit?: {

[key: string]: number;

};

readonly updateTime?: Date;

}

§Properties

clientConnectionConfig?: GoogleCloudAiplatformV1ClientConnectionConfig

[src]

Configurations that are applied to the endpoint for online prediction.

readonly createTime?: Date

[src]

Output only. Timestamp when this Endpoint was created.

readonly dedicatedEndpointDns?: string

[src]

Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Depending on the features enabled, uid might be a random number or a string. For example, if fast_tryout is enabled, uid will be fasttryout. Format: https://{endpoint_id}.{region}-{uid}.prediction.vertexai.goog.

dedicatedEndpointEnabled?: boolean

[src]

If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitation will be removed soon.

readonly deployedModels?: GoogleCloudAiplatformV1DeployedModel[]

[src]

Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively.

description?: string

[src]

The description of the Endpoint.

displayName?: string

[src]

Required. The display name of the Endpoint. The name can be up to 128 characters long and can consist of any UTF-8 characters.

enablePrivateServiceConnect?: boolean

[src]

Deprecated: If true, expose the Endpoint via private service connect. Only one of the fields, network or enable_private_service_connect, can be set.

encryptionSpec?: GoogleCloudAiplatformV1EncryptionSpec

[src]

Customer-managed encryption key spec for an Endpoint. If set, this Endpoint and all sub-resources of this Endpoint will be secured by this key.

etag?: string

[src]

Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

genAiAdvancedFeaturesConfig?: GoogleCloudAiplatformV1GenAiAdvancedFeaturesConfig

[src]

Optional. Configuration for GenAiAdvancedFeatures. If the endpoint is serving GenAI models, advanced features like native RAG integration can be configured. Currently, only Model Garden models are supported.

labels?: {

[key: string]: string;

}

[src]

The labels with user-defined metadata to organize your Endpoints. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.

readonly modelDeploymentMonitoringJob?: string

[src]

Output only. Resource name of the Model Monitoring job associated with this Endpoint if monitoring is enabled by JobService.CreateModelDeploymentMonitoringJob. Format: projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}

readonly name?: string

[src]

Output only. The resource name of the Endpoint.

network?: string

[src]

Optional. The full name of the Google Compute Engine network to which the Endpoint should be peered. Private services access must already be configured for the network. If left unspecified, the Endpoint is not peered with any network. Only one of the fields, network or enable_private_service_connect, can be set. Format: projects/{project}/global/networks/{network}. Where {project} is a project number, as in 12345, and {network} is network name.

predictRequestResponseLoggingConfig?: GoogleCloudAiplatformV1PredictRequestResponseLoggingConfig

[src]

Configures the request-response logging for online prediction.

privateServiceConnectConfig?: GoogleCloudAiplatformV1PrivateServiceConnectConfig

[src]

Optional. Configuration for private service connect. network and private_service_connect_config are mutually exclusive.

readonly satisfiesPzi?: boolean

[src]

Output only. Reserved for future use.

readonly satisfiesPzs?: boolean

[src]

Output only. Reserved for future use.

trafficSplit?: {

[key: string]: number;

}

[src]

A map from a DeployedModel's ID to the percentage of this Endpoint's traffic that should be forwarded to that DeployedModel. If a DeployedModel's ID is not listed in this map, then it receives no traffic. The traffic percentage values must add up to 100, or map must be empty if the Endpoint is to not accept any traffic at a moment.

readonly updateTime?: Date

[src]

Output only. Timestamp when this Endpoint was last updated.