2026-01-22
▼ ▲ dialogflow.projects.operations.cancel
Parameters :
name
Required : Yes
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/operations/[^/]+$
Location : path
Type : string
▼ ▲ dialogflow.projects.operations.list
Parameters :
returnPartialSuccess
Location : query
Type : boolean
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.
pageSize
Format : int32
Type : integer
Description : The standard list page size.
Location : query
pageToken
Description : The standard list page token.
Location : query
Type : string
filter
Location : query
Type : string
Description : The standard list filter.
name
Required : Yes
Pattern : ^projects/[^/]+$
Description : The name of the operation's parent resource.
Location : path
Type : string
▼ ▲ dialogflow.projects.operations.get
Parameters :
name
Description : The name of the operation resource.
Location : path
Type : string
Required : Yes
Pattern : ^projects/[^/]+/operations/[^/]+$
▼ ▲ dialogflow.projects.locations.get
Parameters :
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
Description : Resource name for the location.
Required : Yes
Type : string
▼ ▲ dialogflow.projects.locations.list
Parameters :
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.
extraLocationTypes
Repeated : Yes
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.
Type : string
name
Required : Yes
Location : path
Pattern : ^projects/[^/]+$
Description : The resource that owns the locations collection, if applicable.
Type : string
pageSize
Format : int32
Type : integer
Description : The maximum number of results to return. If not set, the service selects a default.
Location : query
filter
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).
Location : query
Type : string
▼ ▲ dialogflow.projects.locations.agents.getValidationResult
Parameters :
languageCode
Type : string
Description : If not specified, the agent's default language is used.
Location : query
name
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/validationResult$
Description : Required. The agent name. Format: `projects//locations//agents//validationResult`.
Type : string
Required : Yes
Location : path
▼ ▲ dialogflow.projects.locations.agents.updateGenerativeSettings
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/generativeSettings$
Location : path
Type : string
Description : Format: `projects//locations//agents//generativeSettings`.
Required : Yes
updateMask
Description : Optional. The mask to control which fields get updated. If the mask is not present, all fields will be updated.
Format : google-fieldmask
Location : query
Type : string
▼ ▲ dialogflow.projects.locations.agents.get
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
Location : path
Description : Required. The name of the agent. Format: `projects//locations//agents/`.
Type : string
Required : Yes
▼ ▲ dialogflow.projects.locations.agents.delete
Parameters :
name
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
Description : Required. The name of the agent to delete. Format: `projects//locations//agents/`.
Type : string
▼ ▲ dialogflow.projects.locations.agents.validate
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
Type : string
Required : Yes
Location : path
Description : Required. The agent to validate. Format: `projects//locations//agents/`.
▼ ▲ dialogflow.projects.locations.agents.patch
Parameters :
updateMask
Format : google-fieldmask
Description : The mask to control which fields get updated. If the mask is not present, all fields will be updated.
Type : string
Location : query
name
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
Location : path
Type : string
Description : The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: `projects//locations//agents/`.
▼ ▲ dialogflow.projects.locations.agents.create
Parameters :
parent
Pattern : ^projects/[^/]+/locations/[^/]+$
Required : Yes
Type : string
Location : path
Description : Required. The location to create a agent for. Format: `projects//locations/`.
▼ ▲ dialogflow.projects.locations.agents.list
Parameters :
parent
Required : Yes
Type : string
Location : path
Description : Required. The location to list all agents for. Format: `projects//locations/`.
Pattern : ^projects/[^/]+/locations/[^/]+$
pageSize
Location : query
Format : int32
Type : integer
Description : The maximum number of items to return in a single page. By default 100 and at most 1000.
pageToken
Description : The next_page_token value returned from a previous list request.
Type : string
Location : query
▼ ▲ dialogflow.projects.locations.agents.export
Parameters :
name
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
Required : Yes
Location : path
Description : Required. The name of the agent to export. Format: `projects//locations//agents/`.
▼ ▲ dialogflow.projects.locations.agents.getGenerativeSettings
Parameters :
name
Description : Required. Format: `projects//locations//agents//generativeSettings`.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/generativeSettings$
Required : Yes
Location : path
Type : string
languageCode
Description : Required. Language code of the generative settings.
Location : query
Type : string
▼ ▲ dialogflow.projects.locations.agents.restore
Parameters :
name
Description : Required. The name of the agent to restore into. Format: `projects//locations//agents/`.
Required : Yes
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
▼ ▲ dialogflow.projects.locations.agents.flows.delete
Parameters :
name
Type : string
Description : Required. The name of the flow to delete. Format: `projects//locations//agents//flows/`.
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+$
force
Type : boolean
Description : This field has no effect for flows with no incoming transitions. For flows with incoming transitions: * If `force` is set to false, an error will be returned with message indicating the incoming transitions. * If `force` is set to true, Dialogflow will remove the flow, as well as any transitions to the flow (i.e. Target flow in event handlers or Target flow in transition routes that point to this flow will be cleared).
Location : query
▼ ▲ dialogflow.projects.locations.agents.flows.import
Parameters :
parent
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
Type : string
Location : path
Description : Required. The agent to import the flow into. Format: `projects//locations//agents/`.
▼ ▲ dialogflow.projects.locations.agents.flows.get
Parameters :
languageCode
Type : string
Description : The language to retrieve the flow for. The following fields are language dependent: * `Flow.event_handlers.trigger_fulfillment.messages` * `Flow.event_handlers.trigger_fulfillment.conditional_cases` * `Flow.transition_routes.trigger_fulfillment.messages` * `Flow.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
Location : query
name
Location : path
Description : Required. The name of the flow to get. Format: `projects//locations//agents//flows/`.
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+$
▼ ▲ dialogflow.projects.locations.agents.flows.validate
Parameters :
name
Description : Required. The flow to validate. Format: `projects//locations//agents//flows/`.
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+$
Required : Yes
Location : path
▼ ▲ dialogflow.projects.locations.agents.flows.list
Parameters :
parent
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
Type : string
Description : Required. The agent containing the flows. Format: `projects//locations//agents/`.
Location : path
pageToken
Location : query
Type : string
Description : The next_page_token value returned from a previous list request.
languageCode
Type : string
Description : The language to list flows for. The following fields are language dependent: * `Flow.event_handlers.trigger_fulfillment.messages` * `Flow.event_handlers.trigger_fulfillment.conditional_cases` * `Flow.transition_routes.trigger_fulfillment.messages` * `Flow.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
Location : query
pageSize
Description : 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.agents.flows.patch
Parameters :
name
Required : Yes
Location : path
Description : The unique identifier of the flow. Format: `projects//locations//agents//flows/`.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+$
Type : string
languageCode
Location : query
Type : string
Description : The language of the following fields in `flow`: * `Flow.event_handlers.trigger_fulfillment.messages` * `Flow.event_handlers.trigger_fulfillment.conditional_cases` * `Flow.transition_routes.trigger_fulfillment.messages` * `Flow.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
updateMask
Location : query
Description : The mask to control which fields get updated. If the mask is not present, all fields will be updated.
Type : string
Format : google-fieldmask
▼ ▲ dialogflow.projects.locations.agents.flows.export
Parameters :
name
Location : path
Description : Required. The name of the flow to export. Format: `projects//locations//agents//flows/`.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+$
Required : Yes
Type : string
▼ ▲ dialogflow.projects.locations.agents.flows.train
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+$
Description : Required. The flow to train. Format: `projects//locations//agents//flows/`.
Type : string
Location : path
Required : Yes
▼ ▲ dialogflow.projects.locations.agents.flows.create
Parameters :
parent
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
Location : path
Description : Required. The agent to create a flow for. Format: `projects//locations//agents/`.
Required : Yes
Type : string
languageCode
Location : query
Type : string
Description : The language of the following fields in `flow`: * `Flow.event_handlers.trigger_fulfillment.messages` * `Flow.event_handlers.trigger_fulfillment.conditional_cases` * `Flow.transition_routes.trigger_fulfillment.messages` * `Flow.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
▼ ▲ dialogflow.projects.locations.agents.flows.getValidationResult
Parameters :
languageCode
Description : If not specified, the agent's default language is used.
Location : query
Type : string
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+/validationResult$
Required : Yes
Type : string
Description : Required. The flow name. Format: `projects//locations//agents//flows//validationResult`.
▼ ▲ dialogflow.projects.locations.agents.flows.transitionRouteGroups.list
Parameters :
pageToken
Location : query
Type : string
Description : The next_page_token value returned from a previous list request.
languageCode
Location : query
Type : string
Description : The language to list transition route groups for. The following fields are language dependent: * `TransitionRouteGroup.transition_routes.trigger_fulfillment.messages` * `TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
parent
Required : Yes
Description : Required. The flow to list all transition route groups for. Format: `projects//locations//agents//flows/` or `projects//locations//agents/.
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+$
pageSize
Format : int32
Description : 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.agents.flows.transitionRouteGroups.delete
Parameters :
name
Location : path
Description : Required. The name of the TransitionRouteGroup to delete. Format: `projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/`.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+/transitionRouteGroups/[^/]+$
Type : string
force
Type : boolean
Description : This field has no effect for transition route group that no page is using. If the transition route group is referenced by any page: * If `force` is set to false, an error will be returned with message indicating pages that reference the transition route group. * If `force` is set to true, Dialogflow will remove the transition route group, as well as any reference to it.
Location : query
▼ ▲ dialogflow.projects.locations.agents.flows.transitionRouteGroups.patch
Parameters :
name
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+/transitionRouteGroups/[^/]+$
Type : string
Location : path
Description : The unique identifier of the transition route group. TransitionRouteGroups.CreateTransitionRouteGroup populates the name automatically. Format: `projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/` for agent-level groups.
languageCode
Type : string
Description : The language of the following fields in `TransitionRouteGroup`: * `TransitionRouteGroup.transition_routes.trigger_fulfillment.messages` * `TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
Location : query
updateMask
Format : google-fieldmask
Type : string
Description : The mask to control which fields get updated.
Location : query
▼ ▲ dialogflow.projects.locations.agents.flows.transitionRouteGroups.create
Parameters :
parent
Required : Yes
Description : Required. The flow to create an TransitionRouteGroup for. Format: `projects//locations//agents//flows/` or `projects//locations//agents/` for agent-level groups.
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+$
Type : string
languageCode
Type : string
Description : The language of the following fields in `TransitionRouteGroup`: * `TransitionRouteGroup.transition_routes.trigger_fulfillment.messages` * `TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
Location : query
▼ ▲ dialogflow.projects.locations.agents.flows.transitionRouteGroups.get
Parameters :
languageCode
Location : query
Description : The language to retrieve the transition route group for. The following fields are language dependent: * `TransitionRouteGroup.transition_routes.trigger_fulfillment.messages` * `TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
Type : string
name
Location : path
Description : Required. The name of the TransitionRouteGroup. Format: `projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/`.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+/transitionRouteGroups/[^/]+$
Type : string
▼ ▲ dialogflow.projects.locations.agents.flows.pages.delete
Parameters :
force
Type : boolean
Description : This field has no effect for pages with no incoming transitions. For pages with incoming transitions: * If `force` is set to false, an error will be returned with message indicating the incoming transitions. * If `force` is set to true, Dialogflow will remove the page, as well as any transitions to the page (i.e. Target page in event handlers or Target page in transition routes that point to this page will be cleared).
Location : query
name
Type : string
Required : Yes
Description : Required. The name of the page to delete. Format: `projects//locations//agents//Flows//pages/`.
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+/pages/[^/]+$
▼ ▲ dialogflow.projects.locations.agents.flows.pages.list
Parameters :
parent
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+$
Location : path
Description : Required. The flow to list all pages for. Format: `projects//locations//agents//flows/`.
Required : Yes
Type : string
pageSize
Format : int32
Description : The maximum number of items to return in a single page. By default 100 and at most 1000.
Location : query
Type : integer
languageCode
Location : query
Description : The language to list pages for. The following fields are language dependent: * `Page.entry_fulfillment.messages` * `Page.entry_fulfillment.conditional_cases` * `Page.event_handlers.trigger_fulfillment.messages` * `Page.event_handlers.trigger_fulfillment.conditional_cases` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.messages` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases` * `Page.transition_routes.trigger_fulfillment.messages` * `Page.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
Type : string
pageToken
Description : The next_page_token value returned from a previous list request.
Location : query
Type : string
▼ ▲ dialogflow.projects.locations.agents.flows.pages.patch
Parameters :
updateMask
Format : google-fieldmask
Type : string
Location : query
Description : The mask to control which fields get updated. If the mask is not present, all fields will be updated.
name
Description : The unique identifier of the page. Required for the Pages.UpdatePage method. Pages.CreatePage populates the name automatically. Format: `projects//locations//agents//flows//pages/`.
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+/pages/[^/]+$
Location : path
languageCode
Type : string
Location : query
Description : The language of the following fields in `page`: * `Page.entry_fulfillment.messages` * `Page.entry_fulfillment.conditional_cases` * `Page.event_handlers.trigger_fulfillment.messages` * `Page.event_handlers.trigger_fulfillment.conditional_cases` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.messages` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases` * `Page.transition_routes.trigger_fulfillment.messages` * `Page.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
▼ ▲ dialogflow.projects.locations.agents.flows.pages.create
Parameters :
languageCode
Description : The language of the following fields in `page`: * `Page.entry_fulfillment.messages` * `Page.entry_fulfillment.conditional_cases` * `Page.event_handlers.trigger_fulfillment.messages` * `Page.event_handlers.trigger_fulfillment.conditional_cases` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.messages` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases` * `Page.transition_routes.trigger_fulfillment.messages` * `Page.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
Type : string
Location : query
parent
Location : path
Required : Yes
Description : Required. The flow to create a page for. Format: `projects//locations//agents//flows/`.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+$
Type : string
▼ ▲ dialogflow.projects.locations.agents.flows.pages.get
Parameters :
name
Location : path
Required : Yes
Description : Required. The name of the page. Format: `projects//locations//agents//flows//pages/`.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+/pages/[^/]+$
Type : string
languageCode
Description : The language to retrieve the page for. The following fields are language dependent: * `Page.entry_fulfillment.messages` * `Page.entry_fulfillment.conditional_cases` * `Page.event_handlers.trigger_fulfillment.messages` * `Page.event_handlers.trigger_fulfillment.conditional_cases` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.messages` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases` * `Page.transition_routes.trigger_fulfillment.messages` * `Page.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
Location : query
Type : string
▼ ▲ dialogflow.projects.locations.agents.flows.versions.get
Parameters :
name
Type : string
Description : Required. The name of the Version. Format: `projects//locations//agents//flows//versions/`.
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+/versions/[^/]+$
▼ ▲ dialogflow.projects.locations.agents.flows.versions.compareVersions
Parameters :
baseVersion
Location : path
Description : Required. Name of the base flow version to compare with the target version. Use version ID `0` to indicate the draft version of the specified flow. Format: `projects//locations//agents//flows//versions/`.
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+/versions/[^/]+$
▼ ▲ dialogflow.projects.locations.agents.flows.versions.patch
Parameters :
updateMask
Description : Required. The mask to control which fields get updated. Currently only `description` and `display_name` can be updated.
Location : query
Type : string
Format : google-fieldmask
name
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+/versions/[^/]+$
Description : Format: projects//locations//agents//flows//versions/. Version ID is a self-increasing number generated by Dialogflow upon version creation.
Type : string
▼ ▲ dialogflow.projects.locations.agents.flows.versions.load
Parameters :
name
Description : Required. The Version to be loaded to draft flow. Format: `projects//locations//agents//flows//versions/`.
Required : Yes
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+/versions/[^/]+$
▼ ▲ dialogflow.projects.locations.agents.flows.versions.create
Parameters :
parent
Description : Required. The Flow to create an Version for. Format: `projects//locations//agents//flows/`.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+$
Location : path
Type : string
Required : Yes
▼ ▲ dialogflow.projects.locations.agents.flows.versions.delete
Parameters :
name
Description : Required. The name of the Version to delete. Format: `projects//locations//agents//flows//versions/`.
Type : string
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+/versions/[^/]+$
▼ ▲ dialogflow.projects.locations.agents.flows.versions.list
Parameters :
pageToken
Description : The next_page_token value returned from a previous list request.
Type : string
Location : query
pageSize
Format : int32
Location : query
Type : integer
Description : The maximum number of items to return in a single page. By default 20 and at most 100.
parent
Description : Required. The Flow to list all versions for. Format: `projects//locations//agents//flows/`.
Required : Yes
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+$
▼ ▲ dialogflow.projects.locations.agents.sessions.submitAnswerFeedback
Parameters :
session
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/sessions/[^/]+$
Description : Required. The name of the session the feedback was sent to.
Type : string
▼ ▲ dialogflow.projects.locations.agents.sessions.matchIntent
Parameters :
session
Description : Required. The name of the session this query is sent to. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length of the `Session ID` must not exceed 36 characters. For more information, see the [sessions guide](https://cloud.google.com/dialogflow/cx/docs/concept/session).
Location : path
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/sessions/[^/]+$
▼ ▲ dialogflow.projects.locations.agents.sessions.detectIntent
Parameters :
session
Description : Required. The name of the session this query is sent to. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length of the `Session ID` must not exceed 36 characters. For more information, see the [sessions guide](https://cloud.google.com/dialogflow/cx/docs/concept/session). Note: Always use agent versions for production traffic. See [Versions and environments](https://cloud.google.com/dialogflow/cx/docs/concept/version).
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/sessions/[^/]+$
Location : path
Type : string
▼ ▲ dialogflow.projects.locations.agents.sessions.fulfillIntent
Parameters :
session
Description : Required. The name of the session this query is sent to. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length of the `Session ID` must not exceed 36 characters. For more information, see the [sessions guide](https://cloud.google.com/dialogflow/cx/docs/concept/session).
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/sessions/[^/]+$
Required : Yes
Location : path
Type : string
▼ ▲ dialogflow.projects.locations.agents.sessions.serverStreamingDetectIntent
Parameters :
session
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/sessions/[^/]+$
Type : string
Required : Yes
Description : Required. The name of the session this query is sent to. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length of the `Session ID` must not exceed 36 characters. For more information, see the [sessions guide](https://cloud.google.com/dialogflow/cx/docs/concept/session). Note: Always use agent versions for production traffic. See [Versions and environments](https://cloud.google.com/dialogflow/cx/docs/concept/version).
Location : path
▼ ▲ dialogflow.projects.locations.agents.sessions.entityTypes.list
Parameters :
pageSize
Location : query
Description : The maximum number of items to return in a single page. By default 100 and at most 1000.
Format : int32
Type : integer
pageToken
Type : string
Location : query
Description : The next_page_token value returned from a previous list request.
parent
Location : path
Required : Yes
Type : string
Description : Required. The session to list all session entity types from. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/sessions/[^/]+$
▼ ▲ dialogflow.projects.locations.agents.sessions.entityTypes.patch
Parameters :
updateMask
Description : The mask to control which fields get updated.
Format : google-fieldmask
Type : string
Location : query
name
Description : Required. The unique identifier of the session entity type. Format: `projects//locations//agents//sessions//entityTypes/` or `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment.
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/sessions/[^/]+/entityTypes/[^/]+$
Location : path
▼ ▲ dialogflow.projects.locations.agents.sessions.entityTypes.delete
Parameters :
name
Description : Required. The name of the session entity type to delete. Format: `projects//locations//agents//sessions//entityTypes/` or `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment.
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/sessions/[^/]+/entityTypes/[^/]+$
Type : string
▼ ▲ dialogflow.projects.locations.agents.sessions.entityTypes.get
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/sessions/[^/]+/entityTypes/[^/]+$
Location : path
Description : Required. The name of the session entity type. Format: `projects//locations//agents//sessions//entityTypes/` or `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment.
Required : Yes
Type : string
▼ ▲ dialogflow.projects.locations.agents.sessions.entityTypes.create
Parameters :
parent
Location : path
Description : Required. The session to create a session entity type for. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/sessions/[^/]+$
Type : string
Required : Yes
▼ ▲ dialogflow.projects.locations.agents.environments.deployFlow
Parameters :
environment
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+$
Description : Required. The environment to deploy the flow to. Format: `projects//locations//agents//environments/`.
Required : Yes
Location : path
Type : string
▼ ▲ dialogflow.projects.locations.agents.environments.lookupEnvironmentHistory
Parameters :
pageSize
Type : integer
Location : query
Description : The maximum number of items to return in a single page. By default 100 and at most 1000.
Format : int32
name
Description : Required. Resource name of the environment to look up the history for. Format: `projects//locations//agents//environments/`.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+$
Location : path
Required : Yes
Type : string
pageToken
Description : The next_page_token value returned from a previous list request.
Location : query
Type : string
▼ ▲ dialogflow.projects.locations.agents.environments.create
Parameters :
parent
Description : Required. The Agent to create an Environment for. Format: `projects//locations//agents/`.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
Required : Yes
Location : path
Type : string
▼ ▲ dialogflow.projects.locations.agents.environments.delete
Parameters :
name
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+$
Description : Required. The name of the Environment to delete. Format: `projects//locations//agents//environments/`.
Required : Yes
▼ ▲ dialogflow.projects.locations.agents.environments.patch
Parameters :
updateMask
Description : Required. The mask to control which fields get updated.
Format : google-fieldmask
Type : string
Location : query
name
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+$
Type : string
Required : Yes
Description : The name of the environment. Format: `projects//locations//agents//environments/`.
Location : path
▼ ▲ dialogflow.projects.locations.agents.environments.list
Parameters :
pageSize
Description : The maximum number of items to return in a single page. By default 20 and at most 100.
Location : query
Type : integer
Format : int32
parent
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
Description : Required. The Agent to list all environments for. Format: `projects//locations//agents/`.
Type : string
Required : Yes
pageToken
Location : query
Description : The next_page_token value returned from a previous list request.
Type : string
▼ ▲ dialogflow.projects.locations.agents.environments.get
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+$
Description : Required. The name of the Environment. Format: `projects//locations//agents//environments/`.
Location : path
Type : string
Required : Yes
▼ ▲ dialogflow.projects.locations.agents.environments.runContinuousTest
Parameters :
environment
Description : Required. Format: `projects//locations//agents//environments/`.
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+$
Location : path
▼ ▲ dialogflow.projects.locations.agents.environments.continuousTestResults.list
Parameters :
pageToken
Description : The next_page_token value returned from a previous list request.
Location : query
Type : string
parent
Description : Required. The environment to list results for. Format: `projects//locations//agents//environments/`.
Required : Yes
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+$
pageSize
Description : The maximum number of items to return in a single page. By default 100 and at most 1000.
Location : query
Type : integer
Format : int32
▼ ▲ dialogflow.projects.locations.agents.environments.deployments.list
Parameters :
pageSize
Format : int32
Location : query
Type : integer
Description : The maximum number of items to return in a single page. By default 20 and at most 100.
pageToken
Description : The next_page_token value returned from a previous list request.
Type : string
Location : query
parent
Type : string
Description : Required. The Environment to list all environments for. Format: `projects//locations//agents//environments/`.
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+$
▼ ▲ dialogflow.projects.locations.agents.environments.deployments.get
Parameters :
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+/deployments/[^/]+$
Type : string
Required : Yes
Description : Required. The name of the Deployment. Format: `projects//locations//agents//environments//deployments/`.
▼ ▲ dialogflow.projects.locations.agents.environments.experiments.get
Parameters :
name
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+/experiments/[^/]+$
Description : Required. The name of the Environment. Format: `projects//locations//agents//environments//experiments/`.
Required : Yes
▼ ▲ dialogflow.projects.locations.agents.environments.experiments.start
Parameters :
name
Type : string
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+/experiments/[^/]+$
Description : Required. Resource name of the experiment to start. Format: `projects//locations//agents//environments//experiments/`.
▼ ▲ dialogflow.projects.locations.agents.environments.experiments.list
Parameters :
parent
Description : Required. The Environment to list all environments for. Format: `projects//locations//agents//environments/`.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+$
Type : string
Location : path
Required : Yes
pageSize
Description : The maximum number of items to return in a single page. By default 20 and at most 100.
Location : query
Format : int32
Type : integer
pageToken
Location : query
Type : string
Description : The next_page_token value returned from a previous list request.
▼ ▲ dialogflow.projects.locations.agents.environments.experiments.patch
Parameters :
updateMask
Description : Required. The mask to control which fields get updated.
Type : string
Format : google-fieldmask
Location : query
name
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+/experiments/[^/]+$
Required : Yes
Description : The name of the experiment. Format: projects//locations//agents//environments//experiments/.
Type : string
Location : path
▼ ▲ dialogflow.projects.locations.agents.environments.experiments.stop
Parameters :
name
Description : Required. Resource name of the experiment to stop. Format: `projects//locations//agents//environments//experiments/`.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+/experiments/[^/]+$
Type : string
Required : Yes
Location : path
▼ ▲ dialogflow.projects.locations.agents.environments.experiments.create
Parameters :
parent
Location : path
Type : string
Description : Required. The Agent to create an Environment for. Format: `projects//locations//agents//environments/`.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+$
Required : Yes
▼ ▲ dialogflow.projects.locations.agents.environments.experiments.delete
Parameters :
name
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+/experiments/[^/]+$
Description : Required. The name of the Environment to delete. Format: `projects//locations//agents//environments//experiments/`.
Required : Yes
▼ ▲ dialogflow.projects.locations.agents.environments.sessions.entityTypes.get
Parameters :
name
Description : Required. The name of the session entity type. Format: `projects//locations//agents//sessions//entityTypes/` or `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment.
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+/sessions/[^/]+/entityTypes/[^/]+$
Location : path
▼ ▲ dialogflow.projects.locations.agents.environments.sessions.entityTypes.list
Parameters :
pageToken
Type : string
Location : query
Description : The next_page_token value returned from a previous list request.
parent
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+/sessions/[^/]+$
Location : path
Type : string
Description : Required. The session to list all session entity types from. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment.
pageSize
Type : integer
Location : query
Description : The maximum number of items to return in a single page. By default 100 and at most 1000.
Format : int32
▼ ▲ dialogflow.projects.locations.agents.environments.sessions.entityTypes.delete
Parameters :
name
Location : path
Type : string
Required : Yes
Description : Required. The name of the session entity type to delete. Format: `projects//locations//agents//sessions//entityTypes/` or `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+/sessions/[^/]+/entityTypes/[^/]+$
▼ ▲ dialogflow.projects.locations.agents.environments.sessions.entityTypes.patch
Parameters :
updateMask
Format : google-fieldmask
Description : The mask to control which fields get updated.
Location : query
Type : string
name
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+/sessions/[^/]+/entityTypes/[^/]+$
Description : Required. The unique identifier of the session entity type. Format: `projects//locations//agents//sessions//entityTypes/` or `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment.
Required : Yes
Location : path
Type : string
▼ ▲ dialogflow.projects.locations.agents.environments.sessions.entityTypes.create
Parameters :
parent
Type : string
Required : Yes
Location : path
Description : Required. The session to create a session entity type for. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+/sessions/[^/]+$
▼ ▲ dialogflow.projects.locations.agents.environments.sessions.fulfillIntent
Parameters :
session
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+/sessions/[^/]+$
Location : path
Description : Required. The name of the session this query is sent to. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length of the `Session ID` must not exceed 36 characters. For more information, see the [sessions guide](https://cloud.google.com/dialogflow/cx/docs/concept/session).
▼ ▲ dialogflow.projects.locations.agents.environments.sessions.matchIntent
Parameters :
session
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+/sessions/[^/]+$
Required : Yes
Description : Required. The name of the session this query is sent to. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length of the `Session ID` must not exceed 36 characters. For more information, see the [sessions guide](https://cloud.google.com/dialogflow/cx/docs/concept/session).
Type : string
Location : path
▼ ▲ dialogflow.projects.locations.agents.environments.sessions.detectIntent
Parameters :
session
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+/sessions/[^/]+$
Location : path
Type : string
Required : Yes
Description : Required. The name of the session this query is sent to. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length of the `Session ID` must not exceed 36 characters. For more information, see the [sessions guide](https://cloud.google.com/dialogflow/cx/docs/concept/session). Note: Always use agent versions for production traffic. See [Versions and environments](https://cloud.google.com/dialogflow/cx/docs/concept/version).
▼ ▲ dialogflow.projects.locations.agents.environments.sessions.serverStreamingDetectIntent
Parameters :
session
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+/sessions/[^/]+$
Description : Required. The name of the session this query is sent to. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length of the `Session ID` must not exceed 36 characters. For more information, see the [sessions guide](https://cloud.google.com/dialogflow/cx/docs/concept/session). Note: Always use agent versions for production traffic. See [Versions and environments](https://cloud.google.com/dialogflow/cx/docs/concept/version).
Required : Yes
Type : string
Location : path
▼ ▲ dialogflow.projects.locations.agents.conversations.list
Parameters :
pageToken
Location : query
Type : string
Description : Optional. The next_page_token value returned from a previous list request.
parent
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
Description : Required. The agent to list all conversations for. Format: `projects//locations//agents/`.
Required : Yes
Type : string
Location : path
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
filter
Description : Optional. The filter string. Supports filter by create_time, metrics.has_end_interaction, metrics.has_live_agent_handoff, intents.display_name, pages.display_name and flows.display_name. Timestamps expect an RFC-3339 formatted string (e.g. 2012-04-21T11:30:00-04:00). UTC offsets are supported. Some examples: 1. By create time: create_time > "2022-04-21T11:30:00-04:00" 2. By intent display name: intents.display_name : "billing" 3. By end interaction signal: metrics.has_end_interaction = true
Type : string
Location : query
▼ ▲ dialogflow.projects.locations.agents.conversations.get
Parameters :
name
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/conversations/[^/]+$
Location : path
Description : Required. The name of the conversation. Format: `projects//locations//agents//conversations/`.
Required : Yes
▼ ▲ dialogflow.projects.locations.agents.conversations.delete
Parameters :
name
Type : string
Description : Required. The name of the conversation. Format: `projects//locations//agents//conversations/`.
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/conversations/[^/]+$
▼ ▲ dialogflow.projects.locations.agents.transitionRouteGroups.delete
Parameters :
name
Description : Required. The name of the TransitionRouteGroup to delete. Format: `projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/`.
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/transitionRouteGroups/[^/]+$
Required : Yes
Type : string
force
Description : This field has no effect for transition route group that no page is using. If the transition route group is referenced by any page: * If `force` is set to false, an error will be returned with message indicating pages that reference the transition route group. * If `force` is set to true, Dialogflow will remove the transition route group, as well as any reference to it.
Location : query
Type : boolean
▼ ▲ dialogflow.projects.locations.agents.transitionRouteGroups.patch
Parameters :
name
Required : Yes
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/transitionRouteGroups/[^/]+$
Description : The unique identifier of the transition route group. TransitionRouteGroups.CreateTransitionRouteGroup populates the name automatically. Format: `projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/` for agent-level groups.
updateMask
Type : string
Location : query
Format : google-fieldmask
Description : The mask to control which fields get updated.
languageCode
Type : string
Location : query
Description : The language of the following fields in `TransitionRouteGroup`: * `TransitionRouteGroup.transition_routes.trigger_fulfillment.messages` * `TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
▼ ▲ dialogflow.projects.locations.agents.transitionRouteGroups.get
Parameters :
name
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/transitionRouteGroups/[^/]+$
Required : Yes
Location : path
Description : Required. The name of the TransitionRouteGroup. Format: `projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/`.
languageCode
Location : query
Type : string
Description : The language to retrieve the transition route group for. The following fields are language dependent: * `TransitionRouteGroup.transition_routes.trigger_fulfillment.messages` * `TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
▼ ▲ dialogflow.projects.locations.agents.transitionRouteGroups.list
Parameters :
parent
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
Location : path
Description : Required. The flow to list all transition route groups for. Format: `projects//locations//agents//flows/` or `projects//locations//agents/.
languageCode
Description : The language to list transition route groups for. The following fields are language dependent: * `TransitionRouteGroup.transition_routes.trigger_fulfillment.messages` * `TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
Type : string
Location : query
pageSize
Location : query
Format : int32
Type : integer
Description : The maximum number of items to return in a single page. By default 100 and at most 1000.
pageToken
Type : string
Description : The next_page_token value returned from a previous list request.
Location : query
▼ ▲ dialogflow.projects.locations.agents.transitionRouteGroups.create
Parameters :
parent
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
Description : Required. The flow to create an TransitionRouteGroup for. Format: `projects//locations//agents//flows/` or `projects//locations//agents/` for agent-level groups.
Type : string
Location : path
languageCode
Location : query
Description : The language of the following fields in `TransitionRouteGroup`: * `TransitionRouteGroup.transition_routes.trigger_fulfillment.messages` * `TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
Type : string
▼ ▲ dialogflow.projects.locations.agents.intents.export
Parameters :
parent
Description : Required. The name of the parent agent to export intents. Format: `projects//locations//agents/`.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
Location : path
Type : string
▼ ▲ dialogflow.projects.locations.agents.intents.get
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/intents/[^/]+$
Type : string
Description : Required. The name of the intent. Format: `projects//locations//agents//intents/`.
Required : Yes
Location : path
languageCode
Location : query
Description : The language to retrieve the intent for. The following fields are language dependent: * `Intent.training_phrases.parts.text` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
Type : string
▼ ▲ dialogflow.projects.locations.agents.intents.import
Parameters :
parent
Description : Required. The agent to import the intents into. Format: `projects//locations//agents/`.
Required : Yes
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
▼ ▲ dialogflow.projects.locations.agents.intents.list
Parameters :
pageToken
Description : The next_page_token value returned from a previous list request.
Location : query
Type : string
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
languageCode
Type : string
Description : The language to list intents for. The following fields are language dependent: * `Intent.training_phrases.parts.text` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
Location : query
intentView
Description : The resource view to apply to the returned intent.
Location : query
Type : string
Enum Descriptions :
Enum :
parent
Location : path
Description : Required. The agent to list all intents for. Format: `projects//locations//agents/`.
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
Required : Yes
▼ ▲ dialogflow.projects.locations.agents.intents.create
Parameters :
languageCode
Description : The language of the following fields in `intent`: * `Intent.training_phrases.parts.text` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
Location : query
Type : string
parent
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
Location : path
Required : Yes
Description : Required. The agent to create an intent for. Format: `projects//locations//agents/`.
Type : string
▼ ▲ dialogflow.projects.locations.agents.intents.delete
Parameters :
name
Location : path
Type : string
Required : Yes
Description : Required. The name of the intent to delete. Format: `projects//locations//agents//intents/`.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/intents/[^/]+$
▼ ▲ dialogflow.projects.locations.agents.intents.patch
Parameters :
updateMask
Type : string
Format : google-fieldmask
Location : query
Description : The mask to control which fields get updated. If the mask is not present, all fields will be updated.
name
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/intents/[^/]+$
Required : Yes
Description : The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`.
Location : path
Type : string
languageCode
Description : The language of the following fields in `intent`: * `Intent.training_phrases.parts.text` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
Type : string
Location : query
▼ ▲ dialogflow.projects.locations.agents.entityTypes.patch
Parameters :
name
Description : The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType. Format: `projects//locations//agents//entityTypes/`.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/entityTypes/[^/]+$
Type : string
Location : path
Required : Yes
updateMask
Type : string
Description : The mask to control which fields get updated.
Format : google-fieldmask
Location : query
languageCode
Location : query
Description : The language of the following fields in `entity_type`: * `EntityType.entities.value` * `EntityType.entities.synonyms` * `EntityType.excluded_phrases.value` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
Type : string
▼ ▲ dialogflow.projects.locations.agents.entityTypes.delete
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/entityTypes/[^/]+$
Required : Yes
Type : string
Description : Required. The name of the entity type to delete. Format: `projects//locations//agents//entityTypes/`.
Location : path
force
Location : query
Description : This field has no effect for entity type not being used. For entity types that are used by intents or pages: * If `force` is set to false, an error will be returned with message indicating the referencing resources. * If `force` is set to true, Dialogflow will remove the entity type, as well as any references to the entity type (i.e. Page parameter of the entity type will be changed to '@sys.any' and intent parameter of the entity type will be removed).
Type : boolean
▼ ▲ dialogflow.projects.locations.agents.entityTypes.get
Parameters :
languageCode
Type : string
Location : query
Description : The language to retrieve the entity type for. The following fields are language dependent: * `EntityType.entities.value` * `EntityType.entities.synonyms` * `EntityType.excluded_phrases.value` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/entityTypes/[^/]+$
Required : Yes
Type : string
Description : Required. The name of the entity type. Format: `projects//locations//agents//entityTypes/`.
▼ ▲ dialogflow.projects.locations.agents.entityTypes.create
Parameters :
languageCode
Location : query
Description : The language of the following fields in `entity_type`: * `EntityType.entities.value` * `EntityType.entities.synonyms` * `EntityType.excluded_phrases.value` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
Type : string
parent
Required : Yes
Description : Required. The agent to create a entity type for. Format: `projects//locations//agents/`.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
Location : path
Type : string
▼ ▲ dialogflow.projects.locations.agents.entityTypes.export
Parameters :
parent
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
Description : Required. The name of the parent agent to export entity types. Format: `projects//locations//agents/`.
Location : path
Required : Yes
Type : string
▼ ▲ dialogflow.projects.locations.agents.entityTypes.import
Parameters :
parent
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
Location : path
Type : string
Description : Required. The agent to import the entity types into. Format: `projects//locations//agents/`.
▼ ▲ dialogflow.projects.locations.agents.entityTypes.list
Parameters :
languageCode
Location : query
Type : string
Description : The language to list entity types for. The following fields are language dependent: * `EntityType.entities.value` * `EntityType.entities.synonyms` * `EntityType.excluded_phrases.value` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
parent
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
Location : path
Type : string
Description : Required. The agent to list all entity types for. Format: `projects//locations//agents/`.
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.agents.changelogs.list
Parameters :
filter
Location : query
Description : The filter string. Supports filter by user_email, resource, type and create_time. Some examples: 1. By user email: user_email = "someone@google.com" 2. By resource name: resource = "projects/123/locations/global/agents/456/flows/789" 3. By resource display name: display_name = "my agent" 4. By action: action = "Create" 5. By type: type = "flows" 6. By create time. Currently predicates on `create_time` and `create_time_epoch_seconds` are supported: create_time_epoch_seconds > 1551790877 AND create_time <= 2017-01-15T01:30:15.01Z 7. Combination of above filters: resource = "projects/123/locations/global/agents/456/flows/789" AND user_email = "someone@google.com" AND create_time <= 2017-01-15T01:30:15.01Z
Type : string
pageSize
Type : integer
Description : The maximum number of items to return in a single page. By default 100 and at most 1000.
Location : query
Format : int32
parent
Description : Required. The agent containing the changelogs. Format: `projects//locations//agents/`.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
Type : string
Required : Yes
Location : path
pageToken
Type : string
Location : query
Description : The next_page_token value returned from a previous list request.
▼ ▲ dialogflow.projects.locations.agents.changelogs.get
Parameters :
name
Location : path
Type : string
Required : Yes
Description : Required. The name of the changelog to get. Format: `projects//locations//agents//changelogs/`.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/changelogs/[^/]+$
▼ ▲ dialogflow.projects.locations.agents.testCases.get
Parameters :
name
Location : path
Required : Yes
Description : Required. The name of the testcase. Format: `projects//locations//agents//testCases/`.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/testCases/[^/]+$
Type : string
▼ ▲ dialogflow.projects.locations.agents.testCases.import
Parameters :
parent
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
Description : Required. The agent to import test cases to. Format: `projects//locations//agents/`.
Type : string
▼ ▲ dialogflow.projects.locations.agents.testCases.list
Parameters :
view
Enum :
Type : string
Location : query
Description : Specifies whether response should include all fields or just the metadata.
Enum Descriptions :
parent
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
Location : path
Required : Yes
Type : string
Description : Required. The agent to list all pages for. Format: `projects//locations//agents/`.
pageToken
Location : query
Description : The next_page_token value returned from a previous list request.
Type : string
pageSize
Type : integer
Location : query
Description : The maximum number of items to return in a single page. By default 20. Note that when TestCaseView = FULL, the maximum page size allowed is 20. When TestCaseView = BASIC, the maximum page size allowed is 500.
Format : int32
▼ ▲ dialogflow.projects.locations.agents.testCases.create
Parameters :
parent
Location : path
Description : Required. The agent to create the test case for. Format: `projects//locations//agents/`.
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
▼ ▲ dialogflow.projects.locations.agents.testCases.calculateCoverage
Parameters :
agent
Description : Required. The agent to calculate coverage for. Format: `projects//locations//agents/`.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
Type : string
Required : Yes
Location : path
type
Enum Descriptions :
Location : query
Description : Required. The type of coverage requested.
Type : string
Enum :
▼ ▲ dialogflow.projects.locations.agents.testCases.export
Parameters :
parent
Description : Required. The agent where to export test cases from. Format: `projects//locations//agents/`.
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
Type : string
▼ ▲ dialogflow.projects.locations.agents.testCases.patch
Parameters :
updateMask
Type : string
Location : query
Description : Required. The mask to specify which fields should be updated. The `creationTime` and `lastTestResult` cannot be updated.
Format : google-fieldmask
name
Type : string
Description : The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents//testCases/`.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/testCases/[^/]+$
Required : Yes
Location : path
▼ ▲ dialogflow.projects.locations.agents.testCases.batchRun
Parameters :
parent
Location : path
Description : Required. Agent name. Format: `projects//locations//agents/`.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
Type : string
Required : Yes
▼ ▲ dialogflow.projects.locations.agents.testCases.batchDelete
Parameters :
parent
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
Description : Required. The agent to delete test cases from. Format: `projects//locations//agents/`.
Required : Yes
Type : string
Location : path
▼ ▲ dialogflow.projects.locations.agents.testCases.run
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/testCases/[^/]+$
Type : string
Location : path
Description : Required. Format of test case name to run: `projects//locations//agents//testCases/`.
Required : Yes
▼ ▲ dialogflow.projects.locations.agents.testCases.results.get
Parameters :
name
Required : Yes
Type : string
Location : path
Description : Required. The name of the testcase. Format: `projects//locations//agents//testCases//results/`.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/testCases/[^/]+/results/[^/]+$
▼ ▲ dialogflow.projects.locations.agents.testCases.results.list
Parameters :
parent
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/testCases/[^/]+$
Location : path
Description : Required. The test case to list results for. Format: `projects//locations//agents//testCases/`. Specify a `-` as a wildcard for TestCase ID to list results across multiple test cases.
filter
Description : The filter expression used to filter test case results. See [API Filtering](https://aip.dev/160). The expression is case insensitive. Only 'AND' is supported for logical operators. The supported syntax is listed below in detail: [AND ] ... [AND latest] The supported fields and operators are: field operator `environment` `=`, `IN` (Use value `draft` for draft environment) `test_time` `>`, `<` `latest` only returns the latest test result in all results for each test case. Examples: * "environment=draft AND latest" matches the latest test result for each test case in the draft environment. * "environment IN (e1,e2)" matches any test case results with an environment resource name of either "e1" or "e2". * "test_time > 1602540713" matches any test case results with test time later than a unix timestamp in seconds 1602540713.
Type : string
Location : query
pageToken
Description : The next_page_token value returned from a previous list request.
Location : query
Type : string
pageSize
Location : query
Format : int32
Type : integer
Description : The maximum number of items to return in a single page. By default 100 and at most 1000.
▼ ▲ dialogflow.projects.locations.agents.tools.patch
Parameters :
updateMask
Format : google-fieldmask
Location : query
Type : string
Description : The mask to control which fields get updated. If the mask is not present, all fields will be updated.
name
Location : path
Description : The unique identifier of the Tool. Format: `projects//locations//agents//tools/`.
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/tools/[^/]+$
▼ ▲ dialogflow.projects.locations.agents.tools.delete
Parameters :
name
Description : Required. The name of the Tool to be deleted. Format: `projects//locations//agents//tools/`.
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/tools/[^/]+$
Required : Yes
force
Location : query
Type : boolean
Description : This field has no effect for Tools not being used. For Tools that are used: * If `force` is set to false, an error will be returned with message indicating the referenced resources. * If `force` is set to true, Dialogflow will remove the tool, as well as any references to the tool.
▼ ▲ dialogflow.projects.locations.agents.tools.get
Parameters :
name
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/tools/[^/]+$
Description : Required. The name of the Tool. Format: `projects//locations//agents//tools/`.
Location : path
Type : string
▼ ▲ dialogflow.projects.locations.agents.tools.export
Parameters :
parent
Required : Yes
Type : string
Location : path
Description : Required. The agent to export tools from. Format: `projects//locations//agents/`.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
▼ ▲ dialogflow.projects.locations.agents.tools.list
Parameters :
parent
Description : Required. The agent to list the Tools from. Format: `projects//locations//agents/`.
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
Required : Yes
pageSize
Description : The maximum number of items to return in a single page. By default 100 and at most 1000.
Location : query
Type : integer
Format : int32
pageToken
Type : string
Location : query
Description : The next_page_token value returned from a previous list request.
▼ ▲ dialogflow.projects.locations.agents.tools.create
Parameters :
parent
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
Description : Required. The agent to create a Tool for. Format: `projects//locations//agents/`.
Location : path
Required : Yes
▼ ▲ dialogflow.projects.locations.agents.tools.versions.create
Parameters :
parent
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/tools/[^/]+$
Description : Required. The tool to create a version for. Format: `projects//locations//agents//tools/`.
Required : Yes
▼ ▲ dialogflow.projects.locations.agents.tools.versions.delete
Parameters :
name
Location : path
Description : Required. The name of the tool version to delete. Format: `projects//locations//agents//tools//versions/`.
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/tools/[^/]+/versions/[^/]+$
force
Description : Optional. This field has no effect for Tools not being used. For Tools that are used: * If `force` is set to false, an error will be returned with message indicating the referenced resources. * If `force` is set to true, Dialogflow will remove the tool, as well as any references to the tool.
Type : boolean
Location : query
▼ ▲ dialogflow.projects.locations.agents.tools.versions.get
Parameters :
name
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/tools/[^/]+/versions/[^/]+$
Description : Required. The name of the tool version. Format: `projects//locations//agents//tools//versions/`.
Type : string
▼ ▲ dialogflow.projects.locations.agents.tools.versions.restore
Parameters :
name
Required : Yes
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/tools/[^/]+/versions/[^/]+$
Description : Required. The name of the tool version. Format: `projects//locations//agents//tools//versions/`.
▼ ▲ dialogflow.projects.locations.agents.tools.versions.list
Parameters :
parent
Description : Required. The parent of the tool versions. Format: `projects//locations//agents//tools/`.
Type : string
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/tools/[^/]+$
pageToken
Location : query
Description : Optional. The next_page_token value returned from a previous list request.
Type : string
pageSize
Type : integer
Format : int32
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.agents.playbooks.list
Parameters :
parent
Description : Required. The agent to list playbooks from. Format: `projects//locations//agents/`.
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
Location : path
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.
pageToken
Type : string
Location : query
Description : The next_page_token value returned from a previous list request.
▼ ▲ dialogflow.projects.locations.agents.playbooks.export
Parameters :
name
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/playbooks/[^/]+$
Description : Required. The name of the playbook to export. Format: `projects//locations//agents//playbooks/`.
Required : Yes
▼ ▲ dialogflow.projects.locations.agents.playbooks.patch
Parameters :
name
Type : string
Location : path
Description : The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/playbooks/[^/]+$
Required : Yes
updateMask
Location : query
Description : The mask to control which fields get updated. If the mask is not present, all fields will be updated.
Format : google-fieldmask
Type : string
▼ ▲ dialogflow.projects.locations.agents.playbooks.import
Parameters :
parent
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
Location : path
Description : Required. The agent to import the playbook into. Format: `projects//locations//agents/`.
▼ ▲ dialogflow.projects.locations.agents.playbooks.delete
Parameters :
name
Location : path
Description : Required. The name of the playbook to delete. Format: `projects//locations//agents//playbooks/`.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/playbooks/[^/]+$
Required : Yes
Type : string
▼ ▲ dialogflow.projects.locations.agents.playbooks.get
Parameters :
name
Description : Required. The name of the playbook. Format: `projects//locations//agents//playbooks/`.
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/playbooks/[^/]+$
Location : path
▼ ▲ dialogflow.projects.locations.agents.playbooks.create
Parameters :
parent
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
Location : path
Description : Required. The agent to create a playbook for. Format: `projects//locations//agents/`.
▼ ▲ dialogflow.projects.locations.agents.playbooks.versions.restore
Parameters :
name
Description : Required. The name of the playbook version. Format: `projects//locations//agents//playbooks//versions/`.
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/playbooks/[^/]+/versions/[^/]+$
Type : string
Required : Yes
▼ ▲ dialogflow.projects.locations.agents.playbooks.versions.get
Parameters :
name
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/playbooks/[^/]+/versions/[^/]+$
Type : string
Description : Required. The name of the playbook version. Format: `projects//locations//agents//playbooks//versions/`.
▼ ▲ dialogflow.projects.locations.agents.playbooks.versions.list
Parameters :
parent
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/playbooks/[^/]+$
Type : string
Location : path
Description : Required. The playbook to list versions for. Format: `projects//locations//agents//playbooks/`.
Required : Yes
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.agents.playbooks.versions.create
Parameters :
parent
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/playbooks/[^/]+$
Type : string
Location : path
Description : Required. The playbook to create a version for. Format: `projects//locations//agents//playbooks/`.
Required : Yes
▼ ▲ dialogflow.projects.locations.agents.playbooks.versions.delete
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/playbooks/[^/]+/versions/[^/]+$
Required : Yes
Type : string
Location : path
Description : Required. The name of the playbook version to delete. Format: `projects//locations//agents//playbooks//versions/`.
▼ ▲ dialogflow.projects.locations.agents.playbooks.examples.create
Parameters :
parent
Required : Yes
Type : string
Location : path
Description : Required. The playbook to create an example for. Format: `projects//locations//agents//playbooks/`.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/playbooks/[^/]+$
▼ ▲ dialogflow.projects.locations.agents.playbooks.examples.patch
Parameters :
name
Type : string
Description : The unique identifier of the playbook example. Format: `projects//locations//agents//playbooks//examples/`.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/playbooks/[^/]+/examples/[^/]+$
Location : path
updateMask
Format : google-fieldmask
Type : string
Location : query
Description : Optional. The mask to control which fields get updated. If the mask is not present, all fields will be updated.
▼ ▲ dialogflow.projects.locations.agents.playbooks.examples.delete
Parameters :
name
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/playbooks/[^/]+/examples/[^/]+$
Location : path
Type : string
Description : Required. The name of the example to delete. Format: `projects//locations//agents//playbooks//examples/`.
▼ ▲ dialogflow.projects.locations.agents.playbooks.examples.list
Parameters :
pageSize
Type : integer
Format : int32
Location : query
Description : Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
languageCode
Type : string
Location : query
Description : Optional. The language to list examples for. If not specified, list all examples under the playbook. Note: languages must be enabled in the agent before they can be used.
pageToken
Description : Optional. The next_page_token value returned from a previous list request.
Location : query
Type : string
parent
Description : Required. The playbook to list the examples from. Format: `projects//locations//agents//playbooks/`.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/playbooks/[^/]+$
Location : path
Type : string
▼ ▲ dialogflow.projects.locations.agents.playbooks.examples.get
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/playbooks/[^/]+/examples/[^/]+$
Required : Yes
Location : path
Type : string
Description : Required. The name of the example. Format: `projects//locations//agents//playbooks//examples/`.
▼ ▲ dialogflow.projects.locations.agents.generators.create
Parameters :
languageCode
Description : The language to create generators for the following fields: * `Generator.prompt_text.text` If not specified, the agent's default language is used.
Type : string
Location : query
parent
Description : Required. The agent to create a generator for. Format: `projects//locations//agents/`.
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
Required : Yes
Type : string
▼ ▲ dialogflow.projects.locations.agents.generators.get
Parameters :
name
Location : path
Type : string
Description : Required. The name of the generator. Format: `projects//locations//agents//generators/`.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/generators/[^/]+$
languageCode
Type : string
Description : The language to list generators for.
Location : query
▼ ▲ dialogflow.projects.locations.agents.generators.patch
Parameters :
languageCode
Description : The language to list generators for.
Type : string
Location : query
name
Required : Yes
Type : string
Description : The unique identifier of the generator. Must be set for the Generators.UpdateGenerator method. Generators.CreateGenerate populates the name automatically. Format: `projects//locations//agents//generators/`.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/generators/[^/]+$
Location : path
updateMask
Description : The mask to control which fields get updated. If the mask is not present, all fields will be updated.
Format : google-fieldmask
Location : query
Type : string
▼ ▲ dialogflow.projects.locations.agents.generators.delete
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/generators/[^/]+$
Required : Yes
Type : string
Location : path
Description : Required. The name of the generator to delete. Format: `projects//locations//agents//generators/`.
force
Location : query
Type : boolean
Description : This field has no effect for generators not being used. For generators that are used by pages/flows/transition route groups: * If `force` is set to false, an error will be returned with message indicating the referenced resources. * If `force` is set to true, Dialogflow will remove the generator, as well as any references to the generator (i.e. Generator) in fulfillments.
▼ ▲ dialogflow.projects.locations.agents.generators.list
Parameters :
pageSize
Location : query
Type : integer
Format : int32
Description : The maximum number of items to return in a single page. By default 100 and at most 1000.
parent
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
Required : Yes
Type : string
Description : Required. The agent to list all generators for. Format: `projects//locations//agents/`.
Location : path
pageToken
Location : query
Description : The next_page_token value returned from a previous list request.
Type : string
languageCode
Description : The language to list generators for.
Location : query
Type : string
▼ ▲ dialogflow.projects.locations.agents.webhooks.delete
Parameters :
name
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/webhooks/[^/]+$
Required : Yes
Location : path
Description : Required. The name of the webhook to delete. Format: `projects//locations//agents//webhooks/`.
force
Location : query
Type : boolean
Description : This field has no effect for webhook not being used. For webhooks that are used by pages/flows/transition route groups: * If `force` is set to false, an error will be returned with message indicating the referenced resources. * If `force` is set to true, Dialogflow will remove the webhook, as well as any references to the webhook (i.e. Webhook and tagin fulfillments that point to this webhook will be removed).
▼ ▲ dialogflow.projects.locations.agents.webhooks.get
Parameters :
name
Description : Required. The name of the webhook. Format: `projects//locations//agents//webhooks/`.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/webhooks/[^/]+$
Type : string
Required : Yes
Location : path
▼ ▲ dialogflow.projects.locations.agents.webhooks.list
Parameters :
pageToken
Type : string
Location : query
Description : The next_page_token value returned from a previous list request.
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.
parent
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
Description : Required. The agent to list all webhooks for. Format: `projects//locations//agents/`.
Location : path
Required : Yes
▼ ▲ dialogflow.projects.locations.agents.webhooks.patch
Parameters :
updateMask
Description : The mask to control which fields get updated. If the mask is not present, all fields will be updated.
Type : string
Location : query
Format : google-fieldmask
name
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/webhooks/[^/]+$
Description : The unique identifier of the webhook. Required for the Webhooks.UpdateWebhook method. Webhooks.CreateWebhook populates the name automatically. Format: `projects//locations//agents//webhooks/`.
Type : string
Location : path
Required : Yes
▼ ▲ dialogflow.projects.locations.agents.webhooks.create
Parameters :
parent
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
Type : string
Description : Required. The agent to create a webhook for. Format: `projects//locations//agents/`.
▼ ▲ dialogflow.projects.locations.operations.list
Parameters :
pageSize
Description : The standard list page size.
Type : integer
Format : int32
Location : query
pageToken
Location : query
Description : The standard list page token.
Type : string
name
Type : string
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+$
Description : The name of the operation's parent resource.
filter
Type : string
Description : The standard list filter.
Location : query
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
▼ ▲ dialogflow.projects.locations.operations.get
Parameters :
name
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Description : The name of the operation resource.
Required : Yes
▼ ▲ dialogflow.projects.locations.operations.cancel
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Required : Yes
Description : The name of the operation resource to be cancelled.
Location : path
Type : string
▼ ▲ dialogflow.projects.locations.securitySettings.get
Parameters :
name
Description : Required. Resource name of the settings. Format: `projects//locations//securitySettings/`.
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/securitySettings/[^/]+$
Required : Yes
▼ ▲ dialogflow.projects.locations.securitySettings.delete
Parameters :
name
Location : path
Type : string
Description : Required. The name of the SecuritySettings to delete. Format: `projects//locations//securitySettings/`.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/securitySettings/[^/]+$
▼ ▲ dialogflow.projects.locations.securitySettings.patch
Parameters :
name
Required : Yes
Description : Resource name of the settings. Required for the SecuritySettingsService.UpdateSecuritySettings method. SecuritySettingsService.CreateSecuritySettings populates the name automatically. Format: `projects//locations//securitySettings/`.
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/securitySettings/[^/]+$
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
▼ ▲ dialogflow.projects.locations.securitySettings.list
Parameters :
pageToken
Type : string
Location : query
Description : The next_page_token value returned from a previous list request.
pageSize
Format : int32
Type : integer
Location : query
Description : The maximum number of items to return in a single page. By default 20 and at most 100.
parent
Type : string
Description : Required. The location to list all security settings for. Format: `projects//locations/`.
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
▼ ▲ dialogflow.projects.locations.securitySettings.create
Parameters :
parent
Type : string
Location : path
Description : Required. The location to create an SecuritySettings for. Format: `projects//locations/`.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+$