2023-12-08
▼ ▲ dialogflow.projects.locations.agents.generators.list
Path : v3/{+parent}/generators
Flat Path : v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/generators
HTTP Method : GET
Parameters :
parent
Description : Required. The agent to list all generators for. Format: `projects//locations//agents/`.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
Location : path
Required : Yes
Type : string
languageCode
Description : The language to list generators for.
Location : query
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 the list of all generators in the specified agent.
▼ ▲ dialogflow.projects.locations.agents.generators.get
Path : v3/{+name}
Flat Path : v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/generators/{generatorsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the generator. Format: `projects//locations//agents//generators/`.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/generators/[^/]+$
Location : path
Required : Yes
Type : string
languageCode
Description : The language to list generators for.
Location : query
Type : string
Parameter Order : name
Scopes :
Description : Retrieves the specified generator.
▼ ▲ dialogflow.projects.locations.agents.generators.create
Path : v3/{+parent}/generators
Flat Path : v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/generators
HTTP Method : POST
Parameters :
parent
Description : Required. The agent to create a generator for. Format: `projects//locations//agents/`.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
Location : path
Required : Yes
Type : string
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.
Location : query
Type : string
Parameter Order : parent
Scopes :
Description : Creates a generator in the specified agent.
▼ ▲ dialogflow.projects.locations.agents.generators.patch
Path : v3/{+name}
Flat Path : v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/generators/{generatorsId}
HTTP Method : PATCH
Parameters :
name
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
Required : Yes
Type : string
languageCode
Description : The language to list generators for.
Location : query
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 generator.
▼ ▲ dialogflow.projects.locations.agents.generators.delete
Path : v3/{+name}
Flat Path : v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/generators/{generatorsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the generator to delete. Format: `projects//locations//agents//generators/`.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/generators/[^/]+$
Location : path
Required : Yes
Type : string
force
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.
Location : query
Type : boolean
Parameter Order : name
Scopes :
Description : Deletes the specified generators.