Dialogflow API (dialogflow:v2)

Updates

Methods


• ▼ ▲ dialogflow.projects.answerRecords.patch

  Parameters :

  updateMask

  Description : Required. The mask to control which fields get updated.

  Location : query

  Type : string

  Format : google-fieldmask

  name

  Description : The unique identifier of this answer record. Format: `projects//locations//answerRecords/`.

  Required : Yes

  Type : string

  Location : path

  Pattern : ^projects/[^/]+/answerRecords/[^/]+$

• ▼ ▲ dialogflow.projects.answerRecords.list

  Parameters :

  filter

  Description : Optional. Filters to restrict results to specific answer records. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * conversation_id with equals(=) operator Examples: * `conversation_id=bar` matches answer records in the `projects/foo/locations/global/conversations/bar` conversation (assuming the parent is `projects/foo/locations/global`). For more information about filtering, see [API Filtering](https://aip.dev/160).

  Type : string

  Location : query

  pageSize

  Location : query

  Description : Optional. The maximum number of records to return in a single page. The server may return fewer records than this. If unspecified, we use 10. The maximum is 100.

  Type : integer

  Format : int32

  parent

  Required : Yes

  Type : string

  Pattern : ^projects/[^/]+$

  Description : Required. The project to list all answer records for in reverse chronological order. Format: `projects//locations/`.

  Location : path

  pageToken

  Description : Optional. The ListAnswerRecordsResponse.next_page_token value returned from a previous list request used to continue listing on the next page.

  Location : query

  Type : string

• ▼ ▲ dialogflow.projects.conversationModels.evaluations.list

  Parameters :

  pageToken

  Description : Optional. The next_page_token value returned from a previous list request.

  Location : query

  Type : string

  parent

  Location : path

  Description : Required. The conversation model resource name. Format: `projects//conversationModels/`

  Pattern : ^projects/[^/]+/conversationModels/[^/]+$

  Required : Yes

  Type : string

  pageSize

  Type : integer

  Description : Optional. Maximum number of evaluations to return in a single page. By default 100 and at most 1000.

  Format : int32

  Location : query

• ▼ ▲ dialogflow.projects.conversationModels.evaluations.get

  Parameters :

  name

  Location : path

  Type : string

  Description : Required. The conversation model evaluation resource name. Format: `projects//conversationModels//evaluations/`

  Required : Yes

  Pattern : ^projects/[^/]+/conversationModels/[^/]+/evaluations/[^/]+$

• ▼ ▲ dialogflow.projects.conversationModels.undeploy

  Parameters :

  name

  Description : Required. The conversation model to undeploy. Format: `projects//conversationModels/`

  Pattern : ^projects/[^/]+/conversationModels/[^/]+$

  Type : string

  Location : path

  Required : Yes

• ▼ ▲ dialogflow.projects.conversationModels.list

  Parameters :

  pageSize

  Description : Optional. Maximum number of conversation models to return in a single page. By default 100 and at most 1000.

  Format : int32

  Location : query

  Type : integer

  pageToken

  Description : Optional. The next_page_token value returned from a previous list request.

  Location : query

  Type : string

  parent

  Description : Required. The project to list all conversation models for. Format: `projects/`

  Pattern : ^projects/[^/]+$

  Type : string

  Required : Yes

  Location : path

• ▼ ▲ dialogflow.projects.conversationModels.create

  Parameters :

  parent

  Location : path

  Description : The project to create conversation model for. Format: `projects/`

  Pattern : ^projects/[^/]+$

  Required : Yes

  Type : string

• ▼ ▲ dialogflow.projects.conversationModels.deploy

  Parameters :

  name

  Pattern : ^projects/[^/]+/conversationModels/[^/]+$

  Type : string

  Location : path

  Description : Required. The conversation model to deploy. Format: `projects//conversationModels/`

  Required : Yes

• ▼ ▲ dialogflow.projects.conversationModels.delete

  Parameters :

  name

  Description : Required. The conversation model to delete. Format: `projects//conversationModels/`

  Type : string

  Pattern : ^projects/[^/]+/conversationModels/[^/]+$

  Location : path

  Required : Yes

• ▼ ▲ dialogflow.projects.conversationModels.get

  Parameters :

  name

  Type : string

  Required : Yes

  Description : Required. The conversation model to retrieve. Format: `projects//conversationModels/`

  Pattern : ^projects/[^/]+/conversationModels/[^/]+$

  Location : path

• ▼ ▲ dialogflow.projects.operations.cancel

  Parameters :

  name

  Location : path

  Description : The name of the operation resource to be cancelled.

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

  Type : string

  Required : Yes

• ▼ ▲ dialogflow.projects.operations.list

  Parameters :

  returnPartialSuccess

  Description : When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.

  Type : boolean

  Location : query

  filter

  Location : query

  Type : string

  Description : The standard list filter.

  pageSize

  Format : int32

  Type : integer

  Description : The standard list page size.

  Location : query

  pageToken

  Description : The standard list page token.

  Location : query

  Type : string

  name

  Pattern : ^projects/[^/]+$

  Required : Yes

  Description : The name of the operation's parent resource.

  Type : string

  Location : path

• ▼ ▲ dialogflow.projects.operations.get

  Parameters :

  name

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

  Description : The name of the operation resource.

  Location : path

  Type : string

  Required : Yes

• ▼ ▲ dialogflow.projects.locations.getAgent

  Parameters :

  parent

  Required : Yes

  Description : Required. The project that the agent to fetch is associated with. Format: `projects/`.

  Type : string

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

  Location : path

• ▼ ▲ dialogflow.projects.locations.getEncryptionSpec

  Parameters :

  name

  Required : Yes

  Location : path

  Type : string

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

  Description : Required. The name of the encryption spec resource to get.

• ▼ ▲ dialogflow.projects.locations.list

  Parameters :

  extraLocationTypes

  Repeated : Yes

  Type : string

  Location : query

  Description : Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.

  pageSize

  Location : query

  Description : The maximum number of results to return. If not set, the service selects a default.

  Type : integer

  Format : int32

  name

  Description : The resource that owns the locations collection, if applicable.

  Required : Yes

  Pattern : ^projects/[^/]+$

  Location : path

  Type : string

  filter

  Location : query

  Type : string

  Description : A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).

  pageToken

  Type : string

  Location : query

  Description : A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.

• ▼ ▲ dialogflow.projects.locations.get

  Parameters :

  name

  Location : path

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

  Type : string

  Description : Resource name for the location.

  Required : Yes

• ▼ ▲ dialogflow.projects.locations.deleteAgent

  Parameters :

  parent

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

  Location : path

  Description : Required. The project that the agent to delete is associated with. Format: `projects/`.

  Required : Yes

  Type : string

• ▼ ▲ dialogflow.projects.locations.setAgent

  Parameters :

  parent

  Location : path

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

  Type : string

  Description : Required. The project of this agent. Format: `projects/`.

  Required : Yes

  updateMask

  Location : query

  Format : google-fieldmask

  Description : Optional. The mask to control which fields get updated.

  Type : string

• ▼ ▲ dialogflow.projects.locations.sipTrunks.patch

  Parameters :

  name

  Description : Identifier. The unique identifier of the SIP trunk. Format: `projects//locations//sipTrunks/`.

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

  Location : path

  Type : string

  Required : Yes

  updateMask

  Type : string

  Location : query

  Format : google-fieldmask

  Description : Optional. The mask to control which fields get updated. If the mask is not present, all fields will be updated.

• ▼ ▲ dialogflow.projects.locations.sipTrunks.delete

  Parameters :

  name

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

  Type : string

  Required : Yes

  Location : path

  Description : Required. The name of the SIP trunk to delete. Format: `projects//locations//sipTrunks/`.

• ▼ ▲ dialogflow.projects.locations.sipTrunks.create

  Parameters :

  parent

  Type : string

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

  Description : Required. The location to create a SIP trunk for. Format: `projects//locations/`.

  Location : path

  Required : Yes

• ▼ ▲ dialogflow.projects.locations.sipTrunks.get

  Parameters :

  name

  Location : path

  Type : string

  Required : Yes

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

  Description : Required. The name of the SIP trunk to delete. Format: `projects//locations//sipTrunks/`.

• ▼ ▲ dialogflow.projects.locations.sipTrunks.list

  Parameters :

  pageToken

  Location : query

  Type : string

  Description : Optional. The next_page_token value returned from a previous list request.

  parent

  Required : Yes

  Description : Required. The location to list SIP trunks from. Format: `projects//locations/`.

  Location : path

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

  Type : string

  pageSize

  Description : Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.

  Format : int32

  Type : integer

  Location : query

• ▼ ▲ dialogflow.projects.locations.conversationDatasets.list

  Parameters :

  pageSize

  Description : Optional. Maximum number of conversation datasets to return in a single page. By default 100 and at most 1000.

  Type : integer

  Format : int32

  Location : query

  parent

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

  Type : string

  Location : path

  Required : Yes

  Description : Required. The project and location name to list all conversation datasets for. Format: `projects//locations/`

  pageToken

  Description : Optional. The next_page_token value returned from a previous list request.

  Location : query

  Type : string

• ▼ ▲ dialogflow.projects.locations.conversationDatasets.get

  Parameters :

  name

  Description : Required. The conversation dataset to retrieve. Format: `projects//locations//conversationDatasets/`

  Location : path

  Type : string

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

  Required : Yes

• ▼ ▲ dialogflow.projects.locations.conversationDatasets.create

  Parameters :

  parent

  Required : Yes

  Type : string

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

  Location : path

  Description : Required. The project to create conversation dataset for. Format: `projects//locations/`

• ▼ ▲ dialogflow.projects.locations.conversationDatasets.delete

  Parameters :

  name

  Location : path

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

  Type : string

  Description : Required. The conversation dataset to delete. Format: `projects//locations//conversationDatasets/`

  Required : Yes

• ▼ ▲ dialogflow.projects.locations.conversationDatasets.importConversationData

  Parameters :

  name

  Description : Required. Dataset resource name. Format: `projects//locations//conversationDatasets/`

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

  Type : string

  Required : Yes

  Location : path

• ▼ ▲ dialogflow.projects.locations.conversationModels.evaluations.get

  Parameters :

  name

  Required : Yes

  Description : Required. The conversation model evaluation resource name. Format: `projects//conversationModels//evaluations/`

  Location : path

  Type : string

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

• ▼ ▲ dialogflow.projects.locations.conversationModels.evaluations.create

  Parameters :

  parent

  Required : Yes

  Type : string

  Location : path

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

  Description : Required. The conversation model resource name. Format: `projects//locations//conversationModels/`

• ▼ ▲ dialogflow.projects.locations.conversationModels.evaluations.list

  Parameters :

  parent

  Description : Required. The conversation model resource name. Format: `projects//conversationModels/`

  Required : Yes

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

  Type : string

  Location : path

  pageToken

  Description : Optional. The next_page_token value returned from a previous list request.

  Type : string

  Location : query

  pageSize

  Description : Optional. Maximum number of evaluations to return in a single page. By default 100 and at most 1000.

  Location : query

  Type : integer

  Format : int32

• ▼ ▲ dialogflow.projects.locations.conversationModels.create

  Parameters :

  parent

  Location : path

  Required : Yes

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

  Type : string

  Description : The project to create conversation model for. Format: `projects/`

• ▼ ▲ dialogflow.projects.locations.conversationModels.undeploy

  Parameters :

  name

  Type : string

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

  Description : Required. The conversation model to undeploy. Format: `projects//conversationModels/`

  Required : Yes

  Location : path

• ▼ ▲ dialogflow.projects.locations.conversationModels.list

  Parameters :

  pageSize

  Location : query

  Format : int32

  Description : Optional. Maximum number of conversation models to return in a single page. By default 100 and at most 1000.

  Type : integer

  parent

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

  Type : string

  Description : Required. The project to list all conversation models for. Format: `projects/`

  Location : path

  Required : Yes

  pageToken

  Location : query

  Description : Optional. The next_page_token value returned from a previous list request.

  Type : string

• ▼ ▲ dialogflow.projects.locations.conversationModels.get

  Parameters :

  name

  Type : string

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

  Required : Yes

  Description : Required. The conversation model to retrieve. Format: `projects//conversationModels/`

  Location : path

• ▼ ▲ dialogflow.projects.locations.conversationModels.delete

  Parameters :

  name

  Required : Yes

  Type : string

  Location : path

  Description : Required. The conversation model to delete. Format: `projects//conversationModels/`

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

• ▼ ▲ dialogflow.projects.locations.conversationModels.deploy

  Parameters :

  name

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

  Description : Required. The conversation model to deploy. Format: `projects//conversationModels/`

  Required : Yes

  Location : path

  Type : string

• ▼ ▲ dialogflow.projects.locations.conversationProfiles.get

  Parameters :

  name

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

  Description : Required. The resource name of the conversation profile. Format: `projects//locations//conversationProfiles/`.

  Required : Yes

  Type : string

  Location : path

• ▼ ▲ dialogflow.projects.locations.conversationProfiles.delete

  Parameters :

  name

  Type : string

  Required : Yes

  Location : path

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

  Description : Required. The name of the conversation profile to delete. Format: `projects//locations//conversationProfiles/`.

• ▼ ▲ dialogflow.projects.locations.conversationProfiles.clearSuggestionFeatureConfig

  Parameters :

  conversationProfile

  Type : string

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

  Description : Required. The Conversation Profile to add or update the suggestion feature config. Format: `projects//locations//conversationProfiles/`.

  Required : Yes

  Location : path

• ▼ ▲ dialogflow.projects.locations.conversationProfiles.setSuggestionFeatureConfig

  Parameters :

  conversationProfile

  Description : Required. The Conversation Profile to add or update the suggestion feature config. Format: `projects//locations//conversationProfiles/`.

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

  Location : path

  Required : Yes

  Type : string

• ▼ ▲ dialogflow.projects.locations.conversationProfiles.list

  Parameters :

  parent

  Required : Yes

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

  Description : Required. The project to list all conversation profiles from. Format: `projects//locations/`.

  Location : path

  Type : string

  pageToken

  Location : query

  Description : The next_page_token value returned from a previous list request.

  Type : string

  pageSize

  Type : integer

  Format : int32

  Location : query

  Description : The maximum number of items to return in a single page. By default 100 and at most 1000.

