Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class DatasetServiceClient.
Service Description: The service that manages Vertex AI Dataset and its child resources.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.
Namespace
Google \ Cloud \ AIPlatform \ V1 \ ClientMethods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
options |
array
Optional. Options for configuring the service API wrapper. |
↳ apiEndpoint |
string
The address of the API remote host. May optionally include the port, formatted as "
|
↳ credentials |
string|array|FetchAuthTokenInterface|CredentialsWrapper
The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. |
↳ credentialsConfig |
array
Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() . |
↳ disableRetries |
bool
Determines whether or not retries defined by the client configuration should be disabled. Defaults to |
↳ clientConfig |
string|array
Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder. |
↳ transport |
string|TransportInterface
The transport used for executing network requests. May be either the string |
↳ transportConfig |
array
Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options. |
↳ clientCertSource |
callable
A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS. |
↳ logger |
false|LoggerInterface
A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag |
createDataset
Creates a Dataset.
The async variant is DatasetServiceClient::createDatasetAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\AIPlatform\V1\CreateDatasetRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\Client\DatasetServiceClient;
use Google\Cloud\AIPlatform\V1\CreateDatasetRequest;
use Google\Cloud\AIPlatform\V1\Dataset;
use Google\Protobuf\Value;
use Google\Rpc\Status;
/**
* @param string $formattedParent The resource name of the Location to create the Dataset in.
* Format: `projects/{project}/locations/{location}`
* Please see {@see DatasetServiceClient::locationName()} for help formatting this field.
* @param string $datasetDisplayName The user-defined name of the Dataset.
* The name can be up to 128 characters long and can consist of any UTF-8
* characters.
* @param string $datasetMetadataSchemaUri Points to a YAML file stored on Google Cloud Storage describing
* additional information about the Dataset. The schema is defined as an
* OpenAPI 3.0.2 Schema Object. The schema files that can be used here are
* found in gs://google-cloud-aiplatform/schema/dataset/metadata/.
*/
function create_dataset_sample(
string $formattedParent,
string $datasetDisplayName,
string $datasetMetadataSchemaUri
): void {
// Create a client.
$datasetServiceClient = new DatasetServiceClient();
// Prepare the request message.
$datasetMetadata = new Value();
$dataset = (new Dataset())
->setDisplayName($datasetDisplayName)
->setMetadataSchemaUri($datasetMetadataSchemaUri)
->setMetadata($datasetMetadata);
$request = (new CreateDatasetRequest())
->setParent($formattedParent)
->setDataset($dataset);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $datasetServiceClient->createDataset($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Dataset $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedParent = DatasetServiceClient::locationName('[PROJECT]', '[LOCATION]');
$datasetDisplayName = '[DISPLAY_NAME]';
$datasetMetadataSchemaUri = '[METADATA_SCHEMA_URI]';
create_dataset_sample($formattedParent, $datasetDisplayName, $datasetMetadataSchemaUri);
}
createDatasetVersion
Create a version from a Dataset.
The async variant is DatasetServiceClient::createDatasetVersionAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\AIPlatform\V1\CreateDatasetVersionRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\Client\DatasetServiceClient;
use Google\Cloud\AIPlatform\V1\CreateDatasetVersionRequest;
use Google\Cloud\AIPlatform\V1\DatasetVersion;
use Google\Protobuf\Value;
use Google\Rpc\Status;
/**
* @param string $formattedParent The name of the Dataset resource.
* Format:
* `projects/{project}/locations/{location}/datasets/{dataset}`
* Please see {@see DatasetServiceClient::datasetName()} for help formatting this field.
*/
function create_dataset_version_sample(string $formattedParent): void
{
// Create a client.
$datasetServiceClient = new DatasetServiceClient();
// Prepare the request message.
$datasetVersionMetadata = new Value();
$datasetVersion = (new DatasetVersion())
->setMetadata($datasetVersionMetadata);
$request = (new CreateDatasetVersionRequest())
->setParent($formattedParent)
->setDatasetVersion($datasetVersion);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $datasetServiceClient->createDatasetVersion($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var DatasetVersion $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedParent = DatasetServiceClient::datasetName('[PROJECT]', '[LOCATION]', '[DATASET]');
create_dataset_version_sample($formattedParent);
}
deleteDataset
Deletes a Dataset.
The async variant is DatasetServiceClient::deleteDatasetAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\AIPlatform\V1\DeleteDatasetRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\Client\DatasetServiceClient;
use Google\Cloud\AIPlatform\V1\DeleteDatasetRequest;
use Google\Rpc\Status;
/**
* @param string $formattedName The resource name of the Dataset to delete.
* Format:
* `projects/{project}/locations/{location}/datasets/{dataset}`
* Please see {@see DatasetServiceClient::datasetName()} for help formatting this field.
*/
function delete_dataset_sample(string $formattedName): void
{
// Create a client.
$datasetServiceClient = new DatasetServiceClient();
// Prepare the request message.
$request = (new DeleteDatasetRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $datasetServiceClient->deleteDataset($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
printf('Operation completed successfully.' . PHP_EOL);
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = DatasetServiceClient::datasetName('[PROJECT]', '[LOCATION]', '[DATASET]');
delete_dataset_sample($formattedName);
}
deleteDatasetVersion
Deletes a Dataset version.
The async variant is DatasetServiceClient::deleteDatasetVersionAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\AIPlatform\V1\DeleteDatasetVersionRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\Client\DatasetServiceClient;
use Google\Cloud\AIPlatform\V1\DeleteDatasetVersionRequest;
use Google\Rpc\Status;
/**
* @param string $formattedName The resource name of the Dataset version to delete.
* Format:
* `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
* Please see {@see DatasetServiceClient::datasetVersionName()} for help formatting this field.
*/
function delete_dataset_version_sample(string $formattedName): void
{
// Create a client.
$datasetServiceClient = new DatasetServiceClient();
// Prepare the request message.
$request = (new DeleteDatasetVersionRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $datasetServiceClient->deleteDatasetVersion($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
printf('Operation completed successfully.' . PHP_EOL);
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = DatasetServiceClient::datasetVersionName(
'[PROJECT]',
'[LOCATION]',
'[DATASET]',
'[DATASET_VERSION]'
);
delete_dataset_version_sample($formattedName);
}
deleteSavedQuery
Deletes a SavedQuery.
The async variant is DatasetServiceClient::deleteSavedQueryAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\AIPlatform\V1\DeleteSavedQueryRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\Client\DatasetServiceClient;
use Google\Cloud\AIPlatform\V1\DeleteSavedQueryRequest;
use Google\Rpc\Status;
/**
* @param string $formattedName The resource name of the SavedQuery to delete.
* Format:
* `projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}`
* Please see {@see DatasetServiceClient::savedQueryName()} for help formatting this field.
*/
function delete_saved_query_sample(string $formattedName): void
{
// Create a client.
$datasetServiceClient = new DatasetServiceClient();
// Prepare the request message.
$request = (new DeleteSavedQueryRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $datasetServiceClient->deleteSavedQuery($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
printf('Operation completed successfully.' . PHP_EOL);
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = DatasetServiceClient::savedQueryName(
'[PROJECT]',
'[LOCATION]',
'[DATASET]',
'[SAVED_QUERY]'
);
delete_saved_query_sample($formattedName);
}
exportData
Exports data from a Dataset.
The async variant is DatasetServiceClient::exportDataAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\AIPlatform\V1\ExportDataRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\Client\DatasetServiceClient;
use Google\Cloud\AIPlatform\V1\ExportDataConfig;
use Google\Cloud\AIPlatform\V1\ExportDataRequest;
use Google\Cloud\AIPlatform\V1\ExportDataResponse;
use Google\Rpc\Status;
/**
* @param string $formattedName The name of the Dataset resource.
* Format:
* `projects/{project}/locations/{location}/datasets/{dataset}`
* Please see {@see DatasetServiceClient::datasetName()} for help formatting this field.
*/
function export_data_sample(string $formattedName): void
{
// Create a client.
$datasetServiceClient = new DatasetServiceClient();
// Prepare the request message.
$exportConfig = new ExportDataConfig();
$request = (new ExportDataRequest())
->setName($formattedName)
->setExportConfig($exportConfig);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $datasetServiceClient->exportData($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var ExportDataResponse $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = DatasetServiceClient::datasetName('[PROJECT]', '[LOCATION]', '[DATASET]');
export_data_sample($formattedName);
}
getAnnotationSpec
Gets an AnnotationSpec.
The async variant is DatasetServiceClient::getAnnotationSpecAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\AIPlatform\V1\GetAnnotationSpecRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\AIPlatform\V1\AnnotationSpec |
use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\AnnotationSpec;
use Google\Cloud\AIPlatform\V1\Client\DatasetServiceClient;
use Google\Cloud\AIPlatform\V1\GetAnnotationSpecRequest;
/**
* @param string $formattedName The name of the AnnotationSpec resource.
* Format:
* `projects/{project}/locations/{location}/datasets/{dataset}/annotationSpecs/{annotation_spec}`
* Please see {@see DatasetServiceClient::annotationSpecName()} for help formatting this field.
*/
function get_annotation_spec_sample(string $formattedName): void
{
// Create a client.
$datasetServiceClient = new DatasetServiceClient();
// Prepare the request message.
$request = (new GetAnnotationSpecRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var AnnotationSpec $response */
$response = $datasetServiceClient->getAnnotationSpec($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = DatasetServiceClient::annotationSpecName(
'[PROJECT]',
'[LOCATION]',
'[DATASET]',
'[ANNOTATION_SPEC]'
);
get_annotation_spec_sample($formattedName);
}
getDataset
Gets a Dataset.
The async variant is DatasetServiceClient::getDatasetAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\AIPlatform\V1\GetDatasetRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\AIPlatform\V1\Dataset |
use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\DatasetServiceClient;
use Google\Cloud\AIPlatform\V1\Dataset;
use Google\Cloud\AIPlatform\V1\GetDatasetRequest;
/**
* @param string $formattedName The name of the Dataset resource. Please see
* {@see DatasetServiceClient::datasetName()} for help formatting this field.
*/
function get_dataset_sample(string $formattedName): void
{
// Create a client.
$datasetServiceClient = new DatasetServiceClient();
// Prepare the request message.
$request = (new GetDatasetRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var Dataset $response */
$response = $datasetServiceClient->getDataset($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = DatasetServiceClient::datasetName('[PROJECT]', '[LOCATION]', '[DATASET]');
get_dataset_sample($formattedName);
}
getDatasetVersion
Gets a Dataset version.
The async variant is DatasetServiceClient::getDatasetVersionAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\AIPlatform\V1\GetDatasetVersionRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\AIPlatform\V1\DatasetVersion |
use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\DatasetServiceClient;
use Google\Cloud\AIPlatform\V1\DatasetVersion;
use Google\Cloud\AIPlatform\V1\GetDatasetVersionRequest;
/**
* @param string $formattedName The resource name of the Dataset version to delete.
* Format:
* `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
* Please see {@see DatasetServiceClient::datasetVersionName()} for help formatting this field.
*/
function get_dataset_version_sample(string $formattedName): void
{
// Create a client.
$datasetServiceClient = new DatasetServiceClient();
// Prepare the request message.
$request = (new GetDatasetVersionRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var DatasetVersion $response */
$response = $datasetServiceClient->getDatasetVersion($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = DatasetServiceClient::datasetVersionName(
'[PROJECT]',
'[LOCATION]',
'[DATASET]',
'[DATASET_VERSION]'
);
get_dataset_version_sample($formattedName);
}
importData
Imports data into a Dataset.
The async variant is DatasetServiceClient::importDataAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\AIPlatform\V1\ImportDataRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\Client\DatasetServiceClient;
use Google\Cloud\AIPlatform\V1\ImportDataConfig;
use Google\Cloud\AIPlatform\V1\ImportDataRequest;
use Google\Cloud\AIPlatform\V1\ImportDataResponse;
use Google\Rpc\Status;
/**
* @param string $formattedName The name of the Dataset resource.
* Format:
* `projects/{project}/locations/{location}/datasets/{dataset}`
* Please see {@see DatasetServiceClient::datasetName()} for help formatting this field.
* @param string $importConfigsImportSchemaUri Points to a YAML file stored on Google Cloud Storage describing
* the import format. Validation will be done against the schema. The schema
* is defined as an [OpenAPI 3.0.2 Schema
* Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
*/
function import_data_sample(string $formattedName, string $importConfigsImportSchemaUri): void
{
// Create a client.
$datasetServiceClient = new DatasetServiceClient();
// Prepare the request message.
$importDataConfig = (new ImportDataConfig())
->setImportSchemaUri($importConfigsImportSchemaUri);
$importConfigs = [$importDataConfig,];
$request = (new ImportDataRequest())
->setName($formattedName)
->setImportConfigs($importConfigs);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $datasetServiceClient->importData($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var ImportDataResponse $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = DatasetServiceClient::datasetName('[PROJECT]', '[LOCATION]', '[DATASET]');
$importConfigsImportSchemaUri = '[IMPORT_SCHEMA_URI]';
import_data_sample($formattedName, $importConfigsImportSchemaUri);
}
listAnnotations
Lists Annotations belongs to a dataitem This RPC is only available in InternalDatasetService. It is only used for exporting conversation data to CCAI Insights.
The async variant is DatasetServiceClient::listAnnotationsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\AIPlatform\V1\ListAnnotationsRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\AIPlatform\V1\Annotation;
use Google\Cloud\AIPlatform\V1\Client\DatasetServiceClient;
use Google\Cloud\AIPlatform\V1\ListAnnotationsRequest;
/**
* @param string $formattedParent The resource name of the DataItem to list Annotations from.
* Format:
* `projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}`
* Please see {@see DatasetServiceClient::dataItemName()} for help formatting this field.
*/
function list_annotations_sample(string $formattedParent): void
{
// Create a client.
$datasetServiceClient = new DatasetServiceClient();
// Prepare the request message.
$request = (new ListAnnotationsRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $datasetServiceClient->listAnnotations($request);
/** @var Annotation $element */
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedParent = DatasetServiceClient::dataItemName(
'[PROJECT]',
'[LOCATION]',
'[DATASET]',
'[DATA_ITEM]'
);
list_annotations_sample($formattedParent);
}
listDataItems
Lists DataItems in a Dataset.
The async variant is DatasetServiceClient::listDataItemsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\AIPlatform\V1\ListDataItemsRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\AIPlatform\V1\Client\DatasetServiceClient;
use Google\Cloud\AIPlatform\V1\DataItem;
use Google\Cloud\AIPlatform\V1\ListDataItemsRequest;
/**
* @param string $formattedParent The resource name of the Dataset to list DataItems from.
* Format:
* `projects/{project}/locations/{location}/datasets/{dataset}`
* Please see {@see DatasetServiceClient::datasetName()} for help formatting this field.
*/
function list_data_items_sample(string $formattedParent): void
{
// Create a client.
$datasetServiceClient = new DatasetServiceClient();
// Prepare the request message.
$request = (new ListDataItemsRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $datasetServiceClient->listDataItems($request);
/** @var DataItem $element */
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedParent = DatasetServiceClient::datasetName('[PROJECT]', '[LOCATION]', '[DATASET]');
list_data_items_sample($formattedParent);
}
listDatasetVersions
Lists DatasetVersions in a Dataset.
The async variant is DatasetServiceClient::listDatasetVersionsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\AIPlatform\V1\ListDatasetVersionsRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\AIPlatform\V1\Client\DatasetServiceClient;
use Google\Cloud\AIPlatform\V1\DatasetVersion;
use Google\Cloud\AIPlatform\V1\ListDatasetVersionsRequest;
/**
* @param string $formattedParent The resource name of the Dataset to list DatasetVersions from.
* Format:
* `projects/{project}/locations/{location}/datasets/{dataset}`
* Please see {@see DatasetServiceClient::datasetName()} for help formatting this field.
*/
function list_dataset_versions_sample(string $formattedParent): void
{
// Create a client.
$datasetServiceClient = new DatasetServiceClient();
// Prepare the request message.
$request = (new ListDatasetVersionsRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $datasetServiceClient->listDatasetVersions($request);
/** @var DatasetVersion $element */
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedParent = DatasetServiceClient::datasetName('[PROJECT]', '[LOCATION]', '[DATASET]');
list_dataset_versions_sample($formattedParent);
}
listDatasets
Lists Datasets in a Location.
The async variant is DatasetServiceClient::listDatasetsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\AIPlatform\V1\ListDatasetsRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\AIPlatform\V1\Client\DatasetServiceClient;
use Google\Cloud\AIPlatform\V1\Dataset;
use Google\Cloud\AIPlatform\V1\ListDatasetsRequest;
/**
* @param string $formattedParent The name of the Dataset's parent resource.
* Format: `projects/{project}/locations/{location}`
* Please see {@see DatasetServiceClient::locationName()} for help formatting this field.
*/
function list_datasets_sample(string $formattedParent): void
{
// Create a client.
$datasetServiceClient = new DatasetServiceClient();
// Prepare the request message.
$request = (new ListDatasetsRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $datasetServiceClient->listDatasets($request);
/** @var Dataset $element */
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedParent = DatasetServiceClient::locationName('[PROJECT]', '[LOCATION]');
list_datasets_sample($formattedParent);
}
listSavedQueries
Lists SavedQueries in a Dataset.
The async variant is DatasetServiceClient::listSavedQueriesAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\AIPlatform\V1\ListSavedQueriesRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\AIPlatform\V1\Client\DatasetServiceClient;
use Google\Cloud\AIPlatform\V1\ListSavedQueriesRequest;
use Google\Cloud\AIPlatform\V1\SavedQuery;
/**
* @param string $formattedParent The resource name of the Dataset to list SavedQueries from.
* Format:
* `projects/{project}/locations/{location}/datasets/{dataset}`
* Please see {@see DatasetServiceClient::datasetName()} for help formatting this field.
*/
function list_saved_queries_sample(string $formattedParent): void
{
// Create a client.
$datasetServiceClient = new DatasetServiceClient();
// Prepare the request message.
$request = (new ListSavedQueriesRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $datasetServiceClient->listSavedQueries($request);
/** @var SavedQuery $element */
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedParent = DatasetServiceClient::datasetName('[PROJECT]', '[LOCATION]', '[DATASET]');
list_saved_queries_sample($formattedParent);
}
restoreDatasetVersion
Restores a dataset version.
The async variant is DatasetServiceClient::restoreDatasetVersionAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\AIPlatform\V1\RestoreDatasetVersionRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\Client\DatasetServiceClient;
use Google\Cloud\AIPlatform\V1\DatasetVersion;
use Google\Cloud\AIPlatform\V1\RestoreDatasetVersionRequest;
use Google\Rpc\Status;
/**
* @param string $formattedName The name of the DatasetVersion resource.
* Format:
* `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
* Please see {@see DatasetServiceClient::datasetVersionName()} for help formatting this field.
*/
function restore_dataset_version_sample(string $formattedName): void
{
// Create a client.
$datasetServiceClient = new DatasetServiceClient();
// Prepare the request message.
$request = (new RestoreDatasetVersionRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $datasetServiceClient->restoreDatasetVersion($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var DatasetVersion $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = DatasetServiceClient::datasetVersionName(
'[PROJECT]',
'[LOCATION]',
'[DATASET]',
'[DATASET_VERSION]'
);
restore_dataset_version_sample($formattedName);
}
searchDataItems
Searches DataItems in a Dataset.
The async variant is DatasetServiceClient::searchDataItemsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\AIPlatform\V1\SearchDataItemsRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\AIPlatform\V1\Client\DatasetServiceClient;
use Google\Cloud\AIPlatform\V1\DataItemView;
use Google\Cloud\AIPlatform\V1\SearchDataItemsRequest;
/**
* @param string $formattedDataset The resource name of the Dataset from which to search DataItems.
* Format:
* `projects/{project}/locations/{location}/datasets/{dataset}`
* Please see {@see DatasetServiceClient::datasetName()} for help formatting this field.
*/
function search_data_items_sample(string $formattedDataset): void
{
// Create a client.
$datasetServiceClient = new DatasetServiceClient();
// Prepare the request message.
$request = (new SearchDataItemsRequest())
->setDataset($formattedDataset);
// Call the API and handle any ne