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

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

Service Description: Service for conversational search.

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

answerQuery

Answer query method.

The async variant is Google\Cloud\DiscoveryEngine\V1beta\Client\ConversationalSearchServiceClient::answerQueryAsync() .

Parameters
Name Description
request Google\Cloud\DiscoveryEngine\V1beta\AnswerQueryRequest

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\AnswerQueryResponse
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\DiscoveryEngine\V1beta\AnswerQueryRequest;
use Google\Cloud\DiscoveryEngine\V1beta\AnswerQueryResponse;
use Google\Cloud\DiscoveryEngine\V1beta\Client\ConversationalSearchServiceClient;
use Google\Cloud\DiscoveryEngine\V1beta\Query;

/**
 * @param string $formattedServingConfig The resource name of the Search serving config, such as
 *                                       `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`,
 *                                       or
 *                                       `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`.
 *                                       This field is used to identify the serving configuration name, set
 *                                       of models used to make the search. Please see
 *                                       {@see ConversationalSearchServiceClient::servingConfigName()} for help formatting this field.
 */
function answer_query_sample(string $formattedServingConfig): void
{
    // Create a client.
    $conversationalSearchServiceClient = new ConversationalSearchServiceClient();

    // Prepare the request message.
    $query = new Query();
    $request = (new AnswerQueryRequest())
        ->setServingConfig($formattedServingConfig)
        ->setQuery($query);

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

    answer_query_sample($formattedServingConfig);
}

converseConversation

Converses a conversation.

The async variant is Google\Cloud\DiscoveryEngine\V1beta\Client\ConversationalSearchServiceClient::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\ConversationalSearchServiceClient::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);
}

createSession

Creates a Session.

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

The async variant is Google\Cloud\DiscoveryEngine\V1beta\Client\ConversationalSearchServiceClient::createSessionAsync() .

Parameters
Name Description
request Google\Cloud\DiscoveryEngine\V1beta\CreateSessionRequest

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\Session
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\DiscoveryEngine\V1beta\Client\ConversationalSearchServiceClient;
use Google\Cloud\DiscoveryEngine\V1beta\CreateSessionRequest;
use Google\Cloud\DiscoveryEngine\V1beta\Session;

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

    // Prepare the request message.
    $session = new Session();
    $request = (new CreateSessionRequest())
        ->setParent($formattedParent)
        ->setSession($session);

    // Call the API and handle any network failures.
    try {
        /** @var Session $response */
        $response = $conversationalSearchServiceClient->createSession($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_session_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\ConversationalSearchServiceClient::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);
}

deleteSession

Deletes a Session.

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

The async variant is Google\Cloud\DiscoveryEngine\V1beta\Client\ConversationalSearchServiceClient::deleteSessionAsync() .

Parameters
Name Description
request Google\Cloud\DiscoveryEngine\V1beta\DeleteSessionRequest

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\DeleteSessionRequest;

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

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

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

    delete_session_sample($formattedName);
}

getAnswer

Gets a Answer.

The async variant is Google\Cloud\DiscoveryEngine\V1beta\Client\ConversationalSearchServiceClient::getAnswerAsync() .

Parameters
Name Description
request Google\Cloud\DiscoveryEngine\V1beta\GetAnswerRequest

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\Answer
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\DiscoveryEngine\V1beta\Answer;
use Google\Cloud\DiscoveryEngine\V1beta\Client\ConversationalSearchServiceClient;
use Google\Cloud\DiscoveryEngine\V1beta\GetAnswerRequest;

/**
 * @param string $formattedName The resource name of the Answer to get. Format:
 *                              `projects/{project_number}/locations/{location_id}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`
 *                              Please see {@see ConversationalSearchServiceClient::answerName()} for help formatting this field.
 */
function get_answer_sample(string $formattedName): void
{
    // Create a client.
    $conversationalSearchServiceClient = new ConversationalSearchServiceClient();

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

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

    get_answer_sample($formattedName);
}

getConversation

Gets a Conversation.

The async variant is Google\Cloud\DiscoveryEngine\V1beta\Client\ConversationalSearchServiceClient::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);
}

getSession

Gets a Session.

The async variant is Google\Cloud\DiscoveryEngine\V1beta\Client\ConversationalSearchServiceClient::getSessionAsync() .

Parameters
Name Description
request Google\Cloud\DiscoveryEngine\V1beta\GetSessionRequest

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\Session
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\DiscoveryEngine\V1beta\Client\ConversationalSearchServiceClient;
use Google\Cloud\DiscoveryEngine\V1beta\GetSessionRequest;
use Google\Cloud\DiscoveryEngine\V1beta\Session;

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

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

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

    get_session_sample($formattedName);
}

listConversations

Lists all Conversations by their parent DataStore.

The async variant is Google\Cloud\DiscoveryEngine\V1beta\Client\ConversationalSearchServiceClient::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);
}

listSessions

Lists all Sessions by their parent DataStore.

The async variant is Google\Cloud\DiscoveryEngine\V1beta\Client\ConversationalSearchServiceClient::listSessionsAsync() .

