# Dialogflow API . projects . locations . agents . generators

## Instance Methods

Close httplib2 connections.

Creates a generator in the specified agent.

Deletes the specified generators.

Retrieves the specified generator.

Returns the list of all generators in the specified agent.

Retrieves the next page of results.

Update the specified generator.

### Method Details

`close()`

    Close httplib2 connections.

`create(parent, body=None, languageCode=None, x__xgafv=None)`

    Creates a generator in the specified agent.

    Args:
      parent: string, Required. The agent to create a generator for. Format: `projects//locations//agents/`. (required)
      body: object, The request body.
        The object takes the form of:

    { # Generators contain prompt to be sent to the LLM model to generate text. The prompt can contain parameters which will be resolved before calling the model. It can optionally contain banned phrases to ensure the model responses are safe.
      "displayName": "A String", # Required. The human-readable name of the generator, unique within the agent. The prompt contains pre-defined parameters such as $conversation, $last-user-utterance, etc. populated by Dialogflow. It can also contain custom placeholders which will be resolved during fulfillment.
      "llmModelSettings": { # Settings for LLM models. # The LLM model settings.
        "model": "A String", # The selected LLM model.
        "promptText": "A String", # The custom prompt to use.
      },
      "modelParameter": { # Parameters to be passed to the LLM. If not set, default values will be used. # Parameters passed to the LLM to configure its behavior.
        "maxDecodeSteps": 42, # The maximum number of tokens to generate.
        "temperature": 3.14, # The temperature used for sampling. Temperature sampling occurs after both topP and topK have been applied. Valid range: [0.0, 1.0] Low temperature = less random. High temperature = more random.
        "topK": 42, # If set, the sampling process in each step is limited to the top_k tokens with highest probabilities. Valid range: [1, 40] or 1000+. Small topK = less random. Large topK = more random.
        "topP": 3.14, # If set, only the tokens comprising the top top_p probability mass are considered. If both top_p and top_k are set, top_p will be used for further refining candidates selected with top_k. Valid range: (0.0, 1.0]. Small topP = less random. Large topP = more random.
      },
      "name": "A String", # 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/`.
      "placeholders": [ # Optional. List of custom placeholders in the prompt text.
        { # Represents a custom placeholder in the prompt text.
          "id": "A String", # Unique ID used to map custom placeholder to parameters in fulfillment.
          "name": "A String", # Custom placeholder value in the prompt text.
        },
      ],
      "promptText": { # Text input which can be used for prompt or banned phrases. # Required. Prompt for the LLM model.
        "text": "A String", # Required. Text input which can be used for prompt or banned phrases.
      },
    }

      languageCode: string, The language to create generators for the following fields: * `Generator.prompt_text.text` If not specified, the agent's default language is used.
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Generators contain prompt to be sent to the LLM model to generate text. The prompt can contain parameters which will be resolved before calling the model. It can optionally contain banned phrases to ensure the model responses are safe.
      "displayName": "A String", # Required. The human-readable name of the generator, unique within the agent. The prompt contains pre-defined parameters such as $conversation, $last-user-utterance, etc. populated by Dialogflow. It can also contain custom placeholders which will be resolved during fulfillment.
      "llmModelSettings": { # Settings for LLM models. # The LLM model settings.
        "model": "A String", # The selected LLM model.
        "promptText": "A String", # The custom prompt to use.
      },
      "modelParameter": { # Parameters to be passed to the LLM. If not set, default values will be used. # Parameters passed to the LLM to configure its behavior.
        "maxDecodeSteps": 42, # The maximum number of tokens to generate.
        "temperature": 3.14, # The temperature used for sampling. Temperature sampling occurs after both topP and topK have been applied. Valid range: [0.0, 1.0] Low temperature = less random. High temperature = more random.
        "topK": 42, # If set, the sampling process in each step is limited to the top_k tokens with highest probabilities. Valid range: [1, 40] or 1000+. Small topK = less random. Large topK = more random.
        "topP": 3.14, # If set, only the tokens comprising the top top_p probability mass are considered. If both top_p and top_k are set, top_p will be used for further refining candidates selected with top_k. Valid range: (0.0, 1.0]. Small topP = less random. Large topP = more random.
      },
      "name": "A String", # 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/`.
      "placeholders": [ # Optional. List of custom placeholders in the prompt text.
        { # Represents a custom placeholder in the prompt text.
          "id": "A String", # Unique ID used to map custom placeholder to parameters in fulfillment.
          "name": "A String", # Custom placeholder value in the prompt text.
        },
      ],
      "promptText": { # Text input which can be used for prompt or banned phrases. # Required. Prompt for the LLM model.
        "text": "A String", # Required. Text input which can be used for prompt or banned phrases.
      },
    }

