2024-06-06
▼ ▲ dialogflow.projects.locations.agents.playbooks.create
Path : v3beta1/{+parent}/playbooks
Flat Path : v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks
HTTP Method : POST
Parameters :
parent
Description : Required. The agent to create a playbook for. Format: `projects//locations//agents/`.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes :
Description : Creates a playbook in a specified agent.
▼ ▲ dialogflow.projects.locations.agents.playbooks.delete
Path : v3beta1/{+name}
Flat Path : v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks/{playbooksId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the playbook to delete. Format: `projects//locations//agents//playbooks/`.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/playbooks/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Deletes a specified playbook.
▼ ▲ dialogflow.projects.locations.agents.playbooks.list
Path : v3beta1/{+parent}/playbooks
Flat Path : v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks
HTTP Method : GET
Parameters :
parent
Description : Required. The agent to list playbooks from. Format: `projects//locations//agents/`.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
Location : path
Required : Yes
Type : string
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
Description : The next_page_token value returned from a previous list request.
Location : query
Type : string
Parameter Order : parent
Scopes :
Description : Returns a list of playbooks in the specified agent.
▼ ▲ dialogflow.projects.locations.agents.playbooks.get
Path : v3beta1/{+name}
Flat Path : v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks/{playbooksId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the playbook. Format: `projects//locations//agents//playbooks/`.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/playbooks/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Retrieves the specified Playbook.
▼ ▲ dialogflow.projects.locations.agents.playbooks.patch
Path : v3beta1/{+name}
Flat Path : v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks/{playbooksId}
HTTP Method : PATCH
Parameters :
name
Description : The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/playbooks/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : The mask to control which fields get updated. If the mask is not present, all fields will be updated.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes :
Description : Updates the specified Playbook.
▼ ▲ dialogflow.projects.locations.agents.playbooks.examples.create
Path : v3beta1/{+parent}/examples
Flat Path : v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks/{playbooksId}/examples
HTTP Method : POST
Parameters :
parent
Description : Required. The playbook to create an example for. Format: `projects//locations//agents//playbooks/`.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/playbooks/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes :
Description : Creates an example in the specified playbook.
▼ ▲ dialogflow.projects.locations.agents.playbooks.examples.delete
Path : v3beta1/{+name}
Flat Path : v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks/{playbooksId}/examples/{examplesId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the example to delete. Format: `projects//locations//agents//playbooks//examples/`.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/playbooks/[^/]+/examples/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Deletes the specified example.
▼ ▲ dialogflow.projects.locations.agents.playbooks.examples.list
Path : v3beta1/{+parent}/examples
Flat Path : v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks/{playbooksId}/examples
HTTP Method : GET
Parameters :
parent
Description : Required. The playbook to list the examples from. Format: `projects//locations//agents//playbooks/`.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/playbooks/[^/]+$
Location : path
Required : Yes
Type : string
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
pageToken
Description : Optional. The next_page_token value returned from a previous list request.
Location : query
Type : string
languageCode
Description : Optional. The language to list examples for. If not specified, the agent's default language is used. Note: languages must be enabled in the agent before they can be used.
Location : query
Type : string
Parameter Order : parent
Scopes :
Description : Returns a list of examples in the specified playbook.
▼ ▲ dialogflow.projects.locations.agents.playbooks.examples.get
Path : v3beta1/{+name}
Flat Path : v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks/{playbooksId}/examples/{examplesId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the example. Format: `projects//locations//agents//playbooks//examples/`.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/playbooks/[^/]+/examples/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Retrieves the specified example.
▼ ▲ dialogflow.projects.locations.agents.playbooks.examples.patch
Path : v3beta1/{+name}
Flat Path : v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks/{playbooksId}/examples/{examplesId}
HTTP Method : PATCH
Parameters :
name
Description : The unique identifier of the playbook example. Format: `projects//locations//agents//playbooks//examples/`.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/playbooks/[^/]+/examples/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Optional. The mask to control which fields get updated. If the mask is not present, all fields will be updated.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes :
Description : Update the specified example.
▼ ▲ dialogflow.projects.locations.agents.playbooks.versions.create
Path : v3beta1/{+parent}/versions
Flat Path : v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks/{playbooksId}/versions
HTTP Method : POST
Parameters :
parent
Description : Required. The playbook to create a version for. Format: `projects//locations//agents//playbooks/`.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/playbooks/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes :
Description : Creates a version for the specified Playbook.
▼ ▲ dialogflow.projects.locations.agents.playbooks.versions.get
Path : v3beta1/{+name}
Flat Path : v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks/{playbooksId}/versions/{versionsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the playbook version. Format: `projects//locations//agents//playbooks//versions/`.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/playbooks/[^/]+/versions/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Retrieves the specified version of the Playbook.
▼ ▲ dialogflow.projects.locations.agents.playbooks.versions.list
Path : v3beta1/{+parent}/versions
Flat Path : v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks/{playbooksId}/versions
HTTP Method : GET
Parameters :
parent
Description : Required. The playbook to list versions for. Format: `projects//locations//agents//playbooks/`.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/playbooks/[^/]+$
Location : path
Required : Yes
Type : string
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
pageToken
Description : Optional. The next_page_token value returned from a previous list request.
Location : query
Type : string
Parameter Order : parent
Scopes :
Description : Lists versions for the specified Playbook.
▼ ▲ dialogflow.projects.locations.agents.playbooks.versions.delete
Path : v3beta1/{+name}
Flat Path : v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks/{playbooksId}/versions/{versionsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the playbook version to delete. Format: `projects//locations//agents//playbooks//versions/`.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/playbooks/[^/]+/versions/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Deletes the specified version of the Playbook.
▼ ▲ dialogflow.projects.locations.agents.tools.create
Path : v3beta1/{+parent}/tools
Flat Path : v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/tools
HTTP Method : POST
Parameters :
parent
Description : Required. The agent to create a Tool for. Format: `projects//locations//agents/`.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes :
Description : Creates a Tool in the specified agent.
▼ ▲ dialogflow.projects.locations.agents.tools.list
Path : v3beta1/{+parent}/tools
Flat Path : v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/tools
HTTP Method : GET
Parameters :
parent
Description : Required. The agent to list the Tools from. Format: `projects//locations//agents/`.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
Location : path
Required : Yes
Type : string
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
Description : The next_page_token value returned from a previous list request.
Location : query
Type : string
Parameter Order : parent
Scopes :
Description : Returns a list of Tools in the specified agent.
▼ ▲ dialogflow.projects.locations.agents.tools.export
Path : v3beta1/{+parent}/tools:export
Flat Path : v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/tools:export
HTTP Method : POST
Parameters :
parent
Description : Required. The agent to export tools from. Format: `projects//locations//agents/`.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes :
Description : Exports the selected tools.
▼ ▲ dialogflow.projects.locations.agents.tools.get
Path : v3beta1/{+name}
Flat Path : v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/tools/{toolsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the Tool. Format: `projects//locations//agents//tools/`.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/tools/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Retrieves the specified Tool.
▼ ▲ dialogflow.projects.locations.agents.tools.patch
Path : v3beta1/{+name}
Flat Path : v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/tools/{toolsId}
HTTP Method : PATCH
Parameters :
name
Description : The unique identifier of the Tool. Format: `projects//locations//agents//tools/`.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/tools/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : The mask to control which fields get updated. If the mask is not present, all fields will be updated.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes :
Description : Update the specified Tool.
▼ ▲ dialogflow.projects.locations.agents.tools.delete
Path : v3beta1/{+name}
Flat Path : v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/tools/{toolsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the Tool to be deleted. Format: `projects//locations//agents//tools/`.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/tools/[^/]+$
Location : path
Required : Yes
Type : string
force
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.
Location : query
Type : boolean
Parameter Order : name
Scopes :
Description : Deletes a specified Tool.