Discovery Engine API (discoveryengine:v1alpha)

Additions

Methods


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

  Path: v1alpha/{+servingConfig}:answer

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

  HTTP Method: POST

  Parameters:

  servingConfig

  Description: Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/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

  Type: string

  Parameter Order: servingConfig

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

  Description: Answer query method.

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

  Path: v1alpha/{+parent}/sessions

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

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

  Location: path

  Required: Yes

  Type: string

  Parameter Order: parent

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

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

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

  Path: v1alpha/{+name}

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

  HTTP Method: DELETE

  Parameters:

  name

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

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

  Location: path

  Required: Yes

  Type: string

  Parameter Order: name

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

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

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

  Path: v1alpha/{+name}

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

  HTTP Method: PATCH

  Parameters:

  name

  Description: Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*`

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

  Location: path

  Required: Yes

  Type: string

  updateMask

  Description: Indicates which fields in the provided Session to update. The following are NOT supported: * Session.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 Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned.

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

  Path: v1alpha/{+name}

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

  HTTP Method: GET

  Parameters:

  name

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

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

  Location: path

  Required: Yes

  Type: string

  Parameter Order: name

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

  Description: Gets a Session.

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

  Path: v1alpha/{+parent}/sessions

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

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

  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 `ListSessions` 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` * `session_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 Sessions by their parent DataStore.

• ▼ ▲ discoveryengine.projects.locations.collections.dataStores.sessions.answers.get

  Path: v1alpha/{+name}

  Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/sessions/{sessionsId}/answers/{answersId}

  HTTP Method: GET

  Parameters:

  name

  Description: Required. The resource name of the Answer to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`

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

  Location: path

  Required: Yes

  Type: string

  Parameter Order: name

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

  Description: Gets a Answer.

• ▼ ▲ discoveryengine.projects.locations.collections.engines.servingConfigs.answer

  Path: v1alpha/{+servingConfig}:answer

  Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}:answer

  HTTP Method: POST

  Parameters:

  servingConfig

  Description: Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/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/[^/]+/engines/[^/]+/servingConfigs/[^/]+$

  Location: path

  Required: Yes

  Type: string

  Parameter Order: servingConfig

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

  Description: Answer query method.

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

  Path: v1alpha/{+parent}/sessions

  Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions

  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 Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.

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

  Path: v1alpha/{+name}

  Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}

  HTTP Method: DELETE

  Parameters:

  name

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

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

  Location: path

  Required: Yes

  Type: string

  Parameter Order: name

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

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

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

  Path: v1alpha/{+name}

  Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}

  HTTP Method: PATCH

  Parameters:

  name

  Description: Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*`

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

  Location: path

  Required: Yes

  Type: string

  updateMask

  Description: Indicates which fields in the provided Session to update. The following are NOT supported: * Session.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 Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned.

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

  Path: v1alpha/{+name}

  Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}

  HTTP Method: GET

  Parameters:

  name

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

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

  Location: path

  Required: Yes

  Type: string

  Parameter Order: name

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

  Description: Gets a Session.

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

  Path: v1alpha/{+parent}/sessions

  Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions

  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 `ListSessions` 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` * `session_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 Sessions by their parent DataStore.

• ▼ ▲ discoveryengine.projects.locations.collections.engines.sessions.answers.get

  Path: v1alpha/{+name}

  Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}/answers/{answersId}

  HTTP Method: GET

  Parameters:

  name

  Description: Required. The resource name of the Answer to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`

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

  Location: path

  Required: Yes

  Type: string

  Parameter Order: name

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

  Description: Gets a Answer.

• ▼ ▲ discoveryengine.projects.locations.evaluations.operations.get

  Path: v1alpha/{+name}

  Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/evaluations/{evaluationsId}/operations/{operationsId}

  HTTP Method: GET

  Parameters:

  name

  Description: The name of the operation resource.

  Pattern: ^projects/[^/]+/locations/[^/]+/evaluations/[^/]+/operations/[^/]+$

  Location: path

  Required: Yes

  Type: string

  Parameter Order: name

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

  Description: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

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

  Path: v1alpha/{+servingConfig}:answer

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

  HTTP Method: POST

  Parameters:

  servingConfig

  Description: Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/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/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$

  Location: path

  Required: Yes

  Type: string

  Parameter Order: servingConfig

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

  Description: Answer query method.

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

  Path: v1alpha/{+parent}/sessions

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

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

  Location: path

  Required: Yes

  Type: string

  Parameter Order: parent

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

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

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

  Path: v1alpha/{+name}

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

  HTTP Method: DELETE

  Parameters:

  name

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

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

  Location: path

  Required: Yes

  Type: string

  Parameter Order: name

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

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

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

  Path: v1alpha/{+name}

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

  HTTP Method: PATCH

  Parameters:

  name

  Description: Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*`

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

  Location: path

  Required: Yes

  Type: string

  updateMask

  Description: Indicates which fields in the provided Session to update. The following are NOT supported: * Session.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 Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned.

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

  Path: v1alpha/{+name}

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

  HTTP Method: GET

  Parameters:

  name

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

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

  Location: path

  Required: Yes

  Type: string

  Parameter Order: name

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

  Description: Gets a Session.

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

  Path: v1alpha/{+parent}/sessions

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

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

  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 `ListSessions` 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` * `session_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 Sessions by their parent DataStore.

• ▼ ▲ discoveryengine.projects.locations.dataStores.sessions.answers.get

  Path: v1alpha/{+name}

  Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/sessions/{sessionsId}/answers/{answersId}

  HTTP Method: GET

  Parameters:

  name

  Description: Required. The resource name of the Answer to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`

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

  Location: path

  Required: Yes

  Type: string

  Parameter Order: name

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

  Description: Gets a Answer.

• ▼ ▲ discoveryengine.projects.locations.groundingConfigs.check

  Path: v1alpha/{+groundingConfig}:check

  Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/groundingConfigs/{groundingConfigsId}:check

  HTTP Method: POST

  Parameters:

  groundingConfig

  Description: Required. The resource name of the grounding config, such as `projects/*/locations/global/groundingConfigs/default_grounding_config`.

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

  Location: path

  Required: Yes

  Type: string

  Parameter Order: groundingConfig

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

  Description: Performs a grounding check.