Discovery Engine API (discoveryengine:v1alpha)

Additions

Methods


• ▼ ▲ discoveryengine.projects.locations.collections.dataStores.completeQuery

  Parameters:

  userPseudoId

  Type: string

  Description: A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.

  Location: query

  includeTailSuggestions

  Type: boolean

  Description: Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned.

  Location: query

  dataStore

  Type: string

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

  Description: Required. The parent data store resource name for which the completion is performed, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`.

  Location: path

  Required: Yes

  query

  Type: string

  Location: query

  Description: Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters.

  queryModel

  Description: Selects data model of query suggestions for serving. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for IndustryVertical.SITE_SEARCH dataStores.

  Type: string

  Location: query

  Parameter Order: dataStore

  Description: Completes the specified user input with keyword suggestions.

  HTTP Method: GET

  Path: v1alpha/{+dataStore}:completeQuery

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

  Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}:completeQuery

• ▼ ▲ discoveryengine.projects.locations.collections.dataStores.servingConfigs.search

  Description: Performs a search.

  Parameter Order: servingConfig

  Parameters:

  servingConfig

  Location: path

  Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$

  Required: Yes

  Type: string

  Description: Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.

  Path: v1alpha/{+servingConfig}:search

  HTTP Method: POST

  Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:search

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

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

  Description: Gets a Conversation.

  Parameters:

  name

  Type: string

  Location: path

  Required: Yes

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

  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}`

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

  Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/conversations/{conversationsId}

  Path: v1alpha/{+name}

  Parameter Order: name

  HTTP Method: GET

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

  HTTP Method: POST

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

  Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/conversations

  Parameters:

  parent

  Required: Yes

  Location: path

  Type: string

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

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

  Parameter Order: parent

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

  Path: v1alpha/{+parent}/conversations

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

  Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/conversations/{conversationsId}

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

  HTTP Method: DELETE

  Parameters:

  name

  Location: path

  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}`

  Required: Yes

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

  Type: string

  Path: v1alpha/{+name}

  Parameter Order: name

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

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

  Parameters:

  name

  Location: path

  Required: Yes

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

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

  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

  Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/conversations/{conversationsId}

  HTTP Method: PATCH

  Path: v1alpha/{+name}

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

  Parameter Order: name

  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.dataStores.conversations.list

  Parameter Order: parent

  Path: v1alpha/{+parent}/conversations

  HTTP Method: GET

  Parameters:

  parent

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

  Type: string

  Required: Yes

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

  Location: path

  pageSize

  Type: integer

  Location: query

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

  Format: int32

  filter

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

  Type: string

  Location: query

  orderBy

  Location: query

  Type: string

  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"

  pageToken

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

  Location: query

  Type: string

  Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/conversations

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

  Description: Lists all Conversations by their parent DataStore.

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

  Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/conversations/{conversationsId}:converse

  Description: Converses a conversation.

  Path: v1alpha/{+name}:converse

  Parameter Order: name

  Parameters:

  name

  Location: path

  Type: string

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

  Required: Yes

  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.

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

  HTTP Method: POST

• ▼ ▲ discoveryengine.projects.locations.collections.dataStores.schemas.create

  Parameter Order: parent

  Parameters:

  parent

  Required: Yes

  Location: path

  Description: Required. The parent data store resource name, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.

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

  Type: string

  schemaId

  Description: Required. The ID to use for the Schema, which will become the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.

  Location: query

  Type: string

  Path: v1alpha/{+parent}/schemas

  HTTP Method: POST

  Description: Creates a Schema.

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

  Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/schemas

• ▼ ▲ discoveryengine.projects.locations.collections.dataStores.schemas.patch

  Description: Updates a Schema.

  HTTP Method: PATCH

  Parameters:

  name

  Required: Yes

  Type: string

  Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/schemas/[^/]+$

  Location: path

  Description: Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.

  allowMissing

  Description: If set to true, and the Schema is not found, a new Schema will be created. In this situation, `update_mask` is ignored.

  Location: query

  Type: boolean

  Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/schemas/{schemasId}

  Path: v1alpha/{+name}

  Parameter Order: name

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

• ▼ ▲ discoveryengine.projects.locations.collections.dataStores.schemas.delete

  Parameters:

  name

  Location: path

  Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/schemas/[^/]+$

  Type: string

  Description: Required. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`.

  Required: Yes

  Description: Deletes a Schema.

  Parameter Order: name

  Path: v1alpha/{+name}

  HTTP Method: DELETE

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

  Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/schemas/{schemasId}

• ▼ ▲ discoveryengine.projects.locations.collections.dataStores.schemas.list

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

  Description: Gets a list of Schemas.

  Parameters:

  pageToken

  Type: string

  Description: A page token, received from a previous SchemaService.ListSchemas call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SchemaService.ListSchemas must match the call that provided the page token.

  Location: query

  parent

  Location: path

  Type: string

  Description: Required. The parent data store resource name, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.

  Required: Yes

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

  pageSize

  Location: query

  Description: The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

  Format: int32

  Type: integer

  Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/schemas

  Path: v1alpha/{+parent}/schemas

  Parameter Order: parent

  HTTP Method: GET

• ▼ ▲ discoveryengine.projects.locations.collections.dataStores.schemas.get

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

  Parameter Order: name

  HTTP Method: GET

  Parameters:

  name

  Required: Yes

  Location: path

  Description: Required. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`.

  Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/schemas/[^/]+$

  Type: string

  Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/schemas/{schemasId}

  Path: v1alpha/{+name}

  Description: Gets a Schema.

• ▼ ▲ discoveryengine.projects.locations.dataStores.completeQuery

  Description: Completes the specified user input with keyword suggestions.

  Parameter Order: dataStore

  Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}:completeQuery

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

  Parameters:

  includeTailSuggestions

  Description: Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned.

  Location: query

  Type: boolean

  userPseudoId

  Location: query

  Description: A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.

  Type: string

  dataStore

  Location: path

  Required: Yes

  Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$

  Description: Required. The parent data store resource name for which the completion is performed, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`.

  Type: string

  query

  Location: query

  Type: string

  Description: Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters.

  queryModel

  Location: query

  Description: Selects data model of query suggestions for serving. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for IndustryVertical.SITE_SEARCH dataStores.

  Type: string

  Path: v1alpha/{+dataStore}:completeQuery

  HTTP Method: GET

• ▼ ▲ discoveryengine.projects.locations.dataStores.schemas.delete

  Parameters:

  name

  Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/schemas/[^/]+$

  Required: Yes

  Description: Required. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`.

  Location: path

  Type: string

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

  HTTP Method: DELETE

  Path: v1alpha/{+name}

  Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/schemas/{schemasId}

  Description: Deletes a Schema.

  Parameter Order: name

• ▼ ▲ discoveryengine.projects.locations.dataStores.schemas.list

  Path: v1alpha/{+parent}/schemas

  Parameters:

  pageSize

  Type: integer

  Location: query

  Format: int32

  Description: The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

  parent

  Required: Yes

  Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$

  Description: Required. The parent data store resource name, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.

  Location: path

  Type: string

  pageToken

  Location: query

  Type: string

  Description: A page token, received from a previous SchemaService.ListSchemas call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SchemaService.ListSchemas must match the call that provided the page token.

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

  Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/schemas

  HTTP Method: GET

  Description: Gets a list of Schemas.

  Parameter Order: parent

• ▼ ▲ discoveryengine.projects.locations.dataStores.schemas.patch

  Parameter Order: name

  Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/schemas/{schemasId}

  Description: Updates a Schema.

  HTTP Method: PATCH

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

  Parameters:

  name

  Location: path

  Description: Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.

  Type: string

  Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/schemas/[^/]+$

  Required: Yes

  allowMissing

  Type: boolean

  Location: query

  Description: If set to true, and the Schema is not found, a new Schema will be created. In this situation, `update_mask` is ignored.

  Path: v1alpha/{+name}

• ▼ ▲ discoveryengine.projects.locations.dataStores.schemas.create

  Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/schemas

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

  Path: v1alpha/{+parent}/schemas

  Parameter Order: parent

  HTTP Method: POST

  Parameters:

  schemaId

  Description: Required. The ID to use for the Schema, which will become the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.

  Type: string

  Location: query

  parent

  Type: string

  Description: Required. The parent data store resource name, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.

  Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$

  Location: path

  Required: Yes

  Description: Creates a Schema.

• ▼ ▲ discoveryengine.projects.locations.dataStores.schemas.get

  Parameter Order: name

  Parameters:

  name

  Required: Yes

  Location: path

  Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/schemas/[^/]+$

  Type: string

  Description: Required. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`.

  HTTP Method: GET

  Description: Gets a Schema.

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

  Path: v1alpha/{+name}

  Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/schemas/{schemasId}

• ▼ ▲ discoveryengine.projects.locations.dataStores.servingConfigs.search

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

  Path: v1alpha/{+servingConfig}:search

  Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:search

  Parameter Order: servingConfig

  Description: Performs a search.

  HTTP Method: POST

  Parameters:

  servingConfig

  Required: Yes

  Type: string

  Location: path

  Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$

  Description: Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.

• ▼ ▲ discoveryengine.projects.locations.dataStores.conversations.converse

  Parameters:

  name

  Required: Yes

  Location: path

  Type: string

  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/[^/]+/dataStores/[^/]+/conversations/[^/]+$

  HTTP Method: POST

  Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/conversations/{conversationsId}:converse

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

  Description: Converses a conversation.

  Parameter Order: name

  Path: v1alpha/{+name}:converse

• ▼ ▲ discoveryengine.projects.locations.dataStores.conversations.create

  Path: v1alpha/{+parent}/conversations

  Parameter Order: parent

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

  HTTP Method: POST

  Parameters:

  parent

  Required: Yes

  Type: string

  Location: path

  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/[^/]+/dataStores/[^/]+$

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

  Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/conversations

• ▼ ▲ discoveryengine.projects.locations.dataStores.conversations.list

  Parameter Order: parent

  Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/conversations

  Path: v1alpha/{+parent}/conversations

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

  Description: Lists all Conversations by their parent DataStore.

  Parameters:

  pageSize

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

  Format: int32

  Type: integer

  Location: query

  orderBy

  Type: string

  Location: query

  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"

  parent

  Location: path

  Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$

  Type: string

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

  Required: Yes

  pageToken

  Type: string

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

  Location: query

  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

  HTTP Method: GET

• ▼ ▲ discoveryengine.projects.locations.dataStores.conversations.patch

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

  Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/conversations/{conversationsId}

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

  HTTP Method: PATCH

  Parameters:

  name

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

  Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/conversations/[^/]+$

  Type: string

  Required: Yes

  Location: path

  updateMask

  Location: query

  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.

  Format: google-fieldmask

  Type: string

  Path: v1alpha/{+name}

  Parameter Order: name

• ▼ ▲ discoveryengine.projects.locations.dataStores.conversations.delete

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

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

  Parameter Order: name

  Path: v1alpha/{+name}

  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}`

  Required: Yes

  Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/conversations/[^/]+$

  Type: string

  Location: path

  Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/conversations/{conversationsId}

  HTTP Method: DELETE

• ▼ ▲ discoveryengine.projects.locations.dataStores.conversations.get

  Parameters:

  name

  Required: Yes

  Location: path

  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/[^/]+/dataStores/[^/]+/conversations/[^/]+$

  Type: string

  HTTP Method: GET

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

  Description: Gets a Conversation.

  Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/conversations/{conversationsId}

  Path: v1alpha/{+name}

  Parameter Order: name