Google Cloud Discovery Engine V1beta Client - Class ConversationalSearchServiceClient (0.6.0)

Reference documentation and code samples for the Google Cloud Discovery Engine V1beta Client class ConversationalSearchServiceClient.

Service Description: Service for conversational search.

This class is currently experimental and may be subject to changes.

Namespace

Google \ Cloud \ DiscoveryEngine \ V1beta \ 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.

converseConversation

Converses a conversation.

The async variant is Google\Cloud\DiscoveryEngine\V1beta\Client\BaseClient\self::converseConversationAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DiscoveryEngine\V1beta\ConverseConversationRequest` 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\DiscoveryEngine\V1beta\ConverseConversationResponse`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\DiscoveryEngine\V1beta\Client\ConversationalSearchServiceClient;
use Google\Cloud\DiscoveryEngine\V1beta\ConverseConversationRequest;
use Google\Cloud\DiscoveryEngine\V1beta\ConverseConversationResponse;
use Google\Cloud\DiscoveryEngine\V1beta\TextInput;

/**
 * @param string $formattedName The resource name of the Conversation to get. Format:
 *                              `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`.
 *                              Use
 *                              `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-`
 *                              to activate auto session mode, which automatically creates a new
 *                              conversation inside a ConverseConversation session. Please see
 *                              {@see ConversationalSearchServiceClient::conversationName()} for help formatting this field.
 */
