Discovery Engine API (discoveryengine:v1)

▼ ▲ discoveryengine.projects.locations.collections.dataStores.servingConfigs.streamAnswer

Path : v1/{+servingConfig}:streamAnswer

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

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 (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream.

▼ ▲ discoveryengine.projects.locations.collections.dataStores.servingConfigs.patch

Path : v1/{+name}

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

HTTP Method : PATCH

Parameters :

name

Description : Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`

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

Location : path

Required : Yes

Type : string

updateMask

Description : Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, 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 ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.

▼ ▲ discoveryengine.projects.locations.collections.engines.servingConfigs.streamAnswer

Path : v1/{+servingConfig}:streamAnswer

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

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 (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream.

▼ ▲ discoveryengine.projects.locations.collections.engines.servingConfigs.patch

Path : v1/{+name}

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

HTTP Method : PATCH

Parameters :

name

Description : Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`

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

Location : path

Required : Yes

Type : string

updateMask

Description : Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, 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 ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.

▼ ▲ discoveryengine.projects.locations.dataStores.servingConfigs.streamAnswer

Path : v1/{+servingConfig}:streamAnswer

Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:streamAnswer

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 (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream.

▼ ▲ discoveryengine.projects.locations.dataStores.servingConfigs.patch

Path : v1/{+name}

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

HTTP Method : PATCH

Parameters :

name

Description : Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`

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

Location : path

Required : Yes

Type : string

updateMask

Description : Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, 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 ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.

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

Parameters :

includeAnswerDetails

Description : Optional. If set to true, the full session including all answer details will be returned.

Location : query

Type : boolean

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

Parameters :

includeAnswerDetails

Description : Optional. If set to true, the full session including all answer details will be returned.

Location : query

Type : boolean

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

Parameters :

includeAnswerDetails

Description : Optional. If set to true, the full session including all answer details will be returned.

Location : query

Type : boolean