Discovery Engine API (discoveryengine:v1alpha)

▼ ▲ discoveryengine.projects.locations.collections.dataStores.customModels.list

Path: v1alpha/{+dataStore}/customModels

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

HTTP Method: GET

Parameters:

dataStore

Description: Required. The resource name of the parent Data Store, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to fetch the models from.

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

Location: path

Required: Yes

Type: string

Parameter Order: dataStore

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

Description: Gets a list of all the custom models.

▼ ▲ discoveryengine.projects.locations.collections.dataStores.branches.documents.getProcessedDocument

Parameters:

processedDocumentType

Enum Descriptions  Returns the converted PNG Image bytes if available.

Enum  PNG_CONVERTED_DOCUMENT

▼ ▲ discoveryengine.projects.locations.dataStores.branches.documents.getProcessedDocument

Parameters:

processedDocumentType

Enum Descriptions  Returns the converted PNG Image bytes if available.

Enum  PNG_CONVERTED_DOCUMENT

▼ ▲ discoveryengine.locations.widgetSearch

Path: v1alpha/{+location}/widgetSearch

Flat Path: v1alpha/locations/{locationsId}/widgetSearch

HTTP Method: POST

Parameters:

location

Description: Required. The location resource where widget search will be performed. Format: `locations/{location}`

Pattern: ^locations/[^/]+$

Location: path

Required: Yes

Type: string

Parameter Order: location

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

Description: Performs a search. Similar to the SearchService.Search method, but a widget version that allows search without API Key. It supports search with or without JWT token.

▼ ▲ discoveryengine.locations.widgetCompleteQuery

Path: v1alpha/{+location}/widgetCompleteQuery

Flat Path: v1alpha/locations/{locationsId}/widgetCompleteQuery

HTTP Method: POST

Parameters:

location

Description: Required. The location resource where widget complete query will be performed. Format: `locations/{location}`

Pattern: ^locations/[^/]+$

Location: path

Required: Yes

Type: string

Parameter Order: location

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

Description: Performs a user input completion with keyword suggestion. Similar to the CompletionService.CompleteQuery method, but a widget version that allows CompleteQuery without API Key. It supports CompleteQuery with or without JWT token.

▼ ▲ discoveryengine.locations.widgetConverseConversation

Path: v1alpha/{+location}/widgetConverseConversation

Flat Path: v1alpha/locations/{locationsId}/widgetConverseConversation

HTTP Method: POST

Parameters:

location

Description: Required. The location resource where widget converse conversation will be performed. Format: `locations/{location}`

Pattern: ^locations/[^/]+$

Location: path

Required: Yes

Type: string

Parameter Order: location

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

Description: Converse a conversation with Widget.

▼ ▲ discoveryengine.locations.lookupWidgetConfig

Path: v1alpha/{+location}/lookupWidgetConfig

Flat Path: v1alpha/locations/{locationsId}/lookupWidgetConfig

HTTP Method: POST

Parameters:

location

Description: Required. The location resource where lookup widget will be performed. Format: `locations/{location}`

Pattern: ^locations/[^/]+$

Location: path

Required: Yes

Type: string

Parameter Order: location

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

Description: Gets the Widget Config using the uuid.