Google Cloud Dialogflow V2 Client - Class DocumentsClient (1.10.2)

Reference documentation and code samples for the Google Cloud Dialogflow V2 Client class DocumentsClient.

Service Description: Service for managing knowledge Documents.

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.

This class is currently experimental and may be subject to changes. See Google\Cloud\Dialogflow\V2\DocumentsClient for the stable implementation

Namespace

Google \ Cloud \ Dialogflow \ V2 \ Client

Methods

__construct

Constructor.

Parameters
Name	Description
`options`	`array` Optional. Options for configuring the service API wrapper.
`↳ apiEndpoint`	`string` The address of the API remote host. May optionally include the port, formatted as "
`↳ credentials`	`string\|array\|FetchAuthTokenInterface\|CredentialsWrapper` The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
`↳ credentialsConfig`	`array` Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
`↳ disableRetries`	`bool` Determines whether or not retries defined by the client configuration should be disabled. Defaults to `false`.
`↳ clientConfig`	`string\|array` Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
`↳ transport`	`string\|TransportInterface` The transport used for executing network requests. May be either the string `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
`↳ transportConfig`	`array` Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
`↳ clientCertSource`	`callable` A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

createDocument

Creates a new document.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

metadata: KnowledgeOperationMetadata
response: Document

The async variant is Google\Cloud\Dialogflow\V2\Client\DocumentsClient::createDocumentAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\V2\CreateDocumentRequest` 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\OperationResponse`

deleteDocument

Deletes the specified document.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

metadata: KnowledgeOperationMetadata
response: An Empty message

The async variant is Google\Cloud\Dialogflow\V2\Client\DocumentsClient::deleteDocumentAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\V2\DeleteDocumentRequest` 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\OperationResponse`

exportDocument

Exports a smart messaging candidate document into the specified destination.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

metadata: KnowledgeOperationMetadata
response: Document

The async variant is Google\Cloud\Dialogflow\V2\Client\DocumentsClient::exportDocumentAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\V2\ExportDocumentRequest` 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\OperationResponse`

getDocument

Retrieves the specified document.

The async variant is Google\Cloud\Dialogflow\V2\Client\DocumentsClient::getDocumentAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\V2\GetDocumentRequest` 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\Document`

importDocuments

Creates documents by importing data from external sources.

Dialogflow supports up to 350 documents in each request. If you try to import more, Dialogflow will return an error.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

metadata: KnowledgeOperationMetadata
response: ImportDocumentsResponse

The async variant is Google\Cloud\Dialogflow\V2\Client\DocumentsClient::importDocumentsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\V2\ImportDocumentsRequest` 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\OperationResponse`

listDocuments

Returns the list of all documents of the knowledge base.

The async variant is Google\Cloud\Dialogflow\V2\Client\DocumentsClient::listDocumentsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\V2\ListDocumentsRequest` 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`

reloadDocument

Reloads the specified document from its specified source, content_uri or content. The previously loaded content of the document will be deleted.

Note: Even when the content of the document has not changed, there still may be side effects because of internal implementation changes.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

metadata: KnowledgeOperationMetadata
response: Document

Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents.

The async variant is Google\Cloud\Dialogflow\V2\Client\DocumentsClient::reloadDocumentAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\V2\ReloadDocumentRequest` 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\OperationResponse`

updateDocument

Updates the specified document.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

metadata: KnowledgeOperationMetadata
response: Document

The async variant is Google\Cloud\Dialogflow\V2\Client\DocumentsClient::updateDocumentAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\V2\UpdateDocumentRequest` 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\OperationResponse`

getLocation

Gets information about a location.

The async variant is Google\Cloud\Dialogflow\V2\Client\DocumentsClient::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\DocumentsClient::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`

createDocumentAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\V2\CreateDocumentRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deleteDocumentAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\V2\DeleteDocumentRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

exportDocumentAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\V2\ExportDocumentRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getDocumentAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\V2\GetDocumentRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

importDocumentsAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\V2\ImportDocumentsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listDocumentsAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\V2\ListDocumentsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

reloadDocumentAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\V2\ReloadDocumentRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

updateDocumentAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\V2\UpdateDocumentRequest`
`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`

getOperationsClient

Return an OperationsClient object with the same endpoint as $this.

Returns
Type	Description
`Google\ApiCore\LongRunning\OperationsClient`

resumeOperation

Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.

Parameters
Name	Description
`operationName`	`string` The name of the long running operation
`methodName`	`string` The name of the method used to start the operation

Returns
Type	Description
`Google\ApiCore\OperationResponse`

static::documentName

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

Parameters
Name	Description
`project`	`string`
`knowledgeBase`	`string`
`document`	`string`

Returns
Type	Description
`string`	The formatted document resource.

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

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

Parameters
Name	Description
`project`	`string`
`knowledgeBase`	`string`
`document`	`string`

Returns
Type	Description
`string`	The formatted project_knowledge_base_document 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::projectLocationKnowledgeBaseDocumentName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`knowledgeBase`	`string`
`document`	`string`

Returns
Type	Description
`string`	The formatted project_location_knowledge_base_document 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

document: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}
knowledgeBase: projects/{project}/knowledgeBases/{knowledge_base}
projectKnowledgeBase: projects/{project}/knowledgeBases/{knowledge_base}
projectKnowledgeBaseDocument: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}
projectLocationKnowledgeBase: projects/{project}/locations/{location}/knowledgeBases/{knowledge_base}
projectLocationKnowledgeBaseDocument: projects/{project}/locations/{location}/knowledgeBases/{knowledge_base}/documents/{document}

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.