REST Resource: projects.locations.generators

Resource: Generator

LLM generator.

JSON representation
{
  "name": string,
  "description": string,
  "inferenceParameter": {
    object (InferenceParameter)
  },
  "triggerEvent": enum (TriggerEvent),
  "createTime": string,
  "updateTime": string,
  "tools": [
    string
  ],
  "suggestionDedupingConfig": {
    object (SuggestionDedupingConfig)
  },
  "toolsetTools": [
    {
      object (ToolsetTool)
    }
  ],
  "cesToolSpecs": [
    {
      object (CesToolSpec)
    }
  ],
  "cesAppSpecs": [
    {
      object (CesAppSpec)
    }
  ],

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "freeFormContext": {
    object (FreeFormContext)
  },
  "agentCoachingContext": {
    object (AgentCoachingContext)
  },
  "summarizationContext": {
    object (SummarizationContext)
  }
  // End of mutually exclusive fields.

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "publishedModel": string
  // End of mutually exclusive fields.
}
Fields
name

string

Output only. Identifier. The resource name of the generator. Format: projects/<Project ID>/locations/<Location ID>/generators/<Generator ID>

description

string

Optional. Human readable description of the generator.

inferenceParameter

object (InferenceParameter)

Optional. Inference parameters for this generator.

triggerEvent

enum (TriggerEvent)

Optional. The trigger event of the generator. It defines when the generator is triggered in a conversation.

createTime

string (Timestamp format)

Output only. Creation time of this generator.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

Output only. Update time of this generator.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

tools[]

string

Optional. Resource names of the tools that the generator can choose from. Format: projects/<Project ID>/locations/<Location ID>/tools/<tool ID>.

suggestionDedupingConfig

object (SuggestionDedupingConfig)

Optional. Configuration for suggestion deduping. This is only applicable to AI Coach feature.

toolsetTools[]

object (ToolsetTool)

Optional. List of CES toolset specs that the generator can choose from.

cesToolSpecs[]

object (CesToolSpec)

Optional. List of CES tool specs that the generator can choose from.

cesAppSpecs[]
(deprecated)

object (CesAppSpec)

Optional. Deprecated: Use cesToolSpecs instead. List of CES app specs that the generator can choose from.

Required. Input context of the generator. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response:
freeFormContext

object (FreeFormContext)

Input of free from generator to LLM.

agentCoachingContext

object (AgentCoachingContext)

Input of Agent Coaching feature.

summarizationContext

object (SummarizationContext)

Input of Summarization feature.

End of mutually exclusive fields.
The foundation model to use for generating suggestions. If a foundation model isn't specified here, a model specifically tuned for the feature type (and version when applicable) will be used. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response:
publishedModel

string

Optional. The published Large Language Model name. * To use the latest model version, specify the model name without version number. Example: text-bison * To use a stable model version, specify the version number as well. Example: text-bison@002.

End of mutually exclusive fields.

Methods

create

Creates a generator.

delete

Deletes a generator.

get

Retrieves a generator.

list

Lists generators.

patch

Updates a generator.