Reference documentation and code samples for the Google Cloud Dialogflow V2 Client class KnowledgeBasesClient.
Service Description: Service for managing KnowledgeBases.
This class is currently experimental and may be subject to changes.
Namespace
Google \ Cloud \ Dialogflow \ V2 \ ClientMethods
__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. |
createKnowledgeBase
Creates a knowledge base.
The async variant is Google\Cloud\Dialogflow\V2\Client\BaseClient\self::createKnowledgeBaseAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dialogflow\V2\CreateKnowledgeBaseRequest
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\Dialogflow\V2\KnowledgeBase |
deleteKnowledgeBase
Deletes the specified knowledge base.
The async variant is Google\Cloud\Dialogflow\V2\Client\BaseClient\self::deleteKnowledgeBaseAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dialogflow\V2\DeleteKnowledgeBaseRequest
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. |
getKnowledgeBase
Retrieves the specified knowledge base.
The async variant is Google\Cloud\Dialogflow\V2\Client\BaseClient\self::getKnowledgeBaseAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dialogflow\V2\GetKnowledgeBaseRequest
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\Dialogflow\V2\KnowledgeBase |
listKnowledgeBases
Returns the list of all knowledge bases of the specified agent.
The async variant is Google\Cloud\Dialogflow\V2\Client\BaseClient\self::listKnowledgeBasesAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dialogflow\V2\ListKnowledgeBasesRequest
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 |
updateKnowledgeBase
Updates the specified knowledge base.
The async variant is Google\Cloud\Dialogflow\V2\Client\BaseClient\self::updateKnowledgeBaseAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dialogflow\V2\UpdateKnowledgeBaseRequest
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\Dialogflow\V2\KnowledgeBase |
getLocation
Gets information about a location.
The async variant is Google\Cloud\Dialogflow\V2\Client\BaseClient\self::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 |
listLocations
Lists information about the supported locations for this service.
The async variant is Google\Cloud\Dialogflow\V2\Client\BaseClient\self::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 |
createKnowledgeBaseAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dialogflow\V2\CreateKnowledgeBaseRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
deleteKnowledgeBaseAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dialogflow\V2\DeleteKnowledgeBaseRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getKnowledgeBaseAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dialogflow\V2\GetKnowledgeBaseRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
listKnowledgeBasesAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dialogflow\V2\ListKnowledgeBasesRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
updateKnowledgeBaseAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dialogflow\V2\UpdateKnowledgeBaseRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getLocationAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Location\GetLocationRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
listLocationsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Location\ListLocationsRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
static::knowledgeBaseName
Formats a string containing the fully-qualified path to represent a knowledge_base resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
knowledgeBase |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted knowledge_base 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::projectKnowledgeBaseName
Formats a string containing the fully-qualified path to represent a project_knowledge_base resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
knowledgeBase |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted project_knowledge_base resource. |
static::projectLocationKnowledgeBaseName
Formats a string containing the fully-qualified path to represent a project_location_knowledge_base resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
knowledgeBase |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted project_location_knowledge_base 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
- knowledgeBase: projects/{project}/knowledgeBases/{knowledge_base}
- location: projects/{project}/locations/{location}
- project: projects/{project}
- projectKnowledgeBase: projects/{project}/knowledgeBases/{knowledge_base}
- projectLocationKnowledgeBase: projects/{project}/locations/{location}/knowledgeBases/{knowledge_base}
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. |