generators

Creates, updates, deletes, gets or lists a generators resource.

Overview

Name	generators
Type	Resource
Id	google.dialogflow.generators

Fields

The following fields are returned by SELECT queries:

projects_locations_agents_generators_get

Name	Datatype	Description
name	string
displayName	string
llmModelSettings	object	(id: GoogleCloudDialogflowCxV3LlmModelSettings)
modelParameter	object	(id: GoogleCloudDialogflowCxV3GeneratorModelParameter)
placeholders	array
promptText	object	(id: GoogleCloudDialogflowCxV3Phrase)

projects_locations_agents_generators_list

Name	Datatype	Description
name	string
displayName	string
llmModelSettings	object	(id: GoogleCloudDialogflowCxV3LlmModelSettings)
modelParameter	object	(id: GoogleCloudDialogflowCxV3GeneratorModelParameter)
placeholders	array
promptText	object	(id: GoogleCloudDialogflowCxV3Phrase)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_agents_generators_get	select	projectsId, locationsId, agentsId, generatorsId	languageCode
projects_locations_agents_generators_list	select	projectsId, locationsId, agentsId	languageCode, pageSize, pageToken
projects_locations_agents_generators_create	insert	projectsId, locationsId, agentsId	languageCode
projects_locations_agents_generators_patch	update	projectsId, locationsId, agentsId, generatorsId	languageCode, updateMask
projects_locations_agents_generators_delete	delete	projectsId, locationsId, agentsId, generatorsId	force

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
agentsId	string
generatorsId	string
locationsId	string
projectsId	string
force	boolean
languageCode	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

projects_locations_agents_generators_get

Successful response

SELECT
name,
displayName,
llmModelSettings,
modelParameter,
placeholders,
promptText
FROM google.dialogflow.generators
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND agentsId = '{{ agentsId }}' -- required
AND generatorsId = '{{ generatorsId }}' -- required
AND languageCode = '{{ languageCode }}'
;

projects_locations_agents_generators_list

Successful response

SELECT
name,
displayName,
llmModelSettings,
modelParameter,
placeholders,
promptText
FROM google.dialogflow.generators
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND agentsId = '{{ agentsId }}' -- required
AND languageCode = '{{ languageCode }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;

INSERT examples

projects_locations_agents_generators_create

No description available.

INSERT INTO google.dialogflow.generators (
data__displayName,
data__llmModelSettings,
data__modelParameter,
data__name,
data__placeholders,
data__promptText,
projectsId,
locationsId,
agentsId,
languageCode
)
SELECT 
'{{ displayName }}',
'{{ llmModelSettings }}',
'{{ modelParameter }}',
'{{ name }}',
'{{ placeholders }}',
'{{ promptText }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ agentsId }}',
'{{ languageCode }}'
RETURNING
name,
displayName,
llmModelSettings,
modelParameter,
placeholders,
promptText
;

Manifest

# Description fields are for documentation purposes
- name: generators
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the generators resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the generators resource.
  - name: agentsId
    value: "{{ agentsId }}"
    description: Required parameter for the generators resource.
  - name: displayName
    value: "{{ displayName }}"
  - name: llmModelSettings
    value:
      model: "{{ model }}"
      promptText: "{{ promptText }}"
  - name: modelParameter
    value:
      maxDecodeSteps: {{ maxDecodeSteps }}
      temperature: {{ temperature }}
      topK: {{ topK }}
      topP: {{ topP }}
  - name: name
    value: "{{ name }}"
  - name: placeholders
    value:
      - id: "{{ id }}"
        name: "{{ name }}"
  - name: promptText
    value:
      text: "{{ text }}"
  - name: languageCode
    value: "{{ languageCode }}"

UPDATE examples

projects_locations_agents_generators_patch

No description available.

UPDATE google.dialogflow.generators
SET 
data__displayName = '{{ displayName }}',
data__llmModelSettings = '{{ llmModelSettings }}',
data__modelParameter = '{{ modelParameter }}',
data__name = '{{ name }}',
data__placeholders = '{{ placeholders }}',
data__promptText = '{{ promptText }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND agentsId = '{{ agentsId }}' --required
AND generatorsId = '{{ generatorsId }}' --required
AND languageCode = '{{ languageCode}}'
AND updateMask = '{{ updateMask}}'
RETURNING
name,
displayName,
llmModelSettings,
modelParameter,
placeholders,
promptText;

DELETE examples

projects_locations_agents_generators_delete

No description available.

DELETE FROM google.dialogflow.generators
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND agentsId = '{{ agentsId }}' --required
AND generatorsId = '{{ generatorsId }}' --required
AND force = '{{ force }}'
;