1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Aiplatform
  7. \
  8. Resource
  9. \
  10. ProjectsLocationsIndexEndpoints

ProjectsLocationsIndexEndpoints

class ProjectsLocationsIndexEndpoints extends Resource (View source)

The "indexEndpoints" collection of methods.

Typical usage is:

 $aiplatformService = new Google\Service\Aiplatform(...);
 $indexEndpoints = $aiplatformService->projects_locations_indexEndpoints;

Methods

GoogleLongrunningOperation
create(string $parent, GoogleCloudAiplatformV1IndexEndpoint $postBody, array $optParams = [])

Creates an IndexEndpoint. (indexEndpoints.create)

GoogleLongrunningOperation
delete(string $name, array $optParams = [])

Deletes an IndexEndpoint. (indexEndpoints.delete)

GoogleLongrunningOperation
deployIndex(string $indexEndpoint, GoogleCloudAiplatformV1DeployIndexRequest $postBody, array $optParams = [])

Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it.

GoogleCloudAiplatformV1FindNeighborsResponse
findNeighbors(string $indexEndpoint, GoogleCloudAiplatformV1FindNeighborsRequest $postBody, array $optParams = [])

Finds the nearest neighbors of each vector within the request.

GoogleCloudAiplatformV1IndexEndpoint
get(string $name, array $optParams = [])

Gets an IndexEndpoint. (indexEndpoints.get)

GoogleCloudAiplatformV1ListIndexEndpointsResponse
listProjectsLocationsIndexEndpoints(string $parent, array $optParams = [])

Lists IndexEndpoints in a Location.

GoogleLongrunningOperation
mutateDeployedIndex(string $indexEndpoint, GoogleCloudAiplatformV1DeployedIndex $postBody, array $optParams = [])

Update an existing DeployedIndex under an IndexEndpoint.

GoogleCloudAiplatformV1IndexEndpoint
patch(string $name, GoogleCloudAiplatformV1IndexEndpoint $postBody, array $optParams = [])

Updates an IndexEndpoint. (indexEndpoints.patch)

GoogleCloudAiplatformV1ReadIndexDatapointsResponse
readIndexDatapoints(string $indexEndpoint, GoogleCloudAiplatformV1ReadIndexDatapointsRequest $postBody, array $optParams = [])

Reads the datapoints/vectors of the given IDs. A maximum of 1000 datapoints can be retrieved in a batch. (indexEndpoints.readIndexDatapoints)

GoogleLongrunningOperation
undeployIndex(string $indexEndpoint, GoogleCloudAiplatformV1UndeployIndexRequest $postBody, array $optParams = [])

Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using. (indexEndpoints.undeployIndex)

Details

at line 51
GoogleLongrunningOperation create(string $parent, GoogleCloudAiplatformV1IndexEndpoint $postBody, array $optParams = [])

Creates an IndexEndpoint. (indexEndpoints.create)

Parameters

string $parent

Required. The resource name of the Location to create the IndexEndpoint in. Format: projects/{project}/locations/{location}
GoogleCloudAiplatformV1IndexEndpoint $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

at line 67
GoogleLongrunningOperation delete(string $name, array $optParams = [])

Deletes an IndexEndpoint. (indexEndpoints.delete)

Parameters

string $name

Required. The name of the IndexEndpoint resource to be deleted. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

at line 85
GoogleLongrunningOperation deployIndex(string $indexEndpoint, GoogleCloudAiplatformV1DeployIndexRequest $postBody, array $optParams = [])

Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it.

Only non-empty Indexes can be deployed. (indexEndpoints.deployIndex)

Parameters

string $indexEndpoint

Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
GoogleCloudAiplatformV1DeployIndexRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

at line 103
GoogleCloudAiplatformV1FindNeighborsResponse findNeighbors(string $indexEndpoint, GoogleCloudAiplatformV1FindNeighborsRequest $postBody, array $optParams = [])

Finds the nearest neighbors of each vector within the request.

(indexEndpoints.findNeighbors)

Parameters

string $indexEndpoint

Required. The name of the index endpoint. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
GoogleCloudAiplatformV1FindNeighborsRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1FindNeighborsResponse

Exceptions

Exception

at line 118
GoogleCloudAiplatformV1IndexEndpoint get(string $name, array $optParams = [])

Gets an IndexEndpoint. (indexEndpoints.get)

Parameters

string $name

Required. The name of the IndexEndpoint resource. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1IndexEndpoint

Exceptions

Exception

at line 151
GoogleCloudAiplatformV1ListIndexEndpointsResponse listProjectsLocationsIndexEndpoints(string $parent, array $optParams = [])

Lists IndexEndpoints in a Location.

(indexEndpoints.listProjectsLocationsIndexEndpoints)

Parameters

string $parent

Required. The resource name of the Location from which to list the IndexEndpoints. Format: projects/{project}/locations/{location}
array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1ListIndexEndpointsResponse

Exceptions

Exception

at line 169
GoogleLongrunningOperation mutateDeployedIndex(string $indexEndpoint, GoogleCloudAiplatformV1DeployedIndex $postBody, array $optParams = [])

Update an existing DeployedIndex under an IndexEndpoint.

(indexEndpoints.mutateDeployedIndex)

Parameters

string $indexEndpoint

Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
GoogleCloudAiplatformV1DeployedIndex $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

at line 187
GoogleCloudAiplatformV1IndexEndpoint patch(string $name, GoogleCloudAiplatformV1IndexEndpoint $postBody, array $optParams = [])

Updates an IndexEndpoint. (indexEndpoints.patch)

Parameters

string $name

Output only. The resource name of the IndexEndpoint.
GoogleCloudAiplatformV1IndexEndpoint $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1IndexEndpoint

Exceptions

Exception

at line 205
GoogleCloudAiplatformV1ReadIndexDatapointsResponse readIndexDatapoints(string $indexEndpoint, GoogleCloudAiplatformV1ReadIndexDatapointsRequest $postBody, array $optParams = [])

Reads the datapoints/vectors of the given IDs. A maximum of 1000 datapoints can be retrieved in a batch. (indexEndpoints.readIndexDatapoints)

Parameters

string $indexEndpoint

Required. The name of the index endpoint. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
GoogleCloudAiplatformV1ReadIndexDatapointsRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1ReadIndexDatapointsResponse

Exceptions

Exception

at line 223
GoogleLongrunningOperation undeployIndex(string $indexEndpoint, GoogleCloudAiplatformV1UndeployIndexRequest $postBody, array $optParams = [])

Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using. (indexEndpoints.undeployIndex)

Parameters

string $indexEndpoint

Required. The name of the IndexEndpoint resource from which to undeploy an Index. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
GoogleCloudAiplatformV1UndeployIndexRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception