Discovery Engine API (discoveryengine:v1beta)

2023-08-16

26 new methods

Additions

    Methods
  • discoveryengine.projects.locations.collections.dataStores.conversations.get

      Path : v1beta/{+name}

      Description : Gets a Conversation.

      Parameters :

        name

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

          Required : Yes

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

          Location : path

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

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

      Parameter Order : name

      HTTP Method : GET

  • discoveryengine.projects.locations.collections.dataStores.conversations.list

      Description : Lists all Conversations by their parent DataStore.

      Parameters :

        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"

        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

        pageToken

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

          Type : string

          Location : query

        parent

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

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

          Location : path

          Required : Yes

          Type : string

        pageSize

          Location : query

          Type : integer

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

          Format : int32

      HTTP Method : GET

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

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

      Parameter Order : parent

      Path : v1beta/{+parent}/conversations

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

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

      Path : v1beta/{+parent}/conversations

      Parameter Order : parent

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

      Parameters :

        parent

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

          Required : Yes

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

      HTTP Method : POST

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

      Parameter Order : name

      HTTP Method : PATCH

      Parameters :

        name

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

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

          Type : string

          Location : path

          Required : Yes

        updateMask

          Location : query

          Format : google-fieldmask

          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.

          Type : string

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

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

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

      Path : v1beta/{+name}

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

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

      HTTP Method : POST

      Description : Converses a conversation.

      Parameter Order : name

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

      Path : v1beta/{+name}:converse

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

          Required : Yes

          Location : path

          Type : string

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

      Path : v1beta/{+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.

      HTTP Method : DELETE

      Parameters :

        name

          Required : Yes

          Type : string

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

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

      Parameter Order : name

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

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

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

      Parameter Order : parent

      Parameters :

        pageSize

          Format : int32

          Type : integer

          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.

        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.

        parent

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

          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

      Description : Gets a list of Schemas.

      Path : v1beta/{+parent}/schemas

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

      HTTP Method : GET

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

      Description : Creates a Schema.

      Parameter Order : parent

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

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

      Path : v1beta/{+parent}/schemas

      Parameters :

        parent

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

          Required : Yes

          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

        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

      HTTP Method : POST

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

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

      Path : v1beta/{+name}

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

      HTTP Method : PATCH

      Description : Updates a Schema.

      Parameter Order : name

      Parameters :

        name

          Required : Yes

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

        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

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

      HTTP Method : GET

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

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

      Description : Gets a Schema.

      Parameter Order : name

      Parameters :

        name

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

          Location : path

          Type : string

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

      Path : v1beta/{+name}

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

      Path : v1beta/{+name}

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

      Parameters :

        name

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

          Type : string

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

          Required : Yes

      Description : Deletes a Schema.

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

      HTTP Method : DELETE

      Parameter Order : name

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

      Path : v1beta/{+servingConfig}:search

      HTTP Method : POST

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

      Parameter Order : servingConfig

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

      Description : Performs a search.

      Parameters :

        servingConfig

          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.

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

          Location : path

          Required : Yes

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

      HTTP Method : GET

      Parameters :

        queryModel

          Type : string

          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.

          Location : query

        dataStore

          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

          Location : path

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

          Required : Yes

        query

          Location : query

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

          Type : string

        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

          Location : query

          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.

          Type : boolean

      Parameter Order : dataStore

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

      Path : v1beta/{+dataStore}:completeQuery

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

      Description : Completes the specified user input with keyword suggestions.

  • discoveryengine.projects.locations.dataStores.completeQuery

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

      Parameters :

        query

          Type : string

          Location : query

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

        dataStore

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

          Type : string

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

          Required : Yes

          Location : path

        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

        queryModel

          Location : query

          Type : string

          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.

        userPseudoId

          Type : string

          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.

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

      Path : v1beta/{+dataStore}:completeQuery

      Description : Completes the specified user input with keyword suggestions.

      Parameter Order : dataStore

      HTTP Method : GET

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

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

      Path : v1beta/{+servingConfig}:search

      Description : Performs a search.

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

      HTTP Method : POST

      Parameter Order : servingConfig

      Parameters :

        servingConfig

          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.

          Required : Yes

          Location : path

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

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

      Parameter Order : name

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

      Parameters :

        name

          Location : path

          Required : Yes

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

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

          Type : string

      HTTP Method : GET

      Description : Gets a Schema.

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

      Path : v1beta/{+name}

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

      Description : Creates a Schema.

      Parameters :

        schemaId

          Location : query

          Type : string

          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.

        parent

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

          Type : string

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

          Location : path

          Required : Yes

      Path : v1beta/{+parent}/schemas

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

      HTTP Method : POST

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

      Parameter Order : parent

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

      Parameter Order : name

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

      Path : v1beta/{+name}

      HTTP Method : DELETE

      Description : Deletes a Schema.

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

      Parameters :

        name

          Required : Yes

          Location : path

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

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

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

      Parameters :

        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.

          Type : boolean

          Location : query

        name

          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

          Location : path

      Path : v1beta/{+name}

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

      HTTP Method : PATCH

      Parameter Order : name

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

      Description : Updates a Schema.

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

      Parameters :

        parent

          Type : string

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

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

        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.

        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

      Parameter Order : parent

      Description : Gets a list of Schemas.

      HTTP Method : GET

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

      Path : v1beta/{+parent}/schemas

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

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

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

      Parameters :

        name

          Location : path

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

          Required : Yes

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

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

      Description : Gets a Conversation.

      Parameter Order : name

      HTTP Method : GET

      Path : v1beta/{+name}

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

      HTTP Method : GET

      Parameters :

        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"

        filter

          Location : query

          Type : string

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

        parent

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

          Required : Yes

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

          Type : string

          Location : path

        pageToken

          Location : query

          Type : string

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

        pageSize

          Format : int32

          Type : integer

          Location : query

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

      Description : Lists all Conversations by their parent DataStore.

      Path : v1beta/{+parent}/conversations

      Parameter Order : parent

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

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

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

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

      Parameter Order : name

      HTTP Method : PATCH

      Parameters :

        updateMask

          Format : google-fieldmask

          Type : string

          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.

        name

          Type : string

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

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

          Required : Yes

          Location : path

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

      Path : v1beta/{+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.dataStores.conversations.create

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

      Parameter Order : parent

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

      Parameters :

        parent

          Location : path

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

          Required : Yes

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

          Type : string

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

      HTTP Method : POST

      Path : v1beta/{+parent}/conversations

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

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

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

          Type : string

          Required : Yes

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

      Parameter Order : name

      Path : v1beta/{+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.

      HTTP Method : DELETE

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

      Parameters :

        name

          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.

          Location : path

          Type : string

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

      Parameter Order : name

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

      Path : v1beta/{+name}:converse

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

      Description : Converses a conversation.

      HTTP Method : POST