• ▼ ▲ dialogflow.projects.locations.conversationProfiles.patch

  Parameters :

  name

  Location : path

  Type : string

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

  Required : Yes

  Description : The unique identifier of this conversation profile. Format: `projects//locations//conversationProfiles/`.

  updateMask

  Type : string

  Description : Required. The mask to control which fields to update.

  Format : google-fieldmask

  Location : query

• ▼ ▲ dialogflow.projects.locations.conversationProfiles.create

  Parameters :

  parent

  Type : string

  Location : path

  Required : Yes

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

  Description : Required. The project to create a conversation profile for. Format: `projects//locations/`.

• ▼ ▲ dialogflow.projects.locations.agent.search

  Parameters :

  parent

  Required : Yes

  Type : string

  Description : Required. The project to list agents from. Format: `projects/`.

  Location : path

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

  pageToken

  Description : The next_page_token value returned from a previous list request.

  Type : string

  Location : query

  pageSize

  Description : Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.

  Format : int32

  Type : integer

  Location : query

• ▼ ▲ dialogflow.projects.locations.agent.import

  Parameters :

  parent

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

  Required : Yes

  Description : Required. The project that the agent to import is associated with. Format: `projects/`.

  Location : path

  Type : string

• ▼ ▲ dialogflow.projects.locations.agent.train

  Parameters :

  parent

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

  Description : Required. The project that the agent to train is associated with. Format: `projects/`.

  Required : Yes

  Type : string

  Location : path

• ▼ ▲ dialogflow.projects.locations.agent.updateFulfillment

  Parameters :

  updateMask

  Location : query

  Description : Required. The mask to control which fields get updated. If the mask is not present, all fields will be updated.

  Type : string

  Format : google-fieldmask

  name

  Location : path

  Description : Required. The unique identifier of the fulfillment. Supported formats: - `projects//agent/fulfillment` - `projects//locations//agent/fulfillment` This field is not used for Fulfillment in an Environment.

  Type : string

  Required : Yes

  Pattern : ^projects/[^/]+/locations/[^/]+/agent/fulfillment$

• ▼ ▲ dialogflow.projects.locations.agent.restore

  Parameters :

  parent

  Required : Yes

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

  Location : path

  Description : Required. The project that the agent to restore is associated with. Format: `projects/`.

  Type : string

• ▼ ▲ dialogflow.projects.locations.agent.getValidationResult

  Parameters :

  parent

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

  Location : path

  Description : Required. The project that the agent is associated with. Format: `projects/`.

  Type : string

  Required : Yes

  languageCode

  Location : query

  Description : Optional. The language for which you want a validation result. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.

  Type : string

• ▼ ▲ dialogflow.projects.locations.agent.export

  Parameters :

  parent

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

  Type : string

  Required : Yes

  Description : Required. The project that the agent to export is associated with. Format: `projects/`.

  Location : path

• ▼ ▲ dialogflow.projects.locations.agent.getFulfillment

  Parameters :

  name

  Description : Required. The name of the fulfillment. Format: `projects//agent/fulfillment`.

  Location : path

  Type : string

  Required : Yes

  Pattern : ^projects/[^/]+/locations/[^/]+/agent/fulfillment$

• ▼ ▲ dialogflow.projects.locations.agent.environments.patch

  Parameters :

  updateMask

  Type : string

  Format : google-fieldmask

  Description : Required. The mask to control which fields get updated.

  Location : query

  name

  Required : Yes

  Location : path

  Description : Output only. The unique identifier of this agent environment. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/` The environment ID for the default environment is `-`.

  Pattern : ^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+$

  Type : string

  allowLoadToDraftAndDiscardChanges

  Location : query

  Description : Optional. This field is used to prevent accidental overwrite of the default environment, which is an operation that cannot be undone. To confirm that the caller desires this overwrite, this field must be explicitly set to true when updating the default environment (environment ID = `-`).

  Type : boolean

• ▼ ▲ dialogflow.projects.locations.agent.environments.get

  Parameters :

  name

  Location : path

  Pattern : ^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+$

  Required : Yes

  Type : string

  Description : Required. The name of the environment. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/` The environment ID for the default environment is `-`.

• ▼ ▲ dialogflow.projects.locations.agent.environments.getHistory

  Parameters :

  pageToken

  Type : string

  Description : Optional. The next_page_token value returned from a previous list request.

  Location : query

  pageSize

  Type : integer

  Format : int32

  Description : Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.

  Location : query

  parent

  Required : Yes

  Location : path

  Pattern : ^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+$

  Description : Required. The name of the environment to retrieve history for. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/` The environment ID for the default environment is `-`.

  Type : string

• ▼ ▲ dialogflow.projects.locations.agent.environments.list

  Parameters :

  parent

  Required : Yes

  Type : string

  Location : path

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

  Description : Required. The agent to list all environments from. Format: - `projects//agent` - `projects//locations//agent`

  pageToken

  Location : query

  Description : Optional. The next_page_token value returned from a previous list request.

  Type : string

  pageSize

  Format : int32

  Description : Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.

  Location : query

  Type : integer

• ▼ ▲ dialogflow.projects.locations.agent.environments.create

  Parameters :

  environmentId

  Type : string

  Description : Required. The unique id of the new environment.

  Location : query

  parent

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

  Required : Yes

  Type : string

  Description : Required. The agent to create an environment for. Supported formats: - `projects//agent` - `projects//locations//agent`

  Location : path

• ▼ ▲ dialogflow.projects.locations.agent.environments.delete

  Parameters :

  name

  Description : Required. The name of the environment to delete. / Format: - `projects//agent/environments/` - `projects//locations//agent/environments/` The environment ID for the default environment is `-`.

  Location : path

  Required : Yes

  Pattern : ^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+$

  Type : string

• ▼ ▲ dialogflow.projects.locations.agent.environments.intents.list

  Parameters :

  pageToken

  Location : query

  Type : string

  Description : Optional. The next_page_token value returned from a previous list request.

  parent

  Required : Yes

  Pattern : ^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+$

  Type : string

  Description : Required. The agent to list all intents from. Format: `projects//agent` or `projects//locations//agent`. Alternatively, you can specify the environment to list intents for. Format: `projects//agent/environments/` or `projects//locations//agent/environments/`. Note: training phrases of the intents will not be returned for non-draft environment.

  Location : path

  languageCode

  Type : string

  Description : Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).

  Location : query

  intentView

  Location : query

  Description : Optional. The resource view to apply to the returned intent.

  Enum :

  • INTENT_VIEW_UNSPECIFIED
  • INTENT_VIEW_FULL

  Type : string

  Enum Descriptions :

  • Training phrases field is not populated in the response.
  • All fields are populated.

  pageSize

  Format : int32

  Description : Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.

  Type : integer

  Location : query

• ▼ ▲ dialogflow.projects.locations.agent.environments.users.sessions.detectIntent

  Parameters :

  session

  Pattern : ^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+$

  Required : Yes

  Type : string

  Location : path

  Description : Required. The name of the session this query is sent to. Format: `projects//agent/sessions/`, or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment (`Environment ID` might be referred to as environment name at some places). If `User ID` is not specified, we are using "-". It's up to the API caller to choose an appropriate `Session ID` and `User Id`. They can be a random number or some type of user and session identifiers (preferably hashed). The length of the `Session ID` and `User ID` must not exceed 36 characters. For more information, see the [API interactions guide](https://cloud.google.com/dialogflow/docs/api-overview). Note: Always use agent versions for production traffic. See [Versions and environments](https://cloud.google.com/dialogflow/es/docs/agents-versions).

• ▼ ▲ dialogflow.projects.locations.agent.environments.users.sessions.deleteContexts

  Parameters :

  parent

  Description : Required. The name of the session to delete all contexts from. Format: `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.

  Location : path

  Pattern : ^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+$

  Required : Yes

  Type : string

• ▼ ▲ dialogflow.projects.locations.agent.environments.users.sessions.entityTypes.patch

  Parameters :

  updateMask

  Type : string

  Format : google-fieldmask

  Description : Optional. The mask to control which fields get updated.

  Location : query

  name

  Description : Required. The unique identifier of this session entity type. Format: `projects//agent/sessions//entityTypes/`, or `projects//agent/environments//users//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. `` must be the display name of an existing entity type in the same agent that will be overridden or supplemented.

  Location : path

  Pattern : ^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/entityTypes/[^/]+$

  Type : string

  Required : Yes

• ▼ ▲ dialogflow.projects.locations.agent.environments.users.sessions.entityTypes.delete

  Parameters :

  name

  Type : string

  Required : Yes

  Location : path

  Description : Required. The name of the entity type to delete. Format: `projects//agent/sessions//entityTypes/` or `projects//agent/environments//users//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.

  Pattern : ^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/entityTypes/[^/]+$

• ▼ ▲ dialogflow.projects.locations.agent.environments.users.sessions.entityTypes.create

  Parameters :

  parent

  Required : Yes

  Type : string

  Description : Required. The session to create a session entity type for. Format: `projects//agent/sessions/` or `projects//agent/environments//users// sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.

  Location : path

  Pattern : ^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+$

• ▼ ▲ dialogflow.projects.locations.agent.environments.users.sessions.entityTypes.get

  Parameters :

  name

  Type : string

  Required : Yes

  Pattern : ^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/entityTypes/[^/]+$

  Description : Required. The name of the session entity type. Format: `projects//agent/sessions//entityTypes/` or `projects//agent/environments//users//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.

  Location : path

• ▼ ▲ dialogflow.projects.locations.agent.environments.users.sessions.entityTypes.list

  Parameters :

  pageToken

  Description : Optional. The next_page_token value returned from a previous list request.

  Location : query

  Type : string

  parent

  Pattern : ^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+$

  Required : Yes

  Type : string

  Location : path

  Description : Required. The session to list all session entity types from. Format: `projects//agent/sessions/` or `projects//agent/environments//users// sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.

  pageSize

  Type : integer

  Location : query

  Format : int32

  Description : Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.

• ▼ ▲ dialogflow.projects.locations.agent.environments.users.sessions.contexts.list

  Parameters :

  parent

  Required : Yes

  Pattern : ^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+$

  Description : Required. The session to list all contexts from. Format: `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.

  Type : string

  Location : path

  pageSize

  Format : int32

  Type : integer

  Description : Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.

  Location : query

  pageToken

  Location : query

  Type : string

  Description : Optional. The next_page_token value returned from a previous list request.

• ▼ ▲ dialogflow.projects.locations.agent.environments.users.sessions.contexts.delete

  Parameters :

  name

  Required : Yes

  Location : path

  Type : string

  Pattern : ^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/contexts/[^/]+$

  Description : Required. The name of the context to delete. Format: `projects//agent/sessions//contexts/` or `projects//agent/environments//users//sessions//contexts/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.

• ▼ ▲ dialogflow.projects.locations.agent.environments.users.sessions.contexts.patch

  Parameters :

  name

  Type : string

  Pattern : ^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/contexts/[^/]+$

  Location : path

  Required : Yes

  Description : Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. The `Context ID` is always converted to lowercase, may only contain characters in `a-zA-Z0-9_-%` and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`

  updateMask

  Location : query

  Format : google-fieldmask

  Description : Optional. The mask to control which fields get updated.

  Type : string

• ▼ ▲ dialogflow.projects.locations.agent.environments.users.sessions.contexts.get

  Parameters :

  name

  Required : Yes

  Description : Required. The name of the context. Format: `projects//agent/sessions//contexts/` or `projects//agent/environments//users//sessions//contexts/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.

  Location : path

  Pattern : ^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/contexts/[^/]+$

  Type : string

• ▼ ▲ dialogflow.projects.locations.agent.environments.users.sessions.contexts.create

  Parameters :

  parent

  Type : string

  Required : Yes

  Location : path

  Pattern : ^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+$

  Description : Required. The session to create a context for. Format: `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.

• ▼ ▲ dialogflow.projects.locations.agent.intents.patch

  Parameters :

  updateMask

  Description : Optional. The mask to control which fields get updated.

  Format : google-fieldmask

  Location : query

  Type : string

  name

  Location : path

  Required : Yes

  Description : Optional. The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Format: `projects//agent/intents/`.

  Pattern : ^projects/[^/]+/locations/[^/]+/agent/intents/[^/]+$

  Type : string

  intentView

  Enum Descriptions :

  • Training phrases field is not populated in the response.
  • All fields are populated.

  Type : string

  Location : query

  Enum :

  • INTENT_VIEW_UNSPECIFIED
  • INTENT_VIEW_FULL

  Description : Optional. The resource view to apply to the returned intent.

  languageCode

  Description : Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).

  Type : string

  Location : query

• ▼ ▲ dialogflow.projects.locations.agent.intents.delete

  Parameters :

  name

  Required : Yes

  Type : string

  Description : Required. The name of the intent to delete. If this intent has direct or indirect followup intents, we also delete them. Format: `projects//agent/intents/`.

  Location : path

  Pattern : ^projects/[^/]+/locations/[^/]+/agent/intents/[^/]+$

• ▼ ▲ dialogflow.projects.locations.agent.intents.batchDelete

  Parameters :

  parent

  Type : string

  Description : Required. The name of the agent to delete all entities types for. Format: `projects//agent`.

  Location : path

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

  Required : Yes

• ▼ ▲ dialogflow.projects.locations.agent.intents.create

  Parameters :

  intentView

  Description : Optional. The resource view to apply to the returned intent.

  Location : query

  Type : string

  Enum :

  • INTENT_VIEW_UNSPECIFIED
  • INTENT_VIEW_FULL

  Enum Descriptions :

  • Training phrases field is not populated in the response.
  • All fields are populated.

  languageCode

  Type : string

  Location : query

  Description : Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).

  parent

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

  Required : Yes

  Type : string

  Description : Required. The agent to create a intent for. Format: `projects//agent`.

  Location : path

• ▼ ▲ dialogflow.projects.locations.agent.intents.batchUpdate

  Parameters :

  parent

  Description : Required. The name of the agent to update or create intents in. Format: `projects//agent`.

  Location : path

  Required : Yes

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

  Type : string

