207 lines
9.0 KiB
PHP
207 lines
9.0 KiB
PHP
<?php
|
|
/*
|
|
* Copyright 2014 Google Inc.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
|
|
* use this file except in compliance with the License. You may obtain a copy of
|
|
* the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
* License for the specific language governing permissions and limitations under
|
|
* the License.
|
|
*/
|
|
|
|
namespace Google\Service\Dialogflow\Resource;
|
|
|
|
use Google\Service\Dialogflow\GoogleCloudDialogflowCxV3ExportIntentsRequest;
|
|
use Google\Service\Dialogflow\GoogleCloudDialogflowCxV3ImportIntentsRequest;
|
|
use Google\Service\Dialogflow\GoogleCloudDialogflowCxV3Intent;
|
|
use Google\Service\Dialogflow\GoogleCloudDialogflowCxV3ListIntentsResponse;
|
|
use Google\Service\Dialogflow\GoogleLongrunningOperation;
|
|
use Google\Service\Dialogflow\GoogleProtobufEmpty;
|
|
|
|
/**
|
|
* The "intents" collection of methods.
|
|
* Typical usage is:
|
|
* <code>
|
|
* $dialogflowService = new Google\Service\Dialogflow(...);
|
|
* $intents = $dialogflowService->projects_locations_agents_intents;
|
|
* </code>
|
|
*/
|
|
class ProjectsLocationsAgentsIntents extends \Google\Service\Resource
|
|
{
|
|
/**
|
|
* Creates an intent in the specified agent. Note: You should always train a
|
|
* flow prior to sending it queries. See the [training
|
|
* documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
|
|
* (intents.create)
|
|
*
|
|
* @param string $parent Required. The agent to create an intent for. Format:
|
|
* `projects//locations//agents/`.
|
|
* @param GoogleCloudDialogflowCxV3Intent $postBody
|
|
* @param array $optParams Optional parameters.
|
|
*
|
|
* @opt_param string languageCode The language of the following fields in
|
|
* `intent`: * `Intent.training_phrases.parts.text` If not specified, the
|
|
* agent's default language is used. [Many
|
|
* languages](https://cloud.google.com/dialogflow/cx/docs/reference/language)
|
|
* are supported. Note: languages must be enabled in the agent before they can
|
|
* be used.
|
|
* @return GoogleCloudDialogflowCxV3Intent
|
|
* @throws \Google\Service\Exception
|
|
*/
|
|
public function create($parent, GoogleCloudDialogflowCxV3Intent $postBody, $optParams = [])
|
|
{
|
|
$params = ['parent' => $parent, 'postBody' => $postBody];
|
|
$params = array_merge($params, $optParams);
|
|
return $this->call('create', [$params], GoogleCloudDialogflowCxV3Intent::class);
|
|
}
|
|
/**
|
|
* Deletes the specified intent. Note: You should always train a flow prior to
|
|
* sending it queries. See the [training
|
|
* documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
|
|
* (intents.delete)
|
|
*
|
|
* @param string $name Required. The name of the intent to delete. Format:
|
|
* `projects//locations//agents//intents/`.
|
|
* @param array $optParams Optional parameters.
|
|
* @return GoogleProtobufEmpty
|
|
* @throws \Google\Service\Exception
|
|
*/
|
|
public function delete($name, $optParams = [])
|
|
{
|
|
$params = ['name' => $name];
|
|
$params = array_merge($params, $optParams);
|
|
return $this->call('delete', [$params], GoogleProtobufEmpty::class);
|
|
}
|
|
/**
|
|
* Exports the selected intents. This method is a [long-running
|
|
* operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-
|
|
* operation). The returned `Operation` type has the following method-specific
|
|
* fields: - `metadata`: ExportIntentsMetadata - `response`:
|
|
* ExportIntentsResponse (intents.export)
|
|
*
|
|
* @param string $parent Required. The name of the parent agent to export
|
|
* intents. Format: `projects//locations//agents/`.
|
|
* @param GoogleCloudDialogflowCxV3ExportIntentsRequest $postBody
|
|
* @param array $optParams Optional parameters.
|
|
* @return GoogleLongrunningOperation
|
|
* @throws \Google\Service\Exception
|
|
*/
|
|
public function export($parent, GoogleCloudDialogflowCxV3ExportIntentsRequest $postBody, $optParams = [])
|
|
{
|
|
$params = ['parent' => $parent, 'postBody' => $postBody];
|
|
$params = array_merge($params, $optParams);
|
|
return $this->call('export', [$params], GoogleLongrunningOperation::class);
|
|
}
|
|
/**
|
|
* Retrieves the specified intent. (intents.get)
|
|
*
|
|
* @param string $name Required. The name of the intent. Format:
|
|
* `projects//locations//agents//intents/`.
|
|
* @param array $optParams Optional parameters.
|
|
*
|
|
* @opt_param string languageCode The language to retrieve the intent for. The
|
|
* following fields are language dependent: *
|
|
* `Intent.training_phrases.parts.text` If not specified, the agent's default
|
|
* language is used. [Many
|
|
* languages](https://cloud.google.com/dialogflow/cx/docs/reference/language)
|
|
* are supported. Note: languages must be enabled in the agent before they can
|
|
* be used.
|
|
* @return GoogleCloudDialogflowCxV3Intent
|
|
* @throws \Google\Service\Exception
|
|
*/
|
|
public function get($name, $optParams = [])
|
|
{
|
|
$params = ['name' => $name];
|
|
$params = array_merge($params, $optParams);
|
|
return $this->call('get', [$params], GoogleCloudDialogflowCxV3Intent::class);
|
|
}
|
|
/**
|
|
* Imports the specified intents into the agent. This method is a [long-running
|
|
* operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-
|
|
* operation). The returned `Operation` type has the following method-specific
|
|
* fields: - `metadata`: ImportIntentsMetadata - `response`:
|
|
* ImportIntentsResponse (intents.import)
|
|
*
|
|
* @param string $parent Required. The agent to import the intents into. Format:
|
|
* `projects//locations//agents/`.
|
|
* @param GoogleCloudDialogflowCxV3ImportIntentsRequest $postBody
|
|
* @param array $optParams Optional parameters.
|
|
* @return GoogleLongrunningOperation
|
|
* @throws \Google\Service\Exception
|
|
*/
|
|
public function import($parent, GoogleCloudDialogflowCxV3ImportIntentsRequest $postBody, $optParams = [])
|
|
{
|
|
$params = ['parent' => $parent, 'postBody' => $postBody];
|
|
$params = array_merge($params, $optParams);
|
|
return $this->call('import', [$params], GoogleLongrunningOperation::class);
|
|
}
|
|
/**
|
|
* Returns the list of all intents in the specified agent.
|
|
* (intents.listProjectsLocationsAgentsIntents)
|
|
*
|
|
* @param string $parent Required. The agent to list all intents for. Format:
|
|
* `projects//locations//agents/`.
|
|
* @param array $optParams Optional parameters.
|
|
*
|
|
* @opt_param string intentView The resource view to apply to the returned
|
|
* intent.
|
|
* @opt_param string languageCode The language to list intents for. The
|
|
* following fields are language dependent: *
|
|
* `Intent.training_phrases.parts.text` If not specified, the agent's default
|
|
* language is used. [Many
|
|
* languages](https://cloud.google.com/dialogflow/cx/docs/reference/language)
|
|
* are supported. Note: languages must be enabled in the agent before they can
|
|
* be used.
|
|
* @opt_param int pageSize The maximum number of items to return in a single
|
|
* page. By default 100 and at most 1000.
|
|
* @opt_param string pageToken The next_page_token value returned from a
|
|
* previous list request.
|
|
* @return GoogleCloudDialogflowCxV3ListIntentsResponse
|
|
* @throws \Google\Service\Exception
|
|
*/
|
|
public function listProjectsLocationsAgentsIntents($parent, $optParams = [])
|
|
{
|
|
$params = ['parent' => $parent];
|
|
$params = array_merge($params, $optParams);
|
|
return $this->call('list', [$params], GoogleCloudDialogflowCxV3ListIntentsResponse::class);
|
|
}
|
|
/**
|
|
* Updates the specified intent. Note: You should always train a flow prior to
|
|
* sending it queries. See the [training
|
|
* documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
|
|
* (intents.patch)
|
|
*
|
|
* @param string $name The unique identifier of the intent. Required for the
|
|
* Intents.UpdateIntent method. Intents.CreateIntent populates the name
|
|
* automatically. Format: `projects//locations//agents//intents/`.
|
|
* @param GoogleCloudDialogflowCxV3Intent $postBody
|
|
* @param array $optParams Optional parameters.
|
|
*
|
|
* @opt_param string languageCode The language of the following fields in
|
|
* `intent`: * `Intent.training_phrases.parts.text` If not specified, the
|
|
* agent's default language is used. [Many
|
|
* languages](https://cloud.google.com/dialogflow/cx/docs/reference/language)
|
|
* are supported. Note: languages must be enabled in the agent before they can
|
|
* be used.
|
|
* @opt_param string updateMask The mask to control which fields get updated. If
|
|
* the mask is not present, all fields will be updated.
|
|
* @return GoogleCloudDialogflowCxV3Intent
|
|
* @throws \Google\Service\Exception
|
|
*/
|
|
public function patch($name, GoogleCloudDialogflowCxV3Intent $postBody, $optParams = [])
|
|
{
|
|
$params = ['name' => $name, 'postBody' => $postBody];
|
|
$params = array_merge($params, $optParams);
|
|
return $this->call('patch', [$params], GoogleCloudDialogflowCxV3Intent::class);
|
|
}
|
|
}
|
|
|
|
// Adding a class alias for backwards compatibility with the previous class name.
|
|
class_alias(ProjectsLocationsAgentsIntents::class, 'Google_Service_Dialogflow_Resource_ProjectsLocationsAgentsIntents');
|