Class ProjectsResource.LocationsResource.EndpointsResource
The "endpoints" collection of methods.
Inherited Members
Namespace: Google.Apis.Aiplatform.v1beta1
Assembly: Google.Apis.Aiplatform.v1beta1.dll
Syntax
public class ProjectsResource.LocationsResource.EndpointsResource
Constructors
EndpointsResource(IClientService)
Constructs a new resource.
Declaration
public EndpointsResource(IClientService service)
Parameters
Type | Name | Description |
---|---|---|
IClientService | service |
Properties
Chat
Gets the Chat resource.
Declaration
public virtual ProjectsResource.LocationsResource.EndpointsResource.ChatResource Chat { get; }
Property Value
Type | Description |
---|---|
ProjectsResource.LocationsResource.EndpointsResource.ChatResource |
Operations
Gets the Operations resource.
Declaration
public virtual ProjectsResource.LocationsResource.EndpointsResource.OperationsResource Operations { get; }
Property Value
Type | Description |
---|---|
ProjectsResource.LocationsResource.EndpointsResource.OperationsResource |
Methods
ComputeTokens(GoogleCloudAiplatformV1beta1ComputeTokensRequest, string)
Return a list of tokens based on the input text.
Declaration
public virtual ProjectsResource.LocationsResource.EndpointsResource.ComputeTokensRequest ComputeTokens(GoogleCloudAiplatformV1beta1ComputeTokensRequest body, string endpoint)
Parameters
Type | Name | Description |
---|---|---|
GoogleCloudAiplatformV1beta1ComputeTokensRequest | body | The body of the request. |
string | endpoint | Required. The name of the Endpoint requested to get lists of tokens and token ids. |
Returns
Type | Description |
---|---|
ProjectsResource.LocationsResource.EndpointsResource.ComputeTokensRequest |
CountTokens(GoogleCloudAiplatformV1beta1CountTokensRequest, string)
Perform a token counting.
Declaration
public virtual ProjectsResource.LocationsResource.EndpointsResource.CountTokensRequest CountTokens(GoogleCloudAiplatformV1beta1CountTokensRequest body, string endpoint)
Parameters
Type | Name | Description |
---|---|---|
GoogleCloudAiplatformV1beta1CountTokensRequest | body | The body of the request. |
string | endpoint | Required. The name of the Endpoint requested to perform token counting. Format:
|
Returns
Type | Description |
---|---|
ProjectsResource.LocationsResource.EndpointsResource.CountTokensRequest |
Create(GoogleCloudAiplatformV1beta1Endpoint, string)
Creates an Endpoint.
Declaration
public virtual ProjectsResource.LocationsResource.EndpointsResource.CreateRequest Create(GoogleCloudAiplatformV1beta1Endpoint body, string parent)
Parameters
Type | Name | Description |
---|---|---|
GoogleCloudAiplatformV1beta1Endpoint | body | The body of the request. |
string | parent | Required. The resource name of the Location to create the Endpoint in. Format:
|
Returns
Type | Description |
---|---|
ProjectsResource.LocationsResource.EndpointsResource.CreateRequest |
Delete(string)
Deletes an Endpoint.
Declaration
public virtual ProjectsResource.LocationsResource.EndpointsResource.DeleteRequest Delete(string name)
Parameters
Type | Name | Description |
---|---|---|
string | name | Required. The name of the Endpoint resource to be deleted. Format:
|
Returns
Type | Description |
---|---|
ProjectsResource.LocationsResource.EndpointsResource.DeleteRequest |
DeployModel(GoogleCloudAiplatformV1beta1DeployModelRequest, string)
Deploys a Model into this Endpoint, creating a DeployedModel within it.
Declaration
public virtual ProjectsResource.LocationsResource.EndpointsResource.DeployModelRequest DeployModel(GoogleCloudAiplatformV1beta1DeployModelRequest body, string endpoint)
Parameters
Type | Name | Description |
---|---|---|
GoogleCloudAiplatformV1beta1DeployModelRequest | body | The body of the request. |
string | endpoint | Required. The name of the Endpoint resource into which to deploy a Model. Format:
|
Returns
Type | Description |
---|---|
ProjectsResource.LocationsResource.EndpointsResource.DeployModelRequest |
DirectPredict(GoogleCloudAiplatformV1beta1DirectPredictRequest, string)
Perform an unary online prediction request to a gRPC model server for Vertex first-party products and frameworks.
Declaration
public virtual ProjectsResource.LocationsResource.EndpointsResource.DirectPredictRequest DirectPredict(GoogleCloudAiplatformV1beta1DirectPredictRequest body, string endpoint)
Parameters
Type | Name | Description |
---|---|---|
GoogleCloudAiplatformV1beta1DirectPredictRequest | body | The body of the request. |
string | endpoint | Required. The name of the Endpoint requested to serve the prediction. Format:
|
Returns
Type | Description |
---|---|
ProjectsResource.LocationsResource.EndpointsResource.DirectPredictRequest |
DirectRawPredict(GoogleCloudAiplatformV1beta1DirectRawPredictRequest, string)
Perform an unary online prediction request to a gRPC model server for custom containers.
Declaration
public virtual ProjectsResource.LocationsResource.EndpointsResource.DirectRawPredictRequest DirectRawPredict(GoogleCloudAiplatformV1beta1DirectRawPredictRequest body, string endpoint)
Parameters
Type | Name | Description |
---|---|---|
GoogleCloudAiplatformV1beta1DirectRawPredictRequest | body | The body of the request. |
string | endpoint | Required. The name of the Endpoint requested to serve the prediction. Format:
|
Returns
Type | Description |
---|---|
ProjectsResource.LocationsResource.EndpointsResource.DirectRawPredictRequest |
Explain(GoogleCloudAiplatformV1beta1ExplainRequest, string)
Perform an online explanation. If deployed_model_id is specified, the corresponding DeployModel must have explanation_spec populated. If deployed_model_id is not specified, all DeployedModels must have explanation_spec populated.
Declaration
public virtual ProjectsResource.LocationsResource.EndpointsResource.ExplainRequest Explain(GoogleCloudAiplatformV1beta1ExplainRequest body, string endpoint)
Parameters
Type | Name | Description |
---|---|---|
GoogleCloudAiplatformV1beta1ExplainRequest | body | The body of the request. |
string | endpoint | Required. The name of the Endpoint requested to serve the explanation. Format:
|
Returns
Type | Description |
---|---|
ProjectsResource.LocationsResource.EndpointsResource.ExplainRequest |
FetchPredictOperation(GoogleCloudAiplatformV1beta1FetchPredictOperationRequest, string)
Fetch an asynchronous online prediction operation.
Declaration
public virtual ProjectsResource.LocationsResource.EndpointsResource.FetchPredictOperationRequest FetchPredictOperation(GoogleCloudAiplatformV1beta1FetchPredictOperationRequest body, string endpoint)
Parameters
Type | Name | Description |
---|---|---|
GoogleCloudAiplatformV1beta1FetchPredictOperationRequest | body | The body of the request. |
string | endpoint | Required. The name of the Endpoint requested to serve the prediction. Format:
|
Returns
Type | Description |
---|---|
ProjectsResource.LocationsResource.EndpointsResource.FetchPredictOperationRequest |
GenerateContent(GoogleCloudAiplatformV1beta1GenerateContentRequest, string)
Generate content with multimodal inputs.
Declaration
public virtual ProjectsResource.LocationsResource.EndpointsResource.GenerateContentRequest GenerateContent(GoogleCloudAiplatformV1beta1GenerateContentRequest body, string model)
Parameters
Type | Name | Description |
---|---|---|
GoogleCloudAiplatformV1beta1GenerateContentRequest | body | The body of the request. |
string | model | Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher
model format: |
Returns
Type | Description |
---|---|
ProjectsResource.LocationsResource.EndpointsResource.GenerateContentRequest |
Get(string)
Gets an Endpoint.
Declaration
public virtual ProjectsResource.LocationsResource.EndpointsResource.GetRequest Get(string name)
Parameters
Type | Name | Description |
---|---|---|
string | name | Required. The name of the Endpoint resource. Format:
|
Returns
Type | Description |
---|---|
ProjectsResource.LocationsResource.EndpointsResource.GetRequest |
GetIamPolicy(string)
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Declaration
public virtual ProjectsResource.LocationsResource.EndpointsResource.GetIamPolicyRequest GetIamPolicy(string resource)
Parameters
Type | Name | Description |
---|---|---|
string | resource | REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field. |
Returns
Type | Description |
---|---|
ProjectsResource.LocationsResource.EndpointsResource.GetIamPolicyRequest |
List(string)
Lists Endpoints in a Location.
Declaration
public virtual ProjectsResource.LocationsResource.EndpointsResource.ListRequest List(string parent)
Parameters
Type | Name | Description |
---|---|---|
string | parent | Required. The resource name of the Location from which to list the Endpoints. Format:
|
Returns
Type | Description |
---|---|
ProjectsResource.LocationsResource.EndpointsResource.ListRequest |
MutateDeployedModel(GoogleCloudAiplatformV1beta1MutateDeployedModelRequest, string)
Updates an existing deployed model. Updatable fields include min_replica_count
,
max_replica_count
, autoscaling_metric_specs
, disable_container_logging
(v1 only), and
enable_container_logging
(v1beta1 only).
Declaration
public virtual ProjectsResource.LocationsResource.EndpointsResource.MutateDeployedModelRequest MutateDeployedModel(GoogleCloudAiplatformV1beta1MutateDeployedModelRequest body, string endpoint)
Parameters
Type | Name | Description |
---|---|---|
GoogleCloudAiplatformV1beta1MutateDeployedModelRequest | body | The body of the request. |
string | endpoint | Required. The name of the Endpoint resource into which to mutate a DeployedModel. Format:
|
Returns
Type | Description |
---|---|
ProjectsResource.LocationsResource.EndpointsResource.MutateDeployedModelRequest |
Patch(GoogleCloudAiplatformV1beta1Endpoint, string)
Updates an Endpoint.
Declaration
public virtual ProjectsResource.LocationsResource.EndpointsResource.PatchRequest Patch(GoogleCloudAiplatformV1beta1Endpoint body, string name)
Parameters
Type | Name | Description |
---|---|---|
GoogleCloudAiplatformV1beta1Endpoint | body | The body of the request. |
string | name | Output only. The resource name of the Endpoint. |
Returns
Type | Description |
---|---|
ProjectsResource.LocationsResource.EndpointsResource.PatchRequest |
Predict(GoogleCloudAiplatformV1beta1PredictRequest, string)
Perform an online prediction.
Declaration
public virtual ProjectsResource.LocationsResource.EndpointsResource.PredictRequest Predict(GoogleCloudAiplatformV1beta1PredictRequest body, string endpoint)
Parameters
Type | Name | Description |
---|---|---|
GoogleCloudAiplatformV1beta1PredictRequest | body | The body of the request. |
string | endpoint | Required. The name of the Endpoint requested to serve the prediction. Format:
|
Returns
Type | Description |
---|---|
ProjectsResource.LocationsResource.EndpointsResource.PredictRequest |
PredictLongRunning(GoogleCloudAiplatformV1beta1PredictLongRunningRequest, string)
Declaration
public virtual ProjectsResource.LocationsResource.EndpointsResource.PredictLongRunningRequest PredictLongRunning(GoogleCloudAiplatformV1beta1PredictLongRunningRequest body, string endpoint)
Parameters
Type | Name | Description |
---|---|---|
GoogleCloudAiplatformV1beta1PredictLongRunningRequest | body | The body of the request. |
string | endpoint | Required. The name of the Endpoint requested to serve the prediction. Format:
|
Returns
Type | Description |
---|---|
ProjectsResource.LocationsResource.EndpointsResource.PredictLongRunningRequest |
RawPredict(GoogleCloudAiplatformV1beta1RawPredictRequest, string)
Perform an online prediction with an arbitrary HTTP payload. The response includes the following
HTTP headers: * X-Vertex-AI-Endpoint-Id
: ID of the Endpoint that served this prediction. *
X-Vertex-AI-Deployed-Model-Id
: ID of the Endpoint's DeployedModel that served this prediction.
Declaration
public virtual ProjectsResource.LocationsResource.EndpointsResource.RawPredictRequest RawPredict(GoogleCloudAiplatformV1beta1RawPredictRequest body, string endpoint)
Parameters
Type | Name | Description |
---|---|---|
GoogleCloudAiplatformV1beta1RawPredictRequest | body | The body of the request. |
string | endpoint | Required. The name of the Endpoint requested to serve the prediction. Format:
|
Returns
Type | Description |
---|---|
ProjectsResource.LocationsResource.EndpointsResource.RawPredictRequest |
ServerStreamingPredict(GoogleCloudAiplatformV1beta1StreamingPredictRequest, string)
Perform a server-side streaming online prediction request for Vertex LLM streaming.
Declaration
public virtual ProjectsResource.LocationsResource.EndpointsResource.ServerStreamingPredictRequest ServerStreamingPredict(GoogleCloudAiplatformV1beta1StreamingPredictRequest body, string endpoint)
Parameters
Type | Name | Description |
---|---|---|
GoogleCloudAiplatformV1beta1StreamingPredictRequest | body | The body of the request. |
string | endpoint | Required. The name of the Endpoint requested to serve the prediction. Format:
|
Returns
Type | Description |
---|---|
ProjectsResource.LocationsResource.EndpointsResource.ServerStreamingPredictRequest |
SetIamPolicy(GoogleIamV1SetIamPolicyRequest, string)
Sets the access control policy on the specified resource. Replaces any existing policy. Can return
NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
Declaration
public virtual ProjectsResource.LocationsResource.EndpointsResource.SetIamPolicyRequest SetIamPolicy(GoogleIamV1SetIamPolicyRequest body, string resource)
Parameters
Type | Name | Description |
---|---|---|
GoogleIamV1SetIamPolicyRequest | body | The body of the request. |
string | resource | REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field. |
Returns
Type | Description |
---|---|
ProjectsResource.LocationsResource.EndpointsResource.SetIamPolicyRequest |
StreamGenerateContent(GoogleCloudAiplatformV1beta1GenerateContentRequest, string)
Generate content with multimodal inputs with streaming support.
Declaration
public virtual ProjectsResource.LocationsResource.EndpointsResource.StreamGenerateContentRequest StreamGenerateContent(GoogleCloudAiplatformV1beta1GenerateContentRequest body, string model)
Parameters
Type | Name | Description |
---|---|---|
GoogleCloudAiplatformV1beta1GenerateContentRequest | body | The body of the request. |
string | model | Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher
model format: |
Returns
Type | Description |
---|---|
ProjectsResource.LocationsResource.EndpointsResource.StreamGenerateContentRequest |
StreamRawPredict(GoogleCloudAiplatformV1beta1StreamRawPredictRequest, string)
Perform a streaming online prediction with an arbitrary HTTP payload.
Declaration
public virtual ProjectsResource.LocationsResource.EndpointsResource.StreamRawPredictRequest StreamRawPredict(GoogleCloudAiplatformV1beta1StreamRawPredictRequest body, string endpoint)
Parameters
Type | Name | Description |
---|---|---|
GoogleCloudAiplatformV1beta1StreamRawPredictRequest | body | The body of the request. |
string | endpoint | Required. The name of the Endpoint requested to serve the prediction. Format:
|
Returns
Type | Description |
---|---|
ProjectsResource.LocationsResource.EndpointsResource.StreamRawPredictRequest |
TestIamPermissions(string)
Returns permissions that a caller has on the specified resource. If the resource does not exist,
this will return an empty set of permissions, not a NOT_FOUND
error. Note: This operation is
designed to be used for building permission-aware UIs and command-line tools, not for authorization
checking. This operation may "fail open" without warning.
Declaration
public virtual ProjectsResource.LocationsResource.EndpointsResource.TestIamPermissionsRequest TestIamPermissions(string resource)
Parameters
Type | Name | Description |
---|---|---|
string | resource | REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field. |
Returns
Type | Description |
---|---|
ProjectsResource.LocationsResource.EndpointsResource.TestIamPermissionsRequest |
UndeployModel(GoogleCloudAiplatformV1beta1UndeployModelRequest, string)
Undeploys a Model from an Endpoint, removing a DeployedModel from it, and freeing all resources it's using.
Declaration
public virtual ProjectsResource.LocationsResource.EndpointsResource.UndeployModelRequest UndeployModel(GoogleCloudAiplatformV1beta1UndeployModelRequest body, string endpoint)
Parameters
Type | Name | Description |
---|---|---|
GoogleCloudAiplatformV1beta1UndeployModelRequest | body | The body of the request. |
string | endpoint | Required. The name of the Endpoint resource from which to undeploy a Model. Format:
|
Returns
Type | Description |
---|---|
ProjectsResource.LocationsResource.EndpointsResource.UndeployModelRequest |
Update(GoogleCloudAiplatformV1beta1UpdateEndpointLongRunningRequest, string)
Updates an Endpoint with a long running operation.
Declaration
public virtual ProjectsResource.LocationsResource.EndpointsResource.UpdateRequest Update(GoogleCloudAiplatformV1beta1UpdateEndpointLongRunningRequest body, string name)
Parameters
Type | Name | Description |
---|---|---|
GoogleCloudAiplatformV1beta1UpdateEndpointLongRunningRequest | body | The body of the request. |
string | name | Output only. The resource name of the Endpoint. |
Returns
Type | Description |
---|---|
ProjectsResource.LocationsResource.EndpointsResource.UpdateRequest |