• ▼ ▲ dialogflow.projects.locations.agent.intents.list

  Parameters :

  pageToken

  Location : query

  Type : string

  Description : Optional. The next_page_token value returned from a previous list request.

  languageCode

  Type : string

  Location : query

  Description : Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).

  pageSize

  Type : integer

  Location : query

  Format : int32

  Description : Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.

  intentView

  Enum :

  • INTENT_VIEW_UNSPECIFIED
  • INTENT_VIEW_FULL

  Location : query

  Description : Optional. The resource view to apply to the returned intent.

  Type : string

  Enum Descriptions :

  • Training phrases field is not populated in the response.
  • All fields are populated.

  parent

  Description : Required. The agent to list all intents from. Format: `projects//agent` or `projects//locations//agent`. Alternatively, you can specify the environment to list intents for. Format: `projects//agent/environments/` or `projects//locations//agent/environments/`. Note: training phrases of the intents will not be returned for non-draft environment.

  Type : string

  Location : path

  Required : Yes

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

• ▼ ▲ dialogflow.projects.locations.agent.intents.get

  Parameters :

  intentView

  Type : string

  Location : query

  Enum :

  • INTENT_VIEW_UNSPECIFIED
  • INTENT_VIEW_FULL

  Enum Descriptions :

  • Training phrases field is not populated in the response.
  • All fields are populated.

  Description : Optional. The resource view to apply to the returned intent.

  name

  Location : path

  Required : Yes

  Pattern : ^projects/[^/]+/locations/[^/]+/agent/intents/[^/]+$

  Description : Required. The name of the intent. Format: `projects//agent/intents/`.

  Type : string

  languageCode

  Location : query

  Description : Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).

  Type : string

• ▼ ▲ dialogflow.projects.locations.agent.entityTypes.entities.batchCreate

  Parameters :

  parent

  Pattern : ^projects/[^/]+/locations/[^/]+/agent/entityTypes/[^/]+$

  Type : string

  Location : path

  Required : Yes

  Description : Required. The name of the entity type to create entities in. Format: `projects//agent/entityTypes/`.

• ▼ ▲ dialogflow.projects.locations.agent.entityTypes.entities.batchDelete

  Parameters :

  parent

  Required : Yes

  Type : string

  Pattern : ^projects/[^/]+/locations/[^/]+/agent/entityTypes/[^/]+$

  Location : path

  Description : Required. The name of the entity type to delete entries for. Format: `projects//agent/entityTypes/`.

• ▼ ▲ dialogflow.projects.locations.agent.entityTypes.entities.batchUpdate

  Parameters :

  parent

  Required : Yes

  Location : path

  Description : Required. The name of the entity type to update or create entities in. Format: `projects//agent/entityTypes/`.

  Type : string

  Pattern : ^projects/[^/]+/locations/[^/]+/agent/entityTypes/[^/]+$

• ▼ ▲ dialogflow.projects.locations.agent.entityTypes.batchDelete

  Parameters :

  parent

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

  Description : Required. The name of the agent to delete all entities types for. Format: `projects//agent`.

  Required : Yes

  Location : path

  Type : string

• ▼ ▲ dialogflow.projects.locations.agent.entityTypes.patch

  Parameters :

  name

  Required : Yes

  Type : string

  Pattern : ^projects/[^/]+/locations/[^/]+/agent/entityTypes/[^/]+$

  Description : The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Format: `projects//agent/entityTypes/`.

  Location : path

  languageCode

  Description : Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).

  Location : query

  Type : string

  updateMask

  Location : query

  Format : google-fieldmask

  Type : string

  Description : Optional. The mask to control which fields get updated.

• ▼ ▲ dialogflow.projects.locations.agent.entityTypes.batchUpdate

  Parameters :

  parent

  Required : Yes

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

  Type : string

  Description : Required. The name of the agent to update or create entity types in. Format: `projects//agent`.

  Location : path

• ▼ ▲ dialogflow.projects.locations.agent.entityTypes.delete

  Parameters :

  name

  Type : string

  Required : Yes

  Location : path

  Description : Required. The name of the entity type to delete. Format: `projects//agent/entityTypes/`.

  Pattern : ^projects/[^/]+/locations/[^/]+/agent/entityTypes/[^/]+$

• ▼ ▲ dialogflow.projects.locations.agent.entityTypes.list

  Parameters :

  languageCode

  Description : Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).

  Type : string

  Location : query

  pageToken

  Location : query

  Description : Optional. The next_page_token value returned from a previous list request.

  Type : string

  pageSize

  Location : query

  Format : int32

  Description : Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.

  Type : integer

  parent

  Type : string

  Location : path

  Description : Required. The agent to list all entity types from. Format: `projects//agent`.

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

  Required : Yes

• ▼ ▲ dialogflow.projects.locations.agent.entityTypes.create

  Parameters :

  parent

  Location : path

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

  Description : Required. The agent to create a entity type for. Format: `projects//agent`.

  Type : string

  Required : Yes

  languageCode

  Location : query

  Type : string

  Description : Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).

• ▼ ▲ dialogflow.projects.locations.agent.entityTypes.get

  Parameters :

  name

  Pattern : ^projects/[^/]+/locations/[^/]+/agent/entityTypes/[^/]+$

  Required : Yes

  Location : path

  Type : string

  Description : Required. The name of the entity type. Format: `projects//agent/entityTypes/`.

  languageCode

  Type : string

  Location : query

  Description : Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).

• ▼ ▲ dialogflow.projects.locations.agent.sessions.entityTypes.create

  Parameters :

  parent

  Location : path

  Description : Required. The session to create a session entity type for. Format: `projects//agent/sessions/` or `projects//agent/environments//users// sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.

  Required : Yes

  Type : string

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

• ▼ ▲ dialogflow.projects.locations.agent.sessions.entityTypes.delete

  Parameters :

  name

  Pattern : ^projects/[^/]+/locations/[^/]+/agent/sessions/[^/]+/entityTypes/[^/]+$

  Required : Yes

  Description : Required. The name of the entity type to delete. Format: `projects//agent/sessions//entityTypes/` or `projects//agent/environments//users//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.

  Type : string

  Location : path

• ▼ ▲ dialogflow.projects.locations.agent.sessions.entityTypes.list

  Parameters :

  pageToken

  Type : string

  Location : query

  Description : Optional. The next_page_token value returned from a previous list request.

  pageSize

  Type : integer

  Format : int32

  Description : Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.

  Location : query

  parent

  Description : Required. The session to list all session entity types from. Format: `projects//agent/sessions/` or `projects//agent/environments//users// sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.

  Location : path

  Required : Yes

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

  Type : string

• ▼ ▲ dialogflow.projects.locations.agent.sessions.entityTypes.get

  Parameters :

  name

  Type : string

  Pattern : ^projects/[^/]+/locations/[^/]+/agent/sessions/[^/]+/entityTypes/[^/]+$

  Required : Yes

  Location : path

  Description : Required. The name of the session entity type. Format: `projects//agent/sessions//entityTypes/` or `projects//agent/environments//users//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.

• ▼ ▲ dialogflow.projects.locations.agent.sessions.entityTypes.patch

  Parameters :

  name

  Type : string

  Location : path

  Description : Required. The unique identifier of this session entity type. Format: `projects//agent/sessions//entityTypes/`, or `projects//agent/environments//users//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. `` must be the display name of an existing entity type in the same agent that will be overridden or supplemented.

  Pattern : ^projects/[^/]+/locations/[^/]+/agent/sessions/[^/]+/entityTypes/[^/]+$

  Required : Yes

  updateMask

  Format : google-fieldmask

  Location : query

  Description : Optional. The mask to control which fields get updated.

  Type : string

• ▼ ▲ dialogflow.projects.locations.agent.sessions.contexts.patch

  Parameters :

  name

  Description : Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. The `Context ID` is always converted to lowercase, may only contain characters in `a-zA-Z0-9_-%` and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`

  Pattern : ^projects/[^/]+/locations/[^/]+/agent/sessions/[^/]+/contexts/[^/]+$

  Location : path

  Type : string

  Required : Yes

  updateMask

  Location : query

  Description : Optional. The mask to control which fields get updated.

  Type : string

  Format : google-fieldmask

• ▼ ▲ dialogflow.projects.locations.agent.sessions.contexts.delete

  Parameters :

  name

  Pattern : ^projects/[^/]+/locations/[^/]+/agent/sessions/[^/]+/contexts/[^/]+$

  Type : string

  Description : Required. The name of the context to delete. Format: `projects//agent/sessions//contexts/` or `projects//agent/environments//users//sessions//contexts/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.

  Location : path

  Required : Yes

• ▼ ▲ dialogflow.projects.locations.agent.sessions.contexts.list

  Parameters :

  parent

  Type : string

  Description : Required. The session to list all contexts from. Format: `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.

  Required : Yes

  Location : path

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

  pageToken

  Type : string

  Location : query

  Description : Optional. The next_page_token value returned from a previous list request.

  pageSize

  Format : int32

  Type : integer

  Description : Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.

  Location : query

• ▼ ▲ dialogflow.projects.locations.agent.sessions.contexts.get

  Parameters :

  name

  Type : string

  Location : path

  Description : Required. The name of the context. Format: `projects//agent/sessions//contexts/` or `projects//agent/environments//users//sessions//contexts/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.

  Pattern : ^projects/[^/]+/locations/[^/]+/agent/sessions/[^/]+/contexts/[^/]+$

  Required : Yes

• ▼ ▲ dialogflow.projects.locations.agent.sessions.contexts.create

  Parameters :

  parent

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

  Description : Required. The session to create a context for. Format: `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.

  Location : path

  Required : Yes

  Type : string

• ▼ ▲ dialogflow.projects.locations.agent.sessions.detectIntent

  Parameters :

  session

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

  Location : path

  Description : Required. The name of the session this query is sent to. Format: `projects//agent/sessions/`, or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment (`Environment ID` might be referred to as environment name at some places). If `User ID` is not specified, we are using "-". It's up to the API caller to choose an appropriate `Session ID` and `User Id`. They can be a random number or some type of user and session identifiers (preferably hashed). The length of the `Session ID` and `User ID` must not exceed 36 characters. For more information, see the [API interactions guide](https://cloud.google.com/dialogflow/docs/api-overview). Note: Always use agent versions for production traffic. See [Versions and environments](https://cloud.google.com/dialogflow/es/docs/agents-versions).

  Required : Yes

  Type : string

• ▼ ▲ dialogflow.projects.locations.agent.sessions.deleteContexts

  Parameters :

  parent

  Required : Yes

  Location : path

  Type : string

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

  Description : Required. The name of the session to delete all contexts from. Format: `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.

• ▼ ▲ dialogflow.projects.locations.agent.versions.list

  Parameters :

  parent

  Required : Yes

  Description : Required. The agent to list all versions from. Supported formats: - `projects//agent` - `projects//locations//agent`

  Location : path

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

  Type : string

  pageToken

  Description : Optional. The next_page_token value returned from a previous list request.

  Location : query

  Type : string

  pageSize

  Format : int32

  Type : integer

  Description : Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.

  Location : query

• ▼ ▲ dialogflow.projects.locations.agent.versions.patch

  Parameters :

  name

  Description : Output only. The unique identifier of this agent version. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`

  Pattern : ^projects/[^/]+/locations/[^/]+/agent/versions/[^/]+$

  Required : Yes

  Type : string

  Location : path

  updateMask

  Location : query

  Description : Required. The mask to control which fields get updated.

  Type : string

  Format : google-fieldmask

• ▼ ▲ dialogflow.projects.locations.agent.versions.get

  Parameters :

  name

  Pattern : ^projects/[^/]+/locations/[^/]+/agent/versions/[^/]+$

  Required : Yes

  Type : string

  Location : path

  Description : Required. The name of the version. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`

• ▼ ▲ dialogflow.projects.locations.agent.versions.create

  Parameters :

  parent

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

  Type : string

  Required : Yes

  Location : path

  Description : Required. The agent to create a version for. Supported formats: - `projects//agent` - `projects//locations//agent`

• ▼ ▲ dialogflow.projects.locations.agent.versions.delete

  Parameters :

  name

  Pattern : ^projects/[^/]+/locations/[^/]+/agent/versions/[^/]+$

  Location : path

  Type : string

  Required : Yes

  Description : Required. The name of the version to delete. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`

• ▼ ▲ dialogflow.projects.locations.conversations.create

  Parameters :

  conversationId

  Description : Optional. Identifier of the conversation. Generally it's auto generated by Google. Only set it if you cannot wait for the response to return a auto-generated one to you. The conversation ID must be compliant with the regression formula `a-zA-Z*` with the characters length in range of [3,64]. If the field is provided, the caller is responsible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.

  Location : query

  Type : string

  parent

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

  Type : string

  Description : Required. Resource identifier of the project creating the conversation. Format: `projects//locations/`.

  Location : path

  Required : Yes

• ▼ ▲ dialogflow.projects.locations.conversations.complete

  Parameters :

  name

  Location : path

  Type : string

  Required : Yes

  Description : Required. Resource identifier of the conversation to close. Format: `projects//locations//conversations/`.

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

• ▼ ▲ dialogflow.projects.locations.conversations.get

  Parameters :

  name

  Description : Required. The name of the conversation. Format: `projects//locations//conversations/`.

  Required : Yes

  Location : path

  Type : string

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