`delete(name, force=None, x__xgafv=None)`

    Deletes the specified generators.

    Args:
      name: string, Required. The name of the generator to delete. Format: `projects//locations//agents//generators/`. (required)
      force: boolean, 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.
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
    }

`get(name, languageCode=None, x__xgafv=None)`

    Retrieves the specified generator.

    Args:
      name: string, Required. The name of the generator. Format: `projects//locations//agents//generators/`. (required)
      languageCode: string, The language to list generators for.
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Generators contain prompt to be sent to the LLM model to generate text. The prompt can contain parameters which will be resolved before calling the model. It can optionally contain banned phrases to ensure the model responses are safe.
      "displayName": "A String", # Required. The human-readable name of the generator, unique within the agent. The prompt contains pre-defined parameters such as $conversation, $last-user-utterance, etc. populated by Dialogflow. It can also contain custom placeholders which will be resolved during fulfillment.
      "llmModelSettings": { # Settings for LLM models. # The LLM model settings.
        "model": "A String", # The selected LLM model.
        "promptText": "A String", # The custom prompt to use.
      },
      "modelParameter": { # Parameters to be passed to the LLM. If not set, default values will be used. # Parameters passed to the LLM to configure its behavior.
        "maxDecodeSteps": 42, # The maximum number of tokens to generate.
        "temperature": 3.14, # The temperature used for sampling. Temperature sampling occurs after both topP and topK have been applied. Valid range: [0.0, 1.0] Low temperature = less random. High temperature = more random.
        "topK": 42, # If set, the sampling process in each step is limited to the top_k tokens with highest probabilities. Valid range: [1, 40] or 1000+. Small topK = less random. Large topK = more random.
        "topP": 3.14, # If set, only the tokens comprising the top top_p probability mass are considered. If both top_p and top_k are set, top_p will be used for further refining candidates selected with top_k. Valid range: (0.0, 1.0]. Small topP = less random. Large topP = more random.
      },
      "name": "A String", # 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/`.
      "placeholders": [ # Optional. List of custom placeholders in the prompt text.
        { # Represents a custom placeholder in the prompt text.
          "id": "A String", # Unique ID used to map custom placeholder to parameters in fulfillment.
          "name": "A String", # Custom placeholder value in the prompt text.
        },
      ],
      "promptText": { # Text input which can be used for prompt or banned phrases. # Required. Prompt for the LLM model.
        "text": "A String", # Required. Text input which can be used for prompt or banned phrases.
      },
    }

`list(parent, languageCode=None, pageSize=None, pageToken=None, x__xgafv=None)`

    Returns the list of all generators in the specified agent.

    Args:
      parent: string, Required. The agent to list all generators for. Format: `projects//locations//agents/`. (required)
      languageCode: string, The language to list generators for.
      pageSize: integer, The maximum number of items to return in a single page. By default 100 and at most 1000.
      pageToken: string, The next_page_token value returned from a previous list request.
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # The response message for Generators.ListGenerators.
      "generators": [ # The list of generators. There will be a maximum number of items returned based on the page_size field in the request.
        { # Generators contain prompt to be sent to the LLM model to generate text. The prompt can contain parameters which will be resolved before calling the model. It can optionally contain banned phrases to ensure the model responses are safe.
          "displayName": "A String", # Required. The human-readable name of the generator, unique within the agent. The prompt contains pre-defined parameters such as $conversation, $last-user-utterance, etc. populated by Dialogflow. It can also contain custom placeholders which will be resolved during fulfillment.
          "llmModelSettings": { # Settings for LLM models. # The LLM model settings.
            "model": "A String", # The selected LLM model.
            "promptText": "A String", # The custom prompt to use.
          },
          "modelParameter": { # Parameters to be passed to the LLM. If not set, default values will be used. # Parameters passed to the LLM to configure its behavior.
            "maxDecodeSteps": 42, # The maximum number of tokens to generate.
            "temperature": 3.14, # The temperature used for sampling. Temperature sampling occurs after both topP and topK have been applied. Valid range: [0.0, 1.0] Low temperature = less random. High temperature = more random.
            "topK": 42, # If set, the sampling process in each step is limited to the top_k tokens with highest probabilities. Valid range: [1, 40] or 1000+. Small topK = less random. Large topK = more random.
            "topP": 3.14, # If set, only the tokens comprising the top top_p probability mass are considered. If both top_p and top_k are set, top_p will be used for further refining candidates selected with top_k. Valid range: (0.0, 1.0]. Small topP = less random. Large topP = more random.
          },
          "name": "A String", # 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/`.
          "placeholders": [ # Optional. List of custom placeholders in the prompt text.
            { # Represents a custom placeholder in the prompt text.
              "id": "A String", # Unique ID used to map custom placeholder to parameters in fulfillment.
              "name": "A String", # Custom placeholder value in the prompt text.
            },
          ],
          "promptText": { # Text input which can be used for prompt or banned phrases. # Required. Prompt for the LLM model.
            "text": "A String", # Required. Text input which can be used for prompt or banned phrases.
          },
        },
      ],
      "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
    }

