2022-02-24
▼ ▲ dialogflow.projects.locations.conversationProfiles.setSuggestionFeatureConfig
Parameter Order : conversationProfile
Description : Adds or updates a suggestion feature in a conversation profile. If the conversation profile contains the type of suggestion feature for the participant role, it will update it. Otherwise it will insert the suggestion feature. This method is a [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields: - `metadata`: SetSuggestionFeatureConfigOperationMetadata - `response`: ConversationProfile If a long running operation to add or update suggestion feature config for the same conversation profile, participant role and suggestion feature type exists, please cancel the existing long running operation before sending such request, otherwise the request will be rejected.
HTTP Method : POST
Parameters :
conversationProfile
Type : string
Required : Yes
Description : Required. The Conversation Profile to add or update the suggestion feature config. Format: `projects//locations//conversationProfiles/`.
Pattern : ^projects/[^/]+/locations/[^/]+/conversationProfiles/[^/]+$
Location : path
Path : v2/{+conversationProfile}:setSuggestionFeatureConfig
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/conversationProfiles/{conversationProfilesId}:setSuggestionFeatureConfig
Scopes :
▼ ▲ dialogflow.projects.locations.conversationProfiles.clearSuggestionFeatureConfig
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/conversationProfiles/{conversationProfilesId}:clearSuggestionFeatureConfig
Path : v2/{+conversationProfile}:clearSuggestionFeatureConfig
Parameters :
conversationProfile
Location : path
Required : Yes
Description : Required. The Conversation Profile to add or update the suggestion feature config. Format: `projects//locations//conversationProfiles/`.
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/conversationProfiles/[^/]+$
Parameter Order : conversationProfile
Description : Clears a suggestion feature from a conversation profile for the given participant role. This method is a [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields: - `metadata`: ClearSuggestionFeatureConfigOperationMetadata - `response`: ConversationProfile
Scopes :
HTTP Method : POST
▼ ▲ dialogflow.projects.locations.conversationDatasets.importConversationData
Parameter Order : name
Path : v2/{+name}:importConversationData
Scopes :
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/conversationDatasets/{conversationDatasetsId}:importConversationData
HTTP Method : POST
Parameters :
name
Required : Yes
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/conversationDatasets/[^/]+$
Description : Required. Dataset resource name. Format: `projects//locations//conversationDatasets/`
Description : Import data into the specified conversation dataset. Note that it is not allowed to import data to a conversation dataset that already has data in it. This method is a [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields: - `metadata`: ImportConversationDataOperationMetadata - `response`: ImportConversationDataOperationResponse
▼ ▲ dialogflow.projects.locations.conversationDatasets.create
Scopes :
Parameters :
parent
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
Description : Required. The project to create conversation dataset for. Format: `projects//locations/`
Required : Yes
Type : string
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/conversationDatasets
Path : v2/{+parent}/conversationDatasets
HTTP Method : POST
Parameter Order : parent
Description : Creates a new conversation dataset. This method is a [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields: - `metadata`: CreateConversationDatasetOperationMetadata - `response`: ConversationDataset
▼ ▲ dialogflow.projects.locations.conversationDatasets.delete
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/conversationDatasets/[^/]+$
Description : Required. The conversation dataset to delete. Format: `projects//locations//conversationDatasets/`
Location : path
Required : Yes
Type : string
Description : Deletes the specified conversation dataset. This method is a [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields: - `metadata`: DeleteConversationDatasetOperationMetadata - `response`: An [Empty message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
HTTP Method : DELETE
Scopes :
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/conversationDatasets/{conversationDatasetsId}
Path : v2/{+name}
Parameter Order : name
▼ ▲ dialogflow.projects.locations.conversationDatasets.get
Parameters :
name
Required : Yes
Location : path
Description : Required. The conversation dataset to retrieve. Format: `projects//locations//conversationDatasets/`
Pattern : ^projects/[^/]+/locations/[^/]+/conversationDatasets/[^/]+$
Type : string
HTTP Method : GET
Description : Retrieves the specified conversation dataset.
Path : v2/{+name}
Scopes :
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/conversationDatasets/{conversationDatasetsId}
Parameter Order : name
▼ ▲ dialogflow.projects.locations.conversationDatasets.list
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/conversationDatasets
Parameters :
pageSize
Type : integer
Location : query
Format : int32
Description : Optional. Maximum number of conversation datasets to return in a single page. By default 100 and at most 1000.
pageToken
Location : query
Type : string
Description : Optional. The next_page_token value returned from a previous list request.
parent
Required : Yes
Type : string
Location : path
Description : Required. The project and location name to list all conversation datasets for. Format: `projects//locations/`
Pattern : ^projects/[^/]+/locations/[^/]+$
Path : v2/{+parent}/conversationDatasets
Description : Returns the list of all conversation datasets in the specified project and location.
Scopes :
HTTP Method : GET
Parameter Order : parent
▼ ▲ dialogflow.projects.locations.conversationModels.evaluations.list
HTTP Method : GET
Scopes :
Description : Lists evaluations of a conversation model.
Parameters :
parent
Type : string
Description : Required. The conversation model resource name. Format: `projects//conversationModels/`
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/conversationModels/[^/]+$
Location : path
pageToken
Description : Optional. The next_page_token value returned from a previous list request.
Type : string
Location : query
pageSize
Format : int32
Location : query
Type : integer
Description : Optional. Maximum number of evaluations to return in a single page. By default 100 and at most 1000.
Path : v2/{+parent}/evaluations
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/conversationModels/{conversationModelsId}/evaluations
Parameter Order : parent
▼ ▲ dialogflow.projects.locations.conversationModels.evaluations.create
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/conversationModels/{conversationModelsId}/evaluations
HTTP Method : POST
Scopes :
Parameters :
parent
Type : string
Location : path
Description : Required. The conversation model resource name. Format: `projects//locations//conversationModels/`
Pattern : ^projects/[^/]+/locations/[^/]+/conversationModels/[^/]+$
Required : Yes
Path : v2/{+parent}/evaluations
Parameter Order : parent
Description : Creates evaluation of a conversation model.
▼ ▲ dialogflow.projects.locations.conversationModels.evaluations.get
Parameter Order : name
HTTP Method : GET
Scopes :
Path : v2/{+name}
Parameters :
name
Type : string
Location : path
Required : Yes
Description : Required. The conversation model evaluation resource name. Format: `projects//conversationModels//evaluations/`
Pattern : ^projects/[^/]+/locations/[^/]+/conversationModels/[^/]+/evaluations/[^/]+$
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/conversationModels/{conversationModelsId}/evaluations/{evaluationsId}
Description : Gets an evaluation of conversation model.
▼ ▲ dialogflow.projects.locations.conversationModels.get
Parameters :
name
Description : Required. The conversation model to retrieve. Format: `projects//conversationModels/`
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/conversationModels/[^/]+$
Type : string
Required : Yes
HTTP Method : GET
Parameter Order : name
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/conversationModels/{conversationModelsId}
Path : v2/{+name}
Description : Gets conversation model.
Scopes :
▼ ▲ dialogflow.projects.locations.conversationModels.create
Path : v2/{+parent}/conversationModels
Description : Creates a model. This method is a [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields: - `metadata`: CreateConversationModelOperationMetadata - `response`: ConversationModel
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/conversationModels
Parameters :
parent
Required : Yes
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+$
Description : The project to create conversation model for. Format: `projects/`
Parameter Order : parent
HTTP Method : POST
Scopes :
▼ ▲ dialogflow.projects.locations.conversationModels.undeploy
Scopes :
HTTP Method : POST
Parameters :
name
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/conversationModels/[^/]+$
Description : Required. The conversation model to undeploy. Format: `projects//conversationModels/`
Type : string
Location : path
Description : Undeploys a model. If the model is not deployed this method has no effect. If the model is currently being used: - For article suggestion, article suggestion will fallback to the default model if model is undeployed. This method is a [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields: - `metadata`: UndeployConversationModelOperationMetadata - `response`: An [Empty message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
Parameter Order : name
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/conversationModels/{conversationModelsId}:undeploy
Path : v2/{+name}:undeploy
▼ ▲ dialogflow.projects.locations.conversationModels.deploy
Parameter Order : name
Parameters :
name
Required : Yes
Description : Required. The conversation model to deploy. Format: `projects//conversationModels/`
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/conversationModels/[^/]+$
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/conversationModels/{conversationModelsId}:deploy
Description : Deploys a model. If a model is already deployed, deploying it has no effect. A model can only serve prediction requests after it gets deployed. For article suggestion, custom model will not be used unless it is deployed. This method is a [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields: - `metadata`: DeployConversationModelOperationMetadata - `response`: An [Empty message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
HTTP Method : POST
Path : v2/{+name}:deploy
Scopes :
▼ ▲ dialogflow.projects.locations.conversationModels.list
Description : Lists conversation models.
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/conversationModels
Scopes :
Parameter Order : parent
HTTP Method : GET
Path : v2/{+parent}/conversationModels
Parameters :
pageToken
Location : query
Description : Optional. The next_page_token value returned from a previous list request.
Type : string
pageSize
Location : query
Format : int32
Type : integer
Description : Optional. Maximum number of conversation models to return in a single page. By default 100 and at most 1000.
parent
Required : Yes
Location : path
Description : Required. The project to list all conversation models for. Format: `projects/`
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+$
▼ ▲ dialogflow.projects.locations.conversationModels.delete
Parameter Order : name
Flat Path : v2/projects/{projectsId}/locations/{locationsId}/conversationModels/{conversationModelsId}
Scopes :
Description : Deletes a model. This method is a [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields: - `metadata`: DeleteConversationModelOperationMetadata - `response`: An [Empty message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
Parameters :
name
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/conversationModels/[^/]+$
Type : string
Description : Required. The conversation model to delete. Format: `projects//conversationModels/`
Path : v2/{+name}
HTTP Method : DELETE
▼ ▲ dialogflow.projects.conversationModels.evaluations.list
Description : Lists evaluations of a conversation model.
Flat Path : v2/projects/{projectsId}/conversationModels/{conversationModelsId}/evaluations
Scopes :
Parameter Order : parent
Parameters :
pageToken
Type : string
Location : query
Description : Optional. The next_page_token value returned from a previous list request.
pageSize
Format : int32
Type : integer
Location : query
Description : Optional. Maximum number of evaluations to return in a single page. By default 100 and at most 1000.
parent
Description : Required. The conversation model resource name. Format: `projects//conversationModels/`
Required : Yes
Location : path
Type : string
Pattern : ^projects/[^/]+/conversationModels/[^/]+$
HTTP Method : GET
Path : v2/{+parent}/evaluations
▼ ▲ dialogflow.projects.conversationModels.evaluations.get
HTTP Method : GET
Flat Path : v2/projects/{projectsId}/conversationModels/{conversationModelsId}/evaluations/{evaluationsId}
Parameter Order : name
Parameters :
name
Description : Required. The conversation model evaluation resource name. Format: `projects//conversationModels//evaluations/`
Pattern : ^projects/[^/]+/conversationModels/[^/]+/evaluations/[^/]+$
Type : string
Location : path
Required : Yes
Description : Gets an evaluation of conversation model.
Scopes :
Path : v2/{+name}
▼ ▲ dialogflow.projects.conversationModels.delete
HTTP Method : DELETE
Description : Deletes a model. This method is a [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields: - `metadata`: DeleteConversationModelOperationMetadata - `response`: An [Empty message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
Path : v2/{+name}
Flat Path : v2/projects/{projectsId}/conversationModels/{conversationModelsId}
Parameters :
name
Required : Yes
Description : Required. The conversation model to delete. Format: `projects//conversationModels/`
Location : path
Pattern : ^projects/[^/]+/conversationModels/[^/]+$
Type : string
Parameter Order : name
Scopes :
▼ ▲ dialogflow.projects.conversationModels.deploy
Flat Path : v2/projects/{projectsId}/conversationModels/{conversationModelsId}:deploy
Scopes :
Parameters :
name
Description : Required. The conversation model to deploy. Format: `projects//conversationModels/`
Pattern : ^projects/[^/]+/conversationModels/[^/]+$
Required : Yes
Type : string
Location : path
Parameter Order : name
HTTP Method : POST
Path : v2/{+name}:deploy
Description : Deploys a model. If a model is already deployed, deploying it has no effect. A model can only serve prediction requests after it gets deployed. For article suggestion, custom model will not be used unless it is deployed. This method is a [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields: - `metadata`: DeployConversationModelOperationMetadata - `response`: An [Empty message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
▼ ▲ dialogflow.projects.conversationModels.list
HTTP Method : GET
Parameters :
parent
Required : Yes
Location : path
Pattern : ^projects/[^/]+$
Type : string
Description : Required. The project to list all conversation models for. Format: `projects/`
pageToken
Type : string
Location : query
Description : Optional. The next_page_token value returned from a previous list request.
pageSize
Format : int32
Description : Optional. Maximum number of conversation models to return in a single page. By default 100 and at most 1000.
Location : query
Type : integer
Description : Lists conversation models.
Flat Path : v2/projects/{projectsId}/conversationModels
Scopes :
Path : v2/{+parent}/conversationModels
Parameter Order : parent
▼ ▲ dialogflow.projects.conversationModels.create
Path : v2/{+parent}/conversationModels
Description : Creates a model. This method is a [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields: - `metadata`: CreateConversationModelOperationMetadata - `response`: ConversationModel
Parameters :
parent
Type : string
Required : Yes
Description : The project to create conversation model for. Format: `projects/`
Location : path
Pattern : ^projects/[^/]+$
Parameter Order : parent
Flat Path : v2/projects/{projectsId}/conversationModels
Scopes :
HTTP Method : POST
▼ ▲ dialogflow.projects.conversationModels.get
Flat Path : v2/projects/{projectsId}/conversationModels/{conversationModelsId}
Path : v2/{+name}
Scopes :
Parameter Order : name
Parameters :
name
Required : Yes
Type : string
Description : Required. The conversation model to retrieve. Format: `projects//conversationModels/`
Pattern : ^projects/[^/]+/conversationModels/[^/]+$
Location : path
Description : Gets conversation model.
HTTP Method : GET
▼ ▲ dialogflow.projects.conversationModels.undeploy
Path : v2/{+name}:undeploy
Scopes :
HTTP Method : POST
Description : Undeploys a model. If the model is not deployed this method has no effect. If the model is currently being used: - For article suggestion, article suggestion will fallback to the default model if model is undeployed. This method is a [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields: - `metadata`: UndeployConversationModelOperationMetadata - `response`: An [Empty message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
Parameter Order : name
Flat Path : v2/projects/{projectsId}/conversationModels/{conversationModelsId}:undeploy
Parameters :
name
Location : path
Description : Required. The conversation model to undeploy. Format: `projects//conversationModels/`
Pattern : ^projects/[^/]+/conversationModels/[^/]+$
Type : string
Required : Yes
▼ ▲ dialogflow.projects.conversationDatasets.importConversationData
Flat Path : v2/projects/{projectsId}/conversationDatasets/{conversationDatasetsId}:importConversationData
Path : v2/{+name}:importConversationData
Description : Import data into the specified conversation dataset. Note that it is not allowed to import data to a conversation dataset that already has data in it. This method is a [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields: - `metadata`: ImportConversationDataOperationMetadata - `response`: ImportConversationDataOperationResponse
Parameters :
name
Location : path
Pattern : ^projects/[^/]+/conversationDatasets/[^/]+$
Required : Yes
Type : string
Description : Required. Dataset resource name. Format: `projects//locations//conversationDatasets/`
Scopes :
HTTP Method : POST
Parameter Order : name
▼ ▲ dialogflow.projects.conversationDatasets.list
Flat Path : v2/projects/{projectsId}/conversationDatasets
Parameter Order : parent
HTTP Method : GET
Scopes :
Description : Returns the list of all conversation datasets in the specified project and location.
Path : v2/{+parent}/conversationDatasets
Parameters :
pageSize
Description : Optional. Maximum number of conversation datasets to return in a single page. By default 100 and at most 1000.
Type : integer
Location : query
Format : int32
parent
Required : Yes
Description : Required. The project and location name to list all conversation datasets for. Format: `projects//locations/`
Type : string
Pattern : ^projects/[^/]+$
Location : path
pageToken
Description : Optional. The next_page_token value returned from a previous list request.
Type : string
Location : query
▼ ▲ dialogflow.projects.conversationDatasets.get
Parameter Order : name
Parameters :
name
Location : path
Description : Required. The conversation dataset to retrieve. Format: `projects//locations//conversationDatasets/`
Pattern : ^projects/[^/]+/conversationDatasets/[^/]+$
Type : string
Required : Yes
Description : Retrieves the specified conversation dataset.
Flat Path : v2/projects/{projectsId}/conversationDatasets/{conversationDatasetsId}
HTTP Method : GET
Scopes :
Path : v2/{+name}
▼ ▲ dialogflow.projects.conversationProfiles.clearSuggestionFeatureConfig
Parameter Order : conversationProfile
Description : Clears a suggestion feature from a conversation profile for the given participant role. This method is a [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields: - `metadata`: ClearSuggestionFeatureConfigOperationMetadata - `response`: ConversationProfile
Flat Path : v2/projects/{projectsId}/conversationProfiles/{conversationProfilesId}:clearSuggestionFeatureConfig
Path : v2/{+conversationProfile}:clearSuggestionFeatureConfig
Parameters :
conversationProfile
Description : Required. The Conversation Profile to add or update the suggestion feature config. Format: `projects//locations//conversationProfiles/`.
Type : string
Pattern : ^projects/[^/]+/conversationProfiles/[^/]+$
Location : path
Required : Yes
HTTP Method : POST
Scopes :
▼ ▲ dialogflow.projects.conversationProfiles.setSuggestionFeatureConfig
Flat Path : v2/projects/{projectsId}/conversationProfiles/{conversationProfilesId}:setSuggestionFeatureConfig
Parameter Order : conversationProfile
Description : Adds or updates a suggestion feature in a conversation profile. If the conversation profile contains the type of suggestion feature for the participant role, it will update it. Otherwise it will insert the suggestion feature. This method is a [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields: - `metadata`: SetSuggestionFeatureConfigOperationMetadata - `response`: ConversationProfile If a long running operation to add or update suggestion feature config for the same conversation profile, participant role and suggestion feature type exists, please cancel the existing long running operation before sending such request, otherwise the request will be rejected.
HTTP Method : POST
Path : v2/{+conversationProfile}:setSuggestionFeatureConfig
Parameters :
conversationProfile
Pattern : ^projects/[^/]+/conversationProfiles/[^/]+$
Type : string
Required : Yes
Description : Required. The Conversation Profile to add or update the suggestion feature config. Format: `projects//locations//conversationProfiles/`.
Location : path
Scopes :