• ▼ ▲ dialogflow.projects.locations.conversations.list

  Parameters :

  filter

  Location : query

  Type : string

  Description : Optional. A filter expression that filters conversations listed in the response. Only `lifecycle_state` can be filtered on in this way. For example, the following expression only returns `COMPLETED` conversations: `lifecycle_state = "COMPLETED"` For more information about filtering, see [API Filtering](https://aip.dev/160).

  parent

  Required : Yes

  Description : Required. The project from which to list all conversation. Format: `projects//locations/`.

  Type : string

  Location : path

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

  pageSize

  Type : integer

  Format : int32

  Description : Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.

  Location : query

  pageToken

  Location : query

  Type : string

  Description : Optional. The next_page_token value returned from a previous list request.

• ▼ ▲ dialogflow.projects.locations.conversations.ingestContextReferences

  Parameters :

  conversation

  Location : path

  Type : string

  Required : Yes

  Description : Required. Resource identifier of the conversation to ingest context information for. Format: `projects//locations//conversations/`.

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

• ▼ ▲ dialogflow.projects.locations.conversations.suggestions.generate

  Parameters :

  conversation

  Location : path

  Type : string

  Required : Yes

  Description : Required. The conversation for which the suggestions are generated. Format: `projects//locations//conversations/`. The conversation must be created with a conversation profile which has generators configured in it to be able to get suggestions.

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

• ▼ ▲ dialogflow.projects.locations.conversations.suggestions.suggestConversationSummary

  Parameters :

  conversation

  Description : Required. The conversation to fetch suggestion for. Format: `projects//locations//conversations/`.

  Required : Yes

  Type : string

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

  Location : path

• ▼ ▲ dialogflow.projects.locations.conversations.suggestions.searchKnowledge

  Parameters :

  conversation

  Required : Yes

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

  Description : Optional. The conversation (between human agent and end user) where the search request is triggered. Format: `projects//locations//conversations/`.

  Location : path

  Type : string

• ▼ ▲ dialogflow.projects.locations.conversations.participants.patch

  Parameters :

  updateMask

  Location : query

  Description : Required. The mask to specify which fields to update.

  Format : google-fieldmask

  Type : string

  name

  Location : path

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

  Type : string

  Required : Yes

  Description : Optional. The unique identifier of this participant. Format: `projects//locations//conversations//participants/`.

• ▼ ▲ dialogflow.projects.locations.conversations.participants.get

  Parameters :

  name

  Required : Yes

  Location : path

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

  Type : string

  Description : Required. The name of the participant. Format: `projects//locations//conversations//participants/`.

• ▼ ▲ dialogflow.projects.locations.conversations.participants.analyzeContent

  Parameters :

  participant

  Location : path

  Type : string

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

  Required : Yes

  Description : Required. The name of the participant this text comes from. Format: `projects//locations//conversations//participants/`.

• ▼ ▲ dialogflow.projects.locations.conversations.participants.create

  Parameters :

  parent

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

  Type : string

  Required : Yes

  Description : Required. Resource identifier of the conversation adding the participant. Format: `projects//locations//conversations/`.

  Location : path

• ▼ ▲ dialogflow.projects.locations.conversations.participants.list

  Parameters :

  parent

  Type : string

  Required : Yes

  Description : Required. The conversation to list all participants from. Format: `projects//locations//conversations/`.

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

  Location : path

  pageToken

  Type : string

  Description : Optional. The next_page_token value returned from a previous list request.

  Location : query

  pageSize

  Format : int32

  Type : integer

  Location : query

  Description : Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.

• ▼ ▲ dialogflow.projects.locations.conversations.participants.suggestions.suggestArticles

  Parameters :

  parent

  Required : Yes

  Type : string

  Description : Required. The name of the participant to fetch suggestion for. Format: `projects//locations//conversations//participants/`.

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

  Location : path

• ▼ ▲ dialogflow.projects.locations.conversations.participants.suggestions.suggestFaqAnswers

  Parameters :

  parent

  Description : Required. The name of the participant to fetch suggestion for. Format: `projects//locations//conversations//participants/`.

  Type : string

  Location : path

  Required : Yes

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

• ▼ ▲ dialogflow.projects.locations.conversations.participants.suggestions.suggestKnowledgeAssist

  Parameters :

  parent

  Type : string

  Location : path

  Description : Required. The name of the participant to fetch suggestions for. Format: `projects//locations//conversations//participants/`.

  Required : Yes

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

• ▼ ▲ dialogflow.projects.locations.conversations.participants.suggestions.suggestSmartReplies

  Parameters :

  parent

  Location : path

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

  Required : Yes

  Description : Required. The name of the participant to fetch suggestion for. Format: `projects//locations//conversations//participants/`.

  Type : string

• ▼ ▲ dialogflow.projects.locations.conversations.messages.list

  Parameters :

  pageToken

  Type : string

  Description : Optional. The next_page_token value returned from a previous list request.

  Location : query

  parent

  Location : path

  Required : Yes

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

  Type : string

  Description : Required. The name of the conversation to list messages for. Format: `projects//locations//conversations/`

  filter

  Description : Optional. Filter on message fields. Currently predicates on `create_time` and `create_time_epoch_microseconds` are supported. `create_time` only support milliseconds accuracy. E.g., `create_time_epoch_microseconds > 1551790877964485` or `create_time > 2017-01-15T01:30:15.01Z`. For more information about filtering, see [API Filtering](https://aip.dev/160).

  Location : query

  Type : string

  pageSize

  Type : integer

  Description : Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.

  Location : query

  Format : int32

• ▼ ▲ dialogflow.projects.locations.suggestions.searchKnowledge

  Parameters :

  parent

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

  Required : Yes

  Location : path

  Description : Required. The parent resource contains the conversation profile Format: 'projects/' or `projects//locations/`.

  Type : string

• ▼ ▲ dialogflow.projects.locations.suggestions.generateStatelessSummary

  Parameters :

  parent

  Description : Required. The parent resource to charge for the Summary's generation. Format: `projects//locations/`.

  Type : string

  Required : Yes

  Location : path

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

• ▼ ▲ dialogflow.projects.locations.knowledgeBases.patch

  Parameters :

  name

  Required : Yes

  Description : The knowledge base resource name. The name must be empty when creating a knowledge base. Format: `projects//locations//knowledgeBases/`.

  Location : path

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

  Type : string

  updateMask

  Format : google-fieldmask

  Type : string

  Description : Optional. Not specified means `update all`. Currently, only `display_name` can be updated, an InvalidArgument will be returned for attempting to update other fields.

  Location : query

• ▼ ▲ dialogflow.projects.locations.knowledgeBases.delete

  Parameters :

  name

  Description : Required. The name of the knowledge base to delete. Format: `projects//locations//knowledgeBases/`.

  Type : string

  Location : path

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

  Required : Yes

  force

  Type : boolean

  Location : query

  Description : Optional. Force deletes the knowledge base. When set to true, any documents in the knowledge base are also deleted.

• ▼ ▲ dialogflow.projects.locations.knowledgeBases.get

  Parameters :

  name

  Location : path

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

  Required : Yes

  Description : Required. The name of the knowledge base to retrieve. Format `projects//locations//knowledgeBases/`.

  Type : string

• ▼ ▲ dialogflow.projects.locations.knowledgeBases.list

  Parameters :

  pageSize

  Format : int32

  Location : query

  Description : The maximum number of items to return in a single page. By default 10 and at most 100.

  Type : integer

  parent

  Type : string

  Description : Required. The project to list of knowledge bases for. Format: `projects//locations/`.

  Location : path

  Required : Yes

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

  pageToken

  Description : The next_page_token value returned from a previous list request.

  Location : query

  Type : string

  filter

  Location : query

  Type : string

  Description : The filter expression used to filter knowledge bases returned by the list method. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * display_name with has(:) operator * language_code with equals(=) operator Examples: * 'language_code=en-us' matches knowledge bases with en-us language code. * 'display_name:articles' matches knowledge bases whose display name contains "articles". * 'display_name:"Best Articles"' matches knowledge bases whose display name contains "Best Articles". * 'language_code=en-gb AND display_name=articles' matches all knowledge bases whose display name contains "articles" and whose language code is "en-gb". Note: An empty filter string (i.e. "") is a no-op and will result in no filtering. For more information about filtering, see [API Filtering](https://aip.dev/160).

• ▼ ▲ dialogflow.projects.locations.knowledgeBases.create

  Parameters :

  parent

  Type : string

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

  Required : Yes

  Location : path

  Description : Required. The project to create a knowledge base for. Format: `projects//locations/`.

• ▼ ▲ dialogflow.projects.locations.knowledgeBases.documents.get

  Parameters :

  name

  Location : path

  Description : Required. The name of the document to retrieve. Format `projects//locations//knowledgeBases//documents/`.

  Pattern : ^projects/[^/]+/locations/[^/]+/knowledgeBases/[^/]+/documents/[^/]+$

  Type : string

  Required : Yes

• ▼ ▲ dialogflow.projects.locations.knowledgeBases.documents.reload

  Parameters :

  name

  Pattern : ^projects/[^/]+/locations/[^/]+/knowledgeBases/[^/]+/documents/[^/]+$

  Required : Yes

  Type : string

  Description : Required. The name of the document to reload. Format: `projects//locations//knowledgeBases//documents/`

  Location : path

• ▼ ▲ dialogflow.projects.locations.knowledgeBases.documents.delete

  Parameters :

  name

  Type : string

  Pattern : ^projects/[^/]+/locations/[^/]+/knowledgeBases/[^/]+/documents/[^/]+$

  Required : Yes

  Location : path

  Description : Required. The name of the document to delete. Format: `projects//locations//knowledgeBases//documents/`.

• ▼ ▲ dialogflow.projects.locations.knowledgeBases.documents.export

  Parameters :

  name

  Pattern : ^projects/[^/]+/locations/[^/]+/knowledgeBases/[^/]+/documents/[^/]+$

  Required : Yes

  Type : string

  Description : Required. The name of the document to export. Format: `projects//locations//knowledgeBases//documents/`.

  Location : path

• ▼ ▲ dialogflow.projects.locations.knowledgeBases.documents.patch

  Parameters :

  updateMask

  Format : google-fieldmask

  Type : string

  Location : query

  Description : Optional. Not specified means `update all`. Currently, only `display_name` can be updated, an InvalidArgument will be returned for attempting to update other fields.

  name

  Required : Yes

  Pattern : ^projects/[^/]+/locations/[^/]+/knowledgeBases/[^/]+/documents/[^/]+$

  Type : string

  Description : Optional. The document resource name. The name must be empty when creating a document. Format: `projects//locations//knowledgeBases//documents/`.

  Location : path

• ▼ ▲ dialogflow.projects.locations.knowledgeBases.documents.import

  Parameters :

  parent

  Description : Required. The knowledge base to import documents into. Format: `projects//locations//knowledgeBases/`.

  Location : path

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

  Type : string

  Required : Yes

• ▼ ▲ dialogflow.projects.locations.knowledgeBases.documents.list

  Parameters :

  parent

  Location : path

  Description : Required. The knowledge base to list all documents for. Format: `projects//locations//knowledgeBases/`.

  Required : Yes

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

  Type : string

  pageSize

  Format : int32

  Type : integer

  Location : query

  Description : The maximum number of items to return in a single page. By default 10 and at most 100.

  pageToken

  Description : The next_page_token value returned from a previous list request.

  Location : query

  Type : string

  filter

  Location : query

  Type : string

  Description : The filter expression used to filter documents returned by the list method. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * knowledge_types with has(:) operator * display_name with has(:) operator * state with equals(=) operator Examples: * "knowledge_types:FAQ" matches documents with FAQ knowledge type. * "display_name:customer" matches documents whose display name contains "customer". * "state=ACTIVE" matches documents with ACTIVE state. * "knowledge_types:FAQ AND state=ACTIVE" matches all active FAQ documents. For more information about filtering, see [API Filtering](https://aip.dev/160).

• ▼ ▲ dialogflow.projects.locations.knowledgeBases.documents.create

  Parameters :

  parent

  Description : Required. The knowledge base to create a document for. Format: `projects//locations//knowledgeBases/`.

  Location : path

  Required : Yes

  Type : string

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

• ▼ ▲ dialogflow.projects.locations.statelessSuggestion.generate

  Parameters :

  parent

  Location : path

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

  Type : string

  Description : Required. The parent resource to charge for the Suggestion's generation. Format: `projects//locations/`.

  Required : Yes

• ▼ ▲ dialogflow.projects.locations.generators.list

  Parameters :

  pageSize

  Format : int32

  Location : query

  Description : Optional. Maximum number of conversation models to return in a single page. Default to 10.

  Type : integer

  pageToken

  Description : Optional. The next_page_token value returned from a previous list request.

  Location : query

  Type : string

  parent

  Location : path

  Description : Required. The project/location to list generators for. Format: `projects//locations/`

  Type : string

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

  Required : Yes

• ▼ ▲ dialogflow.projects.locations.generators.delete

  Parameters :

  name

  Required : Yes

  Description : Required. The generator resource name to delete. Format: `projects//locations//generators/`

  Location : path

  Type : string

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

• ▼ ▲ dialogflow.projects.locations.generators.get

  Parameters :

  name

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

  Type : string

  Location : path

  Description : Required. The generator resource name to retrieve. Format: `projects//locations//generators/`

  Required : Yes

• ▼ ▲ dialogflow.projects.locations.generators.create

  Parameters :

  parent

  Required : Yes

  Description : Required. The project/location to create generator for. Format: `projects//locations/`

  Type : string

  Location : path

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

  generatorId

  Location : query

  Type : string

  Description : Optional. The ID to use for the generator, which will become the final component of the generator's resource name. The generator ID must be compliant with the regression formula `a-zA-Z*` with the characters length in range of [3,64]. If the field is not provided, an Id will be auto-generated. If the field is provided, the caller is responsible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.

• ▼ ▲ dialogflow.projects.locations.generators.patch

  Parameters :

  name

  Location : path

  Description : Output only. Identifier. The resource name of the generator. Format: `projects//locations//generators/`

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

  Required : Yes

  Type : string

  updateMask

  Location : query

  Description : Optional. The list of fields to update.

  Type : string

  Format : google-fieldmask

• ▼ ▲ dialogflow.projects.locations.generators.evaluations.delete

  Parameters :

  name

  Required : Yes

  Location : path

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

  Description : Required. The generator evaluation resource name. Format: `projects//locations//generators// evaluations/`

  Type : string

• ▼ ▲ dialogflow.projects.locations.generators.evaluations.get

  Parameters :

  name

  Description : Required. The generator evaluation resource name. Format: `projects//locations//generators//evaluations/`

  Location : path

  Type : string

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

  Required : Yes

• ▼ ▲ dialogflow.projects.locations.generators.evaluations.list

  Parameters :

  parent

  Type : string

  Required : Yes

  Description : Required. The generator resource name. Format: `projects//locations//generators/` Wildcard value `-` is supported on generator_id to list evaluations across all generators under same project.

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

  Location : path

  pageSize

  Location : query

  Type : integer

  Description : Optional. Maximum number of evaluations to return in a single page. By default 100 and at most 1000.

  Format : int32

  pageToken

  Type : string

  Location : query

  Description : Optional. The next_page_token value returned from a previous list request.

• ▼ ▲ dialogflow.projects.locations.generators.evaluations.create

  Parameters :

  parent

  Required : Yes

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

  Description : Required. The generator resource name. Format: `projects//locations//generators/`

  Type : string

  Location : path

• ▼ ▲ dialogflow.projects.locations.tools.create

  Parameters :

  parent

  Type : string

  Location : path

  Description : Required. The project/location to create tool for. Format: `projects//locations/`

  Required : Yes

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

  toolId

  Description : Optional. The ID to use for the tool, which will become the final component of the tool's resource name. The tool ID must be compliant with the regression formula `a-zA-Z*` with the characters length in range of [3,64]. If the field is not provide, an Id will be auto-generated. If the field is provided, the caller is responsible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.

  Type : string

  Location : query

• ▼ ▲ dialogflow.projects.locations.tools.list

  Parameters :

  parent

  Description : Required. The project/location to list tools for. Format: `projects//locations/`

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

  Location : path

  Required : Yes

  Type : string

  pageSize

  Location : query

  Description : Optional. Maximum number of conversation models to return in a single page. Default to 10.

  Type : integer

  Format : int32

  pageToken

  Type : string

  Location : query

  Description : Optional. The next_page_token value returned from a previous list request.

• ▼ ▲ dialogflow.projects.locations.tools.get

  Parameters :

  name

  Type : string

  Description : Required. The tool resource name to retrieve. Format: `projects//locations//tools/`

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

  Required : Yes

  Location : path

• ▼ ▲ dialogflow.projects.locations.tools.delete

  Parameters :

  name

  Type : string

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

  Description : Required. The tool resource name to delete. Format: `projects//locations//tools/`

  Location : path

  Required : Yes

• ▼ ▲ dialogflow.projects.locations.tools.patch

  Parameters :

  updateMask

  Format : google-fieldmask

  Location : query

  Description : Optional. The list of fields to update.

  Type : string

  name

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

  Description : Output only. Identifier. The resource name of the tool. Format: `projects//locations//tools/`.

  Type : string

  Required : Yes

  Location : path

• ▼ ▲ dialogflow.projects.locations.answerRecords.list

  Parameters :

  parent

  Type : string

  Description : Required. The project to list all answer records for in reverse chronological order. Format: `projects//locations/`.

  Location : path

  Required : Yes

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

  pageToken

  Type : string

  Location : query

  Description : Optional. The ListAnswerRecordsResponse.next_page_token value returned from a previous list request used to continue listing on the next page.

  pageSize

  Type : integer

  Format : int32

  Location : query

  Description : Optional. The maximum number of records to return in a single page. The server may return fewer records than this. If unspecified, we use 10. The maximum is 100.

  filter

  Location : query

  Description : Optional. Filters to restrict results to specific answer records. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * conversation_id with equals(=) operator Examples: * `conversation_id=bar` matches answer records in the `projects/foo/locations/global/conversations/bar` conversation (assuming the parent is `projects/foo/locations/global`). For more information about filtering, see [API Filtering](https://aip.dev/160).

  Type : string

• ▼ ▲ dialogflow.projects.locations.answerRecords.patch

  Parameters :

  name

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

  Type : string

  Required : Yes

  Description : The unique identifier of this answer record. Format: `projects//locations//answerRecords/`.

  Location : path

  updateMask

  Format : google-fieldmask

  Location : query

  Type : string

  Description : Required. The mask to control which fields get updated.

• ▼ ▲ dialogflow.projects.locations.operations.get

  Parameters :

  name

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

  Description : The name of the operation resource.

  Required : Yes

  Type : string

  Location : path

• ▼ ▲ dialogflow.projects.locations.operations.list

  Parameters :

  pageSize

  Format : int32

  Description : The standard list page size.

  Type : integer

  Location : query

  filter

  Type : string

  Location : query

  Description : The standard list filter.

  pageToken

  Type : string

  Description : The standard list page token.

  Location : query

  name

  Required : Yes

  Type : string

  Description : The name of the operation's parent resource.

  Location : path

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

  returnPartialSuccess

  Location : query

  Description : When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.

  Type : boolean

• ▼ ▲ dialogflow.projects.locations.operations.cancel

  Parameters :

  name

  Required : Yes

  Description : The name of the operation resource to be cancelled.

  Type : string

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

  Location : path

• ▼ ▲ dialogflow.projects.locations.encryptionSpec.initialize

  Parameters :

  name

  Description : Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec

  Type : string

  Location : path

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

  Required : Yes

• ▼ ▲ dialogflow.projects.suggestions.generateStatelessSummary

  Parameters :

  parent

  Description : Required. The parent resource to charge for the Summary's generation. Format: `projects//locations/`.

  Type : string

  Required : Yes

  Location : path

  Pattern : ^projects/[^/]+$

• ▼ ▲ dialogflow.projects.suggestions.searchKnowledge

  Parameters :

  parent

  Type : string

  Pattern : ^projects/[^/]+$

  Description : Required. The parent resource contains the conversation profile Format: 'projects/' or `projects//locations/`.

  Location : path

  Required : Yes

• ▼ ▲ dialogflow.projects.conversationDatasets.get

  Parameters :

  name

  Pattern : ^projects/[^/]+/conversationDatasets/[^/]+$

  Location : path

  Description : Required. The conversation dataset to retrieve. Format: `projects//locations//conversationDatasets/`

  Required : Yes

  Type : string

• ▼ ▲ dialogflow.projects.conversationDatasets.importConversationData

  Parameters :

  name

  Type : string

  Location : path

  Required : Yes

  Pattern : ^projects/[^/]+/conversationDatasets/[^/]+$

  Description : Required. Dataset resource name. Format: `projects//locations//conversationDatasets/`

• ▼ ▲ dialogflow.projects.conversationDatasets.list

  Parameters :

  pageToken

  Type : string

  Description : Optional. The next_page_token value returned from a previous list request.

  Location : query

  parent

  Pattern : ^projects/[^/]+$

  Description : Required. The project and location name to list all conversation datasets for. Format: `projects//locations/`

  Type : string

  Location : path

  Required : Yes

  pageSize

  Type : integer

  Format : int32

  Location : query

  Description : Optional. Maximum number of conversation datasets to return in a single page. By default 100 and at most 1000.

• ▼ ▲ dialogflow.projects.generators.list

  Parameters :

  pageToken

  Description : Optional. The next_page_token value returned from a previous list request.

  Type : string

  Location : query

  pageSize

  Location : query

  Description : Optional. Maximum number of conversation models to return in a single page. Default to 10.

  Format : int32

  Type : integer

  parent

  Location : path

  Required : Yes

  Pattern : ^projects/[^/]+$

  Type : string

  Description : Required. The project/location to list generators for. Format: `projects//locations/`

• ▼ ▲ dialogflow.projects.generators.create

  Parameters :

  parent

  Location : path

  Type : string

  Required : Yes

  Pattern : ^projects/[^/]+$

  Description : Required. The project/location to create generator for. Format: `projects//locations/`

  generatorId

  Location : query

  Description : Optional. The ID to use for the generator, which will become the final component of the generator's resource name. The generator ID must be compliant with the regression formula `a-zA-Z*` with the characters length in range of [3,64]. If the field is not provided, an Id will be auto-generated. If the field is provided, the caller is responsible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.

  Type : string

• ▼ ▲ dialogflow.projects.conversations.create

  Parameters :

  parent

  Type : string

  Required : Yes

  Description : Required. Resource identifier of the project creating the conversation. Format: `projects//locations/`.

  Pattern : ^projects/[^/]+$

  Location : path

  conversationId

  Type : string

  Description : Optional. Identifier of the conversation. Generally it's auto generated by Google. Only set it if you cannot wait for the response to return a auto-generated one to you. The conversation ID must be compliant with the regression formula `a-zA-Z*` with the characters length in range of [3,64]. If the field is provided, the caller is responsible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.

  Location : query

• ▼ ▲ dialogflow.projects.conversations.list

  Parameters :

  pageSize

  Format : int32

  Location : query

  Type : integer

  Description : Optional. The maximum number of items 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

  Location : path

  Type : string

  Description : Required. The project from which to list all conversation. Format: `projects//locations/`.

  Pattern : ^projects/[^/]+$

  filter

  Location : query

  Description : Optional. A filter expression that filters conversations listed in the response. Only `lifecycle_state` can be filtered on in this way. For example, the following expression only returns `COMPLETED` conversations: `lifecycle_state = "COMPLETED"` For more information about filtering, see [API Filtering](https://aip.dev/160).

  Type : string

• ▼ ▲ dialogflow.projects.conversations.get

  Parameters :

  name

  Description : Required. The name of the conversation. Format: `projects//locations//conversations/`.

  Location : path

  Type : string

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

  Required : Yes

• ▼ ▲ dialogflow.projects.conversations.complete

  Parameters :

  name

  Type : string

  Required : Yes

  Location : path

  Description : Required. Resource identifier of the conversation to close. Format: `projects//locations//conversations/`.

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

• ▼ ▲ dialogflow.projects.conversations.participants.create

  Parameters :

  parent

  Location : path

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

  Type : string

  Description : Required. Resource identifier of the conversation adding the participant. Format: `projects//locations//conversations/`.

  Required : Yes

• ▼ ▲ dialogflow.projects.conversations.participants.get

  Parameters :

  name

  Description : Required. The name of the participant. Format: `projects//locations//conversations//participants/`.

  Pattern : ^projects/[^/]+/conversations/[^/]+/participants/[^/]+$

  Type : string

  Location : path

  Required : Yes

• ▼ ▲ dialogflow.projects.conversations.participants.analyzeContent

  Parameters :

  participant

  Pattern : ^projects/[^/]+/conversations/[^/]+/participants/[^/]+$

  Location : path

  Required : Yes

  Description : Required. The name of the participant this text comes from. Format: `projects//locations//conversations//participants/`.

  Type : string

• ▼ ▲ dialogflow.projects.conversations.participants.list

  Parameters :

  pageToken

  Location : query

  Description : Optional. The next_page_token value returned from a previous list request.

  Type : string

  parent

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

  Description : Required. The conversation to list all participants from. Format: `projects//locations//conversations/`.

  Required : Yes

  Location : path

  Type : string

  pageSize

  Location : query

  Format : int32

  Description : Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.

  Type : integer

• ▼ ▲ dialogflow.projects.conversations.participants.patch

  Parameters :

  name

  Type : string

  Required : Yes

  Location : path

  Pattern : ^projects/[^/]+/conversations/[^/]+/participants/[^/]+$

  Description : Optional. The unique identifier of this participant. Format: `projects//locations//conversations//participants/`.

  updateMask

  Type : string

  Description : Required. The mask to specify which fields to update.

  Format : google-fieldmask

  Location : query

• ▼ ▲ dialogflow.projects.conversations.participants.suggestions.suggestFaqAnswers

  Parameters :

  parent

  Required : Yes

  Location : path

  Type : string

  Description : Required. The name of the participant to fetch suggestion for. Format: `projects//locations//conversations//participants/`.

  Pattern : ^projects/[^/]+/conversations/[^/]+/participants/[^/]+$

• ▼ ▲ dialogflow.projects.conversations.participants.suggestions.suggestArticles

  Parameters :

  parent

  Description : Required. The name of the participant to fetch suggestion for. Format: `projects//locations//conversations//participants/`.

  Required : Yes

  Pattern : ^projects/[^/]+/conversations/[^/]+/participants/[^/]+$

  Location : path

  Type : string

• ▼ ▲ dialogflow.projects.conversations.participants.suggestions.suggestSmartReplies

  Parameters :

  parent

  Type : string

  Description : Required. The name of the participant to fetch suggestion for. Format: `projects//locations//conversations//participants/`.

  Pattern : ^projects/[^/]+/conversations/[^/]+/participants/[^/]+$

  Required : Yes

  Location : path

• ▼ ▲ dialogflow.projects.conversations.participants.suggestions.suggestKnowledgeAssist

  Parameters :

  parent

  Description : Required. The name of the participant to fetch suggestions for. Format: `projects//locations//conversations//participants/`.

  Pattern : ^projects/[^/]+/conversations/[^/]+/participants/[^/]+$

  Location : path

  Required : Yes

  Type : string

• ▼ ▲ dialogflow.projects.conversations.messages.list

  Parameters :

  pageSize

  Description : Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.

  Format : int32

  Location : query

  Type : integer

  filter

  Location : query

  Type : string

  Description : Optional. Filter on message fields. Currently predicates on `create_time` and `create_time_epoch_microseconds` are supported. `create_time` only support milliseconds accuracy. E.g., `create_time_epoch_microseconds > 1551790877964485` or `create_time > 2017-01-15T01:30:15.01Z`. For more information about filtering, see [API Filtering](https://aip.dev/160).

  parent

  Location : path

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

  Description : Required. The name of the conversation to list messages for. Format: `projects//locations//conversations/`

  Required : Yes

  Type : string

  pageToken

  Type : string

  Description : Optional. The next_page_token value returned from a previous list request.

  Location : query

• ▼ ▲ dialogflow.projects.conversations.suggestions.generate

  Parameters :

  conversation

  Location : path

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

  Description : Required. The conversation for which the suggestions are generated. Format: `projects//locations//conversations/`. The conversation must be created with a conversation profile which has generators configured in it to be able to get suggestions.

  Type : string

  Required : Yes

• ▼ ▲ dialogflow.projects.conversations.suggestions.suggestConversationSummary

  Parameters :

  conversation

  Required : Yes

  Type : string

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

  Location : path

  Description : Required. The conversation to fetch suggestion for. Format: `projects//locations//conversations/`.

• ▼ ▲ dialogflow.projects.conversations.suggestions.searchKnowledge

  Parameters :

  conversation

  Required : Yes

  Description : Optional. The conversation (between human agent and end user) where the search request is triggered. Format: `projects//locations//conversations/`.

  Type : string

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

  Location : path

• ▼ ▲ dialogflow.projects.conversationProfiles.patch

  Parameters :

  updateMask

  Description : Required. The mask to control which fields to update.

  Format : google-fieldmask

  Type : string

  Location : query

  name

  Pattern : ^projects/[^/]+/conversationProfiles/[^/]+$

  Location : path

  Type : string

  Description : The unique identifier of this conversation profile. Format: `projects//locations//conversationProfiles/`.

  Required : Yes

• ▼ ▲ dialogflow.projects.conversationProfiles.get

  Parameters :

  name

  Required : Yes

  Description : Required. The resource name of the conversation profile. Format: `projects//locations//conversationProfiles/`.

  Type : string

  Pattern : ^projects/[^/]+/conversationProfiles/[^/]+$

  Location : path

• ▼ ▲ dialogflow.projects.conversationProfiles.delete

  Parameters :

  name

  Type : string

  Location : path

  Description : Required. The name of the conversation profile to delete. Format: `projects//locations//conversationProfiles/`.

  Pattern : ^projects/[^/]+/conversationProfiles/[^/]+$

  Required : Yes

• ▼ ▲ dialogflow.projects.conversationProfiles.list

  Parameters :

  pageSize

  Format : int32

  Location : query

  Description : The maximum number of items to return in a single page. By default 100 and at most 1000.

  Type : integer

  pageToken

  Location : query

  Type : string

  Description : The next_page_token value returned from a previous list request.

  parent

  Description : Required. The project to list all conversation profiles from. Format: `projects//locations/`.

  Location : path

  Pattern : ^projects/[^/]+$

  Type : string

  Required : Yes

• ▼ ▲ dialogflow.projects.conversationProfiles.create

  Parameters :

  parent

  Required : Yes

  Pattern : ^projects/[^/]+$

  Location : path

  Type : string

  Description : Required. The project to create a conversation profile for. Format: `projects//locations/`.

• ▼ ▲ dialogflow.projects.conversationProfiles.clearSuggestionFeatureConfig

  Parameters :

  conversationProfile

  Required : Yes

  Description : Required. The Conversation Profile to add or update the suggestion feature config. Format: `projects//locations//conversationProfiles/`.

  Pattern : ^projects/[^/]+/conversationProfiles/[^/]+$

  Location : path

  Type : string

• ▼ ▲ dialogflow.projects.conversationProfiles.setSuggestionFeatureConfig

  Parameters :

  conversationProfile

  Location : path

  Type : string

  Pattern : ^projects/[^/]+/conversationProfiles/[^/]+$

  Required : Yes

  Description : Required. The Conversation Profile to add or update the suggestion feature config. Format: `projects//locations//conversationProfiles/`.

• ▼ ▲ dialogflow.projects.agent.restore

  Parameters :

  parent

  Description : Required. The project that the agent to restore is associated with. Format: `projects/`.

  Pattern : ^projects/[^/]+$

  Location : path

  Required : Yes

  Type : string

• ▼ ▲ dialogflow.projects.agent.train

  Parameters :

  parent

  Pattern : ^projects/[^/]+$

  Type : string

  Required : Yes

  Location : path

  Description : Required. The project that the agent to train is associated with. Format: `projects/`.

• ▼ ▲ dialogflow.projects.agent.search

  Parameters :

  pageSize

  Location : query

  Format : int32

  Description : Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.

  Type : integer

  parent

  Pattern : ^projects/[^/]+$

  Type : string

  Required : Yes

  Location : path

  Description : Required. The project to list agents from. Format: `projects/`.

  pageToken

  Location : query

  Description : The next_page_token value returned from a previous list request.

  Type : string

• ▼ ▲ dialogflow.projects.agent.import

  Parameters :

  parent

  Description : Required. The project that the agent to import is associated with. Format: `projects/`.

  Location : path

  Required : Yes

  Type : string

  Pattern : ^projects/[^/]+$

• ▼ ▲ dialogflow.projects.agent.getValidationResult

  Parameters :

  languageCode

  Location : query

  Description : Optional. The language for which you want a validation result. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.

  Type : string

  parent

  Description : Required. The project that the agent is associated with. Format: `projects/`.

  Pattern : ^projects/[^/]+$

  Type : string

  Required : Yes

  Location : path

• ▼ ▲ dialogflow.projects.agent.getFulfillment

  Parameters :

  name

  Pattern : ^projects/[^/]+/agent/fulfillment$

  Required : Yes

  Location : path

  Description : Required. The name of the fulfillment. Format: `projects//agent/fulfillment`.

  Type : string

• ▼ ▲ dialogflow.projects.agent.export

  Parameters :

  parent

  Location : path

  Required : Yes

  Pattern : ^projects/[^/]+$

  Type : string

  Description : Required. The project that the agent to export is associated with. Format: `projects/`.

• ▼ ▲ dialogflow.projects.agent.updateFulfillment

  Parameters :

  updateMask

  Format : google-fieldmask

  Type : string

  Description : Required. The mask to control which fields get updated. If the mask is not present, all fields will be updated.

  Location : query

  name

  Pattern : ^projects/[^/]+/agent/fulfillment$

  Description : Required. The unique identifier of the fulfillment. Supported formats: - `projects//agent/fulfillment` - `projects//locations//agent/fulfillment` This field is not used for Fulfillment in an Environment.

  Type : string

  Required : Yes

  Location : path

• ▼ ▲ dialogflow.projects.agent.intents.create

  Parameters :

  languageCode

  Location : query

  Type : string

  Description : Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).

  parent

  Required : Yes

  Location : path

  Pattern : ^projects/[^/]+/agent$

  Description : Required. The agent to create a intent for. Format: `projects//agent`.

  Type : string

  intentView

  Description : Optional. The resource view to apply to the returned intent.

  Enum :

  • INTENT_VIEW_UNSPECIFIED
  • INTENT_VIEW_FULL

  Enum Descriptions :

  • Training phrases field is not populated in the response.
  • All fields are populated.

  Location : query

  Type : string

• ▼ ▲ dialogflow.projects.agent.intents.get

  Parameters :

  languageCode

  Type : string

  Location : query

  Description : Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).

  intentView

  Type : string

  Enum :

  • INTENT_VIEW_UNSPECIFIED
  • INTENT_VIEW_FULL

  Location : query

  Description : Optional. The resource view to apply to the returned intent.

  Enum Descriptions :

  • Training phrases field is not populated in the response.
  • All fields are populated.

  name

  Type : string

  Required : Yes

  Pattern : ^projects/[^/]+/agent/intents/[^/]+$

  Location : path

  Description : Required. The name of the intent. Format: `projects//agent/intents/`.

• ▼ ▲ dialogflow.projects.agent.intents.list

  Parameters :

  pageToken

  Description : Optional. The next_page_token value returned from a previous list request.

  Type : string

  Location : query

  languageCode

  Type : string

  Location : query

  Description : Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).

  pageSize

  Format : int32

  Type : integer

  Location : query

  Description : Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.

  intentView

  Enum :

  • INTENT_VIEW_UNSPECIFIED
  • INTENT_VIEW_FULL

  Location : query

  Type : string

  Description : Optional. The resource view to apply to the returned intent.

  Enum Descriptions :

  • Training phrases field is not populated in the response.
  • All fields are populated.

  parent

  Required : Yes

  Pattern : ^projects/[^/]+/agent$

  Location : path

  Description : Required. The agent to list all intents from. Format: `projects//agent` or `projects//locations//agent`. Alternatively, you can specify the environment to list intents for. Format: `projects//agent/environments/` or `projects//locations//agent/environments/`. Note: training phrases of the intents will not be returned for non-draft environment.

  Type : string

• ▼ ▲ dialogflow.projects.agent.intents.batchUpdate

  Parameters :

  parent

  Pattern : ^projects/[^/]+/agent$

  Required : Yes

  Type : string

  Location : path

  Description : Required. The name of the agent to update or create intents in. Format: `projects//agent`.

• ▼ ▲ dialogflow.projects.agent.intents.delete

  Parameters :

  name

  Type : string

  Pattern : ^projects/[^/]+/agent/intents/[^/]+$

  Description : Required. The name of the intent to delete. If this intent has direct or indirect followup intents, we also delete them. Format: `projects//agent/intents/`.

  Location : path

  Required : Yes

• ▼ ▲ dialogflow.projects.agent.intents.patch

  Parameters :

  updateMask

  Location : query

  Format : google-fieldmask

  Description : Optional. The mask to control which fields get updated.

  Type : string

  intentView

  Location : query

  Enum :

  • INTENT_VIEW_UNSPECIFIED
  • INTENT_VIEW_FULL

  Type : string

  Description : Optional. The resource view to apply to the returned intent.

  Enum Descriptions :

  • Training phrases field is not populated in the response.
  • All fields are populated.

  name

  Required : Yes

  Description : Optional. The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Format: `projects//agent/intents/`.

  Type : string

  Location : path

  Pattern : ^projects/[^/]+/agent/intents/[^/]+$

  languageCode

  Location : query

  Type : string

  Description : Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).

• ▼ ▲ dialogflow.projects.agent.intents.batchDelete

  Parameters :

  parent

  Required : Yes

  Description : Required. The name of the agent to delete all entities types for. Format: `projects//agent`.

  Type : string

  Pattern : ^projects/[^/]+/agent$

  Location : path

• ▼ ▲ dialogflow.projects.agent.entityTypes.batchUpdate

  Parameters :

  parent

  Required : Yes

  Location : path

  Pattern : ^projects/[^/]+/agent$

  Description : Required. The name of the agent to update or create entity types in. Format: `projects//agent`.

  Type : string

• ▼ ▲ dialogflow.projects.agent.entityTypes.batchDelete

  Parameters :

  parent

  Description : Required. The name of the agent to delete all entities types for. Format: `projects//agent`.

  Required : Yes

  Pattern : ^projects/[^/]+/agent$

  Location : path

  Type : string

• ▼ ▲ dialogflow.projects.agent.entityTypes.get

  Parameters :

  languageCode

  Location : query

  Type : string

  Description : Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).

  name

  Type : string

  Required : Yes

  Pattern : ^projects/[^/]+/agent/entityTypes/[^/]+$

  Location : path

  Description : Required. The name of the entity type. Format: `projects//agent/entityTypes/`.

• ▼ ▲ dialogflow.projects.agent.entityTypes.list

  Parameters :

  parent

  Required : Yes

  Type : string

  Location : path

  Description : Required. The agent to list all entity types from. Format: `projects//agent`.

  Pattern : ^projects/[^/]+/agent$

  pageSize

  Location : query

  Type : integer

  Format : int32

  Description : Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.

  pageToken

  Description : Optional. The next_page_token value returned from a previous list request.

  Location : query

  Type : string

  languageCode

  Location : query

  Type : string

  Description : Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).

• ▼ ▲ dialogflow.projects.agent.entityTypes.delete

  Parameters :

  name

  Description : Required. The name of the entity type to delete. Format: `projects//agent/entityTypes/`.

  Location : path

  Pattern : ^projects/[^/]+/agent/entityTypes/[^/]+$

  Required : Yes

  Type : string

• ▼ ▲ dialogflow.projects.agent.entityTypes.patch

  Parameters :

  languageCode

  Location : query

  Description : Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).

  Type : string

  updateMask

  Format : google-fieldmask

  Description : Optional. The mask to control which fields get updated.

  Type : string

  Location : query

  name

  Required : Yes

  Pattern : ^projects/[^/]+/agent/entityTypes/[^/]+$

  Location : path

  Description : The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Format: `projects//agent/entityTypes/`.

  Type : string

