Google Cloud Discovery Engine V1 Client - Class AssistantServiceClient (1.17.0)

Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class AssistantServiceClient.

Service Description: Service for managing Assistant configuration and assisting users.

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

Methods

__construct

Constructor.

Parameters
Name Description
options array|Google\ApiCore\Options\ClientOptions

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 Google\Auth\FetchAuthTokenInterface|Google\ApiCore\CredentialsWrapper

This option should only be used with a pre-constructed Google\Auth\FetchAuthTokenInterface or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. Important: If you are providing a path to a credentials file, or a decoded credentials file as a PHP array, this usage is now DEPRECATED. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. It is recommended to create the credentials explicitly use Google\Auth\Credentials\ServiceAccountCredentials; use Google\Cloud\DiscoveryEngine\V1\AssistantServiceClient; $creds = new ServiceAccountCredentials($scopes, $json); $options = new AssistantServiceClient(['credentials' => $creds]); https://cloud-0google-0com.linkedin.net.nz/docs/authentication/external/externally-sourced-credentials

↳ 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|Google\ApiCore\Transport\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|Psr\Log\LoggerInterface

A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag

↳ universeDomain string

The service domain for the client. Defaults to 'googleapis.com'.

createAssistant

Creates an Assistant.

The async variant is AssistantServiceClient::createAssistantAsync() .

Parameters
Name Description
request Google\Cloud\DiscoveryEngine\V1\CreateAssistantRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings Google\ApiCore\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\DiscoveryEngine\V1\Assistant
Example
use Google\ApiCore\ApiException;
use Google\Cloud\DiscoveryEngine\V1\Assistant;
use Google\Cloud\DiscoveryEngine\V1\Client\AssistantServiceClient;
use Google\Cloud\DiscoveryEngine\V1\CreateAssistantRequest;

/**
 * @param string $formattedParent      The parent resource name.
 *                                     Format:
 *                                     `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
 *                                     Please see {@see AssistantServiceClient::engineName()} for help formatting this field.
 * @param string $assistantDisplayName The assistant display name.
 *
 *                                     It must be a UTF-8 encoded string with a length limit of 128 characters.
 * @param string $assistantId          The ID to use for the
 *                                     [Assistant][google.cloud.discoveryengine.v1.Assistant], which will become
 *                                     the final component of the
 *                                     [Assistant][google.cloud.discoveryengine.v1.Assistant]'s resource name.
 *
 *                                     This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
 *                                     with a length limit of 63 characters.
 */
