Discovery Engine API (discoveryengine:v1beta)

Additions

Methods


• ▼ ▲ discoveryengine.projects.locations.collections.engines.conversations.converse

  Path: v1beta/{+name}:converse

  Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/conversations/{conversationsId}:converse

  HTTP Method: POST

  Parameters:

  name

  Description: Required. The resource name of the Conversation to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session.

  Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/conversations/[^/]+$

  Location: path

  Required: Yes

  Type: string

  Parameter Order: name

  Scopes: https://www.googleapis.com/auth/cloud-platform

  Description: Converses a conversation.

• ▼ ▲ discoveryengine.projects.locations.collections.engines.conversations.create

  Path: v1beta/{+parent}/conversations

  Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/conversations

  HTTP Method: POST

  Parameters:

  parent

  Description: Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`

  Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$

  Location: path

  Required: Yes

  Type: string

  Parameter Order: parent

  Scopes: https://www.googleapis.com/auth/cloud-platform

  Description: Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned.

• ▼ ▲ discoveryengine.projects.locations.collections.engines.conversations.delete

  Path: v1beta/{+name}

  Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/conversations/{conversationsId}

  HTTP Method: DELETE

  Parameters:

  name

  Description: Required. The resource name of the Conversation to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`

  Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/conversations/[^/]+$

  Location: path

  Required: Yes

  Type: string

  Parameter Order: name

  Scopes: https://www.googleapis.com/auth/cloud-platform

  Description: Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned.

• ▼ ▲ discoveryengine.projects.locations.collections.engines.conversations.patch

  Path: v1beta/{+name}

  Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/conversations/{conversationsId}

  HTTP Method: PATCH

  Parameters:

  name

  Description: Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/dataStore/*/conversations/*` or `project/*/locations/global/collections/{collection}/engines/*/conversations/*`.

  Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/conversations/[^/]+$

  Location: path

  Required: Yes

  Type: string

  updateMask

  Description: Indicates which fields in the provided Conversation to update. The following are NOT supported: * conversation.name If not set or empty, all supported fields are updated.

  Location: query

  Type: string

  Format: google-fieldmask

  Parameter Order: name

  Scopes: https://www.googleapis.com/auth/cloud-platform

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

• ▼ ▲ discoveryengine.projects.locations.collections.engines.conversations.get

  Path: v1beta/{+name}

  Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/conversations/{conversationsId}

  HTTP Method: GET

  Parameters:

  name

  Description: Required. The resource name of the Conversation to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`

  Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/conversations/[^/]+$

  Location: path

  Required: Yes

  Type: string

  Parameter Order: name

  Scopes: https://www.googleapis.com/auth/cloud-platform

  Description: Gets a Conversation.

• ▼ ▲ discoveryengine.projects.locations.collections.engines.conversations.list

  Path: v1beta/{+parent}/conversations

  Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/conversations

  HTTP Method: GET

  Parameters:

  parent

  Description: Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`

  Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$

  Location: path

  Required: Yes

  Type: string

  pageSize

  Description: Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.

  Location: query

  Type: integer

  Format: int32

  pageToken

  Description: A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page.

  Location: query

  Type: string

  filter

  Description: A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id"

  Location: query

  Type: string

  orderBy

  Description: A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `conversation_name` Example: "update_time desc" "create_time"

  Location: query

  Type: string

  Parameter Order: parent

  Scopes: https://www.googleapis.com/auth/cloud-platform

  Description: Lists all Conversations by their parent DataStore.