• ▼ ▲ dialogflow.projects.agent.entityTypes.create

  Parameters :

  parent

  Required : Yes

  Type : string

  Pattern : ^projects/[^/]+/agent$

  Location : path

  Description : Required. The agent to create a entity type for. Format: `projects//agent`.

  languageCode

  Type : string

  Description : Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).

  Location : query

• ▼ ▲ dialogflow.projects.agent.entityTypes.entities.batchCreate

  Parameters :

  parent

  Required : Yes

  Description : Required. The name of the entity type to create entities in. Format: `projects//agent/entityTypes/`.

  Location : path

  Type : string

  Pattern : ^projects/[^/]+/agent/entityTypes/[^/]+$

• ▼ ▲ dialogflow.projects.agent.entityTypes.entities.batchUpdate

  Parameters :

  parent

  Type : string

  Location : path

  Pattern : ^projects/[^/]+/agent/entityTypes/[^/]+$

  Required : Yes

  Description : Required. The name of the entity type to update or create entities in. Format: `projects//agent/entityTypes/`.

• ▼ ▲ dialogflow.projects.agent.entityTypes.entities.batchDelete

  Parameters :

  parent

  Location : path

  Required : Yes

  Type : string

  Pattern : ^projects/[^/]+/agent/entityTypes/[^/]+$

  Description : Required. The name of the entity type to delete entries for. Format: `projects//agent/entityTypes/`.