Parameters
Name Description
request Google\Cloud\DiscoveryEngine\V1beta\ListSessionsRequest

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\ListSessionsRequest;
use Google\Cloud\DiscoveryEngine\V1beta\Session;

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

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

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

        /** @var Session $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_sessions_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\ConversationalSearchServiceClient::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());
    }
}

updateSession

Updates a Session.

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

The async variant is Google\Cloud\DiscoveryEngine\V1beta\Client\ConversationalSearchServiceClient::updateSessionAsync() .

Parameters
Name Description
request Google\Cloud\DiscoveryEngine\V1beta\UpdateSessionRequest

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\Session
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\DiscoveryEngine\V1beta\Client\ConversationalSearchServiceClient;
use Google\Cloud\DiscoveryEngine\V1beta\Session;
use Google\Cloud\DiscoveryEngine\V1beta\UpdateSessionRequest;

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

    // Prepare the request message.
    $session = new Session();
    $request = (new UpdateSessionRequest())
        ->setSession($session);

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

answerQueryAsync

Parameters
Name Description
request Google\Cloud\DiscoveryEngine\V1beta\AnswerQueryRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

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

createSessionAsync

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

deleteSessionAsync

Parameters
Name Description
request Google\Cloud\DiscoveryEngine\V1beta\DeleteSessionRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

getAnswerAsync

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

getSessionAsync

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

listSessionsAsync

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

updateSessionAsync

Parameters
Name Description
request Google\Cloud\DiscoveryEngine\V1beta\UpdateSessionRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

static::answerName

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

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

static::chunkName

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

Parameters
Name Description
project string
location string
dataStore string
branch string
document string
chunk string
Returns
Type Description
string The formatted chunk resource.

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::documentName

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

Parameters
Name Description
project string
location string
dataStore string
branch string
document string
Returns
Type Description
string The formatted document 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::projectLocationCollectionDataStoreBranchDocumentName

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

Parameters
Name Description
project string
location string
collection string
dataStore string
branch string
document string
Returns
Type Description
string The formatted project_location_collection_data_store_branch_document resource.

static::projectLocationCollectionDataStoreBranchDocumentChunkName

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

Parameters
Name Description
project string
location string
collection string
dataStore string
branch string
document string
chunk string
Returns
Type Description
string The formatted project_location_collection_data_store_branch_document_chunk 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::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::projectLocationCollectionDataStoreSessionAnswerName

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

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

static::projectLocationCollectionEngineConversationName

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

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

static::projectLocationCollectionEngineServingConfigName

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

Parameters
Name Description
project string
location string
collection string
engine string
servingConfig string
Returns
Type Description
string The formatted project_location_collection_engine_serving_config 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::projectLocationCollectionEngineSessionAnswerName

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

Parameters
Name Description
project string
location string
collection string
engine string
session string
answer string
Returns
Type Description
string The formatted project_location_collection_engine_session_answer 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::projectLocationDataStoreBranchDocumentName

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

Parameters
Name Description
project string
location string
dataStore string
branch string
document string
Returns
Type Description
string The formatted project_location_data_store_branch_document resource.

static::projectLocationDataStoreBranchDocumentChunkName

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

Parameters
Name Description
project string
location string
dataStore string
branch string
document string
chunk string
Returns
Type Description
string The formatted project_location_data_store_branch_document_chunk 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::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::projectLocationDataStoreSessionAnswerName

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

Parameters
Name Description
project string
location string
dataStore string
session string
answer string
Returns
Type Description
string The formatted project_location_data_store_session_answer 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::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::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

  • answer: projects/{project}/locations/{location}/dataStores/{data_store}/sessions/{session}/answers/{answer}
  • chunk: projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}
  • conversation: projects/{project}/locations/{location}/dataStores/{data_store}/conversations/{conversation}
  • dataStore: projects/{project}/locations/{location}/dataStores/{data_store}
  • document: projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}
  • projectLocationCollectionDataStore: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}
  • projectLocationCollectionDataStoreBranchDocument: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}
  • projectLocationCollectionDataStoreBranchDocumentChunk: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}
  • 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}
  • projectLocationCollectionDataStoreSession: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/sessions/{session}
  • projectLocationCollectionDataStoreSessionAnswer: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/sessions/{session}/answers/{answer}
  • projectLocationCollectionEngineConversation: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/conversations/{conversation}
  • projectLocationCollectionEngineServingConfig: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config}
  • projectLocationCollectionEngineSession: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}
  • projectLocationCollectionEngineSessionAnswer: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/answers/{answer}
  • projectLocationDataStore: projects/{project}/locations/{location}/dataStores/{data_store}
  • projectLocationDataStoreBranchDocument: projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}
  • projectLocationDataStoreBranchDocumentChunk: projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}
  • projectLocationDataStoreConversation: projects/{project}/locations/{location}/dataStores/{data_store}/conversations/{conversation}
  • projectLocationDataStoreServingConfig: projects/{project}/locations/{location}/dataStores/{data_store}/servingConfigs/{serving_config}
  • projectLocationDataStoreSession: projects/{project}/locations/{location}/dataStores/{data_store}/sessions/{session}
  • projectLocationDataStoreSessionAnswer: projects/{project}/locations/{location}/dataStores/{data_store}/sessions/{session}/answers/{answer}
  • servingConfig: projects/{project}/locations/{location}/dataStores/{data_store}/servingConfigs/{serving_config}
  • session: projects/{project}/locations/{location}/dataStores/{data_store}/sessions/{session}

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.