Reference documentation and code samples for the Google Cloud Dialogflow V2 Client class AnswerRecordsClient.
Service Description: Service for managing AnswerRecords.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
$answerRecordsClient = new AnswerRecordsClient();
try {
$formattedParent = $answerRecordsClient->projectName('[PROJECT]');
// Iterate over pages of elements
$pagedResponse = $answerRecordsClient->listAnswerRecords($formattedParent);
foreach ($pagedResponse->iteratePages() as $page) {
foreach ($page as $element) {
// doSomethingWith($element);
}
}
// Alternatively:
// Iterate through all elements
$pagedResponse = $answerRecordsClient->listAnswerRecords($formattedParent);
foreach ($pagedResponse->iterateAllElements() as $element) {
// doSomethingWith($element);
}
} finally {
$answerRecordsClient->close();
}
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.
This service has a new (beta) implementation. See Google\Cloud\Dialogflow\V2\Client\AnswerRecordsClient to use the new surface.
Namespace
Google \ Cloud \ Dialogflow \ V2Methods
__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 |
↳ 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 |
↳ 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. |
listAnswerRecords
Returns the list of all answer records in the specified project in reverse chronological order.
Parameters | |
---|---|
Name | Description |
parent |
string
Required. The project to list all answer records for in reverse
chronological order. Format: |
optionalArgs |
array
Optional. |
↳ filter |
string
Optional. Filters to restrict results to specific answer records. Marked deprecated as it hasn't been, and isn't currently, supported. For more information about filtering, see API Filtering. |
↳ pageSize |
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved. |
↳ pageToken |
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API. |
↳ 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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dialogflow\V2\AnswerRecord;
use Google\Cloud\Dialogflow\V2\AnswerRecordsClient;
/**
* @param string $formattedParent The project to list all answer records for in reverse
* chronological order. Format: `projects/<Project ID>/locations/<Location
* ID>`. Please see
* {@see AnswerRecordsClient::projectName()} for help formatting this field.
*/
function list_answer_records_sample(string $formattedParent): void
{
// Create a client.
$answerRecordsClient = new AnswerRecordsClient();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $answerRecordsClient->listAnswerRecords($formattedParent);
/** @var AnswerRecord $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 = AnswerRecordsClient::projectName('[PROJECT]');
list_answer_records_sample($formattedParent);
}
updateAnswerRecord
Updates the specified answer record.
Parameters | |
---|---|
Name | Description |
answerRecord |
Google\Cloud\Dialogflow\V2\AnswerRecord
Required. Answer record to update. |
updateMask |
Google\Protobuf\FieldMask
Required. The mask to control which fields get updated. |
optionalArgs |
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\Dialogflow\V2\AnswerRecord |
use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\AnswerFeedback;
use Google\Cloud\Dialogflow\V2\AnswerRecord;
use Google\Cloud\Dialogflow\V2\AnswerRecordsClient;
use Google\Protobuf\FieldMask;
/**
* 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_answer_record_sample(): void
{
// Create a client.
$answerRecordsClient = new AnswerRecordsClient();
// Prepare any non-scalar elements to be passed along with the request.
$answerRecordAnswerFeedback = new AnswerFeedback();
$answerRecord = (new AnswerRecord())
->setAnswerFeedback($answerRecordAnswerFeedback);
$updateMask = new FieldMask();
// Call the API and handle any network failures.
try {
/** @var AnswerRecord $response */
$response = $answerRecordsClient->updateAnswerRecord($answerRecord, $updateMask);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
getLocation
Gets information about a location.
Parameters | |
---|---|
Name | Description |
optionalArgs |
array
Optional. |
↳ name |
string
Resource name for the location. |
↳ 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 |
use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\AnswerRecordsClient;
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.
$answerRecordsClient = new AnswerRecordsClient();
// Call the API and handle any network failures.
try {
/** @var Location $response */
$response = $answerRecordsClient->getLocation();
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.
Parameters | |
---|---|
Name | Description |
optionalArgs |
array
Optional. |
↳ name |
string
The resource that owns the locations collection, if applicable. |
↳ filter |
string
The standard list filter. |
↳ pageSize |
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved. |
↳ pageToken |
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API. |
↳ 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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dialogflow\V2\AnswerRecordsClient;
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.
$answerRecordsClient = new AnswerRecordsClient();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $answerRecordsClient->listLocations();
/** @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());
}
}
static::answerRecordName
Formats a string containing the fully-qualified path to represent a answer_record resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
answerRecord |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted answer_record 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::projectAnswerRecordName
Formats a string containing the fully-qualified path to represent a project_answer_record resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
answerRecord |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted project_answer_record resource. |
static::projectLocationAnswerRecordName
Formats a string containing the fully-qualified path to represent a project_location_answer_record resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
answerRecord |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted project_location_answer_record 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
- answerRecord: projects/{project}/answerRecords/{answer_record}
- location: projects/{project}/locations/{location}
- project: projects/{project}
- projectAnswerRecord: projects/{project}/answerRecords/{answer_record}
- projectLocationAnswerRecord: projects/{project}/locations/{location}/answerRecords/{answer_record}
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. |
Constants
SERVICE_NAME
Value: 'google.cloud.dialogflow.v2.AnswerRecords'
The name of the service.
SERVICE_ADDRESS
Value: 'dialogflow.googleapis.com'
The default address of the service.
DEFAULT_SERVICE_PORT
Value: 443
The default port of the service.
CODEGEN_NAME
Value: 'gapic'
The name of the code generator, to be included in the agent header.