• ▼ ▲ dialogflow.projects.agent.versions.create

  Parameters :

  parent

  Pattern : ^projects/[^/]+/agent$

  Description : Required. The agent to create a version for. Supported formats: - `projects//agent` - `projects//locations//agent`

  Type : string

  Location : path

  Required : Yes

• ▼ ▲ dialogflow.projects.agent.versions.list

  Parameters :

  parent

  Required : Yes

  Location : path

  Type : string

  Pattern : ^projects/[^/]+/agent$

  Description : Required. The agent to list all versions from. Supported formats: - `projects//agent` - `projects//locations//agent`

  pageToken

  Type : string

  Description : Optional. The next_page_token value returned from a previous list request.

  Location : query

  pageSize

  Type : integer

  Location : query

  Format : int32

  Description : Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.

• ▼ ▲ dialogflow.projects.agent.versions.get

  Parameters :

  name

  Type : string

  Location : path

  Pattern : ^projects/[^/]+/agent/versions/[^/]+$

  Required : Yes

  Description : Required. The name of the version. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`

• ▼ ▲ dialogflow.projects.agent.versions.patch

  Parameters :

  name

  Location : path

  Required : Yes

  Type : string

  Description : Output only. The unique identifier of this agent version. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`

  Pattern : ^projects/[^/]+/agent/versions/[^/]+$

  updateMask

  Format : google-fieldmask

  Type : string

  Description : Required. The mask to control which fields get updated.

  Location : query

