@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
232 lines • 9.93 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* LLM generator.
*
* To get more information about Generator, see:
*
* * [API documentation](https://cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/projects.locations.generators)
* * How-to Guides
* * [Official Documentation](https://cloud.google.com/agent-assist/docs)
*
* ## Example Usage
*
* ### Dialogflow Generator Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const summarizationBasicGenerator = new gcp.diagflow.Generator("summarization_basic_generator", {
* location: "global",
* description: "A v4.0 summarization generator.",
* inferenceParameter: {
* maxOutputTokens: 1024,
* temperature: 0,
* topK: 40,
* topP: 0.95,
* },
* summarizationContext: {
* version: "4.0",
* outputLanguageCode: "en",
* },
* triggerEvent: "MANUAL_CALL",
* });
* ```
*
* ## Import
*
* Generator can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/generators/{{name}}`
* * `{{project}}/{{location}}/{{name}}`
* * `{{location}}/{{name}}`
*
* When using the `pulumi import` command, Generator can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:diagflow/generator:Generator default projects/{{project}}/locations/{{location}}/generators/{{name}}
* $ pulumi import gcp:diagflow/generator:Generator default {{project}}/{{location}}/{{name}}
* $ pulumi import gcp:diagflow/generator:Generator default {{location}}/{{name}}
* ```
*/
export declare class Generator extends pulumi.CustomResource {
/**
* Get an existing Generator resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: GeneratorState, opts?: pulumi.CustomResourceOptions): Generator;
/**
* Returns true if the given object is an instance of Generator. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Generator;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
readonly deletionPolicy: pulumi.Output<string>;
/**
* Optional. Human readable description of the generator.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Optional. The ID to use for the generator, which will become the final component of the generator's resource name.
*/
readonly generatorId: pulumi.Output<string>;
/**
* Optional. Inference parameters for this generator.
* Structure is documented below.
*/
readonly inferenceParameter: pulumi.Output<outputs.diagflow.GeneratorInferenceParameter | undefined>;
/**
* desc
*/
readonly location: pulumi.Output<string>;
/**
* The resource name of the generator.
*/
readonly name: pulumi.Output<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
readonly project: pulumi.Output<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.
*/
readonly publishedModel: pulumi.Output<string | undefined>;
/**
* Input of prebuilt Summarization feature.
* Structure is documented below.
*/
readonly summarizationContext: pulumi.Output<outputs.diagflow.GeneratorSummarizationContext>;
/**
* Optional. The trigger event of the generator. It defines when the generator is triggered in a conversation.
* Possible values are: `END_OF_UTTERANCE`, `MANUAL_CALL`, `CUSTOMER_MESSAGE`, `AGENT_MESSAGE`.
*/
readonly triggerEvent: pulumi.Output<string | undefined>;
/**
* Create a Generator resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: GeneratorArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Generator resources.
*/
export interface GeneratorState {
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* Optional. Human readable description of the generator.
*/
description?: pulumi.Input<string | undefined>;
/**
* Optional. The ID to use for the generator, which will become the final component of the generator's resource name.
*/
generatorId?: pulumi.Input<string | undefined>;
/**
* Optional. Inference parameters for this generator.
* Structure is documented below.
*/
inferenceParameter?: pulumi.Input<inputs.diagflow.GeneratorInferenceParameter | undefined>;
/**
* desc
*/
location?: pulumi.Input<string | undefined>;
/**
* The resource name of the generator.
*/
name?: pulumi.Input<string | undefined>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string | undefined>;
/**
* 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.
*/
publishedModel?: pulumi.Input<string | undefined>;
/**
* Input of prebuilt Summarization feature.
* Structure is documented below.
*/
summarizationContext?: pulumi.Input<inputs.diagflow.GeneratorSummarizationContext | undefined>;
/**
* Optional. The trigger event of the generator. It defines when the generator is triggered in a conversation.
* Possible values are: `END_OF_UTTERANCE`, `MANUAL_CALL`, `CUSTOMER_MESSAGE`, `AGENT_MESSAGE`.
*/
triggerEvent?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a Generator resource.
*/
export interface GeneratorArgs {
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* Optional. Human readable description of the generator.
*/
description?: pulumi.Input<string | undefined>;
/**
* Optional. The ID to use for the generator, which will become the final component of the generator's resource name.
*/
generatorId?: pulumi.Input<string | undefined>;
/**
* Optional. Inference parameters for this generator.
* Structure is documented below.
*/
inferenceParameter?: pulumi.Input<inputs.diagflow.GeneratorInferenceParameter | undefined>;
/**
* desc
*/
location: pulumi.Input<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string | undefined>;
/**
* 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.
*/
publishedModel?: pulumi.Input<string | undefined>;
/**
* Input of prebuilt Summarization feature.
* Structure is documented below.
*/
summarizationContext: pulumi.Input<inputs.diagflow.GeneratorSummarizationContext>;
/**
* Optional. The trigger event of the generator. It defines when the generator is triggered in a conversation.
* Possible values are: `END_OF_UTTERANCE`, `MANUAL_CALL`, `CUSTOMER_MESSAGE`, `AGENT_MESSAGE`.
*/
triggerEvent?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=generator.d.ts.map