Google Cloud Ai Platform V1 Client - Class VertexRagDataServiceClient (1.13.1)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class VertexRagDataServiceClient.

Service Description: A service for managing user data for RAG.

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 \ Client

Methods

__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 false.

↳ 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 rest or grpc. Defaults to grpc if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.

↳ 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

createRagCorpus

Creates a RagCorpus.

The async variant is VertexRagDataServiceClient::createRagCorpusAsync() .

Parameters
Name Description
request Google\Cloud\AIPlatform\V1\CreateRagCorpusRequest

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
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\Client\VertexRagDataServiceClient;
use Google\Cloud\AIPlatform\V1\CreateRagCorpusRequest;
use Google\Cloud\AIPlatform\V1\RagCorpus;
use Google\Rpc\Status;

/**
 * @param string $formattedParent      The resource name of the Location to create the RagCorpus in.
 *                                     Format: `projects/{project}/locations/{location}`
 *                                     Please see {@see VertexRagDataServiceClient::locationName()} for help formatting this field.
 * @param string $ragCorpusDisplayName The display name of the RagCorpus.
 *                                     The name can be up to 128 characters long and can consist of any UTF-8
 *                                     characters.
 */
function create_rag_corpus_sample(string $formattedParent, string $ragCorpusDisplayName): void
{
    // Create a client.
    $vertexRagDataServiceClient = new VertexRagDataServiceClient();

    // Prepare the request message.
    $ragCorpus = (new RagCorpus())
        ->setDisplayName($ragCorpusDisplayName);
    $request = (new CreateRagCorpusRequest())
        ->setParent($formattedParent)
        ->setRagCorpus($ragCorpus);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $vertexRagDataServiceClient->createRagCorpus($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var RagCorpus $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 = VertexRagDataServiceClient::locationName('[PROJECT]', '[LOCATION]');
    $ragCorpusDisplayName = '[DISPLAY_NAME]';

    create_rag_corpus_sample($formattedParent, $ragCorpusDisplayName);
}

deleteRagCorpus

Deletes a RagCorpus.

The async variant is VertexRagDataServiceClient::deleteRagCorpusAsync() .

Parameters
Name Description
request Google\Cloud\AIPlatform\V1\DeleteRagCorpusRequest

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
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\Client\VertexRagDataServiceClient;
use Google\Cloud\AIPlatform\V1\DeleteRagCorpusRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName The name of the RagCorpus resource to be deleted.
 *                              Format:
 *                              `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
 *                              Please see {@see VertexRagDataServiceClient::ragCorpusName()} for help formatting this field.
 */
function delete_rag_corpus_sample(string $formattedName): void
{
    // Create a client.
    $vertexRagDataServiceClient = new VertexRagDataServiceClient();

    // Prepare the request message.
    $request = (new DeleteRagCorpusRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $vertexRagDataServiceClient->deleteRagCorpus($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 = VertexRagDataServiceClient::ragCorpusName(
        '[PROJECT]',
        '[LOCATION]',
        '[RAG_CORPUS]'
    );

    delete_rag_corpus_sample($formattedName);
}

deleteRagFile

Deletes a RagFile.

The async variant is VertexRagDataServiceClient::deleteRagFileAsync() .

Parameters
Name Description
request Google\Cloud\AIPlatform\V1\DeleteRagFileRequest

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
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\Client\VertexRagDataServiceClient;
use Google\Cloud\AIPlatform\V1\DeleteRagFileRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName The name of the RagFile resource to be deleted.
 *                              Format:
 *                              `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}`
 *                              Please see {@see VertexRagDataServiceClient::ragFileName()} for help formatting this field.
 */
function delete_rag_file_sample(string $formattedName): void
{
    // Create a client.
    $vertexRagDataServiceClient = new VertexRagDataServiceClient();

    // Prepare the request message.
    $request = (new DeleteRagFileRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $vertexRagDataServiceClient->deleteRagFile($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 = VertexRagDataServiceClient::ragFileName(
        '[PROJECT]',
        '[LOCATION]',
        '[RAG_CORPUS]',
        '[RAG_FILE]'
    );

    delete_rag_file_sample($formattedName);
}

getRagCorpus

Gets a RagCorpus.

The async variant is VertexRagDataServiceClient::getRagCorpusAsync() .

Parameters
Name Description
request Google\Cloud\AIPlatform\V1\GetRagCorpusRequest

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\RagCorpus
Example
use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\VertexRagDataServiceClient;
use Google\Cloud\AIPlatform\V1\GetRagCorpusRequest;
use Google\Cloud\AIPlatform\V1\RagCorpus;

/**
 * @param string $formattedName The name of the RagCorpus resource.
 *                              Format:
 *                              `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
 *                              Please see {@see VertexRagDataServiceClient::ragCorpusName()} for help formatting this field.
 */