• ▼ ▲ dialogflow.projects.agent.versions.delete

  Parameters :

  name

  Description : Required. The name of the version to delete. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`

  Required : Yes

  Location : path

  Type : string

  Pattern : ^projects/[^/]+/agent/versions/[^/]+$

• ▼ ▲ dialogflow.projects.agent.environments.list

  Parameters :

  parent

  Description : Required. The agent to list all environments from. Format: - `projects//agent` - `projects//locations//agent`

  Type : string

  Pattern : ^projects/[^/]+/agent$

  Location : path

  Required : Yes

  pageToken

  Location : query

  Description : Optional. The next_page_token value returned from a previous list request.

  Type : string

  pageSize

  Description : Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.

  Type : integer

  Format : int32

  Location : query

• ▼ ▲ dialogflow.projects.agent.environments.get

  Parameters :

  name

  Type : string

  Location : path

  Description : Required. The name of the environment. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/` The environment ID for the default environment is `-`.

  Pattern : ^projects/[^/]+/agent/environments/[^/]+$

  Required : Yes

• ▼ ▲ dialogflow.projects.agent.environments.getHistory

  Parameters :

  pageToken

  Description : Optional. The next_page_token value returned from a previous list request.

  Type : string

  Location : query

  pageSize

  Location : query

  Type : integer

  Format : int32

  Description : Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.

  parent

  Required : Yes

  Type : string

  Description : Required. The name of the environment to retrieve history for. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/` The environment ID for the default environment is `-`.

  Pattern : ^projects/[^/]+/agent/environments/[^/]+$

  Location : path

• ▼ ▲ dialogflow.projects.agent.environments.create

  Parameters :

  environmentId

  Location : query

  Type : string

  Description : Required. The unique id of the new environment.

  parent

  Type : string

  Pattern : ^projects/[^/]+/agent$

  Location : path

  Required : Yes

  Description : Required. The agent to create an environment for. Supported formats: - `projects//agent` - `projects//locations//agent`

• ▼ ▲ dialogflow.projects.agent.environments.delete

  Parameters :

  name

  Type : string

  Required : Yes

  Pattern : ^projects/[^/]+/agent/environments/[^/]+$

  Location : path

  Description : Required. The name of the environment to delete. / Format: - `projects//agent/environments/` - `projects//locations//agent/environments/` The environment ID for the default environment is `-`.

• ▼ ▲ dialogflow.projects.agent.environments.patch

  Parameters :

  updateMask

  Type : string

  Description : Required. The mask to control which fields get updated.

  Location : query

  Format : google-fieldmask

  name

  Required : Yes

  Pattern : ^projects/[^/]+/agent/environments/[^/]+$

  Location : path

  Description : Output only. The unique identifier of this agent environment. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/` The environment ID for the default environment is `-`.

  Type : string

  allowLoadToDraftAndDiscardChanges

  Location : query

  Type : boolean

  Description : Optional. This field is used to prevent accidental overwrite of the default environment, which is an operation that cannot be undone. To confirm that the caller desires this overwrite, this field must be explicitly set to true when updating the default environment (environment ID = `-`).

• ▼ ▲ dialogflow.projects.agent.environments.users.sessions.deleteContexts

  Parameters :

  parent

  Type : string

  Description : Required. The name of the session to delete all contexts from. Format: `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.

  Pattern : ^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+$

  Required : Yes

  Location : path

• ▼ ▲ dialogflow.projects.agent.environments.users.sessions.detectIntent

  Parameters :

  session

  Type : string

  Location : path

  Pattern : ^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+$

  Required : Yes

  Description : Required. The name of the session this query is sent to. Format: `projects//agent/sessions/`, or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment (`Environment ID` might be referred to as environment name at some places). If `User ID` is not specified, we are using "-". It's up to the API caller to choose an appropriate `Session ID` and `User Id`. They can be a random number or some type of user and session identifiers (preferably hashed). The length of the `Session ID` and `User ID` must not exceed 36 characters. For more information, see the [API interactions guide](https://cloud.google.com/dialogflow/docs/api-overview). Note: Always use agent versions for production traffic. See [Versions and environments](https://cloud.google.com/dialogflow/es/docs/agents-versions).

• ▼ ▲ dialogflow.projects.agent.environments.users.sessions.contexts.delete

  Parameters :

  name

  Location : path

  Description : Required. The name of the context to delete. Format: `projects//agent/sessions//contexts/` or `projects//agent/environments//users//sessions//contexts/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.

  Type : string

  Pattern : ^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/contexts/[^/]+$

  Required : Yes

• ▼ ▲ dialogflow.projects.agent.environments.users.sessions.contexts.get

  Parameters :

  name

  Location : path

  Pattern : ^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/contexts/[^/]+$

  Description : Required. The name of the context. Format: `projects//agent/sessions//contexts/` or `projects//agent/environments//users//sessions//contexts/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.

  Required : Yes

  Type : string

• ▼ ▲ dialogflow.projects.agent.environments.users.sessions.contexts.list

  Parameters :

  pageSize

  Description : Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.

  Location : query

  Type : integer

  Format : int32

  parent

  Required : Yes

  Pattern : ^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+$

  Type : string

  Location : path

  Description : Required. The session to list all contexts from. Format: `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.

  pageToken

  Type : string

  Location : query

  Description : Optional. The next_page_token value returned from a previous list request.

• ▼ ▲ dialogflow.projects.agent.environments.users.sessions.contexts.patch

  Parameters :

  name

  Description : Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. The `Context ID` is always converted to lowercase, may only contain characters in `a-zA-Z0-9_-%` and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`

  Pattern : ^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/contexts/[^/]+$

  Location : path

  Required : Yes

  Type : string

  updateMask

  Format : google-fieldmask

  Description : Optional. The mask to control which fields get updated.

  Location : query

  Type : string

• ▼ ▲ dialogflow.projects.agent.environments.users.sessions.contexts.create

  Parameters :

  parent

  Description : Required. The session to create a context for. Format: `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.

  Pattern : ^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+$

  Required : Yes

  Location : path

  Type : string

• ▼ ▲ dialogflow.projects.agent.environments.users.sessions.entityTypes.get

  Parameters :

  name

  Location : path

  Description : Required. The name of the session entity type. Format: `projects//agent/sessions//entityTypes/` or `projects//agent/environments//users//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.

  Pattern : ^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/entityTypes/[^/]+$

  Type : string

  Required : Yes

• ▼ ▲ dialogflow.projects.agent.environments.users.sessions.entityTypes.delete

  Parameters :

  name

  Location : path

  Pattern : ^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/entityTypes/[^/]+$

  Description : Required. The name of the entity type to delete. Format: `projects//agent/sessions//entityTypes/` or `projects//agent/environments//users//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.

  Type : string

  Required : Yes

• ▼ ▲ dialogflow.projects.agent.environments.users.sessions.entityTypes.list

  Parameters :

  pageToken

  Description : Optional. The next_page_token value returned from a previous list request.

  Type : string

  Location : query

  pageSize

  Type : integer

  Format : int32

  Description : Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.

  Location : query

  parent

  Location : path

  Type : string

  Required : Yes

  Description : Required. The session to list all session entity types from. Format: `projects//agent/sessions/` or `projects//agent/environments//users// sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.

  Pattern : ^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+$

• ▼ ▲ dialogflow.projects.agent.environments.users.sessions.entityTypes.create

  Parameters :

  parent

  Pattern : ^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+$

  Required : Yes

  Location : path

  Type : string

  Description : Required. The session to create a session entity type for. Format: `projects//agent/sessions/` or `projects//agent/environments//users// sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.

• ▼ ▲ dialogflow.projects.agent.environments.users.sessions.entityTypes.patch

  Parameters :

  name

  Type : string

  Pattern : ^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/entityTypes/[^/]+$

  Required : Yes

  Location : path

  Description : Required. The unique identifier of this session entity type. Format: `projects//agent/sessions//entityTypes/`, or `projects//agent/environments//users//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. `` must be the display name of an existing entity type in the same agent that will be overridden or supplemented.

  updateMask

  Description : Optional. The mask to control which fields get updated.

  Format : google-fieldmask

  Location : query

  Type : string

• ▼ ▲ dialogflow.projects.agent.environments.intents.list

  Parameters :

  parent

  Pattern : ^projects/[^/]+/agent/environments/[^/]+$

  Type : string

  Required : Yes

  Location : path

  Description : Required. The agent to list all intents from. Format: `projects//agent` or `projects//locations//agent`. Alternatively, you can specify the environment to list intents for. Format: `projects//agent/environments/` or `projects//locations//agent/environments/`. Note: training phrases of the intents will not be returned for non-draft environment.

  languageCode

  Description : Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).

  Location : query

  Type : string

  pageSize

  Type : integer

  Description : Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.

  Format : int32

  Location : query

  intentView

  Enum Descriptions :

  • Training phrases field is not populated in the response.
  • All fields are populated.

  Enum :

  • INTENT_VIEW_UNSPECIFIED
  • INTENT_VIEW_FULL

  Location : query

  Type : string

  Description : Optional. The resource view to apply to the returned intent.

  pageToken

  Type : string

  Description : Optional. The next_page_token value returned from a previous list request.

  Location : query

