Cloud Speech V1p1beta1 Client - Class AdaptationClient (1.19.0)

$adaptationClient = new AdaptationClient();
try {
    $formattedParent = $adaptationClient->locationName('[PROJECT]', '[LOCATION]');
    $customClassId = 'custom_class_id';
    $customClass = new CustomClass();
    $response = $adaptationClient->createCustomClass($formattedParent, $customClassId, $customClass);
} finally {
    $adaptationClient->close();
}

Namespace

Methods

__construct

createCustomClass

use Google\ApiCore\ApiException;
use Google\Cloud\Speech\V1p1beta1\AdaptationClient;
use Google\Cloud\Speech\V1p1beta1\CustomClass;

/**
 * @param string $formattedParent The parent resource where this custom class will be created.
 *                                Format:
 *
 *                                `projects/{project}/locations/{location}/customClasses`
 *
 *                                Speech-to-Text supports three locations: `global`, `us` (US North America),
 *                                and `eu` (Europe). If you are calling the `speech.googleapis.com`
 *                                endpoint, use the `global` location. To specify a region, use a
 *                                [regional endpoint](https://cloud.google.com/speech-to-text/docs/endpoints)
 *                                with matching `us` or `eu` location value. Please see
 *                                {@see AdaptationClient::locationName()} for help formatting this field.
 * @param string $customClassId   The ID to use for the custom class, which will become the final
 *                                component of the custom class' resource name.
 *
 *                                This value should restrict to letters, numbers, and hyphens, with the first
 *                                character a letter, the last a letter or a number, and be 4-63 characters.
 */