function get_rag_corpus_sample(string $formattedName): void
{
    // Create a client.
    $vertexRagDataServiceClient = new VertexRagDataServiceClient();

    // Prepare the request message.
    $request = (new GetRagCorpusRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var RagCorpus $response */
        $response = $vertexRagDataServiceClient->getRagCorpus($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 = VertexRagDataServiceClient::ragCorpusName(
        '[PROJECT]',
        '[LOCATION]',
        '[RAG_CORPUS]'
    );

    get_rag_corpus_sample($formattedName);
}

getRagFile

Gets a RagFile.

The async variant is VertexRagDataServiceClient::getRagFileAsync() .

Parameters
Name Description
request Google\Cloud\AIPlatform\V1\GetRagFileRequest

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\RagFile
Example
use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\VertexRagDataServiceClient;
use Google\Cloud\AIPlatform\V1\GetRagFileRequest;
use Google\Cloud\AIPlatform\V1\RagFile;

/**
 * @param string $formattedName The name of the RagFile resource.
 *                              Format:
 *                              `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}`
 *                              Please see {@see VertexRagDataServiceClient::ragFileName()} for help formatting this field.
 */
function get_rag_file_sample(string $formattedName): void
{
    // Create a client.
    $vertexRagDataServiceClient = new VertexRagDataServiceClient();

    // Prepare the request message.
    $request = (new GetRagFileRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var RagFile $response */
        $response = $vertexRagDataServiceClient->getRagFile($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 = VertexRagDataServiceClient::ragFileName(
        '[PROJECT]',
        '[LOCATION]',
        '[RAG_CORPUS]',
        '[RAG_FILE]'
    );

    get_rag_file_sample($formattedName);
}

importRagFiles

Import files from Google Cloud Storage or Google Drive into a RagCorpus.

The async variant is VertexRagDataServiceClient::importRagFilesAsync() .

Parameters
Name Description
request Google\Cloud\AIPlatform\V1\ImportRagFilesRequest

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
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\Client\VertexRagDataServiceClient;
use Google\Cloud\AIPlatform\V1\ImportRagFilesConfig;
use Google\Cloud\AIPlatform\V1\ImportRagFilesRequest;
use Google\Cloud\AIPlatform\V1\ImportRagFilesResponse;
use Google\Rpc\Status;

/**
 * @param string $formattedParent The name of the RagCorpus resource into which to import files.
 *                                Format:
 *                                `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
 *                                Please see {@see VertexRagDataServiceClient::ragCorpusName()} for help formatting this field.
 */
function import_rag_files_sample(string $formattedParent): void
{
    // Create a client.
    $vertexRagDataServiceClient = new VertexRagDataServiceClient();

    // Prepare the request message.
    $importRagFilesConfig = new ImportRagFilesConfig();
    $request = (new ImportRagFilesRequest())
        ->setParent($formattedParent)
        ->setImportRagFilesConfig($importRagFilesConfig);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $vertexRagDataServiceClient->importRagFiles($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var ImportRagFilesResponse $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 = VertexRagDataServiceClient::ragCorpusName(
        '[PROJECT]',
        '[LOCATION]',
        '[RAG_CORPUS]'
    );

    import_rag_files_sample($formattedParent);
}

listRagCorpora

Lists RagCorpora in a Location.

The async variant is VertexRagDataServiceClient::listRagCorporaAsync() .

Parameters
Name Description
request Google\Cloud\AIPlatform\V1\ListRagCorporaRequest

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
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\AIPlatform\V1\Client\VertexRagDataServiceClient;
use Google\Cloud\AIPlatform\V1\ListRagCorporaRequest;
use Google\Cloud\AIPlatform\V1\RagCorpus;

/**
 * @param string $formattedParent The resource name of the Location from which to list the
 *                                RagCorpora. Format: `projects/{project}/locations/{location}`
 *                                Please see {@see VertexRagDataServiceClient::locationName()} for help formatting this field.
 */
function list_rag_corpora_sample(string $formattedParent): void
{
    // Create a client.
    $vertexRagDataServiceClient = new VertexRagDataServiceClient();

    // Prepare the request message.
    $request = (new ListRagCorporaRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $vertexRagDataServiceClient->listRagCorpora($request);

        /** @var RagCorpus $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 = VertexRagDataServiceClient::locationName('[PROJECT]', '[LOCATION]');

    list_rag_corpora_sample($formattedParent);
}

listRagFiles

Lists RagFiles in a RagCorpus.

The async variant is VertexRagDataServiceClient::listRagFilesAsync() .

Parameters
Name Description
request Google\Cloud\AIPlatform\V1\ListRagFilesRequest

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
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\AIPlatform\V1\Client\VertexRagDataServiceClient;
use Google\Cloud\AIPlatform\V1\ListRagFilesRequest;
use Google\Cloud\AIPlatform\V1\RagFile;

/**
 * @param string $formattedParent The resource name of the RagCorpus from which to list the
 *                                RagFiles. Format:
 *                                `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
 *                                Please see {@see VertexRagDataServiceClient::ragCorpusName()} for help formatting this field.
 */
function list_rag_files_sample(string $formattedParent): void
{
    // Create a client.
    $vertexRagDataServiceClient = new VertexRagDataServiceClient();

    // Prepare the request message.
    $request = (new ListRagFilesRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $vertexRagDataServiceClient->listRagFiles($request);

        /** @var RagFile $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 = VertexRagDataServiceClient::ragCorpusName(
        '[PROJECT]',
        '[LOCATION]',
        '[RAG_CORPUS]'
    );

    list_rag_files_sample($formattedParent);
}

updateRagCorpus

Updates a RagCorpus.

The async variant is VertexRagDataServiceClient::updateRagCorpusAsync() .

Parameters
Name Description
request Google\Cloud\AIPlatform\V1\UpdateRagCorpusRequest

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
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\Client\VertexRagDataServiceClient;
use Google\Cloud\AIPlatform\V1\RagCorpus;
use Google\Cloud\AIPlatform\V1\UpdateRagCorpusRequest;
use Google\Rpc\Status;

/**
 * @param string $ragCorpusDisplayName The display name of the RagCorpus.
 *                                     The name can be up to 128 characters long and can consist of any UTF-8
 *                                     characters.
 */
function update_rag_corpus_sample(string $ragCorpusDisplayName): void
{
    // Create a client.
    $vertexRagDataServiceClient = new VertexRagDataServiceClient();

    // Prepare the request message.
    $ragCorpus = (new RagCorpus())
        ->setDisplayName($ragCorpusDisplayName);
    $request = (new UpdateRagCorpusRequest())
        ->setRagCorpus($ragCorpus);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $vertexRagDataServiceClient->updateRagCorpus($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var RagCorpus $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
{
    $ragCorpusDisplayName = '[DISPLAY_NAME]';

    update_rag_corpus_sample($ragCorpusDisplayName);
}

uploadRagFile

Upload a file into a RagCorpus.

The async variant is VertexRagDataServiceClient::uploadRagFileAsync() .

Parameters
Name Description
request Google\Cloud\AIPlatform\V1\UploadRagFileRequest

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\UploadRagFileResponse
Example
use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\VertexRagDataServiceClient;
use Google\Cloud\AIPlatform\V1\RagFile;
use Google\Cloud\AIPlatform\V1\UploadRagFileConfig;
use Google\Cloud\AIPlatform\V1\UploadRagFileRequest;
use Google\Cloud\AIPlatform\V1\UploadRagFileResponse;

/**
 * @param string $formattedParent    The name of the RagCorpus resource into which to upload the file.
 *                                   Format:
 *                                   `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
 *                                   Please see {@see VertexRagDataServiceClient::ragCorpusName()} for help formatting this field.
 * @param string $ragFileDisplayName The display name of the RagFile.
 *                                   The name can be up to 128 characters long and can consist of any UTF-8
 *                                   characters.
 */
function upload_rag_file_sample(string $formattedParent, string $ragFileDisplayName): void
{
    // Create a client.
    $vertexRagDataServiceClient = new VertexRagDataServiceClient();

    // Prepare the request message.
    $ragFile = (new RagFile())
        ->setDisplayName($ragFileDisplayName);
    $uploadRagFileConfig = new UploadRagFileConfig();
    $request = (new UploadRagFileRequest())
        ->setParent($formattedParent)
        ->setRagFile($ragFile)
        ->setUploadRagFileConfig($uploadRagFileConfig);

    // Call the API and handle any network failures.
    try {
        /** @var UploadRagFileResponse $response */
        $response = $vertexRagDataServiceClient->uploadRagFile($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
{
    $formattedParent = VertexRagDataServiceClient::ragCorpusName(
        '[PROJECT]',
        '[LOCATION]',
        '[RAG_CORPUS]'
    );
    $ragFileDisplayName = '[DISPLAY_NAME]';

    upload_rag_file_sample($formattedParent, $ragFileDisplayName);
}

getLocation

Gets information about a location.

The async variant is VertexRagDataServiceClient::getLocationAsync() .

Parameters
Name Description
request Google\Cloud\Location\GetLocationRequest

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\Location\Location
Example
use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\VertexRagDataServiceClient;
use Google\Cloud\Location\GetLocationRequest;
use Google\Cloud\Location\Location;

/**
 * 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 get_location_sample(): void
{
    // Create a client.
    $vertexRagDataServiceClient = new VertexRagDataServiceClient();

    // Prepare the request message.
    $request = new GetLocationRequest();

    // Call the API and handle any network failures.
    try {
        /** @var Location $response */
        $response = $vertexRagDataServiceClient->getLocation($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

listLocations

Lists information about the supported locations for this service.

The async variant is VertexRagDataServiceClient::listLocationsAsync() .

Parameters
Name Description
request Google\Cloud\Location\ListLocationsRequest

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
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\AIPlatform\V1\Client\VertexRagDataServiceClient;
use Google\Cloud\Location\ListLocationsRequest;
use Google\Cloud\Location\Location;

/**
 * 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 list_locations_sample(): void
{
    // Create a client.
    $vertexRagDataServiceClient = new VertexRagDataServiceClient();

    // Prepare the request message.
    $request = new ListLocationsRequest();

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $vertexRagDataServiceClient->listLocations($request);

        /** @var Location $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());
    }
}

getIamPolicy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

The async variant is VertexRagDataServiceClient::getIamPolicyAsync() .

Parameters
Name Description
request Google\Cloud\Iam\V1\GetIamPolicyRequest

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\Iam\V1\Policy
Example
use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\VertexRagDataServiceClient;
use Google\Cloud\Iam\V1\GetIamPolicyRequest;
use Google\Cloud\Iam\V1\Policy;

/**
 * @param string $resource REQUIRED: The resource for which the policy is being requested.
 *                         See the operation documentation for the appropriate value for this field.
 */
function get_iam_policy_sample(string $resource): void
{
    // Create a client.
    $vertexRagDataServiceClient = new VertexRagDataServiceClient();

    // Prepare the request message.
    $request = (new GetIamPolicyRequest())
        ->setResource($resource);

    // Call the API and handle any network failures.
    try {
        /** @var Policy $response */
        $response = $vertexRagDataServiceClient->getIamPolicy($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
{
    $resource = '[RESOURCE]';

    get_iam_policy_sample($resource);
}

setIamPolicy

Sets the access control policy on the specified resource. Replaces any existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

The async variant is VertexRagDataServiceClient::setIamPolicyAsync() .

Parameters
Name Description
request Google\Cloud\Iam\V1\SetIamPolicyRequest

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\Iam\V1\Policy
Example
use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\VertexRagDataServiceClient;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\Iam\V1\SetIamPolicyRequest;

/**
 * @param string $resource REQUIRED: The resource for which the policy is being specified.
 *                         See the operation documentation for the appropriate value for this field.
 */
function set_iam_policy_sample(string $resource): void
{
    // Create a client.
    $vertexRagDataServiceClient = new VertexRagDataServiceClient();

    // Prepare the request message.
    $policy = new Policy();
    $request = (new SetIamPolicyRequest())
        ->setResource($resource)
        ->setPolicy($policy);

    // Call the API and handle any network failures.
    try {
        /** @var Policy $response */
        $response = $vertexRagDataServiceClient->setIamPolicy($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
{
    $resource = '[RESOURCE]';

    set_iam_policy_sample($resource);
}

testIamPermissions

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.

The async variant is VertexRagDataServiceClient::testIamPermissionsAsync() .

Parameters
Name Description
request Google\Cloud\Iam\V1\TestIamPermissionsRequest

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\Iam\V1\TestIamPermissionsResponse
Example
use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\VertexRagDataServiceClient;
use Google\Cloud\Iam\V1\TestIamPermissionsRequest;
use Google\Cloud\Iam\V1\TestIamPermissionsResponse;

/**
 * @param string $resource           REQUIRED: The resource for which the policy detail is being requested.
 *                                   See the operation documentation for the appropriate value for this field.
 * @param string $permissionsElement The set of permissions to check for the `resource`. Permissions with
 *                                   wildcards (such as '*' or 'storage.*') are not allowed. For more
 *                                   information see
 *                                   [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
 */
function test_iam_permissions_sample(string $resource, string $permissionsElement): void
{
    // Create a client.
    $vertexRagDataServiceClient = new VertexRagDataServiceClient();

    // Prepare the request message.
    $permissions = [$permissionsElement,];
    $request = (new TestIamPermissionsRequest())
        ->setResource($resource)
        ->setPermissions($permissions);

    // Call the API and handle any network failures.
    try {
        /** @var TestIamPermissionsResponse $response */
        $response = $vertexRagDataServiceClient->testIamPermissions($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
{
    $resource = '[RESOURCE]';
    $permissionsElement = '[PERMISSIONS]';

    test_iam_permissions_sample($resource, $permissionsElement);
}

createRagCorpusAsync

Parameters
Name Description
request Google\Cloud\AIPlatform\V1\CreateRagCorpusRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

deleteRagCorpusAsync

Parameters
Name Description
request Google\Cloud\AIPlatform\V1\DeleteRagCorpusRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

deleteRagFileAsync

Parameters
Name Description
request Google\Cloud\AIPlatform\V1\DeleteRagFileRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

getRagCorpusAsync

Parameters
Name Description
request Google\Cloud\AIPlatform\V1\GetRagCorpusRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\AIPlatform\V1\RagCorpus>

getRagFileAsync

Parameters
Name Description
request Google\Cloud\AIPlatform\V1\GetRagFileRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\AIPlatform\V1\RagFile>

importRagFilesAsync

Parameters
Name Description
request Google\Cloud\AIPlatform\V1\ImportRagFilesRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

listRagCorporaAsync

Parameters
Name Description
request Google\Cloud\AIPlatform\V1\ListRagCorporaRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

listRagFilesAsync

Parameters
Name Description
request Google\Cloud\AIPlatform\V1\ListRagFilesRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

updateRagCorpusAsync

Parameters
Name Description
request Google\Cloud\AIPlatform\V1\UpdateRagCorpusRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

uploadRagFileAsync

Parameters
Name Description
request Google\Cloud\AIPlatform\V1\UploadRagFileRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\AIPlatform\V1\UploadRagFileResponse>

getLocationAsync

Parameters
Name Description
request Google\Cloud\Location\GetLocationRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Location\Location>

listLocationsAsync

Parameters
Name Description
request Google\Cloud\Location\ListLocationsRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

getIamPolicyAsync

Parameters
Name Description
request Google\Cloud\Iam\V1\GetIamPolicyRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Iam\V1\Policy>

setIamPolicyAsync

Parameters
Name Description
request Google\Cloud\Iam\V1\SetIamPolicyRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Iam\V1\Policy>

testIamPermissionsAsync

Parameters
Name Description
request Google\Cloud\Iam\V1\TestIamPermissionsRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Iam\V1\TestIamPermissionsResponse>

getOperationsClient

Return an OperationsClient object with the same endpoint as $this.

Returns
Type Description
Google\LongRunning\Client\OperationsClient

resumeOperation

Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.

Parameters
Name Description
operationName string

The name of the long running operation

methodName string

The name of the method used to start the operation

Returns
Type Description
Google\ApiCore\OperationResponse

static::endpointName

Formats a string containing the fully-qualified path to represent a endpoint resource.

Parameters
Name Description
project string
location string
endpoint string
Returns
Type Description
string The formatted endpoint resource.

static::locationName

Formats a string containing the fully-qualified path to represent a location resource.

Parameters
Name Description
project string
location string
Returns
Type Description
string The formatted location resource.

static::modelName

Formats a string containing the fully-qualified path to represent a model resource.

Parameters
Name Description
project string
location string
model string
Returns
Type Description
string The formatted model resource.

static::projectLocationEndpointName

Formats a string containing the fully-qualified path to represent a project_location_endpoint resource.

Parameters
Name Description
project string
location string
endpoint string
Returns
Type Description
string The formatted project_location_endpoint resource.

static::projectLocationPublisherModelName

Formats a string containing the fully-qualified path to represent a project_location_publisher_model resource.

Parameters
Name Description
project string
location string
publisher string
model string
Returns
Type Description
string The formatted project_location_publisher_model resource.

static::ragCorpusName

Formats a string containing the fully-qualified path to represent a rag_corpus resource.

Parameters
Name Description
project string
location string
ragCorpus string
Returns
Type Description
string The formatted rag_corpus resource.

static::ragFileName

Formats a string containing the fully-qualified path to represent a rag_file resource.

Parameters
Name Description
project string
location string
ragCorpus string
ragFile string
Returns
Type Description
string The formatted rag_file resource.

static::secretVersionName

Formats a string containing the fully-qualified path to represent a secret_version resource.

Parameters
Name Description
project string
secret string
secretVersion string
Returns
Type Description
string The formatted secret_version resource.

static::parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported: Template: Pattern

  • endpoint: projects/{project}/locations/{location}/endpoints/{endpoint}
  • location: projects/{project}/locations/{location}
  • model: projects/{project}/locations/{location}/models/{model}
  • projectLocationEndpoint: projects/{project}/locations/{location}/endpoints/{endpoint}
  • projectLocationPublisherModel: projects/{project}/locations/{location}/publishers/{publisher}/models/{model}
  • ragCorpus: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}
  • ragFile: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}
  • secretVersion: projects/{project}/secrets/{secret}/versions/{secret_version}

The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.

Parameters
Name Description
formattedName string

The formatted name string

template ?string

Optional name of template to match

Returns
Type Description
array An associative array from name component IDs to component values.