• ▼ ▲ dialogflow.projects.agent.knowledgeBases.list

  Parameters :

  parent

  Type : string

  Pattern : ^projects/[^/]+/agent$

  Required : Yes

  Location : path

  Description : Required. The project to list of knowledge bases for. Format: `projects//locations/`.

  pageToken

  Location : query

  Description : The next_page_token value returned from a previous list request.

  Type : string

  filter

  Location : query

  Description : The filter expression used to filter knowledge bases returned by the list method. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * display_name with has(:) operator * language_code with equals(=) operator Examples: * 'language_code=en-us' matches knowledge bases with en-us language code. * 'display_name:articles' matches knowledge bases whose display name contains "articles". * 'display_name:"Best Articles"' matches knowledge bases whose display name contains "Best Articles". * 'language_code=en-gb AND display_name=articles' matches all knowledge bases whose display name contains "articles" and whose language code is "en-gb". Note: An empty filter string (i.e. "") is a no-op and will result in no filtering. For more information about filtering, see [API Filtering](https://aip.dev/160).

  Type : string

  pageSize

  Description : The maximum number of items to return in a single page. By default 10 and at most 100.

  Type : integer

  Location : query

  Format : int32

• ▼ ▲ dialogflow.projects.agent.knowledgeBases.create

  Parameters :

  parent

  Location : path

  Pattern : ^projects/[^/]+/agent$

  Type : string

  Required : Yes

  Description : Required. The project to create a knowledge base for. Format: `projects//locations/`.

• ▼ ▲ dialogflow.projects.agent.knowledgeBases.delete

  Parameters :

  force

  Type : boolean

  Location : query

  Description : Optional. Force deletes the knowledge base. When set to true, any documents in the knowledge base are also deleted.

  name

  Pattern : ^projects/[^/]+/agent/knowledgeBases/[^/]+$

  Description : Required. The name of the knowledge base to delete. Format: `projects//locations//knowledgeBases/`.

  Required : Yes

  Location : path

  Type : string

• ▼ ▲ dialogflow.projects.agent.knowledgeBases.patch

  Parameters :

  name

  Description : The knowledge base resource name. The name must be empty when creating a knowledge base. Format: `projects//locations//knowledgeBases/`.

  Pattern : ^projects/[^/]+/agent/knowledgeBases/[^/]+$

  Type : string

  Location : path

  Required : Yes

  updateMask

  Description : Optional. Not specified means `update all`. Currently, only `display_name` can be updated, an InvalidArgument will be returned for attempting to update other fields.

  Location : query

  Type : string

  Format : google-fieldmask

• ▼ ▲ dialogflow.projects.agent.knowledgeBases.get

  Parameters :

  name

  Description : Required. The name of the knowledge base to retrieve. Format `projects//locations//knowledgeBases/`.

  Required : Yes

  Pattern : ^projects/[^/]+/agent/knowledgeBases/[^/]+$

  Location : path

  Type : string

• ▼ ▲ dialogflow.projects.agent.knowledgeBases.documents.delete

  Parameters :

  name

  Location : path

  Pattern : ^projects/[^/]+/agent/knowledgeBases/[^/]+/documents/[^/]+$

  Description : Required. The name of the document to delete. Format: `projects//locations//knowledgeBases//documents/`.

  Required : Yes

  Type : string

• ▼ ▲ dialogflow.projects.agent.knowledgeBases.documents.patch

  Parameters :

  updateMask

  Type : string

  Format : google-fieldmask

  Description : Optional. Not specified means `update all`. Currently, only `display_name` can be updated, an InvalidArgument will be returned for attempting to update other fields.

  Location : query

  name

  Location : path

  Required : Yes

  Description : Optional. The document resource name. The name must be empty when creating a document. Format: `projects//locations//knowledgeBases//documents/`.

  Pattern : ^projects/[^/]+/agent/knowledgeBases/[^/]+/documents/[^/]+$

  Type : string

• ▼ ▲ dialogflow.projects.agent.knowledgeBases.documents.get

  Parameters :

  name

  Type : string

  Pattern : ^projects/[^/]+/agent/knowledgeBases/[^/]+/documents/[^/]+$

  Description : Required. The name of the document to retrieve. Format `projects//locations//knowledgeBases//documents/`.

  Required : Yes

  Location : path

• ▼ ▲ dialogflow.projects.agent.knowledgeBases.documents.reload

  Parameters :

  name

  Type : string

  Description : Required. The name of the document to reload. Format: `projects//locations//knowledgeBases//documents/`

  Location : path

  Pattern : ^projects/[^/]+/agent/knowledgeBases/[^/]+/documents/[^/]+$

  Required : Yes

• ▼ ▲ dialogflow.projects.agent.knowledgeBases.documents.create

  Parameters :

  parent

  Type : string

  Location : path

  Pattern : ^projects/[^/]+/agent/knowledgeBases/[^/]+$

  Required : Yes

  Description : Required. The knowledge base to create a document for. Format: `projects//locations//knowledgeBases/`.

• ▼ ▲ dialogflow.projects.agent.knowledgeBases.documents.list

  Parameters :

  filter

  Type : string

  Description : The filter expression used to filter documents returned by the list method. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * knowledge_types with has(:) operator * display_name with has(:) operator * state with equals(=) operator Examples: * "knowledge_types:FAQ" matches documents with FAQ knowledge type. * "display_name:customer" matches documents whose display name contains "customer". * "state=ACTIVE" matches documents with ACTIVE state. * "knowledge_types:FAQ AND state=ACTIVE" matches all active FAQ documents. For more information about filtering, see [API Filtering](https://aip.dev/160).

  Location : query

  pageToken

  Type : string

  Location : query

  Description : The next_page_token value returned from a previous list request.

  parent

  Location : path

  Description : Required. The knowledge base to list all documents for. Format: `projects//locations//knowledgeBases/`.

  Type : string

  Pattern : ^projects/[^/]+/agent/knowledgeBases/[^/]+$

  Required : Yes

  pageSize

  Type : integer

  Description : The maximum number of items to return in a single page. By default 10 and at most 100.

  Format : int32

  Location : query

• ▼ ▲ dialogflow.projects.agent.sessions.entityTypes.get

  Parameters :

  name

  Required : Yes

  Type : string

  Location : path

  Description : Required. The name of the session entity type. Format: `projects//agent/sessions//entityTypes/` or `projects//agent/environments//users//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.

  Pattern : ^projects/[^/]+/agent/sessions/[^/]+/entityTypes/[^/]+$

• ▼ ▲ dialogflow.projects.agent.sessions.entityTypes.patch

  Parameters :

  name

  Description : Required. The unique identifier of this session entity type. Format: `projects//agent/sessions//entityTypes/`, or `projects//agent/environments//users//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. `` must be the display name of an existing entity type in the same agent that will be overridden or supplemented.

  Pattern : ^projects/[^/]+/agent/sessions/[^/]+/entityTypes/[^/]+$

  Type : string

  Required : Yes

  Location : path

  updateMask

  Format : google-fieldmask

  Type : string

  Location : query

  Description : Optional. The mask to control which fields get updated.

• ▼ ▲ dialogflow.projects.agent.sessions.entityTypes.delete

  Parameters :

  name

  Type : string

  Pattern : ^projects/[^/]+/agent/sessions/[^/]+/entityTypes/[^/]+$

  Location : path

  Description : Required. The name of the entity type to delete. Format: `projects//agent/sessions//entityTypes/` or `projects//agent/environments//users//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.

  Required : Yes

• ▼ ▲ dialogflow.projects.agent.sessions.entityTypes.create

  Parameters :

  parent

  Description : Required. The session to create a session entity type for. Format: `projects//agent/sessions/` or `projects//agent/environments//users// sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.

  Pattern : ^projects/[^/]+/agent/sessions/[^/]+$

  Type : string

  Required : Yes

  Location : path

• ▼ ▲ dialogflow.projects.agent.sessions.entityTypes.list

  Parameters :

  pageToken

  Description : Optional. The next_page_token value returned from a previous list request.

  Type : string

  Location : query

  parent

  Location : path

  Description : Required. The session to list all session entity types from. Format: `projects//agent/sessions/` or `projects//agent/environments//users// sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.

  Type : string

  Required : Yes

  Pattern : ^projects/[^/]+/agent/sessions/[^/]+$

  pageSize

  Type : integer

  Location : query

  Format : int32

  Description : Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.

• ▼ ▲ dialogflow.projects.agent.sessions.contexts.delete

  Parameters :

  name

  Location : path

  Pattern : ^projects/[^/]+/agent/sessions/[^/]+/contexts/[^/]+$

  Description : Required. The name of the context to delete. Format: `projects//agent/sessions//contexts/` or `projects//agent/environments//users//sessions//contexts/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.

  Type : string

  Required : Yes

• ▼ ▲ dialogflow.projects.agent.sessions.contexts.get

  Parameters :

  name

  Pattern : ^projects/[^/]+/agent/sessions/[^/]+/contexts/[^/]+$

  Location : path

  Description : Required. The name of the context. Format: `projects//agent/sessions//contexts/` or `projects//agent/environments//users//sessions//contexts/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.

  Type : string

  Required : Yes

• ▼ ▲ dialogflow.projects.agent.sessions.contexts.patch

  Parameters :

  name

  Pattern : ^projects/[^/]+/agent/sessions/[^/]+/contexts/[^/]+$

  Type : string

  Required : Yes

  Description : Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. The `Context ID` is always converted to lowercase, may only contain characters in `a-zA-Z0-9_-%` and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`

  Location : path

  updateMask

  Description : Optional. The mask to control which fields get updated.

  Format : google-fieldmask

  Type : string

  Location : query

• ▼ ▲ dialogflow.projects.agent.sessions.contexts.list

  Parameters :

  pageToken

  Description : Optional. The next_page_token value returned from a previous list request.

  Type : string

  Location : query

  parent

  Pattern : ^projects/[^/]+/agent/sessions/[^/]+$

  Type : string

  Location : path

  Description : Required. The session to list all contexts from. Format: `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.

  Required : Yes

  pageSize

  Description : Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.

  Location : query

  Format : int32

  Type : integer

• ▼ ▲ dialogflow.projects.agent.sessions.contexts.create

  Parameters :

  parent

  Description : Required. The session to create a context for. Format: `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.

  Location : path

  Pattern : ^projects/[^/]+/agent/sessions/[^/]+$

  Type : string

  Required : Yes

• ▼ ▲ dialogflow.projects.agent.sessions.detectIntent

  Parameters :

  session

  Location : path

  Required : Yes

  Type : string

  Description : Required. The name of the session this query is sent to. Format: `projects//agent/sessions/`, or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment (`Environment ID` might be referred to as environment name at some places). If `User ID` is not specified, we are using "-". It's up to the API caller to choose an appropriate `Session ID` and `User Id`. They can be a random number or some type of user and session identifiers (preferably hashed). The length of the `Session ID` and `User ID` must not exceed 36 characters. For more information, see the [API interactions guide](https://cloud.google.com/dialogflow/docs/api-overview). Note: Always use agent versions for production traffic. See [Versions and environments](https://cloud.google.com/dialogflow/es/docs/agents-versions).

  Pattern : ^projects/[^/]+/agent/sessions/[^/]+$

• ▼ ▲ dialogflow.projects.agent.sessions.deleteContexts

  Parameters :

  parent

  Type : string

  Location : path

  Required : Yes

  Pattern : ^projects/[^/]+/agent/sessions/[^/]+$

  Description : Required. The name of the session to delete all contexts from. Format: `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.

• ▼ ▲ dialogflow.projects.knowledgeBases.patch

  Parameters :

  name

  Required : Yes

  Location : path

  Description : The knowledge base resource name. The name must be empty when creating a knowledge base. Format: `projects//locations//knowledgeBases/`.

  Pattern : ^projects/[^/]+/knowledgeBases/[^/]+$

  Type : string

  updateMask

  Format : google-fieldmask

  Location : query

  Type : string

  Description : Optional. Not specified means `update all`. Currently, only `display_name` can be updated, an InvalidArgument will be returned for attempting to update other fields.

• ▼ ▲ dialogflow.projects.knowledgeBases.list

  Parameters :

  pageToken

  Description : The next_page_token value returned from a previous list request.

  Type : string

  Location : query

  parent

  Location : path

  Description : Required. The project to list of knowledge bases for. Format: `projects//locations/`.

  Required : Yes

  Type : string

  Pattern : ^projects/[^/]+$

  pageSize

  Location : query

  Description : The maximum number of items to return in a single page. By default 10 and at most 100.

  Type : integer

  Format : int32

  filter

  Description : The filter expression used to filter knowledge bases returned by the list method. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * display_name with has(:) operator * language_code with equals(=) operator Examples: * 'language_code=en-us' matches knowledge bases with en-us language code. * 'display_name:articles' matches knowledge bases whose display name contains "articles". * 'display_name:"Best Articles"' matches knowledge bases whose display name contains "Best Articles". * 'language_code=en-gb AND display_name=articles' matches all knowledge bases whose display name contains "articles" and whose language code is "en-gb". Note: An empty filter string (i.e. "") is a no-op and will result in no filtering. For more information about filtering, see [API Filtering](https://aip.dev/160).

  Location : query

  Type : string

• ▼ ▲ dialogflow.projects.knowledgeBases.get

  Parameters :

  name

  Description : Required. The name of the knowledge base to retrieve. Format `projects//locations//knowledgeBases/`.

  Pattern : ^projects/[^/]+/knowledgeBases/[^/]+$

  Location : path

  Type : string

  Required : Yes

• ▼ ▲ dialogflow.projects.knowledgeBases.delete

  Parameters :

  force

  Description : Optional. Force deletes the knowledge base. When set to true, any documents in the knowledge base are also deleted.

  Location : query

  Type : boolean

  name

  Location : path

  Pattern : ^projects/[^/]+/knowledgeBases/[^/]+$

  Type : string

  Required : Yes

  Description : Required. The name of the knowledge base to delete. Format: `projects//locations//knowledgeBases/`.

• ▼ ▲ dialogflow.projects.knowledgeBases.create

  Parameters :

  parent

  Pattern : ^projects/[^/]+$

  Type : string

  Location : path

  Description : Required. The project to create a knowledge base for. Format: `projects//locations/`.

  Required : Yes

• ▼ ▲ dialogflow.projects.knowledgeBases.documents.list

  Parameters :

  pageToken

  Location : query

  Description : The next_page_token value returned from a previous list request.

  Type : string

  filter

  Description : The filter expression used to filter documents returned by the list method. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * knowledge_types with has(:) operator * display_name with has(:) operator * state with equals(=) operator Examples: * "knowledge_types:FAQ" matches documents with FAQ knowledge type. * "display_name:customer" matches documents whose display name contains "customer". * "state=ACTIVE" matches documents with ACTIVE state. * "knowledge_types:FAQ AND state=ACTIVE" matches all active FAQ documents. For more information about filtering, see [API Filtering](https://aip.dev/160).

  Location : query

  Type : string

  parent

  Type : string

  Required : Yes

  Location : path

  Description : Required. The knowledge base to list all documents for. Format: `projects//locations//knowledgeBases/`.

  Pattern : ^projects/[^/]+/knowledgeBases/[^/]+$

  pageSize

  Location : query

  Type : integer

  Description : The maximum number of items to return in a single page. By default 10 and at most 100.

  Format : int32

• ▼ ▲ dialogflow.projects.knowledgeBases.documents.export

  Parameters :

  name

  Type : string

  Location : path

  Required : Yes

  Description : Required. The name of the document to export. Format: `projects//locations//knowledgeBases//documents/`.

  Pattern : ^projects/[^/]+/knowledgeBases/[^/]+/documents/[^/]+$

• ▼ ▲ dialogflow.projects.knowledgeBases.documents.reload

  Parameters :

  name

  Location : path

  Pattern : ^projects/[^/]+/knowledgeBases/[^/]+/documents/[^/]+$

  Description : Required. The name of the document to reload. Format: `projects//locations//knowledgeBases//documents/`

  Type : string

  Required : Yes

• ▼ ▲ dialogflow.projects.knowledgeBases.documents.delete

  Parameters :

  name

  Type : string

  Location : path

  Pattern : ^projects/[^/]+/knowledgeBases/[^/]+/documents/[^/]+$

  Description : Required. The name of the document to delete. Format: `projects//locations//knowledgeBases//documents/`.

  Required : Yes

• ▼ ▲ dialogflow.projects.knowledgeBases.documents.get

  Parameters :

  name

  Location : path

  Description : Required. The name of the document to retrieve. Format `projects//locations//knowledgeBases//documents/`.

  Required : Yes

  Type : string

  Pattern : ^projects/[^/]+/knowledgeBases/[^/]+/documents/[^/]+$

• ▼ ▲ dialogflow.projects.knowledgeBases.documents.create

  Parameters :

  parent

  Location : path

  Required : Yes

  Pattern : ^projects/[^/]+/knowledgeBases/[^/]+$

  Type : string

  Description : Required. The knowledge base to create a document for. Format: `projects//locations//knowledgeBases/`.

• ▼ ▲ dialogflow.projects.knowledgeBases.documents.patch

  Parameters :

  name

  Description : Optional. The document resource name. The name must be empty when creating a document. Format: `projects//locations//knowledgeBases//documents/`.

  Type : string

  Required : Yes

  Pattern : ^projects/[^/]+/knowledgeBases/[^/]+/documents/[^/]+$

  Location : path

  updateMask

  Description : Optional. Not specified means `update all`. Currently, only `display_name` can be updated, an InvalidArgument will be returned for attempting to update other fields.

  Format : google-fieldmask

  Type : string

  Location : query

• ▼ ▲ dialogflow.projects.knowledgeBases.documents.import

  Parameters :

  parent

  Description : Required. The knowledge base to import documents into. Format: `projects//locations//knowledgeBases/`.

  Location : path

  Pattern : ^projects/[^/]+/knowledgeBases/[^/]+$

  Type : string

  Required : Yes

• ▼ ▲ dialogflow.projects.setAgent

  Parameters :

  parent

  Pattern : ^projects/[^/]+$

  Required : Yes

  Location : path

  Description : Required. The project of this agent. Format: `projects/`.

  Type : string

  updateMask

  Location : query

  Description : Optional. The mask to control which fields get updated.

  Type : string

  Format : google-fieldmask

• ▼ ▲ dialogflow.projects.getAgent

  Parameters :

  parent

  Type : string

  Location : path

  Required : Yes

  Description : Required. The project that the agent to fetch is associated with. Format: `projects/`.

  Pattern : ^projects/[^/]+$

• ▼ ▲ dialogflow.projects.deleteAgent

  Parameters :

  parent

  Pattern : ^projects/[^/]+$

  Type : string

  Location : path

  Required : Yes

  Description : Required. The project that the agent to delete is associated with. Format: `projects/`.