function create_assistant_sample(
    string $formattedParent,
    string $assistantDisplayName,
    string $assistantId
): void {
    // Create a client.
    $assistantServiceClient = new AssistantServiceClient();

    // Prepare the request message.
    $assistant = (new Assistant())
        ->setDisplayName($assistantDisplayName);
    $request = (new CreateAssistantRequest())
        ->setParent($formattedParent)
        ->setAssistant($assistant)
        ->setAssistantId($assistantId);

    // Call the API and handle any network failures.
    try {
        /** @var Assistant $response */
        $response = $assistantServiceClient->createAssistant($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 = AssistantServiceClient::engineName(
        '[PROJECT]',
        '[LOCATION]',
        '[COLLECTION]',
        '[ENGINE]'
    );
    $assistantDisplayName = '[DISPLAY_NAME]';
    $assistantId = '[ASSISTANT_ID]';

    create_assistant_sample($formattedParent, $assistantDisplayName, $assistantId);
}

deleteAssistant

Deletes an Assistant.

The async variant is AssistantServiceClient::deleteAssistantAsync() .

Parameters
Name Description
request Google\Cloud\DiscoveryEngine\V1\DeleteAssistantRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings Google\ApiCore\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.

Example
use Google\ApiCore\ApiException;
use Google\Cloud\DiscoveryEngine\V1\Client\AssistantServiceClient;
use Google\Cloud\DiscoveryEngine\V1\DeleteAssistantRequest;

/**
 * @param string $formattedName Resource name of
 *                              [Assistant][google.cloud.discoveryengine.v1.Assistant]. Format:
 *                              `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`
 *
 *                              If the caller does not have permission to delete the
 *                              [Assistant][google.cloud.discoveryengine.v1.Assistant], regardless of
 *                              whether or not it exists, a PERMISSION_DENIED error is returned.
 *
 *                              If the [Assistant][google.cloud.discoveryengine.v1.Assistant] to delete
 *                              does not exist, a NOT_FOUND error is returned. Please see
 *                              {@see AssistantServiceClient::assistantName()} for help formatting this field.
 */
function delete_assistant_sample(string $formattedName): void
{
    // Create a client.
    $assistantServiceClient = new AssistantServiceClient();

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

    // Call the API and handle any network failures.
    try {
        $assistantServiceClient->deleteAssistant($request);
        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 = AssistantServiceClient::assistantName(
        '[PROJECT]',
        '[LOCATION]',
        '[COLLECTION]',
        '[ENGINE]',
        '[ASSISTANT]'
    );

    delete_assistant_sample($formattedName);
}

getAssistant

Parameters
Name Description
request Google\Cloud\DiscoveryEngine\V1\GetAssistantRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings Google\ApiCore\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\DiscoveryEngine\V1\Assistant
Example
use Google\ApiCore\ApiException;
use Google\Cloud\DiscoveryEngine\V1\Assistant;
use Google\Cloud\DiscoveryEngine\V1\Client\AssistantServiceClient;
use Google\Cloud\DiscoveryEngine\V1\GetAssistantRequest;

/**
 * @param string $formattedName Resource name of
 *                              [Assistant][google.cloud.discoveryengine.v1.Assistant]. Format:
 *                              `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`
 *                              Please see {@see AssistantServiceClient::assistantName()} for help formatting this field.
 */
function get_assistant_sample(string $formattedName): void
{
    // Create a client.
    $assistantServiceClient = new AssistantServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Assistant $response */
        $response = $assistantServiceClient->getAssistant($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 = AssistantServiceClient::assistantName(
        '[PROJECT]',
        '[LOCATION]',
        '[COLLECTION]',
        '[ENGINE]',
        '[ASSISTANT]'
    );

    get_assistant_sample($formattedName);
}

listAssistants

Lists all Assistants under an Engine.

The async variant is AssistantServiceClient::listAssistantsAsync() .

Parameters
Name Description
request Google\Cloud\DiscoveryEngine\V1\ListAssistantsRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings Google\ApiCore\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\DiscoveryEngine\V1\Assistant;
use Google\Cloud\DiscoveryEngine\V1\Client\AssistantServiceClient;
use Google\Cloud\DiscoveryEngine\V1\ListAssistantsRequest;

/**
 * @param string $formattedParent The parent resource name.
 *                                Format:
 *                                `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
 *                                Please see {@see AssistantServiceClient::engineName()} for help formatting this field.
 */
function list_assistants_sample(string $formattedParent): void
{
    // Create a client.
    $assistantServiceClient = new AssistantServiceClient();

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

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

        /** @var Assistant $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 = AssistantServiceClient::engineName(
        '[PROJECT]',
        '[LOCATION]',
        '[COLLECTION]',
        '[ENGINE]'
    );

    list_assistants_sample($formattedParent);
}

streamAssist

Assists the user with a query in a streaming fashion.

Parameters
Name Description
request Google\Cloud\DiscoveryEngine\V1\StreamAssistRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ timeoutMillis int

Timeout to use for this call.

Returns
Type Description
Google\ApiCore\ServerStream<Google\Cloud\DiscoveryEngine\V1\StreamAssistResponse>
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\ServerStream;
use Google\Cloud\DiscoveryEngine\V1\Client\AssistantServiceClient;
use Google\Cloud\DiscoveryEngine\V1\StreamAssistRequest;
use Google\Cloud\DiscoveryEngine\V1\StreamAssistResponse;

/**
 * @param string $formattedName The resource name of the
 *                              [Assistant][google.cloud.discoveryengine.v1.Assistant]. Format:
 *                              `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`
 *                              Please see {@see AssistantServiceClient::assistantName()} for help formatting this field.
 */
function stream_assist_sample(string $formattedName): void
{
    // Create a client.
    $assistantServiceClient = new AssistantServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var ServerStream $stream */
        $stream = $assistantServiceClient->streamAssist($request);

        /** @var StreamAssistResponse $element */
        foreach ($stream->readAll() 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
{
    $formattedName = AssistantServiceClient::assistantName(
        '[PROJECT]',
        '[LOCATION]',
        '[COLLECTION]',
        '[ENGINE]',
        '[ASSISTANT]'
    );

    stream_assist_sample($formattedName);
}

updateAssistant

Parameters
Name Description
request Google\Cloud\DiscoveryEngine\V1\UpdateAssistantRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings Google\ApiCore\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\DiscoveryEngine\V1\Assistant
Example
use Google\ApiCore\ApiException;
use Google\Cloud\DiscoveryEngine\V1\Assistant;
use Google\Cloud\DiscoveryEngine\V1\Client\AssistantServiceClient;
use Google\Cloud\DiscoveryEngine\V1\UpdateAssistantRequest;

/**
 * @param string $assistantDisplayName The assistant display name.
 *
 *                                     It must be a UTF-8 encoded string with a length limit of 128 characters.
 */
function update_assistant_sample(string $assistantDisplayName): void
{
    // Create a client.
    $assistantServiceClient = new AssistantServiceClient();

    // Prepare the request message.
    $assistant = (new Assistant())
        ->setDisplayName($assistantDisplayName);
    $request = (new UpdateAssistantRequest())
        ->setAssistant($assistant);

    // Call the API and handle any network failures.
    try {
        /** @var Assistant $response */
        $response = $assistantServiceClient->updateAssistant($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
{
    $assistantDisplayName = '[DISPLAY_NAME]';

    update_assistant_sample($assistantDisplayName);
}

createAssistantAsync

Parameters
Name Description
request Google\Cloud\DiscoveryEngine\V1\CreateAssistantRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\DiscoveryEngine\V1\Assistant>

deleteAssistantAsync

Parameters
Name Description
request Google\Cloud\DiscoveryEngine\V1\DeleteAssistantRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<void>

getAssistantAsync

Parameters
Name Description
request Google\Cloud\DiscoveryEngine\V1\GetAssistantRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\DiscoveryEngine\V1\Assistant>

listAssistantsAsync

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

updateAssistantAsync

Parameters
Name Description
request Google\Cloud\DiscoveryEngine\V1\UpdateAssistantRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\DiscoveryEngine\V1\Assistant>

static::assistantName

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

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

static::contentPolicyName

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

Parameters
Name Description
organization string
location string
contentPolicy string
Returns
Type Description
string The formatted content_policy resource.

static::dataStoreName

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

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

static::engineName

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

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

static::organizationLocationContentPolicyName

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

Parameters
Name Description
organization string
location string
contentPolicy string
Returns
Type Description
string The formatted organization_location_content_policy resource.

static::projectLocationCollectionDataStoreName

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

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

static::projectLocationCollectionDataStoreSessionName

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

Parameters
Name Description
project string
location string
collection string
dataStore string
session string
Returns
Type Description
string The formatted project_location_collection_data_store_session resource.

static::projectLocationCollectionEngineCollaborativeProjectSessionName

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

Parameters
Name Description
project string
location string
collection string
engine string
collaborativeProject string
session string
Returns
Type Description
string The formatted project_location_collection_engine_collaborative_project_session resource.

static::projectLocationCollectionEngineSessionName

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

Parameters
Name Description
project string
location string
collection string
engine string
session string
Returns
Type Description
string The formatted project_location_collection_engine_session resource.

static::projectLocationContentPolicyName

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

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

static::projectLocationDataStoreName

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

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

static::projectLocationDataStoreSessionName

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

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

static::sessionName

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

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

static::templateName

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

Parameters
Name Description
project string
location string
template string
Returns
Type Description
string The formatted template 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

  • assistant: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}
  • contentPolicy: organizations/{organization}/locations/{location}/contentPolicies/{content_policy}
  • dataStore: projects/{project}/locations/{location}/dataStores/{data_store}
  • engine: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
  • organizationLocationContentPolicy: organizations/{organization}/locations/{location}/contentPolicies/{content_policy}
  • projectLocationCollectionDataStore: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}
  • projectLocationCollectionDataStoreSession: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/sessions/{session}
  • projectLocationCollectionEngineCollaborativeProjectSession: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/collaborativeProjects/{collaborative_project}/sessions/{session}
  • projectLocationCollectionEngineSession: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}
  • projectLocationContentPolicy: projects/{project}/locations/{location}/contentPolicies/{content_policy}
  • projectLocationDataStore: projects/{project}/locations/{location}/dataStores/{data_store}
  • projectLocationDataStoreSession: projects/{project}/locations/{location}/dataStores/{data_store}/sessions/{session}
  • session: projects/{project}/locations/{location}/dataStores/{data_store}/sessions/{session}
  • template: projects/{project}/locations/{location}/templates/{template}

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.