function create_custom_class_sample(string $formattedParent, string $customClassId): void
{
    // Create a client.
    $adaptationClient = new AdaptationClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $customClass = new CustomClass();

    // Call the API and handle any network failures.
    try {
        /** @var CustomClass $response */
        $response = $adaptationClient->createCustomClass($formattedParent, $customClassId, $customClass);
        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 = AdaptationClient::locationName('[PROJECT]', '[LOCATION]');
    $customClassId = '[CUSTOM_CLASS_ID]';

    create_custom_class_sample($formattedParent, $customClassId);
}

createPhraseSet

use Google\ApiCore\ApiException;
use Google\Cloud\Speech\V1p1beta1\AdaptationClient;
use Google\Cloud\Speech\V1p1beta1\PhraseSet;

/**
 * @param string $formattedParent The parent resource where this phrase set will be created.
 *                                Format:
 *
 *                                `projects/{project}/locations/{location}`
 *
 *                                Speech-to-Text supports three locations: `global`, `us` (US North America),
 *                                and `eu` (Europe). If you are calling the `speech.googleapis.com`
 *                                endpoint, use the `global` location. To specify a region, use a
 *                                [regional endpoint](https://cloud.google.com/speech-to-text/docs/endpoints)
 *                                with matching `us` or `eu` location value. Please see
 *                                {@see AdaptationClient::locationName()} for help formatting this field.
 * @param string $phraseSetId     The ID to use for the phrase set, which will become the final
 *                                component of the phrase set's resource name.
 *
 *                                This value should restrict to letters, numbers, and hyphens, with the first
 *                                character a letter, the last a letter or a number, and be 4-63 characters.
 */
function create_phrase_set_sample(string $formattedParent, string $phraseSetId): void
{
    // Create a client.
    $adaptationClient = new AdaptationClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $phraseSet = new PhraseSet();

    // Call the API and handle any network failures.
    try {
        /** @var PhraseSet $response */
        $response = $adaptationClient->createPhraseSet($formattedParent, $phraseSetId, $phraseSet);
        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 = AdaptationClient::locationName('[PROJECT]', '[LOCATION]');
    $phraseSetId = '[PHRASE_SET_ID]';

    create_phrase_set_sample($formattedParent, $phraseSetId);
}

deleteCustomClass

use Google\ApiCore\ApiException;
use Google\Cloud\Speech\V1p1beta1\AdaptationClient;

/**
 * @param string $formattedName The name of the custom class to delete. Format:
 *
 *                              `projects/{project}/locations/{location}/customClasses/{custom_class}`
 *
 *                              Speech-to-Text supports three locations: `global`, `us` (US North America),
 *                              and `eu` (Europe). If you are calling the `speech.googleapis.com`
 *                              endpoint, use the `global` location. To specify a region, use a
 *                              [regional endpoint](https://cloud.google.com/speech-to-text/docs/endpoints)
 *                              with matching `us` or `eu` location value. Please see
 *                              {@see AdaptationClient::customClassName()} for help formatting this field.
 */
function delete_custom_class_sample(string $formattedName): void
{
    // Create a client.
    $adaptationClient = new AdaptationClient();

    // Call the API and handle any network failures.
    try {
        $adaptationClient->deleteCustomClass($formattedName);
        printf('Call completed successfully.' . PHP_EOL);
    } 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 = AdaptationClient::customClassName('[PROJECT]', '[LOCATION]', '[CUSTOM_CLASS]');

    delete_custom_class_sample($formattedName);
}

deletePhraseSet

use Google\ApiCore\ApiException;
use Google\Cloud\Speech\V1p1beta1\AdaptationClient;

/**
 * @param string $formattedName The name of the phrase set to delete. Format:
 *
 *                              `projects/{project}/locations/{location}/phraseSets/{phrase_set}`
 *                              Please see {@see AdaptationClient::phraseSetName()} for help formatting this field.
 */
function delete_phrase_set_sample(string $formattedName): void
{
    // Create a client.
    $adaptationClient = new AdaptationClient();

    // Call the API and handle any network failures.
    try {
        $adaptationClient->deletePhraseSet($formattedName);
        printf('Call completed successfully.' . PHP_EOL);
    } 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 = AdaptationClient::phraseSetName('[PROJECT]', '[LOCATION]', '[PHRASE_SET]');

    delete_phrase_set_sample($formattedName);
}

getCustomClass

use Google\ApiCore\ApiException;
use Google\Cloud\Speech\V1p1beta1\AdaptationClient;
use Google\Cloud\Speech\V1p1beta1\CustomClass;

/**
 * @param string $formattedName The name of the custom class to retrieve. Format:
 *
 *                              `projects/{project}/locations/{location}/customClasses/{custom_class}`
 *                              Please see {@see AdaptationClient::customClassName()} for help formatting this field.
 */
function get_custom_class_sample(string $formattedName): void
{
    // Create a client.
    $adaptationClient = new AdaptationClient();

    // Call the API and handle any network failures.
    try {
        /** @var CustomClass $response */
        $response = $adaptationClient->getCustomClass($formattedName);
        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 = AdaptationClient::customClassName('[PROJECT]', '[LOCATION]', '[CUSTOM_CLASS]');

    get_custom_class_sample($formattedName);
}

getPhraseSet

use Google\ApiCore\ApiException;
use Google\Cloud\Speech\V1p1beta1\AdaptationClient;
use Google\Cloud\Speech\V1p1beta1\PhraseSet;

/**
 * @param string $formattedName The name of the phrase set to retrieve. Format:
 *
 *                              `projects/{project}/locations/{location}/phraseSets/{phrase_set}`
 *
 *                              Speech-to-Text supports three locations: `global`, `us` (US North America),
 *                              and `eu` (Europe). If you are calling the `speech.googleapis.com`
 *                              endpoint, use the `global` location. To specify a region, use a
 *                              [regional endpoint](https://cloud.google.com/speech-to-text/docs/endpoints)
 *                              with matching `us` or `eu` location value. Please see
 *                              {@see AdaptationClient::phraseSetName()} for help formatting this field.
 */
function get_phrase_set_sample(string $formattedName): void
{
    // Create a client.
    $adaptationClient = new AdaptationClient();

    // Call the API and handle any network failures.
    try {
        /** @var PhraseSet $response */
        $response = $adaptationClient->getPhraseSet($formattedName);
        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 = AdaptationClient::phraseSetName('[PROJECT]', '[LOCATION]', '[PHRASE_SET]');

    get_phrase_set_sample($formattedName);
}

listCustomClasses

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Speech\V1p1beta1\AdaptationClient;
use Google\Cloud\Speech\V1p1beta1\CustomClass;

/**
 * @param string $formattedParent The parent, which owns this collection of custom classes. Format:
 *
 *                                `projects/{project}/locations/{location}/customClasses`
 *
 *                                Speech-to-Text supports three locations: `global`, `us` (US North America),
 *                                and `eu` (Europe). If you are calling the `speech.googleapis.com`
 *                                endpoint, use the `global` location. To specify a region, use a
 *                                [regional endpoint](https://cloud.google.com/speech-to-text/docs/endpoints)
 *                                with matching `us` or `eu` location value. Please see
 *                                {@see AdaptationClient::locationName()} for help formatting this field.
 */
function list_custom_classes_sample(string $formattedParent): void
{
    // Create a client.
    $adaptationClient = new AdaptationClient();

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

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

    list_custom_classes_sample($formattedParent);
}

listPhraseSet

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Speech\V1p1beta1\AdaptationClient;
use Google\Cloud\Speech\V1p1beta1\PhraseSet;

/**
 * @param string $formattedParent The parent, which owns this collection of phrase set. Format:
 *
 *                                `projects/{project}/locations/{location}`
 *
 *                                Speech-to-Text supports three locations: `global`, `us` (US North America),
 *                                and `eu` (Europe). If you are calling the `speech.googleapis.com`
 *                                endpoint, use the `global` location. To specify a region, use a
 *                                [regional endpoint](https://cloud.google.com/speech-to-text/docs/endpoints)
 *                                with matching `us` or `eu` location value. Please see
 *                                {@see AdaptationClient::locationName()} for help formatting this field.
 */
function list_phrase_set_sample(string $formattedParent): void
{
    // Create a client.
    $adaptationClient = new AdaptationClient();

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

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

    list_phrase_set_sample($formattedParent);
}

updateCustomClass

use Google\ApiCore\ApiException;
use Google\Cloud\Speech\V1p1beta1\AdaptationClient;
use Google\Cloud\Speech\V1p1beta1\CustomClass;

/**
 * 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 update_custom_class_sample(): void
{
    // Create a client.
    $adaptationClient = new AdaptationClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $customClass = new CustomClass();

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

updatePhraseSet

use Google\ApiCore\ApiException;
use Google\Cloud\Speech\V1p1beta1\AdaptationClient;
use Google\Cloud\Speech\V1p1beta1\PhraseSet;

/**
 * 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 update_phrase_set_sample(): void
{
    // Create a client.
    $adaptationClient = new AdaptationClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $phraseSet = new PhraseSet();

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

static::customClassName

static::locationName

static::phraseSetName

static::parseName

Constants

SERVICE_NAME

Value: 'google.cloud.speech.v1p1beta1.Adaptation'

SERVICE_ADDRESS

Value: 'speech.googleapis.com'

DEFAULT_SERVICE_PORT

Value: 443

CODEGEN_NAME

Value: 'gapic'