`list_next()`

    Retrieves the next page of results.

            Args:
              previous_request: The request for the previous page. (required)
              previous_response: The response from the request for the previous page. (required)

            Returns:
              A request object that you can call 'execute()' on to request the next
              page. Returns None if there are no more items in the collection.

`patch(name, body=None, languageCode=None, updateMask=None, x__xgafv=None)`

    Update the specified generator.

    Args:
      name: string, 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/`. (required)
      body: object, The request body.
        The object takes the form of:

    { # Generators contain prompt to be sent to the LLM model to generate text. The prompt can contain parameters which will be resolved before calling the model. It can optionally contain banned phrases to ensure the model responses are safe.
      "displayName": "A String", # Required. The human-readable name of the generator, unique within the agent. The prompt contains pre-defined parameters such as $conversation, $last-user-utterance, etc. populated by Dialogflow. It can also contain custom placeholders which will be resolved during fulfillment.
      "llmModelSettings": { # Settings for LLM models. # The LLM model settings.
        "model": "A String", # The selected LLM model.
        "promptText": "A String", # The custom prompt to use.
      },
      "modelParameter": { # Parameters to be passed to the LLM. If not set, default values will be used. # Parameters passed to the LLM to configure its behavior.
        "maxDecodeSteps": 42, # The maximum number of tokens to generate.
        "temperature": 3.14, # The temperature used for sampling. Temperature sampling occurs after both topP and topK have been applied. Valid range: [0.0, 1.0] Low temperature = less random. High temperature = more random.
        "topK": 42, # If set, the sampling process in each step is limited to the top_k tokens with highest probabilities. Valid range: [1, 40] or 1000+. Small topK = less random. Large topK = more random.
        "topP": 3.14, # If set, only the tokens comprising the top top_p probability mass are considered. If both top_p and top_k are set, top_p will be used for further refining candidates selected with top_k. Valid range: (0.0, 1.0]. Small topP = less random. Large topP = more random.
      },
      "name": "A String", # 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/`.
      "placeholders": [ # Optional. List of custom placeholders in the prompt text.
        { # Represents a custom placeholder in the prompt text.
          "id": "A String", # Unique ID used to map custom placeholder to parameters in fulfillment.
          "name": "A String", # Custom placeholder value in the prompt text.
        },
      ],
      "promptText": { # Text input which can be used for prompt or banned phrases. # Required. Prompt for the LLM model.
        "text": "A String", # Required. Text input which can be used for prompt or banned phrases.
      },
    }

      languageCode: string, The language to list generators for.
      updateMask: string, The mask to control which fields get updated. If the mask is not present, all fields will be updated.
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Generators contain prompt to be sent to the LLM model to generate text. The prompt can contain parameters which will be resolved before calling the model. It can optionally contain banned phrases to ensure the model responses are safe.
      "displayName": "A String", # Required. The human-readable name of the generator, unique within the agent. The prompt contains pre-defined parameters such as $conversation, $last-user-utterance, etc. populated by Dialogflow. It can also contain custom placeholders which will be resolved during fulfillment.
      "llmModelSettings": { # Settings for LLM models. # The LLM model settings.
        "model": "A String", # The selected LLM model.
        "promptText": "A String", # The custom prompt to use.
      },
      "modelParameter": { # Parameters to be passed to the LLM. If not set, default values will be used. # Parameters passed to the LLM to configure its behavior.
        "maxDecodeSteps": 42, # The maximum number of tokens to generate.
        "temperature": 3.14, # The temperature used for sampling. Temperature sampling occurs after both topP and topK have been applied. Valid range: [0.0, 1.0] Low temperature = less random. High temperature = more random.
        "topK": 42, # If set, the sampling process in each step is limited to the top_k tokens with highest probabilities. Valid range: [1, 40] or 1000+. Small topK = less random. Large topK = more random.
        "topP": 3.14, # If set, only the tokens comprising the top top_p probability mass are considered. If both top_p and top_k are set, top_p will be used for further refining candidates selected with top_k. Valid range: (0.0, 1.0]. Small topP = less random. Large topP = more random.
      },
      "name": "A String", # 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/`.
      "placeholders": [ # Optional. List of custom placeholders in the prompt text.
        { # Represents a custom placeholder in the prompt text.
          "id": "A String", # Unique ID used to map custom placeholder to parameters in fulfillment.
          "name": "A String", # Custom placeholder value in the prompt text.
        },
      ],
      "promptText": { # Text input which can be used for prompt or banned phrases. # Required. Prompt for the LLM model.
        "text": "A String", # Required. Text input which can be used for prompt or banned phrases.
      },
    }