Google Cloud Gemini Data Analytics V1beta Client - Class DataChatServiceClient (0.1.1)

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

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. Important: If you accept a credential configuration (credential JSON/File/Stream) from an external source for authentication to Google Cloud Platform, you must validate it before providing it to any Google API or library. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. For more information 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() .

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

↳ logger false|LoggerInterface

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

chat

Answers a data question by generating a stream of [Message]s.

Parameters
Name Description
request Google\Cloud\GeminiDataAnalytics\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
Google\ApiCore\ServerStream
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() .

Parameters
Name Description
request Google\Cloud\GeminiDataAnalytics\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\GeminiDataAnalytics\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);
}

getConversation

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

The async variant is DataChatServiceClient::getConversationAsync() .

Parameters
Name Description
request Google\Cloud\GeminiDataAnalytics\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\GeminiDataAnalytics\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() .

Parameters
Name Description
request Google\Cloud\GeminiDataAnalytics\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\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() .

Parameters
Name Description
request Google\Cloud\GeminiDataAnalytics\V1beta\ListMessagesRequest

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\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);
}

getLocation

Gets information about a ___location.

The async variant is DataChatServiceClient::getLocationAsync() .

Parameters
Name Description
request Google\Cloud\Location\GetLocationRequest

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

The async variant is DataChatServiceClient::listLocationsAsync() .

Parameters
Name Description
request Google\Cloud\Location\ListLocationsRequest

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\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 Google\Cloud\GeminiDataAnalytics\V1beta\CreateConversationRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\GeminiDataAnalytics\V1beta\Conversation>

getConversationAsync

Parameters
Name Description
request Google\Cloud\GeminiDataAnalytics\V1beta\GetConversationRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\GeminiDataAnalytics\V1beta\Conversation>

listConversationsAsync

Parameters
Name Description
request Google\Cloud\GeminiDataAnalytics\V1beta\ListConversationsRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

listMessagesAsync

Parameters
Name Description
request Google\Cloud\GeminiDataAnalytics\V1beta\ListMessagesRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

getLocationAsync

Parameters
Name Description
request Google\Cloud\Location\GetLocationRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Location\Location>

listLocationsAsync

Parameters
Name Description
request Google\Cloud\Location\ListLocationsRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

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::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}
  • 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.