0.16.0 (latest) 0.15.0 0.14.1 0.11.1 0.10.0 0.9.0 0.8.0 0.7.1 0.6.0 0.5.0 0.4.0 0.3.1 0.2.0 0.1.1

> [!WARNING]
> **Beta**
>
>
> This library is covered by the [Pre-GA Offerings Terms](https://docs.cloud.google.com/terms/service-terms#1)
> of the Terms of Service. Pre-GA libraries might have limited support,
> and changes to pre-GA libraries might not be compatible with other pre-GA versions.
> For more information, see the
> [launch stage descriptions](https://docs.cloud.google.com/products#product-launch-stages).

Reference documentation and code samples for the Google Cloud Gemini Data Analytics V1beta Client class DataChatServiceClient.

Service Description: Service to ask a natural language question on top of BigQuery
and Looker Studio datasources to get back streamed responses of various kinds
to help provide a rich conversational answer.

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

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `options` | `array|https://docs.cloud.google.com/php/docs/reference/gax/latest/Options.ClientOptions.html` 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` | `https://docs.cloud.google.com/php/docs/reference/auth/latest/FetchAuthTokenInterface.html|https://docs.cloud.google.com/php/docs/reference/gax/latest/CredentialsWrapper.html` This option should only be used with a pre-constructed [Google\\Auth\\FetchAuthTokenInterface](https://docs.cloud.google.com/php/docs/reference/auth/latest/FetchAuthTokenInterface.html) or [Google\\ApiCore\\CredentialsWrapper](https://docs.cloud.google.com/php/docs/reference/gax/latest/CredentialsWrapper.html) 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\GeminiDataAnalytics\V1beta\DataChatServiceClient; $creds = new ServiceAccountCredentials($scopes, $json); $options = new DataChatServiceClient(['credentials' => $creds]);` <https://cloud.google.com/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()](https://docs.cloud.google.com/php/docs/reference/gax/latest/CredentialsWrapper.html#_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|https://docs.cloud.google.com/php/docs/reference/gax/latest/Transport.TransportInterface.html` 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](https://docs.cloud.google.com/php/docs/reference/gax/latest/Transport.TransportInterface.html) 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()](https://docs.cloud.google.com/php/docs/reference/gax/latest/Transport.GrpcTransport.html#_Google_ApiCore_Transport_GrpcTransport__build__) and [Google\\ApiCore\\Transport\\RestTransport::build()](https://docs.cloud.google.com/php/docs/reference/gax/latest/Transport.RestTransport.html#_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'. |

### chat

Answers a data question by generating a stream of
[Message](https://docs.cloud.google.com/php/docs/reference/cloud-geminidataanalytics/latest/V1beta.Message) objects.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-geminidataanalytics/latest/V1beta.ChatRequest` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ timeoutMillis` | `int` Timeout to use for this call. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/gax/latest/ServerStream.html<https://docs.cloud.google.com/php/docs/reference/cloud-geminidataanalytics/latest/V1beta.Message>` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\ApiCore\ServerStream;
    use Google\Cloud\GeminiDataAnalytics\V1beta\ChatRequest;
    use Google\Cloud\GeminiDataAnalytics\V1beta\Client\DataChatServiceClient;
    use Google\Cloud\GeminiDataAnalytics\V1beta\Message;

    /**
     * @param string $parent The parent value for chat request.
     *                       Pattern: `projects/{project}/locations/{location}`
     */
    function chat_sample(string $parent): void
    {
        // Create a client.
        $dataChatServiceClient = new DataChatServiceClient();

        // Prepare the request message.
        $messages = [new Message()];
        $request = (new ChatRequest())
            ->setParent($parent)
            ->setMessages($messages);

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

            /** @var Message $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
    {
        $parent = '[PARENT]';

        chat_sample($parent);
    }

### createConversation

Creates a new conversation to persist the conversation history. Each
conversation will have multiple messages associated with it.

The async variant is [DataChatServiceClient::createConversationAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-geminidataanalytics/latest/V1beta.Client.DataChatServiceClient#_Google_Cloud_GeminiDataAnalytics_V1beta_Client_DataChatServiceClient__createConversationAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-geminidataanalytics/latest/V1beta.CreateConversationRequest` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-geminidataanalytics/latest/V1beta.Conversation` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\Cloud\GeminiDataAnalytics\V1beta\Client\DataChatServiceClient;
    use Google\Cloud\GeminiDataAnalytics\V1beta\Conversation;
    use Google\Cloud\GeminiDataAnalytics\V1beta\CreateConversationRequest;

    /**
     * @param string $formattedParent           Parent value for CreateConversationRequest.
     *                                          Format: `projects/{project}/locations/{location}`
     *                                          Please see {@see DataChatServiceClient::locationName()} for help formatting this field.
     * @param string $conversationAgentsElement Agent(s) in the conversation.
     *                                          Currently, only one agent is supported. This field is repeated to allow
     *                                          for future support of multiple agents in a conversation.
     *                                          Format: `projects/{project}/locations/{location}/dataAgents/{agent}`
     */
    function create_conversation_sample(
        string $formattedParent,
        string $conversationAgentsElement
    ): void {
        // Create a client.
        $dataChatServiceClient = new DataChatServiceClient();

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

        // Call the API and handle any network failures.
        try {
            /** @var Conversation $response */
            $response = $dataChatServiceClient->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 = DataChatServiceClient::locationName('[PROJECT]', '[LOCATION]');
        $conversationAgentsElement = '[AGENTS]';

        create_conversation_sample($formattedParent, $conversationAgentsElement);
    }

### deleteConversation

Deletes a conversation.

The async variant is [DataChatServiceClient::deleteConversationAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-geminidataanalytics/latest/V1beta.Client.DataChatServiceClient#_Google_Cloud_GeminiDataAnalytics_V1beta_Client_DataChatServiceClient__deleteConversationAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-geminidataanalytics/latest/V1beta.DeleteConversationRequest` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

**Example**

    use Google\ApiCore\ApiException;
    use Google\Cloud\GeminiDataAnalytics\V1beta\Client\DataChatServiceClient;
    use Google\Cloud\GeminiDataAnalytics\V1beta\DeleteConversationRequest;

    /**
     * @param string $formattedName Name of the resource.
     *                              Format:
     *                              `projects/{project}/locations/{location}/conversations/{conversation}`
     *                              Please see {@see DataChatServiceClient::conversationName()} for help formatting this field.
     */
    function delete_conversation_sample(string $formattedName): void
    {
        // Create a client.
        $dataChatServiceClient = new DataChatServiceClient();

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

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

        delete_conversation_sample($formattedName);
    }

### getConversation

Gets details of a single conversation by using conversation id and parent.

The async variant is [DataChatServiceClient::getConversationAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-geminidataanalytics/latest/V1beta.Client.DataChatServiceClient#_Google_Cloud_GeminiDataAnalytics_V1beta_Client_DataChatServiceClient__getConversationAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-geminidataanalytics/latest/V1beta.GetConversationRequest` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-geminidataanalytics/latest/V1beta.Conversation` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\Cloud\GeminiDataAnalytics\V1beta\Client\DataChatServiceClient;
    use Google\Cloud\GeminiDataAnalytics\V1beta\Conversation;
    use Google\Cloud\GeminiDataAnalytics\V1beta\GetConversationRequest;

    /**
     * @param string $formattedName Name of the resource.
     *                              Format:
     *                              `projects/{project}/locations/{location}/conversations/{conversation}`
     *                              Please see {@see DataChatServiceClient::conversationName()} for help formatting this field.
     */
    function get_conversation_sample(string $formattedName): void
    {
        // Create a client.
        $dataChatServiceClient = new DataChatServiceClient();

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

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

        get_conversation_sample($formattedName);
    }

### listConversations

Lists all conversations for a given parent.

The async variant is [DataChatServiceClient::listConversationsAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-geminidataanalytics/latest/V1beta.Client.DataChatServiceClient#_Google_Cloud_GeminiDataAnalytics_V1beta_Client_DataChatServiceClient__listConversationsAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-geminidataanalytics/latest/V1beta.ListConversationsRequest` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/gax/latest/PagedListResponse.html` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\ApiCore\PagedListResponse;
    use Google\Cloud\GeminiDataAnalytics\V1beta\Client\DataChatServiceClient;
    use Google\Cloud\GeminiDataAnalytics\V1beta\Conversation;
    use Google\Cloud\GeminiDataAnalytics\V1beta\ListConversationsRequest;

    /**
     * @param string $formattedParent Parent value for ListConversationsRequest.
     *                                Format: `projects/{project}/locations/{location}`
     *                                Please see {@see DataChatServiceClient::locationName()} for help formatting this field.
     */
    function list_conversations_sample(string $formattedParent): void
    {
        // Create a client.
        $dataChatServiceClient = new DataChatServiceClient();

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

        // Call the API and handle any network failures.
        try {
            /** @var PagedListResponse $response */
            $response = $dataChatServiceClient->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 = DataChatServiceClient::locationName('[PROJECT]', '[LOCATION]');

        list_conversations_sample($formattedParent);
    }

### listMessages

Lists all messages for a given conversation.

The async variant is [DataChatServiceClient::listMessagesAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-geminidataanalytics/latest/V1beta.Client.DataChatServiceClient#_Google_Cloud_GeminiDataAnalytics_V1beta_Client_DataChatServiceClient__listMessagesAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-geminidataanalytics/latest/V1beta.ListMessagesRequest` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/gax/latest/PagedListResponse.html` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\ApiCore\PagedListResponse;
    use Google\Cloud\GeminiDataAnalytics\V1beta\Client\DataChatServiceClient;
    use Google\Cloud\GeminiDataAnalytics\V1beta\ListMessagesRequest;
    use Google\Cloud\GeminiDataAnalytics\V1beta\StorageMessage;

    /**
     * @param string $formattedParent The conversation to list messages under.
     *                                Format:
     *                                `projects/{project}/locations/{location}/conversations/{conversation_id}`
     *                                Please see {@see DataChatServiceClient::conversationName()} for help formatting this field.
     */
    function list_messages_sample(string $formattedParent): void
    {
        // Create a client.
        $dataChatServiceClient = new DataChatServiceClient();

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

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

            /** @var StorageMessage $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 = DataChatServiceClient::conversationName(
            '[PROJECT]',
            '[LOCATION]',
            '[CONVERSATION]'
        );

        list_messages_sample($formattedParent);
    }

### queryData

Queries data from a natural language user query.

The async variant is [DataChatServiceClient::queryDataAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-geminidataanalytics/latest/V1beta.Client.DataChatServiceClient#_Google_Cloud_GeminiDataAnalytics_V1beta_Client_DataChatServiceClient__queryDataAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-geminidataanalytics/latest/V1beta.QueryDataRequest` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-geminidataanalytics/latest/V1beta.QueryDataResponse` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\Cloud\GeminiDataAnalytics\V1beta\Client\DataChatServiceClient;
    use Google\Cloud\GeminiDataAnalytics\V1beta\DatasourceReferences;
    use Google\Cloud\GeminiDataAnalytics\V1beta\QueryDataContext;
    use Google\Cloud\GeminiDataAnalytics\V1beta\QueryDataRequest;
    use Google\Cloud\GeminiDataAnalytics\V1beta\QueryDataResponse;

    /**
     * @param string $formattedParent The parent resource to generate the query for.
     *                                Format: projects/{project}/locations/{location}
     *                                Please see {@see DataChatServiceClient::locationName()} for help formatting this field.
     * @param string $prompt          The natural language query for which to generate query.
     *                                Example: "What are the top 5 best selling products this month?"
     */
    function query_data_sample(string $formattedParent, string $prompt): void
    {
        // Create a client.
        $dataChatServiceClient = new DataChatServiceClient();

        // Prepare the request message.
        $contextDatasourceReferences = new DatasourceReferences();
        $context = (new QueryDataContext())
            ->setDatasourceReferences($contextDatasourceReferences);
        $request = (new QueryDataRequest())
            ->setParent($formattedParent)
            ->setPrompt($prompt)
            ->setContext($context);

        // Call the API and handle any network failures.
        try {
            /** @var QueryDataResponse $response */
            $response = $dataChatServiceClient->queryData($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 = DataChatServiceClient::locationName('[PROJECT]', '[LOCATION]');
        $prompt = '[PROMPT]';

        query_data_sample($formattedParent, $prompt);
    }

### updateConversation

Updates a conversation.

The async variant is [DataChatServiceClient::updateConversationAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-geminidataanalytics/latest/V1beta.Client.DataChatServiceClient#_Google_Cloud_GeminiDataAnalytics_V1beta_Client_DataChatServiceClient__updateConversationAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-geminidataanalytics/latest/V1beta.UpdateConversationRequest` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-geminidataanalytics/latest/V1beta.Conversation` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\Cloud\GeminiDataAnalytics\V1beta\Client\DataChatServiceClient;
    use Google\Cloud\GeminiDataAnalytics\V1beta\Conversation;
    use Google\Cloud\GeminiDataAnalytics\V1beta\UpdateConversationRequest;

    /**
     * @param string $conversationAgentsElement Agent(s) in the conversation.
     *                                          Currently, only one agent is supported. This field is repeated to allow
     *                                          for future support of multiple agents in a conversation.
     *                                          Format: `projects/{project}/locations/{location}/dataAgents/{agent}`
     */
    function update_conversation_sample(string $conversationAgentsElement): void
    {
        // Create a client.
        $dataChatServiceClient = new DataChatServiceClient();

        // Prepare the request message.
        $conversationAgents = [$conversationAgentsElement];
        $conversation = (new Conversation())
            ->setAgents($conversationAgents);
        $request = (new UpdateConversationRequest())
            ->setConversation($conversation);

        // Call the API and handle any network failures.
        try {
            /** @var Conversation $response */
            $response = $dataChatServiceClient->updateConversation($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
    {
        $conversationAgentsElement = '[AGENTS]';

        update_conversation_sample($conversationAgentsElement);
    }

### getLocation

Gets information about a location.

The async variant is [DataChatServiceClient::getLocationAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-geminidataanalytics/latest/V1beta.Client.DataChatServiceClient#_Google_Cloud_GeminiDataAnalytics_V1beta_Client_DataChatServiceClient__getLocationAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Cloud.Location.GetLocationRequest.html` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Cloud.Location.Location.html` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\Cloud\GeminiDataAnalytics\V1beta\Client\DataChatServiceClient;
    use Google\Cloud\Location\GetLocationRequest;
    use Google\Cloud\Location\Location;

    /**
     * This sample has been automatically generated and should be regarded as a code
     * template only. It will require modifications to work:
     *  - It may require correct/in-range values for request initialization.
     *  - It may require specifying regional endpoints when creating the service client,
     *    please see the apiEndpoint client configuration option for more details.
     */
    function get_location_sample(): void
    {
        // Create a client.
        $dataChatServiceClient = new DataChatServiceClient();

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

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

### listLocations

Lists information about the supported locations for this service.

This method lists locations based on the resource scope provided in
the [ListLocationsRequest.name](https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Cloud.Location.ListLocationsRequest.html#_Google_Cloud_Location_ListLocationsRequest__getName__) field: \*
**Global locations** : If `name` is empty, the method lists the
public locations available to all projects. \* **Project-specific
locations** : If `name` follows the format
`projects/{project}`, the method lists locations visible to that
specific project. This includes public, private, or other
project-specific locations enabled for the project.

For gRPC and client library implementations, the resource name is
passed as the `name` field. For direct service calls, the resource
name is
incorporated into the request path based on the specific service
implementation and version.

The async variant is [DataChatServiceClient::listLocationsAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-geminidataanalytics/latest/V1beta.Client.DataChatServiceClient#_Google_Cloud_GeminiDataAnalytics_V1beta_Client_DataChatServiceClient__listLocationsAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Cloud.Location.ListLocationsRequest.html` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/gax/latest/PagedListResponse.html` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\ApiCore\PagedListResponse;
    use Google\Cloud\GeminiDataAnalytics\V1beta\Client\DataChatServiceClient;
    use Google\Cloud\Location\ListLocationsRequest;
    use Google\Cloud\Location\Location;

    /**
     * This sample has been automatically generated and should be regarded as a code
     * template only. It will require modifications to work:
     *  - It may require correct/in-range values for request initialization.
     *  - It may require specifying regional endpoints when creating the service client,
     *    please see the apiEndpoint client configuration option for more details.
     */
    function list_locations_sample(): void
    {
        // Create a client.
        $dataChatServiceClient = new DataChatServiceClient();

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

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

            /** @var Location $element */
            foreach ($response as $element) {
                printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
            }
        } catch (ApiException $ex) {
            printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
        }
    }

### createConversationAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-geminidataanalytics/latest/V1beta.CreateConversationRequest` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/cloud-geminidataanalytics/latest/V1beta.Conversation>` |   |

### deleteConversationAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-geminidataanalytics/latest/V1beta.DeleteConversationRequest` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<void>` |   |

### getConversationAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-geminidataanalytics/latest/V1beta.GetConversationRequest` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/cloud-geminidataanalytics/latest/V1beta.Conversation>` |   |

### listConversationsAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-geminidataanalytics/latest/V1beta.ListConversationsRequest` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/gax/latest/PagedListResponse.html>` |   |

### listMessagesAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-geminidataanalytics/latest/V1beta.ListMessagesRequest` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/gax/latest/PagedListResponse.html>` |   |

### queryDataAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-geminidataanalytics/latest/V1beta.QueryDataRequest` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/cloud-geminidataanalytics/latest/V1beta.QueryDataResponse>` |   |

### updateConversationAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-geminidataanalytics/latest/V1beta.UpdateConversationRequest` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/cloud-geminidataanalytics/latest/V1beta.Conversation>` |   |

### getLocationAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Cloud.Location.GetLocationRequest.html` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Cloud.Location.Location.html>` |   |

### listLocationsAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Cloud.Location.ListLocationsRequest.html` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/gax/latest/PagedListResponse.html>` |   |

### static::conversationName

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

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `project` | `string` |
| `location` | `string` |
| `conversation` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` | The formatted conversation resource. |

### static::cryptoKeyName

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

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `project` | `string` |
| `location` | `string` |
| `keyRing` | `string` |
| `cryptoKey` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` | The formatted crypto_key resource. |

### static::dataAgentName

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

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `project` | `string` |
| `location` | `string` |
| `dataAgent` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` | The formatted data_agent resource. |

### static::locationName

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

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `project` | `string` |
| `location` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` | The formatted location resource. |

### static::projectName

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

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `project` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` | The formatted project 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}/conversations/{conversation}
- cryptoKey: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}
- dataAgent: projects/{project}/locations/{location}/dataAgents/{data_agent}
- location: projects/{project}/locations/{location}
- project: projects/{project}

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