function converse_conversation_sample(string $formattedName): void
{
    // Create a client.
    $conversationalSearchServiceClient = new ConversationalSearchServiceClient();

    // Prepare the request message.
    $query = new TextInput();
    $request = (new ConverseConversationRequest())
        ->setName($formattedName)
        ->setQuery($query);

    // Call the API and handle any network failures.
    try {
        /** @var ConverseConversationResponse $response */
        $response = $conversationalSearchServiceClient->converseConversation($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 = ConversationalSearchServiceClient::conversationName(
        '[PROJECT]',
        '[LOCATION]',
        '[DATA_STORE]',
        '[CONVERSATION]'
    );

    converse_conversation_sample($formattedName);
}

createConversation

Creates a Conversation.

If the Conversation to create already exists, an ALREADY_EXISTS error is returned.

The async variant is Google\Cloud\DiscoveryEngine\V1beta\Client\BaseClient\self::createConversationAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DiscoveryEngine\V1beta\CreateConversationRequest` 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\DiscoveryEngine\V1beta\Conversation`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\DiscoveryEngine\V1beta\Client\ConversationalSearchServiceClient;
use Google\Cloud\DiscoveryEngine\V1beta\Conversation;
use Google\Cloud\DiscoveryEngine\V1beta\CreateConversationRequest;

/**
 * @param string $formattedParent Full resource name of parent data store. Format:
 *                                `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
 *                                Please see {@see ConversationalSearchServiceClient::dataStoreName()} for help formatting this field.
 */
function create_conversation_sample(string $formattedParent): void
{
    // Create a client.
    $conversationalSearchServiceClient = new ConversationalSearchServiceClient();

    // Prepare the request message.
    $conversation = new Conversation();
    $request = (new CreateConversationRequest())
        ->setParent($formattedParent)
        ->setConversation($conversation);

    // Call the API and handle any network failures.
    try {
        /** @var Conversation $response */
        $response = $conversationalSearchServiceClient->createConversation($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 = ConversationalSearchServiceClient::dataStoreName(
        '[PROJECT]',
        '[LOCATION]',
        '[DATA_STORE]'
    );

    create_conversation_sample($formattedParent);
}

deleteConversation

Deletes a Conversation.

If the Conversation to delete does not exist, a NOT_FOUND error is returned.

The async variant is Google\Cloud\DiscoveryEngine\V1beta\Client\BaseClient\self::deleteConversationAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DiscoveryEngine\V1beta\DeleteConversationRequest` 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.

Example

use Google\ApiCore\ApiException;
use Google\Cloud\DiscoveryEngine\V1beta\Client\ConversationalSearchServiceClient;
use Google\Cloud\DiscoveryEngine\V1beta\DeleteConversationRequest;

/**
 * @param string $formattedName The resource name of the Conversation to delete. Format:
 *                              `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
 *                              Please see {@see ConversationalSearchServiceClient::conversationName()} for help formatting this field.
 */
function delete_conversation_sample(string $formattedName): void
{
    // Create a client.
    $conversationalSearchServiceClient = new ConversationalSearchServiceClient();

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

    // Call the API and handle any network failures.
    try {
        $conversationalSearchServiceClient->deleteConversation($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 = ConversationalSearchServiceClient::conversationName(
        '[PROJECT]',
        '[LOCATION]',
        '[DATA_STORE]',
        '[CONVERSATION]'
    );

    delete_conversation_sample($formattedName);
}

getConversation

Gets a Conversation.

The async variant is Google\Cloud\DiscoveryEngine\V1beta\Client\BaseClient\self::getConversationAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DiscoveryEngine\V1beta\GetConversationRequest` 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\DiscoveryEngine\V1beta\Conversation`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\DiscoveryEngine\V1beta\Client\ConversationalSearchServiceClient;
use Google\Cloud\DiscoveryEngine\V1beta\Conversation;
use Google\Cloud\DiscoveryEngine\V1beta\GetConversationRequest;

/**
 * @param string $formattedName The resource name of the Conversation to get. Format:
 *                              `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
 *                              Please see {@see ConversationalSearchServiceClient::conversationName()} for help formatting this field.
 */
function get_conversation_sample(string $formattedName): void
{
    // Create a client.
    $conversationalSearchServiceClient = new ConversationalSearchServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Conversation $response */
        $response = $conversationalSearchServiceClient->getConversation($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 = ConversationalSearchServiceClient::conversationName(
        '[PROJECT]',
        '[LOCATION]',
        '[DATA_STORE]',
        '[CONVERSATION]'
    );

    get_conversation_sample($formattedName);
}

listConversations

Lists all Conversations by their parent DataStore.

The async variant is Google\Cloud\DiscoveryEngine\V1beta\Client\BaseClient\self::listConversationsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DiscoveryEngine\V1beta\ListConversationsRequest` 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\DiscoveryEngine\V1beta\Client\ConversationalSearchServiceClient;
use Google\Cloud\DiscoveryEngine\V1beta\Conversation;
use Google\Cloud\DiscoveryEngine\V1beta\ListConversationsRequest;

/**
 * @param string $formattedParent The data store resource name. Format:
 *                                `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
 *                                Please see {@see ConversationalSearchServiceClient::dataStoreName()} for help formatting this field.
 */
function list_conversations_sample(string $formattedParent): void
{
    // Create a client.
    $conversationalSearchServiceClient = new ConversationalSearchServiceClient();

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

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

        /** @var Conversation $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 = ConversationalSearchServiceClient::dataStoreName(
        '[PROJECT]',
        '[LOCATION]',
        '[DATA_STORE]'
    );

    list_conversations_sample($formattedParent);
}

updateConversation

Updates a Conversation.

Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned.

The async variant is Google\Cloud\DiscoveryEngine\V1beta\Client\BaseClient\self::updateConversationAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DiscoveryEngine\V1beta\UpdateConversationRequest` 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\DiscoveryEngine\V1beta\Conversation`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\DiscoveryEngine\V1beta\Client\ConversationalSearchServiceClient;
use Google\Cloud\DiscoveryEngine\V1beta\Conversation;
use Google\Cloud\DiscoveryEngine\V1beta\UpdateConversationRequest;

/**
 * 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_conversation_sample(): void
{
    // Create a client.
    $conversationalSearchServiceClient = new ConversationalSearchServiceClient();

    // Prepare the request message.
    $conversation = new Conversation();
    $request = (new UpdateConversationRequest())
        ->setConversation($conversation);

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

converseConversationAsync

Parameters
Name	Description
`request`	`Google\Cloud\DiscoveryEngine\V1beta\ConverseConversationRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

createConversationAsync

Parameters
Name	Description
`request`	`Google\Cloud\DiscoveryEngine\V1beta\CreateConversationRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deleteConversationAsync

Parameters
Name	Description
`request`	`Google\Cloud\DiscoveryEngine\V1beta\DeleteConversationRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getConversationAsync

Parameters
Name	Description
`request`	`Google\Cloud\DiscoveryEngine\V1beta\GetConversationRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listConversationsAsync

Parameters
Name	Description
`request`	`Google\Cloud\DiscoveryEngine\V1beta\ListConversationsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

updateConversationAsync

Parameters
Name	Description
`request`	`Google\Cloud\DiscoveryEngine\V1beta\UpdateConversationRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

static::conversationName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`dataStore`	`string`
`conversation`	`string`

Returns
Type	Description
`string`	The formatted conversation 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::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::projectLocationCollectionDataStoreConversationName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`collection`	`string`
`dataStore`	`string`
`conversation`	`string`

Returns
Type	Description
`string`	The formatted project_location_collection_data_store_conversation resource.

static::projectLocationCollectionDataStoreServingConfigName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`collection`	`string`
`dataStore`	`string`
`servingConfig`	`string`

Returns
Type	Description
`string`	The formatted project_location_collection_data_store_serving_config 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::projectLocationDataStoreConversationName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`dataStore`	`string`
`conversation`	`string`

Returns
Type	Description
`string`	The formatted project_location_data_store_conversation resource.

static::projectLocationDataStoreServingConfigName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`dataStore`	`string`
`servingConfig`	`string`

Returns
Type	Description
`string`	The formatted project_location_data_store_serving_config resource.

static::servingConfigName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`dataStore`	`string`
`servingConfig`	`string`

Returns
Type	Description
`string`	The formatted serving_config 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

conversation: projects/{project}/locations/{location}/dataStores/{data_store}/conversations/{conversation}
dataStore: projects/{project}/locations/{location}/dataStores/{data_store}
projectLocationCollectionDataStore: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}
projectLocationCollectionDataStoreConversation: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/conversations/{conversation}
projectLocationCollectionDataStoreServingConfig: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config}
projectLocationDataStore: projects/{project}/locations/{location}/dataStores/{data_store}
projectLocationDataStoreConversation: projects/{project}/locations/{location}/dataStores/{data_store}/conversations/{conversation}
projectLocationDataStoreServingConfig: projects/{project}/locations/{location}/dataStores/{data_store}/servingConfigs/{serving_config}
servingConfig: projects/{project}/locations/{location}/dataStores/{data_store}/servingConfigs/{serving_config}

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.