1. class
  2. Google
  3. \
  4. Service
  5. \
  6. DiscoveryEngine
  7. \
  8. Resource
  9. \
  10. ProjectsLocationsCollectionsEnginesConversations

ProjectsLocationsCollectionsEnginesConversations

class ProjectsLocationsCollectionsEnginesConversations extends Resource (View source)

The "conversations" collection of methods.

Typical usage is:

 $discoveryengineService = new Google\Service\DiscoveryEngine(...);
 $conversations = $discoveryengineService->projects_locations_collections_engines_conversations;

Methods

GoogleCloudDiscoveryengineV1ConverseConversationResponse
converse(string $name, GoogleCloudDiscoveryengineV1ConverseConversationRequest $postBody, array $optParams = [])

Converses a conversation. (conversations.converse)

GoogleCloudDiscoveryengineV1Conversation
create(string $parent, GoogleCloudDiscoveryengineV1Conversation $postBody, array $optParams = [])

Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned. (conversations.create)

GoogleProtobufEmpty
delete(string $name, array $optParams = [])

Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned. (conversations.delete)

GoogleCloudDiscoveryengineV1Conversation
get(string $name, array $optParams = [])

Gets a Conversation. (conversations.get)

GoogleCloudDiscoveryengineV1ListConversationsResponse
listProjectsLocationsCollectionsEnginesConversations(string $parent, array $optParams = [])

Lists all Conversations by their parent DataStore.

GoogleCloudDiscoveryengineV1Conversation
patch(string $name, GoogleCloudDiscoveryengineV1Conversation $postBody, array $optParams = [])

Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned.

Details

at line 51
GoogleCloudDiscoveryengineV1ConverseConversationResponse converse(string $name, GoogleCloudDiscoveryengineV1ConverseConversationRequest $postBody, array $optParams = [])

Converses a conversation. (conversations.converse)

Parameters

string $name

Required. The resource name of the Conversation to get. Format: projects/{project_number}/locations/{location_id}/collections/{colle ction}/dataStores/{data_store_id}/conversations/{conversation_id}. Use proj ects/{project_number}/locations/{location_id}/collections/{collection}/dataSt ores/{data_store_id}/conversations/- to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session.
GoogleCloudDiscoveryengineV1ConverseConversationRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudDiscoveryengineV1ConverseConversationResponse

Exceptions

Exception

at line 69
GoogleCloudDiscoveryengineV1Conversation create(string $parent, GoogleCloudDiscoveryengineV1Conversation $postBody, array $optParams = [])

Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned. (conversations.create)

Parameters

string $parent

Required. Full resource name of parent data store. Format: projects/{project_number}/locations/{location_id}/collections/{colle ction}/dataStores/{data_store_id}
GoogleCloudDiscoveryengineV1Conversation $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudDiscoveryengineV1Conversation

Exceptions

Exception

at line 86
GoogleProtobufEmpty delete(string $name, array $optParams = [])

Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned. (conversations.delete)

Parameters

string $name

Required. The resource name of the Conversation to delete. Format: projects/{project_number}/locations/{location_id}/collection s/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}
array $optParams

Optional parameters.

Return Value

GoogleProtobufEmpty

Exceptions

Exception

at line 102
GoogleCloudDiscoveryengineV1Conversation get(string $name, array $optParams = [])

Gets a Conversation. (conversations.get)

Parameters

string $name

Required. The resource name of the Conversation to get. Format: projects/{project_number}/locations/{location_id}/collections/{colle ction}/dataStores/{data_store_id}/conversations/{conversation_id}
array $optParams

Optional parameters.

Return Value

GoogleCloudDiscoveryengineV1Conversation

Exceptions

Exception

at line 130
GoogleCloudDiscoveryengineV1ListConversationsResponse listProjectsLocationsCollectionsEnginesConversations(string $parent, array $optParams = [])

Lists all Conversations by their parent DataStore.

(conversations.listProjectsLocationsCollectionsEnginesConversations)

Parameters

string $parent

Required. The data store resource name. Format: projec ts/{project_number}/locations/{location_id}/collections/{collection}/dataStor es/{data_store_id}
array $optParams

Optional parameters.

Return Value

GoogleCloudDiscoveryengineV1ListConversationsResponse

Exceptions

Exception

at line 153
GoogleCloudDiscoveryengineV1Conversation patch(string $name, GoogleCloudDiscoveryengineV1Conversation $postBody, array $optParams = [])

Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned.

(conversations.patch)

Parameters

string $name

Immutable. Fully qualified name projects/{project}/locat ions/global/collections/{collection}/dataStore/conversations or projects/{p roject}/locations/global/collections/{collection}/engines/conversations.
GoogleCloudDiscoveryengineV1Conversation $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudDiscoveryengineV1Conversation

Exceptions

Exception