* $contactcenterinsightsService = new Google\Service\Contactcenterinsights(...); * $conversations = $contactcenterinsightsService->projects_locations_conversations; * */ class ProjectsLocationsConversations extends \Google\Service\Resource { /** * Analyzes multiple conversations in a single request. * (conversations.bulkAnalyze) * * @param string $parent Required. The parent resource to create analyses in. * @param GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest $postBody * @param array $optParams Optional parameters. * @return GoogleLongrunningOperation * @throws \Google\Service\Exception */ public function bulkAnalyze($parent, GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest $postBody, $optParams = []) { $params = ['parent' => $parent, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('bulkAnalyze', [$params], GoogleLongrunningOperation::class); } /** * Deletes multiple conversations in a single request. * (conversations.bulkDelete) * * @param string $parent Required. The parent resource to delete conversations * from. Format: projects/{project}/locations/{location} * @param GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest $postBody * @param array $optParams Optional parameters. * @return GoogleLongrunningOperation * @throws \Google\Service\Exception */ public function bulkDelete($parent, GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest $postBody, $optParams = []) { $params = ['parent' => $parent, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('bulkDelete', [$params], GoogleLongrunningOperation::class); } /** * Gets conversation statistics. (conversations.calculateStats) * * @param string $location Required. The location of the conversations. * @param array $optParams Optional parameters. * * @opt_param string filter A filter to reduce results to a specific subset. * This field is useful for getting statistics about conversations with specific * properties. * @return GoogleCloudContactcenterinsightsV1CalculateStatsResponse * @throws \Google\Service\Exception */ public function calculateStats($location, $optParams = []) { $params = ['location' => $location]; $params = array_merge($params, $optParams); return $this->call('calculateStats', [$params], GoogleCloudContactcenterinsightsV1CalculateStatsResponse::class); } /** * Creates a conversation. Note that this method does not support audio * transcription or redaction. Use `conversations.upload` instead. * (conversations.create) * * @param string $parent Required. The parent resource of the conversation. * @param GoogleCloudContactcenterinsightsV1Conversation $postBody * @param array $optParams Optional parameters. * * @opt_param string conversationId A unique ID for the new conversation. This * ID will become the final component of the conversation's resource name. If no * ID is specified, a server-generated ID will be used. This value should be * 4-64 characters and must match the regular expression `^[a-z0-9-]{4,64}$`. * Valid characters are `a-z-` * @return GoogleCloudContactcenterinsightsV1Conversation * @throws \Google\Service\Exception */ public function create($parent, GoogleCloudContactcenterinsightsV1Conversation $postBody, $optParams = []) { $params = ['parent' => $parent, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('create', [$params], GoogleCloudContactcenterinsightsV1Conversation::class); } /** * Deletes a conversation. (conversations.delete) * * @param string $name Required. The name of the conversation to delete. * @param array $optParams Optional parameters. * * @opt_param bool force If set to true, all of this conversation's analyses * will also be deleted. Otherwise, the request will only succeed if the * conversation has no analyses. * @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); } /** * Gets a conversation. (conversations.get) * * @param string $name Required. The name of the conversation to get. * @param array $optParams Optional parameters. * * @opt_param string view The level of details of the conversation. Default is * `FULL`. * @return GoogleCloudContactcenterinsightsV1Conversation * @throws \Google\Service\Exception */ public function get($name, $optParams = []) { $params = ['name' => $name]; $params = array_merge($params, $optParams); return $this->call('get', [$params], GoogleCloudContactcenterinsightsV1Conversation::class); } /** * Imports conversations and processes them according to the user's * configuration. (conversations.ingest) * * @param string $parent Required. The parent resource for new conversations. * @param GoogleCloudContactcenterinsightsV1IngestConversationsRequest $postBody * @param array $optParams Optional parameters. * @return GoogleLongrunningOperation * @throws \Google\Service\Exception */ public function ingest($parent, GoogleCloudContactcenterinsightsV1IngestConversationsRequest $postBody, $optParams = []) { $params = ['parent' => $parent, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('ingest', [$params], GoogleLongrunningOperation::class); } /** * Lists conversations. (conversations.listProjectsLocationsConversations) * * @param string $parent Required. The parent resource of the conversation. * @param array $optParams Optional parameters. * * @opt_param string filter A filter to reduce results to a specific subset. * Useful for querying conversations with specific properties. * @opt_param string orderBy Optional. The attribute by which to order * conversations in the response. If empty, conversations will be ordered by * descending creation time. Supported values are one of the following: * * create_time * customer_satisfaction_rating * duration * latest_analysis * * start_time * turn_count The default sort order is ascending. To specify * order, append `asc` or `desc` (`create_time desc`). For more details, see * [Google AIPs Ordering](https://google.aip.dev/132#ordering). * @opt_param int pageSize The maximum number of conversations to return in the * response. A valid page size ranges from 0 to 100,000 inclusive. If the page * size is zero or unspecified, a default page size of 100 will be chosen. Note * that a call might return fewer results than the requested page size. * @opt_param string pageToken The value returned by the last * `ListConversationsResponse`. This value indicates that this is a continuation * of a prior `ListConversations` call and that the system should return the * next page of data. * @opt_param string view The level of details of the conversation. Default is * `BASIC`. * @return GoogleCloudContactcenterinsightsV1ListConversationsResponse * @throws \Google\Service\Exception */ public function listProjectsLocationsConversations($parent, $optParams = []) { $params = ['parent' => $parent]; $params = array_merge($params, $optParams); return $this->call('list', [$params], GoogleCloudContactcenterinsightsV1ListConversationsResponse::class); } /** * Updates a conversation. (conversations.patch) * * @param string $name Immutable. The resource name of the conversation. Format: * projects/{project}/locations/{location}/conversations/{conversation} * @param GoogleCloudContactcenterinsightsV1Conversation $postBody * @param array $optParams Optional parameters. * * @opt_param string updateMask The list of fields to be updated. All possible * fields can be updated by passing `*`, or a subset of the following updateable * fields can be provided: * `agent_id` * `language_code` * `labels` * * `metadata` * `quality_metadata` * `call_metadata` * `start_time` * * `expire_time` or `ttl` * `data_source.gcs_source.audio_uri` or * `data_source.dialogflow_source.audio_uri` * @return GoogleCloudContactcenterinsightsV1Conversation * @throws \Google\Service\Exception */ public function patch($name, GoogleCloudContactcenterinsightsV1Conversation $postBody, $optParams = []) { $params = ['name' => $name, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('patch', [$params], GoogleCloudContactcenterinsightsV1Conversation::class); } /** * Create a long-running conversation upload operation. This method differs from * `CreateConversation` by allowing audio transcription and optional DLP * redaction. (conversations.upload) * * @param string $parent Required. The parent resource of the conversation. * @param GoogleCloudContactcenterinsightsV1UploadConversationRequest $postBody * @param array $optParams Optional parameters. * @return GoogleLongrunningOperation * @throws \Google\Service\Exception */ public function upload($parent, GoogleCloudContactcenterinsightsV1UploadConversationRequest $postBody, $optParams = []) { $params = ['parent' => $parent, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('upload', [$params], GoogleLongrunningOperation::class); } } // Adding a class alias for backwards compatibility with the previous class name. class_alias(ProjectsLocationsConversations::class, 'Google_Service_Contactcenterinsights_Resource_ProjectsLocationsConversations');