Description
Example Usage
Ces App Version Basic
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const my_app = new gcp.ces.App("my-app", {
location: "us",
displayName: "my-app",
appId: "app-id",
timeZoneSettings: {
timeZone: "America/Los_Angeles",
},
});
const my_app_version = new gcp.ces.AppVersion("my-app-version", {
location: "us",
displayName: "my-app-version",
app: my_app.name,
appVersionId: "app-version-id",
description: "example-app-version",
});
import pulumi
import pulumi_gcp as gcp
my_app = gcp.ces.App("my-app",
location="us",
display_name="my-app",
app_id="app-id",
time_zone_settings={
"time_zone": "America/Los_Angeles",
})
my_app_version = gcp.ces.AppVersion("my-app-version",
location="us",
display_name="my-app-version",
app=my_app.name,
app_version_id="app-version-id",
description="example-app-version")
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/ces"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
my_app, err := ces.NewApp(ctx, "my-app", &ces.AppArgs{
Location: pulumi.String("us"),
DisplayName: pulumi.String("my-app"),
AppId: pulumi.String("app-id"),
TimeZoneSettings: &ces.AppTimeZoneSettingsArgs{
TimeZone: pulumi.String("America/Los_Angeles"),
},
})
if err != nil {
return err
}
_, err = ces.NewAppVersion(ctx, "my-app-version", &ces.AppVersionArgs{
Location: pulumi.String("us"),
DisplayName: pulumi.String("my-app-version"),
App: my_app.Name,
AppVersionId: pulumi.String("app-version-id"),
Description: pulumi.String("example-app-version"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var my_app = new Gcp.Ces.App("my-app", new()
{
Location = "us",
DisplayName = "my-app",
AppId = "app-id",
TimeZoneSettings = new Gcp.Ces.Inputs.AppTimeZoneSettingsArgs
{
TimeZone = "America/Los_Angeles",
},
});
var my_app_version = new Gcp.Ces.AppVersion("my-app-version", new()
{
Location = "us",
DisplayName = "my-app-version",
App = my_app.Name,
AppVersionId = "app-version-id",
Description = "example-app-version",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.ces.App;
import com.pulumi.gcp.ces.AppArgs;
import com.pulumi.gcp.ces.inputs.AppTimeZoneSettingsArgs;
import com.pulumi.gcp.ces.AppVersion;
import com.pulumi.gcp.ces.AppVersionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var my_app = new App("my-app", AppArgs.builder()
.location("us")
.displayName("my-app")
.appId("app-id")
.timeZoneSettings(AppTimeZoneSettingsArgs.builder()
.timeZone("America/Los_Angeles")
.build())
.build());
var my_app_version = new AppVersion("my-app-version", AppVersionArgs.builder()
.location("us")
.displayName("my-app-version")
.app(my_app.name())
.appVersionId("app-version-id")
.description("example-app-version")
.build());
}
}
resources:
my-app:
type: gcp:ces:App
properties:
location: us
displayName: my-app
appId: app-id
timeZoneSettings:
timeZone: America/Los_Angeles
my-app-version:
type: gcp:ces:AppVersion
properties:
location: us
displayName: my-app-version
app: ${["my-app"].name}
appVersionId: app-version-id
description: example-app-version
Create AppVersion Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new AppVersion(name: string, args: AppVersionArgs, opts?: CustomResourceOptions);@overload
def AppVersion(resource_name: str,
args: AppVersionArgs,
opts: Optional[ResourceOptions] = None)
@overload
def AppVersion(resource_name: str,
opts: Optional[ResourceOptions] = None,
app: Optional[str] = None,
app_version_id: Optional[str] = None,
location: Optional[str] = None,
description: Optional[str] = None,
display_name: Optional[str] = None,
project: Optional[str] = None)func NewAppVersion(ctx *Context, name string, args AppVersionArgs, opts ...ResourceOption) (*AppVersion, error)public AppVersion(string name, AppVersionArgs args, CustomResourceOptions? opts = null)
public AppVersion(String name, AppVersionArgs args)
public AppVersion(String name, AppVersionArgs args, CustomResourceOptions options)
type: gcp:ces:AppVersion
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args AppVersionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args AppVersionArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args AppVersionArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AppVersionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AppVersionArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var appVersionResource = new Gcp.Ces.AppVersion("appVersionResource", new()
{
App = "string",
AppVersionId = "string",
Location = "string",
Description = "string",
DisplayName = "string",
Project = "string",
});
example, err := ces.NewAppVersion(ctx, "appVersionResource", &ces.AppVersionArgs{
App: pulumi.String("string"),
AppVersionId: pulumi.String("string"),
Location: pulumi.String("string"),
Description: pulumi.String("string"),
DisplayName: pulumi.String("string"),
Project: pulumi.String("string"),
})
var appVersionResource = new AppVersion("appVersionResource", AppVersionArgs.builder()
.app("string")
.appVersionId("string")
.location("string")
.description("string")
.displayName("string")
.project("string")
.build());
app_version_resource = gcp.ces.AppVersion("appVersionResource",
app="string",
app_version_id="string",
location="string",
description="string",
display_name="string",
project="string")
const appVersionResource = new gcp.ces.AppVersion("appVersionResource", {
app: "string",
appVersionId: "string",
location: "string",
description: "string",
displayName: "string",
project: "string",
});
type: gcp:ces:AppVersion
properties:
app: string
appVersionId: string
description: string
displayName: string
location: string
project: string
AppVersion Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The AppVersion resource accepts the following input properties:
- App string
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - App
Version stringId - The ID to use for the app version, which will become the final component of the app version's resource name. If not provided, a unique ID will be automatically assigned for the app version.
- Location string
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - Description string
- The description of the app version.
- Display
Name string - The display name of the app version.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- App string
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - App
Version stringId - The ID to use for the app version, which will become the final component of the app version's resource name. If not provided, a unique ID will be automatically assigned for the app version.
- Location string
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - Description string
- The description of the app version.
- Display
Name string - The display name of the app version.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- app String
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - app
Version StringId - The ID to use for the app version, which will become the final component of the app version's resource name. If not provided, a unique ID will be automatically assigned for the app version.
- location String
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - description String
- The description of the app version.
- display
Name String - The display name of the app version.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- app string
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - app
Version stringId - The ID to use for the app version, which will become the final component of the app version's resource name. If not provided, a unique ID will be automatically assigned for the app version.
- location string
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - description string
- The description of the app version.
- display
Name string - The display name of the app version.
- project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- app str
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - app_
version_ strid - The ID to use for the app version, which will become the final component of the app version's resource name. If not provided, a unique ID will be automatically assigned for the app version.
- location str
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - description str
- The description of the app version.
- display_
name str - The display name of the app version.
- project str
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- app String
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - app
Version StringId - The ID to use for the app version, which will become the final component of the app version's resource name. If not provided, a unique ID will be automatically assigned for the app version.
- location String
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - description String
- The description of the app version.
- display
Name String - The display name of the app version.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Outputs
All input properties are implicitly available as output properties. Additionally, the AppVersion resource produces the following output properties:
- Create
Time string - (Output) Timestamp when the toolset was created.
- Creator string
- Email of the user who created the app version.
- Etag string
- (Output) ETag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - Snapshots
List<App
Version Snapshot> - A snapshot of the app. Structure is documented below.
- Create
Time string - (Output) Timestamp when the toolset was created.
- Creator string
- Email of the user who created the app version.
- Etag string
- (Output) ETag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - Snapshots
[]App
Version Snapshot - A snapshot of the app. Structure is documented below.
- create
Time String - (Output) Timestamp when the toolset was created.
- creator String
- Email of the user who created the app version.
- etag String
- (Output) ETag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - snapshots
List<App
Version Snapshot> - A snapshot of the app. Structure is documented below.
- create
Time string - (Output) Timestamp when the toolset was created.
- creator string
- Email of the user who created the app version.
- etag string
- (Output) ETag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - snapshots
App
Version Snapshot[] - A snapshot of the app. Structure is documented below.
- create_
time str - (Output) Timestamp when the toolset was created.
- creator str
- Email of the user who created the app version.
- etag str
- (Output) ETag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - snapshots
Sequence[App
Version Snapshot] - A snapshot of the app. Structure is documented below.
- create
Time String - (Output) Timestamp when the toolset was created.
- creator String
- Email of the user who created the app version.
- etag String
- (Output) ETag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - snapshots List<Property Map>
- A snapshot of the app. Structure is documented below.
Look up Existing AppVersion Resource
Get an existing AppVersion resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: AppVersionState, opts?: CustomResourceOptions): AppVersion@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
app: Optional[str] = None,
app_version_id: Optional[str] = None,
create_time: Optional[str] = None,
creator: Optional[str] = None,
description: Optional[str] = None,
display_name: Optional[str] = None,
etag: Optional[str] = None,
location: Optional[str] = None,
name: Optional[str] = None,
project: Optional[str] = None,
snapshots: Optional[Sequence[AppVersionSnapshotArgs]] = None) -> AppVersionfunc GetAppVersion(ctx *Context, name string, id IDInput, state *AppVersionState, opts ...ResourceOption) (*AppVersion, error)public static AppVersion Get(string name, Input<string> id, AppVersionState? state, CustomResourceOptions? opts = null)public static AppVersion get(String name, Output<String> id, AppVersionState state, CustomResourceOptions options)resources: _: type: gcp:ces:AppVersion get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- App string
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - App
Version stringId - The ID to use for the app version, which will become the final component of the app version's resource name. If not provided, a unique ID will be automatically assigned for the app version.
- Create
Time string - (Output) Timestamp when the toolset was created.
- Creator string
- Email of the user who created the app version.
- Description string
- The description of the app version.
- Display
Name string - The display name of the app version.
- Etag string
- (Output) ETag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
- Location string
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - Name string
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Snapshots
List<App
Version Snapshot> - A snapshot of the app. Structure is documented below.
- App string
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - App
Version stringId - The ID to use for the app version, which will become the final component of the app version's resource name. If not provided, a unique ID will be automatically assigned for the app version.
- Create
Time string - (Output) Timestamp when the toolset was created.
- Creator string
- Email of the user who created the app version.
- Description string
- The description of the app version.
- Display
Name string - The display name of the app version.
- Etag string
- (Output) ETag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
- Location string
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - Name string
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Snapshots
[]App
Version Snapshot Args - A snapshot of the app. Structure is documented below.
- app String
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - app
Version StringId - The ID to use for the app version, which will become the final component of the app version's resource name. If not provided, a unique ID will be automatically assigned for the app version.
- create
Time String - (Output) Timestamp when the toolset was created.
- creator String
- Email of the user who created the app version.
- description String
- The description of the app version.
- display
Name String - The display name of the app version.
- etag String
- (Output) ETag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
- location String
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - name String
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- snapshots
List<App
Version Snapshot> - A snapshot of the app. Structure is documented below.
- app string
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - app
Version stringId - The ID to use for the app version, which will become the final component of the app version's resource name. If not provided, a unique ID will be automatically assigned for the app version.
- create
Time string - (Output) Timestamp when the toolset was created.
- creator string
- Email of the user who created the app version.
- description string
- The description of the app version.
- display
Name string - The display name of the app version.
- etag string
- (Output) ETag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
- location string
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - name string
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- snapshots
App
Version Snapshot[] - A snapshot of the app. Structure is documented below.
- app str
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - app_
version_ strid - The ID to use for the app version, which will become the final component of the app version's resource name. If not provided, a unique ID will be automatically assigned for the app version.
- create_
time str - (Output) Timestamp when the toolset was created.
- creator str
- Email of the user who created the app version.
- description str
- The description of the app version.
- display_
name str - The display name of the app version.
- etag str
- (Output) ETag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
- location str
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - name str
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - project str
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- snapshots
Sequence[App
Version Snapshot Args] - A snapshot of the app. Structure is documented below.
- app String
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - app
Version StringId - The ID to use for the app version, which will become the final component of the app version's resource name. If not provided, a unique ID will be automatically assigned for the app version.
- create
Time String - (Output) Timestamp when the toolset was created.
- creator String
- Email of the user who created the app version.
- description String
- The description of the app version.
- display
Name String - The display name of the app version.
- etag String
- (Output) ETag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
- location String
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - name String
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- snapshots List<Property Map>
- A snapshot of the app. Structure is documented below.
Supporting Types
AppVersionSnapshot, AppVersionSnapshotArgs
- Agents
List<App
Version Snapshot Agent> - (Output) List of agents in the app. Structure is documented below.
- Apps
List<App
Version Snapshot App> - Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - Examples
List<App
Version Snapshot Example> - (Output) List of examples in the app. Structure is documented below.
- Guardrails
List<App
Version Snapshot Guardrail> - (Output)
List of guardrails for the app.
Format:
projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail} - Tools
List<App
Version Snapshot Tool> - (Output)
List of available tools for the agent.
Format:
projects/{project}/locations/{location}/apps/{app}/tools/{tool} - Toolsets
List<App
Version Snapshot Toolset> - (Output) List of toolsets for the agent. Structure is documented below.
- Agents
[]App
Version Snapshot Agent - (Output) List of agents in the app. Structure is documented below.
- Apps
[]App
Version Snapshot App - Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - Examples
[]App
Version Snapshot Example - (Output) List of examples in the app. Structure is documented below.
- Guardrails
[]App
Version Snapshot Guardrail - (Output)
List of guardrails for the app.
Format:
projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail} - Tools
[]App
Version Snapshot Tool - (Output)
List of available tools for the agent.
Format:
projects/{project}/locations/{location}/apps/{app}/tools/{tool} - Toolsets
[]App
Version Snapshot Toolset - (Output) List of toolsets for the agent. Structure is documented below.
- agents
List<App
Version Snapshot Agent> - (Output) List of agents in the app. Structure is documented below.
- apps
List<App
Version Snapshot App> - Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - examples
List<App
Version Snapshot Example> - (Output) List of examples in the app. Structure is documented below.
- guardrails
List<App
Version Snapshot Guardrail> - (Output)
List of guardrails for the app.
Format:
projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail} - tools
List<App
Version Snapshot Tool> - (Output)
List of available tools for the agent.
Format:
projects/{project}/locations/{location}/apps/{app}/tools/{tool} - toolsets
List<App
Version Snapshot Toolset> - (Output) List of toolsets for the agent. Structure is documented below.
- agents
App
Version Snapshot Agent[] - (Output) List of agents in the app. Structure is documented below.
- apps
App
Version Snapshot App[] - Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - examples
App
Version Snapshot Example[] - (Output) List of examples in the app. Structure is documented below.
- guardrails
App
Version Snapshot Guardrail[] - (Output)
List of guardrails for the app.
Format:
projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail} - tools
App
Version Snapshot Tool[] - (Output)
List of available tools for the agent.
Format:
projects/{project}/locations/{location}/apps/{app}/tools/{tool} - toolsets
App
Version Snapshot Toolset[] - (Output) List of toolsets for the agent. Structure is documented below.
- agents
Sequence[App
Version Snapshot Agent] - (Output) List of agents in the app. Structure is documented below.
- apps
Sequence[App
Version Snapshot App] - Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - examples
Sequence[App
Version Snapshot Example] - (Output) List of examples in the app. Structure is documented below.
- guardrails
Sequence[App
Version Snapshot Guardrail] - (Output)
List of guardrails for the app.
Format:
projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail} - tools
Sequence[App
Version Snapshot Tool] - (Output)
List of available tools for the agent.
Format:
projects/{project}/locations/{location}/apps/{app}/tools/{tool} - toolsets
Sequence[App
Version Snapshot Toolset] - (Output) List of toolsets for the agent. Structure is documented below.
- agents List<Property Map>
- (Output) List of agents in the app. Structure is documented below.
- apps List<Property Map>
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - examples List<Property Map>
- (Output) List of examples in the app. Structure is documented below.
- guardrails List<Property Map>
- (Output)
List of guardrails for the app.
Format:
projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail} - tools List<Property Map>
- (Output)
List of available tools for the agent.
Format:
projects/{project}/locations/{location}/apps/{app}/tools/{tool} - toolsets List<Property Map>
- (Output) List of toolsets for the agent. Structure is documented below.
AppVersionSnapshotAgent, AppVersionSnapshotAgentArgs
- After
Agent List<AppCallbacks Version Snapshot Agent After Agent Callback> - (Output) The callbacks to execute after the agent is called. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped. Structure is documented below.
- After
Model List<AppCallbacks Version Snapshot Agent After Model Callback> - (Output) The callbacks to execute after the model is called. If there are multiple calls to the model, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped. Structure is documented below.
- After
Tool List<AppCallbacks Version Snapshot Agent After Tool Callback> - (Output) The callbacks to execute after the tool is invoked. If there are multiple tool invocations, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped. Structure is documented below.
- Before
Agent List<AppCallbacks Version Snapshot Agent Before Agent Callback> - (Output) The callbacks to execute before the agent is called. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped. Structure is documented below.
- Before
Model List<AppCallbacks Version Snapshot Agent Before Model Callback> - (Output) The callbacks to execute before the model is called. If there are multiple calls to the model, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped. Structure is documented below.
- Before
Tool List<AppCallbacks Version Snapshot Agent Before Tool Callback> - (Output) The callbacks to execute before the tool is invoked. If there are multiple tool invocations, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped. Structure is documented below.
- Child
Agents List<string> - (Output)
List of child agents in the agent tree.
Format:
projects/{project}/locations/{location}/apps/{app}/agents/{agent} - Create
Time string - (Output) Timestamp when the toolset was created.
- Description string
- The description of the app version.
- Display
Name string - The display name of the app version.
- Etag string
- (Output) ETag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
- Generated
Summary string - (Output) If the tool is generated by the LLM assistant, this field contains a descriptive summary of the generation.
- Guardrails List<string>
- (Output)
List of guardrails for the app.
Format:
projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail} - Instruction string
- (Output) Instructions for the LLM model to guide the agent's behavior.
- Llm
Agents List<AppVersion Snapshot Agent Llm Agent> - (Output) Default agent type. The agent uses instructions and callbacks specified in the agent to perform the task using a large language model.
- Model
Settings List<AppVersion Snapshot Agent Model Setting> - (Output) Model settings contains various configurations for the LLM model. Structure is documented below.
- Name string
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - Remote
Dialogflow List<AppAgents Version Snapshot Agent Remote Dialogflow Agent> - (Output) The agent which will transfer execution to an existing remote Dialogflow agent flow. The corresponding Dialogflow agent will process subsequent user queries until the session ends or flow ends and the control is transferred back to the parent CES agent. Structure is documented below.
- Tools List<string>
- (Output)
List of available tools for the agent.
Format:
projects/{project}/locations/{location}/apps/{app}/tools/{tool} - Toolsets
List<App
Version Snapshot Agent Toolset> - (Output) List of toolsets for the agent. Structure is documented below.
- Update
Time string - (Output) Timestamp when the toolset was last updated.
- After
Agent []AppCallbacks Version Snapshot Agent After Agent Callback - (Output) The callbacks to execute after the agent is called. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped. Structure is documented below.
- After
Model []AppCallbacks Version Snapshot Agent After Model Callback - (Output) The callbacks to execute after the model is called. If there are multiple calls to the model, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped. Structure is documented below.
- After
Tool []AppCallbacks Version Snapshot Agent After Tool Callback - (Output) The callbacks to execute after the tool is invoked. If there are multiple tool invocations, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped. Structure is documented below.
- Before
Agent []AppCallbacks Version Snapshot Agent Before Agent Callback - (Output) The callbacks to execute before the agent is called. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped. Structure is documented below.
- Before
Model []AppCallbacks Version Snapshot Agent Before Model Callback - (Output) The callbacks to execute before the model is called. If there are multiple calls to the model, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped. Structure is documented below.
- Before
Tool []AppCallbacks Version Snapshot Agent Before Tool Callback - (Output) The callbacks to execute before the tool is invoked. If there are multiple tool invocations, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped. Structure is documented below.
- Child
Agents []string - (Output)
List of child agents in the agent tree.
Format:
projects/{project}/locations/{location}/apps/{app}/agents/{agent} - Create
Time string - (Output) Timestamp when the toolset was created.
- Description string
- The description of the app version.
- Display
Name string - The display name of the app version.
- Etag string
- (Output) ETag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
- Generated
Summary string - (Output) If the tool is generated by the LLM assistant, this field contains a descriptive summary of the generation.
- Guardrails []string
- (Output)
List of guardrails for the app.
Format:
projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail} - Instruction string
- (Output) Instructions for the LLM model to guide the agent's behavior.
- Llm
Agents []AppVersion Snapshot Agent Llm Agent - (Output) Default agent type. The agent uses instructions and callbacks specified in the agent to perform the task using a large language model.
- Model
Settings []AppVersion Snapshot Agent Model Setting - (Output) Model settings contains various configurations for the LLM model. Structure is documented below.
- Name string
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - Remote
Dialogflow []AppAgents Version Snapshot Agent Remote Dialogflow Agent - (Output) The agent which will transfer execution to an existing remote Dialogflow agent flow. The corresponding Dialogflow agent will process subsequent user queries until the session ends or flow ends and the control is transferred back to the parent CES agent. Structure is documented below.
- Tools []string
- (Output)
List of available tools for the agent.
Format:
projects/{project}/locations/{location}/apps/{app}/tools/{tool} - Toolsets
[]App
Version Snapshot Agent Toolset - (Output) List of toolsets for the agent. Structure is documented below.
- Update
Time string - (Output) Timestamp when the toolset was last updated.
- after
Agent List<AppCallbacks Version Snapshot Agent After Agent Callback> - (Output) The callbacks to execute after the agent is called. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped. Structure is documented below.
- after
Model List<AppCallbacks Version Snapshot Agent After Model Callback> - (Output) The callbacks to execute after the model is called. If there are multiple calls to the model, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped. Structure is documented below.
- after
Tool List<AppCallbacks Version Snapshot Agent After Tool Callback> - (Output) The callbacks to execute after the tool is invoked. If there are multiple tool invocations, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped. Structure is documented below.
- before
Agent List<AppCallbacks Version Snapshot Agent Before Agent Callback> - (Output) The callbacks to execute before the agent is called. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped. Structure is documented below.
- before
Model List<AppCallbacks Version Snapshot Agent Before Model Callback> - (Output) The callbacks to execute before the model is called. If there are multiple calls to the model, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped. Structure is documented below.
- before
Tool List<AppCallbacks Version Snapshot Agent Before Tool Callback> - (Output) The callbacks to execute before the tool is invoked. If there are multiple tool invocations, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped. Structure is documented below.
- child
Agents List<String> - (Output)
List of child agents in the agent tree.
Format:
projects/{project}/locations/{location}/apps/{app}/agents/{agent} - create
Time String - (Output) Timestamp when the toolset was created.
- description String
- The description of the app version.
- display
Name String - The display name of the app version.
- etag String
- (Output) ETag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
- generated
Summary String - (Output) If the tool is generated by the LLM assistant, this field contains a descriptive summary of the generation.
- guardrails List<String>
- (Output)
List of guardrails for the app.
Format:
projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail} - instruction String
- (Output) Instructions for the LLM model to guide the agent's behavior.
- llm
Agents List<AppVersion Snapshot Agent Llm Agent> - (Output) Default agent type. The agent uses instructions and callbacks specified in the agent to perform the task using a large language model.
- model
Settings List<AppVersion Snapshot Agent Model Setting> - (Output) Model settings contains various configurations for the LLM model. Structure is documented below.
- name String
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - remote
Dialogflow List<AppAgents Version Snapshot Agent Remote Dialogflow Agent> - (Output) The agent which will transfer execution to an existing remote Dialogflow agent flow. The corresponding Dialogflow agent will process subsequent user queries until the session ends or flow ends and the control is transferred back to the parent CES agent. Structure is documented below.
- tools List<String>
- (Output)
List of available tools for the agent.
Format:
projects/{project}/locations/{location}/apps/{app}/tools/{tool} - toolsets
List<App
Version Snapshot Agent Toolset> - (Output) List of toolsets for the agent. Structure is documented below.
- update
Time String - (Output) Timestamp when the toolset was last updated.
- after
Agent AppCallbacks Version Snapshot Agent After Agent Callback[] - (Output) The callbacks to execute after the agent is called. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped. Structure is documented below.
- after
Model AppCallbacks Version Snapshot Agent After Model Callback[] - (Output) The callbacks to execute after the model is called. If there are multiple calls to the model, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped. Structure is documented below.
- after
Tool AppCallbacks Version Snapshot Agent After Tool Callback[] - (Output) The callbacks to execute after the tool is invoked. If there are multiple tool invocations, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped. Structure is documented below.
- before
Agent AppCallbacks Version Snapshot Agent Before Agent Callback[] - (Output) The callbacks to execute before the agent is called. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped. Structure is documented below.
- before
Model AppCallbacks Version Snapshot Agent Before Model Callback[] - (Output) The callbacks to execute before the model is called. If there are multiple calls to the model, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped. Structure is documented below.
- before
Tool AppCallbacks Version Snapshot Agent Before Tool Callback[] - (Output) The callbacks to execute before the tool is invoked. If there are multiple tool invocations, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped. Structure is documented below.
- child
Agents string[] - (Output)
List of child agents in the agent tree.
Format:
projects/{project}/locations/{location}/apps/{app}/agents/{agent} - create
Time string - (Output) Timestamp when the toolset was created.
- description string
- The description of the app version.
- display
Name string - The display name of the app version.
- etag string
- (Output) ETag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
- generated
Summary string - (Output) If the tool is generated by the LLM assistant, this field contains a descriptive summary of the generation.
- guardrails string[]
- (Output)
List of guardrails for the app.
Format:
projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail} - instruction string
- (Output) Instructions for the LLM model to guide the agent's behavior.
- llm
Agents AppVersion Snapshot Agent Llm Agent[] - (Output) Default agent type. The agent uses instructions and callbacks specified in the agent to perform the task using a large language model.
- model
Settings AppVersion Snapshot Agent Model Setting[] - (Output) Model settings contains various configurations for the LLM model. Structure is documented below.
- name string
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - remote
Dialogflow AppAgents Version Snapshot Agent Remote Dialogflow Agent[] - (Output) The agent which will transfer execution to an existing remote Dialogflow agent flow. The corresponding Dialogflow agent will process subsequent user queries until the session ends or flow ends and the control is transferred back to the parent CES agent. Structure is documented below.
- tools string[]
- (Output)
List of available tools for the agent.
Format:
projects/{project}/locations/{location}/apps/{app}/tools/{tool} - toolsets
App
Version Snapshot Agent Toolset[] - (Output) List of toolsets for the agent. Structure is documented below.
- update
Time string - (Output) Timestamp when the toolset was last updated.
- after_
agent_ Sequence[Appcallbacks Version Snapshot Agent After Agent Callback] - (Output) The callbacks to execute after the agent is called. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped. Structure is documented below.
- after_
model_ Sequence[Appcallbacks Version Snapshot Agent After Model Callback] - (Output) The callbacks to execute after the model is called. If there are multiple calls to the model, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped. Structure is documented below.
- after_
tool_ Sequence[Appcallbacks Version Snapshot Agent After Tool Callback] - (Output) The callbacks to execute after the tool is invoked. If there are multiple tool invocations, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped. Structure is documented below.
- before_
agent_ Sequence[Appcallbacks Version Snapshot Agent Before Agent Callback] - (Output) The callbacks to execute before the agent is called. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped. Structure is documented below.
- before_
model_ Sequence[Appcallbacks Version Snapshot Agent Before Model Callback] - (Output) The callbacks to execute before the model is called. If there are multiple calls to the model, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped. Structure is documented below.
- before_
tool_ Sequence[Appcallbacks Version Snapshot Agent Before Tool Callback] - (Output) The callbacks to execute before the tool is invoked. If there are multiple tool invocations, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped. Structure is documented below.
- child_
agents Sequence[str] - (Output)
List of child agents in the agent tree.
Format:
projects/{project}/locations/{location}/apps/{app}/agents/{agent} - create_
time str - (Output) Timestamp when the toolset was created.
- description str
- The description of the app version.
- display_
name str - The display name of the app version.
- etag str
- (Output) ETag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
- generated_
summary str - (Output) If the tool is generated by the LLM assistant, this field contains a descriptive summary of the generation.
- guardrails Sequence[str]
- (Output)
List of guardrails for the app.
Format:
projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail} - instruction str
- (Output) Instructions for the LLM model to guide the agent's behavior.
- llm_
agents Sequence[AppVersion Snapshot Agent Llm Agent] - (Output) Default agent type. The agent uses instructions and callbacks specified in the agent to perform the task using a large language model.
- model_
settings Sequence[AppVersion Snapshot Agent Model Setting] - (Output) Model settings contains various configurations for the LLM model. Structure is documented below.
- name str
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - remote_
dialogflow_ Sequence[Appagents Version Snapshot Agent Remote Dialogflow Agent] - (Output) The agent which will transfer execution to an existing remote Dialogflow agent flow. The corresponding Dialogflow agent will process subsequent user queries until the session ends or flow ends and the control is transferred back to the parent CES agent. Structure is documented below.
- tools Sequence[str]
- (Output)
List of available tools for the agent.
Format:
projects/{project}/locations/{location}/apps/{app}/tools/{tool} - toolsets
Sequence[App
Version Snapshot Agent Toolset] - (Output) List of toolsets for the agent. Structure is documented below.
- update_
time str - (Output) Timestamp when the toolset was last updated.
- after
Agent List<Property Map>Callbacks - (Output) The callbacks to execute after the agent is called. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped. Structure is documented below.
- after
Model List<Property Map>Callbacks - (Output) The callbacks to execute after the model is called. If there are multiple calls to the model, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped. Structure is documented below.
- after
Tool List<Property Map>Callbacks - (Output) The callbacks to execute after the tool is invoked. If there are multiple tool invocations, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped. Structure is documented below.
- before
Agent List<Property Map>Callbacks - (Output) The callbacks to execute before the agent is called. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped. Structure is documented below.
- before
Model List<Property Map>Callbacks - (Output) The callbacks to execute before the model is called. If there are multiple calls to the model, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped. Structure is documented below.
- before
Tool List<Property Map>Callbacks - (Output) The callbacks to execute before the tool is invoked. If there are multiple tool invocations, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped. Structure is documented below.
- child
Agents List<String> - (Output)
List of child agents in the agent tree.
Format:
projects/{project}/locations/{location}/apps/{app}/agents/{agent} - create
Time String - (Output) Timestamp when the toolset was created.
- description String
- The description of the app version.
- display
Name String - The display name of the app version.
- etag String
- (Output) ETag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
- generated
Summary String - (Output) If the tool is generated by the LLM assistant, this field contains a descriptive summary of the generation.
- guardrails List<String>
- (Output)
List of guardrails for the app.
Format:
projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail} - instruction String
- (Output) Instructions for the LLM model to guide the agent's behavior.
- llm
Agents List<Property Map> - (Output) Default agent type. The agent uses instructions and callbacks specified in the agent to perform the task using a large language model.
- model
Settings List<Property Map> - (Output) Model settings contains various configurations for the LLM model. Structure is documented below.
- name String
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - remote
Dialogflow List<Property Map>Agents - (Output) The agent which will transfer execution to an existing remote Dialogflow agent flow. The corresponding Dialogflow agent will process subsequent user queries until the session ends or flow ends and the control is transferred back to the parent CES agent. Structure is documented below.
- tools List<String>
- (Output)
List of available tools for the agent.
Format:
projects/{project}/locations/{location}/apps/{app}/tools/{tool} - toolsets List<Property Map>
- (Output) List of toolsets for the agent. Structure is documented below.
- update
Time String - (Output) Timestamp when the toolset was last updated.
AppVersionSnapshotAgentAfterAgentCallback, AppVersionSnapshotAgentAfterAgentCallbackArgs
- Description string
- The description of the app version.
- Disabled bool
- (Output) Whether summarization is disabled.
- Python
Code string - (Output) The Python code to execute for the tool.
- Description string
- The description of the app version.
- Disabled bool
- (Output) Whether summarization is disabled.
- Python
Code string - (Output) The Python code to execute for the tool.
- description String
- The description of the app version.
- disabled Boolean
- (Output) Whether summarization is disabled.
- python
Code String - (Output) The Python code to execute for the tool.
- description string
- The description of the app version.
- disabled boolean
- (Output) Whether summarization is disabled.
- python
Code string - (Output) The Python code to execute for the tool.
- description str
- The description of the app version.
- disabled bool
- (Output) Whether summarization is disabled.
- python_
code str - (Output) The Python code to execute for the tool.
- description String
- The description of the app version.
- disabled Boolean
- (Output) Whether summarization is disabled.
- python
Code String - (Output) The Python code to execute for the tool.
AppVersionSnapshotAgentAfterModelCallback, AppVersionSnapshotAgentAfterModelCallbackArgs
- Description string
- The description of the app version.
- Disabled bool
- (Output) Whether summarization is disabled.
- Python
Code string - (Output) The Python code to execute for the tool.
- Description string
- The description of the app version.
- Disabled bool
- (Output) Whether summarization is disabled.
- Python
Code string - (Output) The Python code to execute for the tool.
- description String
- The description of the app version.
- disabled Boolean
- (Output) Whether summarization is disabled.
- python
Code String - (Output) The Python code to execute for the tool.
- description string
- The description of the app version.
- disabled boolean
- (Output) Whether summarization is disabled.
- python
Code string - (Output) The Python code to execute for the tool.
- description str
- The description of the app version.
- disabled bool
- (Output) Whether summarization is disabled.
- python_
code str - (Output) The Python code to execute for the tool.
- description String
- The description of the app version.
- disabled Boolean
- (Output) Whether summarization is disabled.
- python
Code String - (Output) The Python code to execute for the tool.
AppVersionSnapshotAgentAfterToolCallback, AppVersionSnapshotAgentAfterToolCallbackArgs
- Description string
- The description of the app version.
- Disabled bool
- (Output) Whether summarization is disabled.
- Python
Code string - (Output) The Python code to execute for the tool.
- Description string
- The description of the app version.
- Disabled bool
- (Output) Whether summarization is disabled.
- Python
Code string - (Output) The Python code to execute for the tool.
- description String
- The description of the app version.
- disabled Boolean
- (Output) Whether summarization is disabled.
- python
Code String - (Output) The Python code to execute for the tool.
- description string
- The description of the app version.
- disabled boolean
- (Output) Whether summarization is disabled.
- python
Code string - (Output) The Python code to execute for the tool.
- description str
- The description of the app version.
- disabled bool
- (Output) Whether summarization is disabled.
- python_
code str - (Output) The Python code to execute for the tool.
- description String
- The description of the app version.
- disabled Boolean
- (Output) Whether summarization is disabled.
- python
Code String - (Output) The Python code to execute for the tool.
AppVersionSnapshotAgentBeforeAgentCallback, AppVersionSnapshotAgentBeforeAgentCallbackArgs
- Description string
- The description of the app version.
- Disabled bool
- (Output) Whether summarization is disabled.
- Python
Code string - (Output) The Python code to execute for the tool.
- Description string
- The description of the app version.
- Disabled bool
- (Output) Whether summarization is disabled.
- Python
Code string - (Output) The Python code to execute for the tool.
- description String
- The description of the app version.
- disabled Boolean
- (Output) Whether summarization is disabled.
- python
Code String - (Output) The Python code to execute for the tool.
- description string
- The description of the app version.
- disabled boolean
- (Output) Whether summarization is disabled.
- python
Code string - (Output) The Python code to execute for the tool.
- description str
- The description of the app version.
- disabled bool
- (Output) Whether summarization is disabled.
- python_
code str - (Output) The Python code to execute for the tool.
- description String
- The description of the app version.
- disabled Boolean
- (Output) Whether summarization is disabled.
- python
Code String - (Output) The Python code to execute for the tool.
AppVersionSnapshotAgentBeforeModelCallback, AppVersionSnapshotAgentBeforeModelCallbackArgs
- Description string
- The description of the app version.
- Disabled bool
- (Output) Whether summarization is disabled.
- Python
Code string - (Output) The Python code to execute for the tool.
- Description string
- The description of the app version.
- Disabled bool
- (Output) Whether summarization is disabled.
- Python
Code string - (Output) The Python code to execute for the tool.
- description String
- The description of the app version.
- disabled Boolean
- (Output) Whether summarization is disabled.
- python
Code String - (Output) The Python code to execute for the tool.
- description string
- The description of the app version.
- disabled boolean
- (Output) Whether summarization is disabled.
- python
Code string - (Output) The Python code to execute for the tool.
- description str
- The description of the app version.
- disabled bool
- (Output) Whether summarization is disabled.
- python_
code str - (Output) The Python code to execute for the tool.
- description String
- The description of the app version.
- disabled Boolean
- (Output) Whether summarization is disabled.
- python
Code String - (Output) The Python code to execute for the tool.
AppVersionSnapshotAgentBeforeToolCallback, AppVersionSnapshotAgentBeforeToolCallbackArgs
- Description string
- The description of the app version.
- Disabled bool
- (Output) Whether summarization is disabled.
- Python
Code string - (Output) The Python code to execute for the tool.
- Description string
- The description of the app version.
- Disabled bool
- (Output) Whether summarization is disabled.
- Python
Code string - (Output) The Python code to execute for the tool.
- description String
- The description of the app version.
- disabled Boolean
- (Output) Whether summarization is disabled.
- python
Code String - (Output) The Python code to execute for the tool.
- description string
- The description of the app version.
- disabled boolean
- (Output) Whether summarization is disabled.
- python
Code string - (Output) The Python code to execute for the tool.
- description str
- The description of the app version.
- disabled bool
- (Output) Whether summarization is disabled.
- python_
code str - (Output) The Python code to execute for the tool.
- description String
- The description of the app version.
- disabled Boolean
- (Output) Whether summarization is disabled.
- python
Code String - (Output) The Python code to execute for the tool.
AppVersionSnapshotAgentModelSetting, AppVersionSnapshotAgentModelSettingArgs
- Model string
- (Output) The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
- Temperature double
- (Output) If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
- Model string
- (Output) The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
- Temperature float64
- (Output) If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
- model String
- (Output) The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
- temperature Double
- (Output) If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
- model string
- (Output) The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
- temperature number
- (Output) If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
- model str
- (Output) The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
- temperature float
- (Output) If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
- model String
- (Output) The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
- temperature Number
- (Output) If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
AppVersionSnapshotAgentRemoteDialogflowAgent, AppVersionSnapshotAgentRemoteDialogflowAgentArgs
- Agent string
- (Output)
The name of the agent to transfer the conversation to. The agent must be
in the same app as the current agent.
Format:
projects/{project}/locations/{location}/apps/{app}/agents/{agent} - Environment
Id string - (Output) The environment ID of the Dialogflow agent be used for the agent execution. If not specified, the draft environment will be used.
- Flow
Id string - (Output) The flow ID of the flow in the Dialogflow agent.
- Input
Variable Dictionary<string, string>Mapping - (Output) The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input.
- Output
Variable Dictionary<string, string>Mapping - (Output) The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends.
- Agent string
- (Output)
The name of the agent to transfer the conversation to. The agent must be
in the same app as the current agent.
Format:
projects/{project}/locations/{location}/apps/{app}/agents/{agent} - Environment
Id string - (Output) The environment ID of the Dialogflow agent be used for the agent execution. If not specified, the draft environment will be used.
- Flow
Id string - (Output) The flow ID of the flow in the Dialogflow agent.
- Input
Variable map[string]stringMapping - (Output) The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input.
- Output
Variable map[string]stringMapping - (Output) The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends.
- agent String
- (Output)
The name of the agent to transfer the conversation to. The agent must be
in the same app as the current agent.
Format:
projects/{project}/locations/{location}/apps/{app}/agents/{agent} - environment
Id String - (Output) The environment ID of the Dialogflow agent be used for the agent execution. If not specified, the draft environment will be used.
- flow
Id String - (Output) The flow ID of the flow in the Dialogflow agent.
- input
Variable Map<String,String>Mapping - (Output) The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input.
- output
Variable Map<String,String>Mapping - (Output) The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends.
- agent string
- (Output)
The name of the agent to transfer the conversation to. The agent must be
in the same app as the current agent.
Format:
projects/{project}/locations/{location}/apps/{app}/agents/{agent} - environment
Id string - (Output) The environment ID of the Dialogflow agent be used for the agent execution. If not specified, the draft environment will be used.
- flow
Id string - (Output) The flow ID of the flow in the Dialogflow agent.
- input
Variable {[key: string]: string}Mapping - (Output) The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input.
- output
Variable {[key: string]: string}Mapping - (Output) The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends.
- agent str
- (Output)
The name of the agent to transfer the conversation to. The agent must be
in the same app as the current agent.
Format:
projects/{project}/locations/{location}/apps/{app}/agents/{agent} - environment_
id str - (Output) The environment ID of the Dialogflow agent be used for the agent execution. If not specified, the draft environment will be used.
- flow_
id str - (Output) The flow ID of the flow in the Dialogflow agent.
- input_
variable_ Mapping[str, str]mapping - (Output) The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input.
- output_
variable_ Mapping[str, str]mapping - (Output) The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends.
- agent String
- (Output)
The name of the agent to transfer the conversation to. The agent must be
in the same app as the current agent.
Format:
projects/{project}/locations/{location}/apps/{app}/agents/{agent} - environment
Id String - (Output) The environment ID of the Dialogflow agent be used for the agent execution. If not specified, the draft environment will be used.
- flow
Id String - (Output) The flow ID of the flow in the Dialogflow agent.
- input
Variable Map<String>Mapping - (Output) The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input.
- output
Variable Map<String>Mapping - (Output) The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends.
AppVersionSnapshotAgentToolset, AppVersionSnapshotAgentToolsetArgs
AppVersionSnapshotApp, AppVersionSnapshotAppArgs
- Audio
Processing List<AppConfigs Version Snapshot App Audio Processing Config> - (Output) Configuration for how the input and output audio should be processed and delivered. Structure is documented below.
- Client
Certificate List<AppSettings Version Snapshot App Client Certificate Setting> - (Output) The default client certificate settings for the app. Structure is documented below.
- Create
Time string - (Output) Timestamp when the toolset was created.
- Data
Store List<AppSettings Version Snapshot App Data Store Setting> - (Output) Data store related settings for the app. Structure is documented below.
- Default
Channel List<AppProfiles Version Snapshot App Default Channel Profile> - (Output) A ChannelProfile configures the agent's behavior for a specific communication channel, such as web UI or telephony. Structure is documented below.
- Deployment
Count int - (Output) Number of deployments in the app.
- Description string
- The description of the app version.
- Display
Name string - The display name of the app version.
- Etag string
- (Output) ETag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
- Evaluation
Metrics List<AppThresholds Version Snapshot App Evaluation Metrics Threshold> - (Output) Threshold settings for metrics in an Evaluation. Structure is documented below.
- Global
Instruction string - (Output) Instructions for all the agents in the app. You can use this instruction to set up a stable identity or personality across all the agents.
- Guardrails List<string>
- (Output)
List of guardrails for the app.
Format:
projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail} - Language
Settings List<AppVersion Snapshot App Language Setting> - (Output) Language settings of the app. Structure is documented below.
- Logging
Settings List<AppVersion Snapshot App Logging Setting> - (Output) Settings to describe the logging behaviors for the app. Structure is documented below.
- Metadata Dictionary<string, string>
- (Output) Metadata about the app. This field can be used to store additional information relevant to the app's details or intended usages.
- Model
Settings List<AppVersion Snapshot App Model Setting> - (Output) Model settings contains various configurations for the LLM model. Structure is documented below.
- Name string
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - Root
Agent string - (Output)
The root agent is the entry point of the app.
Format:
projects/{project}/locations/{location}/apps/{app}/agents/{agent} - Time
Zone List<AppSettings Version Snapshot App Time Zone Setting> - (Output) TimeZone settings of the app. Structure is documented below.
- Update
Time string - (Output) Timestamp when the toolset was last updated.
- Variable
Declarations List<AppVersion Snapshot App Variable Declaration> - (Output) The declarations of the variables. Structure is documented below.
- Audio
Processing []AppConfigs Version Snapshot App Audio Processing Config - (Output) Configuration for how the input and output audio should be processed and delivered. Structure is documented below.
- Client
Certificate []AppSettings Version Snapshot App Client Certificate Setting - (Output) The default client certificate settings for the app. Structure is documented below.
- Create
Time string - (Output) Timestamp when the toolset was created.
- Data
Store []AppSettings Version Snapshot App Data Store Setting - (Output) Data store related settings for the app. Structure is documented below.
- Default
Channel []AppProfiles Version Snapshot App Default Channel Profile - (Output) A ChannelProfile configures the agent's behavior for a specific communication channel, such as web UI or telephony. Structure is documented below.
- Deployment
Count int - (Output) Number of deployments in the app.
- Description string
- The description of the app version.
- Display
Name string - The display name of the app version.
- Etag string
- (Output) ETag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
- Evaluation
Metrics []AppThresholds Version Snapshot App Evaluation Metrics Threshold - (Output) Threshold settings for metrics in an Evaluation. Structure is documented below.
- Global
Instruction string - (Output) Instructions for all the agents in the app. You can use this instruction to set up a stable identity or personality across all the agents.
- Guardrails []string
- (Output)
List of guardrails for the app.
Format:
projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail} - Language
Settings []AppVersion Snapshot App Language Setting - (Output) Language settings of the app. Structure is documented below.
- Logging
Settings []AppVersion Snapshot App Logging Setting - (Output) Settings to describe the logging behaviors for the app. Structure is documented below.
- Metadata map[string]string
- (Output) Metadata about the app. This field can be used to store additional information relevant to the app's details or intended usages.
- Model
Settings []AppVersion Snapshot App Model Setting - (Output) Model settings contains various configurations for the LLM model. Structure is documented below.
- Name string
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - Root
Agent string - (Output)
The root agent is the entry point of the app.
Format:
projects/{project}/locations/{location}/apps/{app}/agents/{agent} - Time
Zone []AppSettings Version Snapshot App Time Zone Setting - (Output) TimeZone settings of the app. Structure is documented below.
- Update
Time string - (Output) Timestamp when the toolset was last updated.
- Variable
Declarations []AppVersion Snapshot App Variable Declaration - (Output) The declarations of the variables. Structure is documented below.
- audio
Processing List<AppConfigs Version Snapshot App Audio Prosing Config> - (Output) Configuration for how the input and output audio should be processed and delivered. Structure is documented below.
- client
Certificate List<AppSettings Version Snapshot App Client Certificate Setting> - (Output) The default client certificate settings for the app. Structure is documented below.
- create
Time String - (Output) Timestamp when the toolset was created.
- data
Store List<AppSettings Version Snapshot App Data Store Setting> - (Output) Data store related settings for the app. Structure is documented below.
- default
Channel List<AppProfiles Version Snapshot App Default Channel Profile> - (Output) A ChannelProfile configures the agent's behavior for a specific communication channel, such as web UI or telephony. Structure is documented below.
- deployment
Count Integer - (Output) Number of deployments in the app.
- description String
- The description of the app version.
- display
Name String - The display name of the app version.
- etag String
- (Output) ETag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
- evaluation
Metrics List<AppThresholds Version Snapshot App Evaluation Metrics Threshold> - (Output) Threshold settings for metrics in an Evaluation. Structure is documented below.
- global
Instruction String - (Output) Instructions for all the agents in the app. You can use this instruction to set up a stable identity or personality across all the agents.
- guardrails List<String>
- (Output)
List of guardrails for the app.
Format:
projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail} - language
Settings List<AppVersion Snapshot App Language Setting> - (Output) Language settings of the app. Structure is documented below.
- logging
Settings List<AppVersion Snapshot App Logging Setting> - (Output) Settings to describe the logging behaviors for the app. Structure is documented below.
- metadata Map<String,String>
- (Output) Metadata about the app. This field can be used to store additional information relevant to the app's details or intended usages.
- model
Settings List<AppVersion Snapshot App Model Setting> - (Output) Model settings contains various configurations for the LLM model. Structure is documented below.
- name String
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - root
Agent String - (Output)
The root agent is the entry point of the app.
Format:
projects/{project}/locations/{location}/apps/{app}/agents/{agent} - time
Zone List<AppSettings Version Snapshot App Time Zone Setting> - (Output) TimeZone settings of the app. Structure is documented below.
- update
Time String - (Output) Timestamp when the toolset was last updated.
- variable
Declarations List<AppVersion Snapshot App Variable Declaration> - (Output) The declarations of the variables. Structure is documented below.
- audio
Processing AppConfigs Version Snapshot App Audio Processing Config[] - (Output) Configuration for how the input and output audio should be processed and delivered. Structure is documented below.
- client
Certificate AppSettings Version Snapshot App Client Certificate Setting[] - (Output) The default client certificate settings for the app. Structure is documented below.
- create
Time string - (Output) Timestamp when the toolset was created.
- data
Store AppSettings Version Snapshot App Data Store Setting[] - (Output) Data store related settings for the app. Structure is documented below.
- default
Channel AppProfiles Version Snapshot App Default Channel Profile[] - (Output) A ChannelProfile configures the agent's behavior for a specific communication channel, such as web UI or telephony. Structure is documented below.
- deployment
Count number - (Output) Number of deployments in the app.
- description string
- The description of the app version.
- display
Name string - The display name of the app version.
- etag string
- (Output) ETag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
- evaluation
Metrics AppThresholds Version Snapshot App Evaluation Metrics Threshold[] - (Output) Threshold settings for metrics in an Evaluation. Structure is documented below.
- global
Instruction string - (Output) Instructions for all the agents in the app. You can use this instruction to set up a stable identity or personality across all the agents.
- guardrails string[]
- (Output)
List of guardrails for the app.
Format:
projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail} - language
Settings AppVersion Snapshot App Language Setting[] - (Output) Language settings of the app. Structure is documented below.
- logging
Settings AppVersion Snapshot App Logging Setting[] - (Output) Settings to describe the logging behaviors for the app. Structure is documented below.
- metadata {[key: string]: string}
- (Output) Metadata about the app. This field can be used to store additional information relevant to the app's details or intended usages.
- model
Settings AppVersion Snapshot App Model Setting[] - (Output) Model settings contains various configurations for the LLM model. Structure is documented below.
- name string
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - root
Agent string - (Output)
The root agent is the entry point of the app.
Format:
projects/{project}/locations/{location}/apps/{app}/agents/{agent} - time
Zone AppSettings Version Snapshot App Time Zone Setting[] - (Output) TimeZone settings of the app. Structure is documented below.
- update
Time string - (Output) Timestamp when the toolset was last updated.
- variable
Declarations AppVersion Snapshot App Variable Declaration[] - (Output) The declarations of the variables. Structure is documented below.
- audio_
processing_ Sequence[Appconfigs Version Snapshot App Audio Processing Config] - (Output) Configuration for how the input and output audio should be processed and delivered. Structure is documented below.
- client_
certificate_ Sequence[Appsettings Version Snapshot App Client Certificate Setting] - (Output) The default client certificate settings for the app. Structure is documented below.
- create_
time str - (Output) Timestamp when the toolset was created.
- data_
store_ Sequence[Appsettings Version Snapshot App Data Store Setting] - (Output) Data store related settings for the app. Structure is documented below.
- default_
channel_ Sequence[Appprofiles Version Snapshot App Default Channel Profile] - (Output) A ChannelProfile configures the agent's behavior for a specific communication channel, such as web UI or telephony. Structure is documented below.
- deployment_
count int - (Output) Number of deployments in the app.
- description str
- The description of the app version.
- display_
name str - The display name of the app version.
- etag str
- (Output) ETag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
- evaluation_
metrics_ Sequence[Appthresholds Version Snapshot App Evaluation Metrics Threshold] - (Output) Threshold settings for metrics in an Evaluation. Structure is documented below.
- global_
instruction str - (Output) Instructions for all the agents in the app. You can use this instruction to set up a stable identity or personality across all the agents.
- guardrails Sequence[str]
- (Output)
List of guardrails for the app.
Format:
projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail} - language_
settings Sequence[AppVersion Snapshot App Language Setting] - (Output) Language settings of the app. Structure is documented below.
- logging_
settings Sequence[AppVersion Snapshot App Logging Setting] - (Output) Settings to describe the logging behaviors for the app. Structure is documented below.
- metadata Mapping[str, str]
- (Output) Metadata about the app. This field can be used to store additional information relevant to the app's details or intended usages.
- model_
settings Sequence[AppVersion Snapshot App Model Setting] - (Output) Model settings contains various configurations for the LLM model. Structure is documented below.
- name str
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - root_
agent str - (Output)
The root agent is the entry point of the app.
Format:
projects/{project}/locations/{location}/apps/{app}/agents/{agent} - time_
zone_ Sequence[Appsettings Version Snapshot App Time Zone Setting] - (Output) TimeZone settings of the app. Structure is documented below.
- update_
time str - (Output) Timestamp when the toolset was last updated.
- variable_
declarations Sequence[AppVersion Snapshot App Variable Declaration] - (Output) The declarations of the variables. Structure is documented below.
- audio
Processing List<Property Map>Configs - (Output) Configuration for how the input and output audio should be processed and delivered. Structure is documented below.
- client
Certificate List<Property Map>Settings - (Output) The default client certificate settings for the app. Structure is documented below.
- create
Time String - (Output) Timestamp when the toolset was created.
- data
Store List<Property Map>Settings - (Output) Data store related settings for the app. Structure is documented below.
- default
Channel List<Property Map>Profiles - (Output) A ChannelProfile configures the agent's behavior for a specific communication channel, such as web UI or telephony. Structure is documented below.
- deployment
Count Number - (Output) Number of deployments in the app.
- description String
- The description of the app version.
- display
Name String - The display name of the app version.
- etag String
- (Output) ETag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
- evaluation
Metrics List<Property Map>Thresholds - (Output) Threshold settings for metrics in an Evaluation. Structure is documented below.
- global
Instruction String - (Output) Instructions for all the agents in the app. You can use this instruction to set up a stable identity or personality across all the agents.
- guardrails List<String>
- (Output)
List of guardrails for the app.
Format:
projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail} - language
Settings List<Property Map> - (Output) Language settings of the app. Structure is documented below.
- logging
Settings List<Property Map> - (Output) Settings to describe the logging behaviors for the app. Structure is documented below.
- metadata Map<String>
- (Output) Metadata about the app. This field can be used to store additional information relevant to the app's details or intended usages.
- model
Settings List<Property Map> - (Output) Model settings contains various configurations for the LLM model. Structure is documented below.
- name String
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - root
Agent String - (Output)
The root agent is the entry point of the app.
Format:
projects/{project}/locations/{location}/apps/{app}/agents/{agent} - time
Zone List<Property Map>Settings - (Output) TimeZone settings of the app. Structure is documented below.
- update
Time String - (Output) Timestamp when the toolset was last updated.
- variable
Declarations List<Property Map> - (Output) The declarations of the variables. Structure is documented below.
AppVersionSnapshotAppAudioProcessingConfig, AppVersionSnapshotAppAudioProcessingConfigArgs
- Ambient
Sound List<AppConfigs Version Snapshot App Audio Processing Config Ambient Sound Config> - (Output) Configuration for the ambient sound to be played with the synthesized agent response, to enhance the naturalness of the conversation. Structure is documented below.
- Barge
In List<AppConfigs Version Snapshot App Audio Processing Config Barge In Config> - (Output) Configuration for how the user barge-in activities should be handled. Structure is documented below.
- Inactivity
Timeout string - (Output) The duration of user inactivity (no speech or interaction) before the agent prompts the user for reengagement. If not set, the agent will not prompt the user for reengagement.
- Synthesize
Speech List<AppConfigs Version Snapshot App Audio Processing Config Synthesize Speech Config> - (Output) Configuration of how the agent response should be synthesized, mapping from the language code to SynthesizeSpeechConfig. If the configuration for the specified language code is not found, the configuration for the root language code will be used. For example, if the map contains "en-us" and "en", and the specified language code is "en-gb", then "en" configuration will be used. Note: Language code is case-insensitive. Structure is documented below.
- Ambient
Sound []AppConfigs Version Snapshot App Audio Processing Config Ambient Sound Config - (Output) Configuration for the ambient sound to be played with the synthesized agent response, to enhance the naturalness of the conversation. Structure is documented below.
- Barge
In []AppConfigs Version Snapshot App Audio Processing Config Barge In Config - (Output) Configuration for how the user barge-in activities should be handled. Structure is documented below.
- Inactivity
Timeout string - (Output) The duration of user inactivity (no speech or interaction) before the agent prompts the user for reengagement. If not set, the agent will not prompt the user for reengagement.
- Synthesize
Speech []AppConfigs Version Snapshot App Audio Processing Config Synthesize Speech Config - (Output) Configuration of how the agent response should be synthesized, mapping from the language code to SynthesizeSpeechConfig. If the configuration for the specified language code is not found, the configuration for the root language code will be used. For example, if the map contains "en-us" and "en", and the specified language code is "en-gb", then "en" configuration will be used. Note: Language code is case-insensitive. Structure is documented below.
- ambient
Sound List<AppConfigs Version Snapshot App Audio Prosing Config Ambient Sound Config> - (Output) Configuration for the ambient sound to be played with the synthesized agent response, to enhance the naturalness of the conversation. Structure is documented below.
- barge
In List<AppConfigs Version Snapshot App Audio Prosing Config Barge In Config> - (Output) Configuration for how the user barge-in activities should be handled. Structure is documented below.
- inactivity
Timeout String - (Output) The duration of user inactivity (no speech or interaction) before the agent prompts the user for reengagement. If not set, the agent will not prompt the user for reengagement.
- synthesize
Speech List<AppConfigs Version Snapshot App Audio Prosing Config Synthesize Speech Config> - (Output) Configuration of how the agent response should be synthesized, mapping from the language code to SynthesizeSpeechConfig. If the configuration for the specified language code is not found, the configuration for the root language code will be used. For example, if the map contains "en-us" and "en", and the specified language code is "en-gb", then "en" configuration will be used. Note: Language code is case-insensitive. Structure is documented below.
- ambient
Sound AppConfigs Version Snapshot App Audio Processing Config Ambient Sound Config[] - (Output) Configuration for the ambient sound to be played with the synthesized agent response, to enhance the naturalness of the conversation. Structure is documented below.
- barge
In AppConfigs Version Snapshot App Audio Processing Config Barge In Config[] - (Output) Configuration for how the user barge-in activities should be handled. Structure is documented below.
- inactivity
Timeout string - (Output) The duration of user inactivity (no speech or interaction) before the agent prompts the user for reengagement. If not set, the agent will not prompt the user for reengagement.
- synthesize
Speech AppConfigs Version Snapshot App Audio Processing Config Synthesize Speech Config[] - (Output) Configuration of how the agent response should be synthesized, mapping from the language code to SynthesizeSpeechConfig. If the configuration for the specified language code is not found, the configuration for the root language code will be used. For example, if the map contains "en-us" and "en", and the specified language code is "en-gb", then "en" configuration will be used. Note: Language code is case-insensitive. Structure is documented below.
- ambient_
sound_ Sequence[Appconfigs Version Snapshot App Audio Processing Config Ambient Sound Config] - (Output) Configuration for the ambient sound to be played with the synthesized agent response, to enhance the naturalness of the conversation. Structure is documented below.
- barge_
in_ Sequence[Appconfigs Version Snapshot App Audio Processing Config Barge In Config] - (Output) Configuration for how the user barge-in activities should be handled. Structure is documented below.
- inactivity_
timeout str - (Output) The duration of user inactivity (no speech or interaction) before the agent prompts the user for reengagement. If not set, the agent will not prompt the user for reengagement.
- synthesize_
speech_ Sequence[Appconfigs Version Snapshot App Audio Processing Config Synthesize Speech Config] - (Output) Configuration of how the agent response should be synthesized, mapping from the language code to SynthesizeSpeechConfig. If the configuration for the specified language code is not found, the configuration for the root language code will be used. For example, if the map contains "en-us" and "en", and the specified language code is "en-gb", then "en" configuration will be used. Note: Language code is case-insensitive. Structure is documented below.
- ambient
Sound List<Property Map>Configs - (Output) Configuration for the ambient sound to be played with the synthesized agent response, to enhance the naturalness of the conversation. Structure is documented below.
- barge
In List<Property Map>Configs - (Output) Configuration for how the user barge-in activities should be handled. Structure is documented below.
- inactivity
Timeout String - (Output) The duration of user inactivity (no speech or interaction) before the agent prompts the user for reengagement. If not set, the agent will not prompt the user for reengagement.
- synthesize
Speech List<Property Map>Configs - (Output) Configuration of how the agent response should be synthesized, mapping from the language code to SynthesizeSpeechConfig. If the configuration for the specified language code is not found, the configuration for the root language code will be used. For example, if the map contains "en-us" and "en", and the specified language code is "en-gb", then "en" configuration will be used. Note: Language code is case-insensitive. Structure is documented below.
AppVersionSnapshotAppAudioProcessingConfigAmbientSoundConfig, AppVersionSnapshotAppAudioProcessingConfigAmbientSoundConfigArgs
- Gcs
Uri string - (Output)
Ambient noise as a mono-channel, 16kHz WAV file stored in Cloud
Storage.
Note: Please make sure the CES service agent
service-@gcp-sa-ces.iam.gserviceaccount.comhasstorage.objects.getpermission to the Cloud Storage object. - Prebuilt
Ambient stringSound - (Output) Name of the prebuilt ambient sound. Valid values are: - <span pulumi-lang-nodejs=""coffeeShop"" pulumi-lang-dotnet=""CoffeeShop"" pulumi-lang-go=""coffeeShop"" pulumi-lang-python=""coffee_shop"" pulumi-lang-yaml=""coffeeShop"" pulumi-lang-java=""coffeeShop"">"coffee_shop" - "keyboard" - "keypad" - "hum" -<span pulumi-lang-nodejs=""office1"" pulumi-lang-dotnet=""Office1"" pulumi-lang-go=""office1"" pulumi-lang-python=""office_1"" pulumi-lang-yaml=""office1"" pulumi-lang-java=""office1"">"office_1" - <span pulumi-lang-nodejs=""office2"" pulumi-lang-dotnet=""Office2"" pulumi-lang-go=""office2"" pulumi-lang-python=""office_2"" pulumi-lang-yaml=""office2"" pulumi-lang-java=""office2"">"office_2" - <span pulumi-lang-nodejs=""office3"" pulumi-lang-dotnet=""Office3"" pulumi-lang-go=""office3"" pulumi-lang-python=""office_3"" pulumi-lang-yaml=""office3"" pulumi-lang-java=""office3"">"office_3" -<span pulumi-lang-nodejs=""room1"" pulumi-lang-dotnet=""Room1"" pulumi-lang-go=""room1"" pulumi-lang-python=""room_1"" pulumi-lang-yaml=""room1"" pulumi-lang-java=""room1"">"room_1" - <span pulumi-lang-nodejs=""room2"" pulumi-lang-dotnet=""Room2"" pulumi-lang-go=""room2"" pulumi-lang-python=""room_2"" pulumi-lang-yaml=""room2"" pulumi-lang-java=""room2"">"room_2" - <span pulumi-lang-nodejs=""room3"" pulumi-lang-dotnet=""Room3"" pulumi-lang-go=""room3"" pulumi-lang-python=""room_3"" pulumi-lang-yaml=""room3"" pulumi-lang-java=""room3"">"room_3" -<span pulumi-lang-nodejs=""room4"" pulumi-lang-dotnet=""Room4"" pulumi-lang-go=""room4"" pulumi-lang-python=""room_4"" pulumi-lang-yaml=""room4"" pulumi-lang-java=""room4"">"room_4" - <span pulumi-lang-nodejs=""room5"" pulumi-lang-dotnet=""Room5"" pulumi-lang-go=""room5"" pulumi-lang-python=""room_5"" pulumi-lang-yaml=""room5"" pulumi-lang-java=""room5"">"room_5" - <span pulumi-lang-nodejs=""airConditioner"" pulumi-lang-dotnet=""AirConditioner"" pulumi-lang-go=""airConditioner"" pulumi-lang-python=""air_conditioner"" pulumi-lang-yaml=""airConditioner"" pulumi-lang-java=""airConditioner"">"air_conditioner"
- Volume
Gain doubleDb - (Output) Volume gain (in dB) of the normal native volume supported by ambient noise, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that.
- Gcs
Uri string - (Output)
Ambient noise as a mono-channel, 16kHz WAV file stored in Cloud
Storage.
Note: Please make sure the CES service agent
service-@gcp-sa-ces.iam.gserviceaccount.comhasstorage.objects.getpermission to the Cloud Storage object. - Prebuilt
Ambient stringSound - (Output) Name of the prebuilt ambient sound. Valid values are: - <span pulumi-lang-nodejs=""coffeeShop"" pulumi-lang-dotnet=""CoffeeShop"" pulumi-lang-go=""coffeeShop"" pulumi-lang-python=""coffee_shop"" pulumi-lang-yaml=""coffeeShop"" pulumi-lang-java=""coffeeShop"">"coffee_shop" - "keyboard" - "keypad" - "hum" -<span pulumi-lang-nodejs=""office1"" pulumi-lang-dotnet=""Office1"" pulumi-lang-go=""office1"" pulumi-lang-python=""office_1"" pulumi-lang-yaml=""office1"" pulumi-lang-java=""office1"">"office_1" - <span pulumi-lang-nodejs=""office2"" pulumi-lang-dotnet=""Office2"" pulumi-lang-go=""office2"" pulumi-lang-python=""office_2"" pulumi-lang-yaml=""office2"" pulumi-lang-java=""office2"">"office_2" - <span pulumi-lang-nodejs=""office3"" pulumi-lang-dotnet=""Office3"" pulumi-lang-go=""office3"" pulumi-lang-python=""office_3"" pulumi-lang-yaml=""office3"" pulumi-lang-java=""office3"">"office_3" -<span pulumi-lang-nodejs=""room1"" pulumi-lang-dotnet=""Room1"" pulumi-lang-go=""room1"" pulumi-lang-python=""room_1"" pulumi-lang-yaml=""room1"" pulumi-lang-java=""room1"">"room_1" - <span pulumi-lang-nodejs=""room2"" pulumi-lang-dotnet=""Room2"" pulumi-lang-go=""room2"" pulumi-lang-python=""room_2"" pulumi-lang-yaml=""room2"" pulumi-lang-java=""room2"">"room_2" - <span pulumi-lang-nodejs=""room3"" pulumi-lang-dotnet=""Room3"" pulumi-lang-go=""room3"" pulumi-lang-python=""room_3"" pulumi-lang-yaml=""room3"" pulumi-lang-java=""room3"">"room_3" -<span pulumi-lang-nodejs=""room4"" pulumi-lang-dotnet=""Room4"" pulumi-lang-go=""room4"" pulumi-lang-python=""room_4"" pulumi-lang-yaml=""room4"" pulumi-lang-java=""room4"">"room_4" - <span pulumi-lang-nodejs=""room5"" pulumi-lang-dotnet=""Room5"" pulumi-lang-go=""room5"" pulumi-lang-python=""room_5"" pulumi-lang-yaml=""room5"" pulumi-lang-java=""room5"">"room_5" - <span pulumi-lang-nodejs=""airConditioner"" pulumi-lang-dotnet=""AirConditioner"" pulumi-lang-go=""airConditioner"" pulumi-lang-python=""air_conditioner"" pulumi-lang-yaml=""airConditioner"" pulumi-lang-java=""airConditioner"">"air_conditioner"
- Volume
Gain float64Db - (Output) Volume gain (in dB) of the normal native volume supported by ambient noise, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that.
- gcs
Uri String - (Output)
Ambient noise as a mono-channel, 16kHz WAV file stored in Cloud
Storage.
Note: Please make sure the CES service agent
service-@gcp-sa-ces.iam.gserviceaccount.comhasstorage.objects.getpermission to the Cloud Storage object. - prebuilt
Ambient StringSound - (Output) Name of the prebuilt ambient sound. Valid values are: - <span pulumi-lang-nodejs=""coffeeShop"" pulumi-lang-dotnet=""CoffeeShop"" pulumi-lang-go=""coffeeShop"" pulumi-lang-python=""coffee_shop"" pulumi-lang-yaml=""coffeeShop"" pulumi-lang-java=""coffeeShop"">"coffee_shop" - "keyboard" - "keypad" - "hum" -<span pulumi-lang-nodejs=""office1"" pulumi-lang-dotnet=""Office1"" pulumi-lang-go=""office1"" pulumi-lang-python=""office_1"" pulumi-lang-yaml=""office1"" pulumi-lang-java=""office1"">"office_1" - <span pulumi-lang-nodejs=""office2"" pulumi-lang-dotnet=""Office2"" pulumi-lang-go=""office2"" pulumi-lang-python=""office_2"" pulumi-lang-yaml=""office2"" pulumi-lang-java=""office2"">"office_2" - <span pulumi-lang-nodejs=""office3"" pulumi-lang-dotnet=""Office3"" pulumi-lang-go=""office3"" pulumi-lang-python=""office_3"" pulumi-lang-yaml=""office3"" pulumi-lang-java=""office3"">"office_3" -<span pulumi-lang-nodejs=""room1"" pulumi-lang-dotnet=""Room1"" pulumi-lang-go=""room1"" pulumi-lang-python=""room_1"" pulumi-lang-yaml=""room1"" pulumi-lang-java=""room1"">"room_1" - <span pulumi-lang-nodejs=""room2"" pulumi-lang-dotnet=""Room2"" pulumi-lang-go=""room2"" pulumi-lang-python=""room_2"" pulumi-lang-yaml=""room2"" pulumi-lang-java=""room2"">"room_2" - <span pulumi-lang-nodejs=""room3"" pulumi-lang-dotnet=""Room3"" pulumi-lang-go=""room3"" pulumi-lang-python=""room_3"" pulumi-lang-yaml=""room3"" pulumi-lang-java=""room3"">"room_3" -<span pulumi-lang-nodejs=""room4"" pulumi-lang-dotnet=""Room4"" pulumi-lang-go=""room4"" pulumi-lang-python=""room_4"" pulumi-lang-yaml=""room4"" pulumi-lang-java=""room4"">"room_4" - <span pulumi-lang-nodejs=""room5"" pulumi-lang-dotnet=""Room5"" pulumi-lang-go=""room5"" pulumi-lang-python=""room_5"" pulumi-lang-yaml=""room5"" pulumi-lang-java=""room5"">"room_5" - <span pulumi-lang-nodejs=""airConditioner"" pulumi-lang-dotnet=""AirConditioner"" pulumi-lang-go=""airConditioner"" pulumi-lang-python=""air_conditioner"" pulumi-lang-yaml=""airConditioner"" pulumi-lang-java=""airConditioner"">"air_conditioner"
- volume
Gain DoubleDb - (Output) Volume gain (in dB) of the normal native volume supported by ambient noise, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that.
- gcs
Uri string - (Output)
Ambient noise as a mono-channel, 16kHz WAV file stored in Cloud
Storage.
Note: Please make sure the CES service agent
service-@gcp-sa-ces.iam.gserviceaccount.comhasstorage.objects.getpermission to the Cloud Storage object. - prebuilt
Ambient stringSound - (Output) Name of the prebuilt ambient sound. Valid values are: - <span pulumi-lang-nodejs=""coffeeShop"" pulumi-lang-dotnet=""CoffeeShop"" pulumi-lang-go=""coffeeShop"" pulumi-lang-python=""coffee_shop"" pulumi-lang-yaml=""coffeeShop"" pulumi-lang-java=""coffeeShop"">"coffee_shop" - "keyboard" - "keypad" - "hum" -<span pulumi-lang-nodejs=""office1"" pulumi-lang-dotnet=""Office1"" pulumi-lang-go=""office1"" pulumi-lang-python=""office_1"" pulumi-lang-yaml=""office1"" pulumi-lang-java=""office1"">"office_1" - <span pulumi-lang-nodejs=""office2"" pulumi-lang-dotnet=""Office2"" pulumi-lang-go=""office2"" pulumi-lang-python=""office_2"" pulumi-lang-yaml=""office2"" pulumi-lang-java=""office2"">"office_2" - <span pulumi-lang-nodejs=""office3"" pulumi-lang-dotnet=""Office3"" pulumi-lang-go=""office3"" pulumi-lang-python=""office_3"" pulumi-lang-yaml=""office3"" pulumi-lang-java=""office3"">"office_3" -<span pulumi-lang-nodejs=""room1"" pulumi-lang-dotnet=""Room1"" pulumi-lang-go=""room1"" pulumi-lang-python=""room_1"" pulumi-lang-yaml=""room1"" pulumi-lang-java=""room1"">"room_1" - <span pulumi-lang-nodejs=""room2"" pulumi-lang-dotnet=""Room2"" pulumi-lang-go=""room2"" pulumi-lang-python=""room_2"" pulumi-lang-yaml=""room2"" pulumi-lang-java=""room2"">"room_2" - <span pulumi-lang-nodejs=""room3"" pulumi-lang-dotnet=""Room3"" pulumi-lang-go=""room3"" pulumi-lang-python=""room_3"" pulumi-lang-yaml=""room3"" pulumi-lang-java=""room3"">"room_3" -<span pulumi-lang-nodejs=""room4"" pulumi-lang-dotnet=""Room4"" pulumi-lang-go=""room4"" pulumi-lang-python=""room_4"" pulumi-lang-yaml=""room4"" pulumi-lang-java=""room4"">"room_4" - <span pulumi-lang-nodejs=""room5"" pulumi-lang-dotnet=""Room5"" pulumi-lang-go=""room5"" pulumi-lang-python=""room_5"" pulumi-lang-yaml=""room5"" pulumi-lang-java=""room5"">"room_5" - <span pulumi-lang-nodejs=""airConditioner"" pulumi-lang-dotnet=""AirConditioner"" pulumi-lang-go=""airConditioner"" pulumi-lang-python=""air_conditioner"" pulumi-lang-yaml=""airConditioner"" pulumi-lang-java=""airConditioner"">"air_conditioner"
- volume
Gain numberDb - (Output) Volume gain (in dB) of the normal native volume supported by ambient noise, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that.
- gcs_
uri str - (Output)
Ambient noise as a mono-channel, 16kHz WAV file stored in Cloud
Storage.
Note: Please make sure the CES service agent
service-@gcp-sa-ces.iam.gserviceaccount.comhasstorage.objects.getpermission to the Cloud Storage object. - prebuilt_
ambient_ strsound - (Output) Name of the prebuilt ambient sound. Valid values are: - <span pulumi-lang-nodejs=""coffeeShop"" pulumi-lang-dotnet=""CoffeeShop"" pulumi-lang-go=""coffeeShop"" pulumi-lang-python=""coffee_shop"" pulumi-lang-yaml=""coffeeShop"" pulumi-lang-java=""coffeeShop"">"coffee_shop" - "keyboard" - "keypad" - "hum" -<span pulumi-lang-nodejs=""office1"" pulumi-lang-dotnet=""Office1"" pulumi-lang-go=""office1"" pulumi-lang-python=""office_1"" pulumi-lang-yaml=""office1"" pulumi-lang-java=""office1"">"office_1" - <span pulumi-lang-nodejs=""office2"" pulumi-lang-dotnet=""Office2"" pulumi-lang-go=""office2"" pulumi-lang-python=""office_2"" pulumi-lang-yaml=""office2"" pulumi-lang-java=""office2"">"office_2" - <span pulumi-lang-nodejs=""office3"" pulumi-lang-dotnet=""Office3"" pulumi-lang-go=""office3"" pulumi-lang-python=""office_3"" pulumi-lang-yaml=""office3"" pulumi-lang-java=""office3"">"office_3" -<span pulumi-lang-nodejs=""room1"" pulumi-lang-dotnet=""Room1"" pulumi-lang-go=""room1"" pulumi-lang-python=""room_1"" pulumi-lang-yaml=""room1"" pulumi-lang-java=""room1"">"room_1" - <span pulumi-lang-nodejs=""room2"" pulumi-lang-dotnet=""Room2"" pulumi-lang-go=""room2"" pulumi-lang-python=""room_2"" pulumi-lang-yaml=""room2"" pulumi-lang-java=""room2"">"room_2" - <span pulumi-lang-nodejs=""room3"" pulumi-lang-dotnet=""Room3"" pulumi-lang-go=""room3"" pulumi-lang-python=""room_3"" pulumi-lang-yaml=""room3"" pulumi-lang-java=""room3"">"room_3" -<span pulumi-lang-nodejs=""room4"" pulumi-lang-dotnet=""Room4"" pulumi-lang-go=""room4"" pulumi-lang-python=""room_4"" pulumi-lang-yaml=""room4"" pulumi-lang-java=""room4"">"room_4" - <span pulumi-lang-nodejs=""room5"" pulumi-lang-dotnet=""Room5"" pulumi-lang-go=""room5"" pulumi-lang-python=""room_5"" pulumi-lang-yaml=""room5"" pulumi-lang-java=""room5"">"room_5" - <span pulumi-lang-nodejs=""airConditioner"" pulumi-lang-dotnet=""AirConditioner"" pulumi-lang-go=""airConditioner"" pulumi-lang-python=""air_conditioner"" pulumi-lang-yaml=""airConditioner"" pulumi-lang-java=""airConditioner"">"air_conditioner"
- volume_
gain_ floatdb - (Output) Volume gain (in dB) of the normal native volume supported by ambient noise, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that.
- gcs
Uri String - (Output)
Ambient noise as a mono-channel, 16kHz WAV file stored in Cloud
Storage.
Note: Please make sure the CES service agent
service-@gcp-sa-ces.iam.gserviceaccount.comhasstorage.objects.getpermission to the Cloud Storage object. - prebuilt
Ambient StringSound - (Output) Name of the prebuilt ambient sound. Valid values are: - <span pulumi-lang-nodejs=""coffeeShop"" pulumi-lang-dotnet=""CoffeeShop"" pulumi-lang-go=""coffeeShop"" pulumi-lang-python=""coffee_shop"" pulumi-lang-yaml=""coffeeShop"" pulumi-lang-java=""coffeeShop"">"coffee_shop" - "keyboard" - "keypad" - "hum" -<span pulumi-lang-nodejs=""office1"" pulumi-lang-dotnet=""Office1"" pulumi-lang-go=""office1"" pulumi-lang-python=""office_1"" pulumi-lang-yaml=""office1"" pulumi-lang-java=""office1"">"office_1" - <span pulumi-lang-nodejs=""office2"" pulumi-lang-dotnet=""Office2"" pulumi-lang-go=""office2"" pulumi-lang-python=""office_2"" pulumi-lang-yaml=""office2"" pulumi-lang-java=""office2"">"office_2" - <span pulumi-lang-nodejs=""office3"" pulumi-lang-dotnet=""Office3"" pulumi-lang-go=""office3"" pulumi-lang-python=""office_3"" pulumi-lang-yaml=""office3"" pulumi-lang-java=""office3"">"office_3" -<span pulumi-lang-nodejs=""room1"" pulumi-lang-dotnet=""Room1"" pulumi-lang-go=""room1"" pulumi-lang-python=""room_1"" pulumi-lang-yaml=""room1"" pulumi-lang-java=""room1"">"room_1" - <span pulumi-lang-nodejs=""room2"" pulumi-lang-dotnet=""Room2"" pulumi-lang-go=""room2"" pulumi-lang-python=""room_2"" pulumi-lang-yaml=""room2"" pulumi-lang-java=""room2"">"room_2" - <span pulumi-lang-nodejs=""room3"" pulumi-lang-dotnet=""Room3"" pulumi-lang-go=""room3"" pulumi-lang-python=""room_3"" pulumi-lang-yaml=""room3"" pulumi-lang-java=""room3"">"room_3" -<span pulumi-lang-nodejs=""room4"" pulumi-lang-dotnet=""Room4"" pulumi-lang-go=""room4"" pulumi-lang-python=""room_4"" pulumi-lang-yaml=""room4"" pulumi-lang-java=""room4"">"room_4" - <span pulumi-lang-nodejs=""room5"" pulumi-lang-dotnet=""Room5"" pulumi-lang-go=""room5"" pulumi-lang-python=""room_5"" pulumi-lang-yaml=""room5"" pulumi-lang-java=""room5"">"room_5" - <span pulumi-lang-nodejs=""airConditioner"" pulumi-lang-dotnet=""AirConditioner"" pulumi-lang-go=""airConditioner"" pulumi-lang-python=""air_conditioner"" pulumi-lang-yaml=""airConditioner"" pulumi-lang-java=""airConditioner"">"air_conditioner"
- volume
Gain NumberDb - (Output) Volume gain (in dB) of the normal native volume supported by ambient noise, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that.
AppVersionSnapshotAppAudioProcessingConfigBargeInConfig, AppVersionSnapshotAppAudioProcessingConfigBargeInConfigArgs
- Barge
In boolAwareness - (Output) If enabled, the agent will adapt its next response based on the assumption that the user hasn't heard the full preceding agent message. This should not be used in scenarios where agent responses are displayed visually.
- Barge
In boolAwareness - (Output) If enabled, the agent will adapt its next response based on the assumption that the user hasn't heard the full preceding agent message. This should not be used in scenarios where agent responses are displayed visually.
- barge
In BooleanAwareness - (Output) If enabled, the agent will adapt its next response based on the assumption that the user hasn't heard the full preceding agent message. This should not be used in scenarios where agent responses are displayed visually.
- barge
In booleanAwareness - (Output) If enabled, the agent will adapt its next response based on the assumption that the user hasn't heard the full preceding agent message. This should not be used in scenarios where agent responses are displayed visually.
- barge_
in_ boolawareness - (Output) If enabled, the agent will adapt its next response based on the assumption that the user hasn't heard the full preceding agent message. This should not be used in scenarios where agent responses are displayed visually.
- barge
In BooleanAwareness - (Output) If enabled, the agent will adapt its next response based on the assumption that the user hasn't heard the full preceding agent message. This should not be used in scenarios where agent responses are displayed visually.
AppVersionSnapshotAppAudioProcessingConfigSynthesizeSpeechConfig, AppVersionSnapshotAppAudioProcessingConfigSynthesizeSpeechConfigArgs
- Language
Code string - (Required) The identifier for this object. Format specified above.
- Speaking
Rate double - (Output) The speaking rate/speed in the range [0.25, 2.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. Values outside of the range [0.25, 2.0] will return an error.
- Voice string
- (Output) The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code. For the list of available voices, please refer to Supported voices and languages from Cloud Text-to-Speech.
- Language
Code string - (Required) The identifier for this object. Format specified above.
- Speaking
Rate float64 - (Output) The speaking rate/speed in the range [0.25, 2.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. Values outside of the range [0.25, 2.0] will return an error.
- Voice string
- (Output) The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code. For the list of available voices, please refer to Supported voices and languages from Cloud Text-to-Speech.
- language
Code String - (Required) The identifier for this object. Format specified above.
- speaking
Rate Double - (Output) The speaking rate/speed in the range [0.25, 2.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. Values outside of the range [0.25, 2.0] will return an error.
- voice String
- (Output) The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code. For the list of available voices, please refer to Supported voices and languages from Cloud Text-to-Speech.
- language
Code string - (Required) The identifier for this object. Format specified above.
- speaking
Rate number - (Output) The speaking rate/speed in the range [0.25, 2.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. Values outside of the range [0.25, 2.0] will return an error.
- voice string
- (Output) The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code. For the list of available voices, please refer to Supported voices and languages from Cloud Text-to-Speech.
- language_
code str - (Required) The identifier for this object. Format specified above.
- speaking_
rate float - (Output) The speaking rate/speed in the range [0.25, 2.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. Values outside of the range [0.25, 2.0] will return an error.
- voice str
- (Output) The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code. For the list of available voices, please refer to Supported voices and languages from Cloud Text-to-Speech.
- language
Code String - (Required) The identifier for this object. Format specified above.
- speaking
Rate Number - (Output) The speaking rate/speed in the range [0.25, 2.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. Values outside of the range [0.25, 2.0] will return an error.
- voice String
- (Output) The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code. For the list of available voices, please refer to Supported voices and languages from Cloud Text-to-Speech.
AppVersionSnapshotAppClientCertificateSetting, AppVersionSnapshotAppClientCertificateSettingArgs
- Passphrase string
- (Output) The passphrase to decrypt the private key. Should be left unset if the private key is not encrypted.
- Private
Key string - (Output) The name of the SecretManager secret version resource storing the private key encoded in PEM format. Format: projects/{project}/secrets/{secret}/versions/{version}
- Tls
Certificate string - (Output) The TLS certificate encoded in PEM format. This string must include the begin header and end footer lines.
- Passphrase string
- (Output) The passphrase to decrypt the private key. Should be left unset if the private key is not encrypted.
- Private
Key string - (Output) The name of the SecretManager secret version resource storing the private key encoded in PEM format. Format: projects/{project}/secrets/{secret}/versions/{version}
- Tls
Certificate string - (Output) The TLS certificate encoded in PEM format. This string must include the begin header and end footer lines.
- passphrase String
- (Output) The passphrase to decrypt the private key. Should be left unset if the private key is not encrypted.
- private
Key String - (Output) The name of the SecretManager secret version resource storing the private key encoded in PEM format. Format: projects/{project}/secrets/{secret}/versions/{version}
- tls
Certificate String - (Output) The TLS certificate encoded in PEM format. This string must include the begin header and end footer lines.
- passphrase string
- (Output) The passphrase to decrypt the private key. Should be left unset if the private key is not encrypted.
- private
Key string - (Output) The name of the SecretManager secret version resource storing the private key encoded in PEM format. Format: projects/{project}/secrets/{secret}/versions/{version}
- tls
Certificate string - (Output) The TLS certificate encoded in PEM format. This string must include the begin header and end footer lines.
- passphrase str
- (Output) The passphrase to decrypt the private key. Should be left unset if the private key is not encrypted.
- private_
key str - (Output) The name of the SecretManager secret version resource storing the private key encoded in PEM format. Format: projects/{project}/secrets/{secret}/versions/{version}
- tls_
certificate str - (Output) The TLS certificate encoded in PEM format. This string must include the begin header and end footer lines.
- passphrase String
- (Output) The passphrase to decrypt the private key. Should be left unset if the private key is not encrypted.
- private
Key String - (Output) The name of the SecretManager secret version resource storing the private key encoded in PEM format. Format: projects/{project}/secrets/{secret}/versions/{version}
- tls
Certificate String - (Output) The TLS certificate encoded in PEM format. This string must include the begin header and end footer lines.
AppVersionSnapshotAppDataStoreSetting, AppVersionSnapshotAppDataStoreSettingArgs
- Engines
List<App
Version Snapshot App Data Store Setting Engine> - (Output) The engines for the app. Structure is documented below.
- Engines
[]App
Version Snapshot App Data Store Setting Engine - (Output) The engines for the app. Structure is documented below.
- engines
List<App
Version Snapshot App Data Store Setting Engine> - (Output) The engines for the app. Structure is documented below.
- engines
App
Version Snapshot App Data Store Setting Engine[] - (Output) The engines for the app. Structure is documented below.
- engines
Sequence[App
Version Snapshot App Data Store Setting Engine] - (Output) The engines for the app. Structure is documented below.
- engines List<Property Map>
- (Output) The engines for the app. Structure is documented below.
AppVersionSnapshotAppDataStoreSettingEngine, AppVersionSnapshotAppDataStoreSettingEngineArgs
- Name string
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - Type string
- (Output) The type of the data store. This field is readonly and populated by the server. Possible values: PUBLIC_WEB UNSTRUCTURED FAQ CONNECTOR
- Name string
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - Type string
- (Output) The type of the data store. This field is readonly and populated by the server. Possible values: PUBLIC_WEB UNSTRUCTURED FAQ CONNECTOR
- name String
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - type String
- (Output) The type of the data store. This field is readonly and populated by the server. Possible values: PUBLIC_WEB UNSTRUCTURED FAQ CONNECTOR
- name string
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - type string
- (Output) The type of the data store. This field is readonly and populated by the server. Possible values: PUBLIC_WEB UNSTRUCTURED FAQ CONNECTOR
- name String
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - type String
- (Output) The type of the data store. This field is readonly and populated by the server. Possible values: PUBLIC_WEB UNSTRUCTURED FAQ CONNECTOR
AppVersionSnapshotAppDefaultChannelProfile, AppVersionSnapshotAppDefaultChannelProfileArgs
- Channel
Type string - (Output) The type of the channel profile. Possible values: UNKNOWN WEB_UI API TWILIO GOOGLE_TELEPHONY_PLATFORM CONTACT_CENTER_AS_A_SERVICE
- Disable
Barge boolIn Control - (Output)
Whether to disable user barge-in in the conversation.
- true: User interruptions are disabled while the agent is speaking.
- false: The agent retains automatic control over when the user can interrupt.
- Disable
Dtmf bool - (Output) Whether to disable DTMF (dual-tone multi-frequency).
- Persona
Properties List<AppVersion Snapshot App Default Channel Profile Persona Property> - (Output) Represents the persona property of a channel. Structure is documented below.
- Profile
Id string - (Output) The unique identifier of the channel profile.
- Web
Widget List<AppConfigs Version Snapshot App Default Channel Profile Web Widget Config> - (Output) Message for configuration for the web widget. Structure is documented below.
- Channel
Type string - (Output) The type of the channel profile. Possible values: UNKNOWN WEB_UI API TWILIO GOOGLE_TELEPHONY_PLATFORM CONTACT_CENTER_AS_A_SERVICE
- Disable
Barge boolIn Control - (Output)
Whether to disable user barge-in in the conversation.
- true: User interruptions are disabled while the agent is speaking.
- false: The agent retains automatic control over when the user can interrupt.
- Disable
Dtmf bool - (Output) Whether to disable DTMF (dual-tone multi-frequency).
- Persona
Properties []AppVersion Snapshot App Default Channel Profile Persona Property - (Output) Represents the persona property of a channel. Structure is documented below.
- Profile
Id string - (Output) The unique identifier of the channel profile.
- Web
Widget []AppConfigs Version Snapshot App Default Channel Profile Web Widget Config - (Output) Message for configuration for the web widget. Structure is documented below.
- channel
Type String - (Output) The type of the channel profile. Possible values: UNKNOWN WEB_UI API TWILIO GOOGLE_TELEPHONY_PLATFORM CONTACT_CENTER_AS_A_SERVICE
- disable
Barge BooleanIn Control - (Output)
Whether to disable user barge-in in the conversation.
- true: User interruptions are disabled while the agent is speaking.
- false: The agent retains automatic control over when the user can interrupt.
- disable
Dtmf Boolean - (Output) Whether to disable DTMF (dual-tone multi-frequency).
- persona
Properties List<AppVersion Snapshot App Default Channel Profile Persona Property> - (Output) Represents the persona property of a channel. Structure is documented below.
- profile
Id String - (Output) The unique identifier of the channel profile.
- web
Widget List<AppConfigs Version Snapshot App Default Channel Profile Web Widget Config> - (Output) Message for configuration for the web widget. Structure is documented below.
- channel
Type string - (Output) The type of the channel profile. Possible values: UNKNOWN WEB_UI API TWILIO GOOGLE_TELEPHONY_PLATFORM CONTACT_CENTER_AS_A_SERVICE
- disable
Barge booleanIn Control - (Output)
Whether to disable user barge-in in the conversation.
- true: User interruptions are disabled while the agent is speaking.
- false: The agent retains automatic control over when the user can interrupt.
- disable
Dtmf boolean - (Output) Whether to disable DTMF (dual-tone multi-frequency).
- persona
Properties AppVersion Snapshot App Default Channel Profile Persona Property[] - (Output) Represents the persona property of a channel. Structure is documented below.
- profile
Id string - (Output) The unique identifier of the channel profile.
- web
Widget AppConfigs Version Snapshot App Default Channel Profile Web Widget Config[] - (Output) Message for configuration for the web widget. Structure is documented below.
- channel_
type str - (Output) The type of the channel profile. Possible values: UNKNOWN WEB_UI API TWILIO GOOGLE_TELEPHONY_PLATFORM CONTACT_CENTER_AS_A_SERVICE
- disable_
barge_ boolin_ control - (Output)
Whether to disable user barge-in in the conversation.
- true: User interruptions are disabled while the agent is speaking.
- false: The agent retains automatic control over when the user can interrupt.
- disable_
dtmf bool - (Output) Whether to disable DTMF (dual-tone multi-frequency).
- persona_
properties Sequence[AppVersion Snapshot App Default Channel Profile Persona Property] - (Output) Represents the persona property of a channel. Structure is documented below.
- profile_
id str - (Output) The unique identifier of the channel profile.
- web_
widget_ Sequence[Appconfigs Version Snapshot App Default Channel Profile Web Widget Config] - (Output) Message for configuration for the web widget. Structure is documented below.
- channel
Type String - (Output) The type of the channel profile. Possible values: UNKNOWN WEB_UI API TWILIO GOOGLE_TELEPHONY_PLATFORM CONTACT_CENTER_AS_A_SERVICE
- disable
Barge BooleanIn Control - (Output)
Whether to disable user barge-in in the conversation.
- true: User interruptions are disabled while the agent is speaking.
- false: The agent retains automatic control over when the user can interrupt.
- disable
Dtmf Boolean - (Output) Whether to disable DTMF (dual-tone multi-frequency).
- persona
Properties List<Property Map> - (Output) Represents the persona property of a channel. Structure is documented below.
- profile
Id String - (Output) The unique identifier of the channel profile.
- web
Widget List<Property Map>Configs - (Output) Message for configuration for the web widget. Structure is documented below.
AppVersionSnapshotAppDefaultChannelProfilePersonaProperty, AppVersionSnapshotAppDefaultChannelProfilePersonaPropertyArgs
- Persona string
- (Output) The persona of the channel. Possible values: UNKNOWN CONCISE CHATTY
- Persona string
- (Output) The persona of the channel. Possible values: UNKNOWN CONCISE CHATTY
- persona String
- (Output) The persona of the channel. Possible values: UNKNOWN CONCISE CHATTY
- persona string
- (Output) The persona of the channel. Possible values: UNKNOWN CONCISE CHATTY
- persona str
- (Output) The persona of the channel. Possible values: UNKNOWN CONCISE CHATTY
- persona String
- (Output) The persona of the channel. Possible values: UNKNOWN CONCISE CHATTY
AppVersionSnapshotAppDefaultChannelProfileWebWidgetConfig, AppVersionSnapshotAppDefaultChannelProfileWebWidgetConfigArgs
- Modality string
- (Output) The modality of the web widget. Possible values: UNKNOWN_MODALITY CHAT_AND_VOICE VOICE_ONLY CHAT_ONLY
- Theme string
- (Output) The theme of the web widget. Possible values: UNKNOWN_THEME LIGHT DARK
- Web
Widget stringTitle - (Output) The title of the web widget.
- Modality string
- (Output) The modality of the web widget. Possible values: UNKNOWN_MODALITY CHAT_AND_VOICE VOICE_ONLY CHAT_ONLY
- Theme string
- (Output) The theme of the web widget. Possible values: UNKNOWN_THEME LIGHT DARK
- Web
Widget stringTitle - (Output) The title of the web widget.
- modality String
- (Output) The modality of the web widget. Possible values: UNKNOWN_MODALITY CHAT_AND_VOICE VOICE_ONLY CHAT_ONLY
- theme String
- (Output) The theme of the web widget. Possible values: UNKNOWN_THEME LIGHT DARK
- web
Widget StringTitle - (Output) The title of the web widget.
- modality string
- (Output) The modality of the web widget. Possible values: UNKNOWN_MODALITY CHAT_AND_VOICE VOICE_ONLY CHAT_ONLY
- theme string
- (Output) The theme of the web widget. Possible values: UNKNOWN_THEME LIGHT DARK
- web
Widget stringTitle - (Output) The title of the web widget.
- modality str
- (Output) The modality of the web widget. Possible values: UNKNOWN_MODALITY CHAT_AND_VOICE VOICE_ONLY CHAT_ONLY
- theme str
- (Output) The theme of the web widget. Possible values: UNKNOWN_THEME LIGHT DARK
- web_
widget_ strtitle - (Output) The title of the web widget.
- modality String
- (Output) The modality of the web widget. Possible values: UNKNOWN_MODALITY CHAT_AND_VOICE VOICE_ONLY CHAT_ONLY
- theme String
- (Output) The theme of the web widget. Possible values: UNKNOWN_THEME LIGHT DARK
- web
Widget StringTitle - (Output) The title of the web widget.
AppVersionSnapshotAppEvaluationMetricsThreshold, AppVersionSnapshotAppEvaluationMetricsThresholdArgs
- Golden
Evaluation List<AppMetrics Thresholds Version Snapshot App Evaluation Metrics Threshold Golden Evaluation Metrics Threshold> - (Output) Settings for golden evaluations. Structure is documented below.
- Golden
Evaluation []AppMetrics Thresholds Version Snapshot App Evaluation Metrics Threshold Golden Evaluation Metrics Threshold - (Output) Settings for golden evaluations. Structure is documented below.
- golden
Evaluation List<AppMetrics Thresholds Version Snapshot App Evaluation Metrics Threshold Golden Evaluation Metrics Threshold> - (Output) Settings for golden evaluations. Structure is documented below.
- golden
Evaluation AppMetrics Thresholds Version Snapshot App Evaluation Metrics Threshold Golden Evaluation Metrics Threshold[] - (Output) Settings for golden evaluations. Structure is documented below.
- golden_
evaluation_ Sequence[Appmetrics_ thresholds Version Snapshot App Evaluation Metrics Threshold Golden Evaluation Metrics Threshold] - (Output) Settings for golden evaluations. Structure is documented below.
- golden
Evaluation List<Property Map>Metrics Thresholds - (Output) Settings for golden evaluations. Structure is documented below.
AppVersionSnapshotAppEvaluationMetricsThresholdGoldenEvaluationMetricsThreshold, AppVersionSnapshotAppEvaluationMetricsThresholdGoldenEvaluationMetricsThresholdArgs
- Expectation
Level List<AppMetrics Thresholds Version Snapshot App Evaluation Metrics Threshold Golden Evaluation Metrics Threshold Expectation Level Metrics Threshold> - (Output) Expectation level metrics thresholds. Structure is documented below.
- Turn
Level List<AppMetrics Thresholds Version Snapshot App Evaluation Metrics Threshold Golden Evaluation Metrics Threshold Turn Level Metrics Threshold> - (Output) Turn level metrics thresholds. Structure is documented below.
- Expectation
Level []AppMetrics Thresholds Version Snapshot App Evaluation Metrics Threshold Golden Evaluation Metrics Threshold Expectation Level Metrics Threshold - (Output) Expectation level metrics thresholds. Structure is documented below.
- Turn
Level []AppMetrics Thresholds Version Snapshot App Evaluation Metrics Threshold Golden Evaluation Metrics Threshold Turn Level Metrics Threshold - (Output) Turn level metrics thresholds. Structure is documented below.
- expectation
Level List<AppMetrics Thresholds Version Snapshot App Evaluation Metrics Threshold Golden Evaluation Metrics Threshold Expectation Level Metrics Threshold> - (Output) Expectation level metrics thresholds. Structure is documented below.
- turn
Level List<AppMetrics Thresholds Version Snapshot App Evaluation Metrics Threshold Golden Evaluation Metrics Threshold Turn Level Metrics Threshold> - (Output) Turn level metrics thresholds. Structure is documented below.
- expectation
Level AppMetrics Thresholds Version Snapshot App Evaluation Metrics Threshold Golden Evaluation Metrics Threshold Expectation Level Metrics Threshold[] - (Output) Expectation level metrics thresholds. Structure is documented below.
- turn
Level AppMetrics Thresholds Version Snapshot App Evaluation Metrics Threshold Golden Evaluation Metrics Threshold Turn Level Metrics Threshold[] - (Output) Turn level metrics thresholds. Structure is documented below.
- expectation_
level_ Sequence[Appmetrics_ thresholds Version Snapshot App Evaluation Metrics Threshold Golden Evaluation Metrics Threshold Expectation Level Metrics Threshold] - (Output) Expectation level metrics thresholds. Structure is documented below.
- turn_
level_ Sequence[Appmetrics_ thresholds Version Snapshot App Evaluation Metrics Threshold Golden Evaluation Metrics Threshold Turn Level Metrics Threshold] - (Output) Turn level metrics thresholds. Structure is documented below.
- expectation
Level List<Property Map>Metrics Thresholds - (Output) Expectation level metrics thresholds. Structure is documented below.
- turn
Level List<Property Map>Metrics Thresholds - (Output) Turn level metrics thresholds. Structure is documented below.
AppVersionSnapshotAppEvaluationMetricsThresholdGoldenEvaluationMetricsThresholdExpectationLevelMetricsThreshold, AppVersionSnapshotAppEvaluationMetricsThresholdGoldenEvaluationMetricsThresholdExpectationLevelMetricsThresholdArgs
- Tool
Invocation doubleParameter Correctness Threshold - (Output) The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0.
- Tool
Invocation float64Parameter Correctness Threshold - (Output) The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0.
- tool
Invocation DoubleParameter Correctness Threshold - (Output) The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0.
- tool
Invocation numberParameter Correctness Threshold - (Output) The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0.
- tool_
invocation_ floatparameter_ correctness_ threshold - (Output) The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0.
- tool
Invocation NumberParameter Correctness Threshold - (Output) The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0.
AppVersionSnapshotAppEvaluationMetricsThresholdGoldenEvaluationMetricsThresholdTurnLevelMetricsThreshold, AppVersionSnapshotAppEvaluationMetricsThresholdGoldenEvaluationMetricsThresholdTurnLevelMetricsThresholdArgs
- Overall
Tool doubleInvocation Correctness Threshold - (Output) The success threshold for overall tool invocation correctness. Must be a float between 0 and 1. Default is 1.0.
- Semantic
Similarity intSuccess Threshold - (Output) The success threshold for semantic similarity. Must be an integer between 0 and 4. Default is >= 3.
- Overall
Tool float64Invocation Correctness Threshold - (Output) The success threshold for overall tool invocation correctness. Must be a float between 0 and 1. Default is 1.0.
- Semantic
Similarity intSuccess Threshold - (Output) The success threshold for semantic similarity. Must be an integer between 0 and 4. Default is >= 3.
- overall
Tool DoubleInvocation Correctness Threshold - (Output) The success threshold for overall tool invocation correctness. Must be a float between 0 and 1. Default is 1.0.
- semantic
Similarity IntegerSuccess Threshold - (Output) The success threshold for semantic similarity. Must be an integer between 0 and 4. Default is >= 3.
- overall
Tool numberInvocation Correctness Threshold - (Output) The success threshold for overall tool invocation correctness. Must be a float between 0 and 1. Default is 1.0.
- semantic
Similarity numberSuccess Threshold - (Output) The success threshold for semantic similarity. Must be an integer between 0 and 4. Default is >= 3.
- overall_
tool_ floatinvocation_ correctness_ threshold - (Output) The success threshold for overall tool invocation correctness. Must be a float between 0 and 1. Default is 1.0.
- semantic_
similarity_ intsuccess_ threshold - (Output) The success threshold for semantic similarity. Must be an integer between 0 and 4. Default is >= 3.
- overall
Tool NumberInvocation Correctness Threshold - (Output) The success threshold for overall tool invocation correctness. Must be a float between 0 and 1. Default is 1.0.
- semantic
Similarity NumberSuccess Threshold - (Output) The success threshold for semantic similarity. Must be an integer between 0 and 4. Default is >= 3.
AppVersionSnapshotAppLanguageSetting, AppVersionSnapshotAppLanguageSettingArgs
- Default
Language stringCode - (Output) The default language code of the app.
- Enable
Multilingual boolSupport - (Output) Enables multilingual support. If true, agents in the app will use pre-built instructions to improve handling of multilingual input.
- Fallback
Action string - (Output)
The action to perform when an agent receives input in an unsupported
language.
This can be a predefined action or a custom tool call.
Valid values are:
- A tool's full resource name, which triggers a specific tool execution.
- A predefined system action, such as "escalate" or "exit", which triggers an EndSession signal with corresponding metadata to terminate the conversation.
- Supported
Language List<string>Codes - (Output)
List of languages codes supported by the app, in addition to the
default_language_code.
- Default
Language stringCode - (Output) The default language code of the app.
- Enable
Multilingual boolSupport - (Output) Enables multilingual support. If true, agents in the app will use pre-built instructions to improve handling of multilingual input.
- Fallback
Action string - (Output)
The action to perform when an agent receives input in an unsupported
language.
This can be a predefined action or a custom tool call.
Valid values are:
- A tool's full resource name, which triggers a specific tool execution.
- A predefined system action, such as "escalate" or "exit", which triggers an EndSession signal with corresponding metadata to terminate the conversation.
- Supported
Language []stringCodes - (Output)
List of languages codes supported by the app, in addition to the
default_language_code.
- default
Language StringCode - (Output) The default language code of the app.
- enable
Multilingual BooleanSupport - (Output) Enables multilingual support. If true, agents in the app will use pre-built instructions to improve handling of multilingual input.
- fallback
Action String - (Output)
The action to perform when an agent receives input in an unsupported
language.
This can be a predefined action or a custom tool call.
Valid values are:
- A tool's full resource name, which triggers a specific tool execution.
- A predefined system action, such as "escalate" or "exit", which triggers an EndSession signal with corresponding metadata to terminate the conversation.
- supported
Language List<String>Codes - (Output)
List of languages codes supported by the app, in addition to the
default_language_code.
- default
Language stringCode - (Output) The default language code of the app.
- enable
Multilingual booleanSupport - (Output) Enables multilingual support. If true, agents in the app will use pre-built instructions to improve handling of multilingual input.
- fallback
Action string - (Output)
The action to perform when an agent receives input in an unsupported
language.
This can be a predefined action or a custom tool call.
Valid values are:
- A tool's full resource name, which triggers a specific tool execution.
- A predefined system action, such as "escalate" or "exit", which triggers an EndSession signal with corresponding metadata to terminate the conversation.
- supported
Language string[]Codes - (Output)
List of languages codes supported by the app, in addition to the
default_language_code.
- default_
language_ strcode - (Output) The default language code of the app.
- enable_
multilingual_ boolsupport - (Output) Enables multilingual support. If true, agents in the app will use pre-built instructions to improve handling of multilingual input.
- fallback_
action str - (Output)
The action to perform when an agent receives input in an unsupported
language.
This can be a predefined action or a custom tool call.
Valid values are:
- A tool's full resource name, which triggers a specific tool execution.
- A predefined system action, such as "escalate" or "exit", which triggers an EndSession signal with corresponding metadata to terminate the conversation.
- supported_
language_ Sequence[str]codes - (Output)
List of languages codes supported by the app, in addition to the
default_language_code.
- default
Language StringCode - (Output) The default language code of the app.
- enable
Multilingual BooleanSupport - (Output) Enables multilingual support. If true, agents in the app will use pre-built instructions to improve handling of multilingual input.
- fallback
Action String - (Output)
The action to perform when an agent receives input in an unsupported
language.
This can be a predefined action or a custom tool call.
Valid values are:
- A tool's full resource name, which triggers a specific tool execution.
- A predefined system action, such as "escalate" or "exit", which triggers an EndSession signal with corresponding metadata to terminate the conversation.
- supported
Language List<String>Codes - (Output)
List of languages codes supported by the app, in addition to the
default_language_code.
AppVersionSnapshotAppLoggingSetting, AppVersionSnapshotAppLoggingSettingArgs
- Audio
Recording List<AppConfigs Version Snapshot App Logging Setting Audio Recording Config> - (Output) Configuration for how the audio interactions should be recorded. Structure is documented below.
- Bigquery
Export List<AppSettings Version Snapshot App Logging Setting Bigquery Export Setting> - (Output) Settings to describe the BigQuery export behaviors for the app. Structure is documented below.
- Cloud
Logging List<AppSettings Version Snapshot App Logging Setting Cloud Logging Setting> - (Output) Settings to describe the Cloud Logging behaviors for the app. Structure is documented below.
- Conversation
Logging List<AppSettings Version Snapshot App Logging Setting Conversation Logging Setting> - (Output) Settings to describe the conversation logging behaviors for the app. Structure is documented below.
- Redaction
Configs List<AppVersion Snapshot App Logging Setting Redaction Config> - (Output) Configuration to instruct how sensitive data should be handled. Structure is documented below.
- Audio
Recording []AppConfigs Version Snapshot App Logging Setting Audio Recording Config - (Output) Configuration for how the audio interactions should be recorded. Structure is documented below.
- Bigquery
Export []AppSettings Version Snapshot App Logging Setting Bigquery Export Setting - (Output) Settings to describe the BigQuery export behaviors for the app. Structure is documented below.
- Cloud
Logging []AppSettings Version Snapshot App Logging Setting Cloud Logging Setting - (Output) Settings to describe the Cloud Logging behaviors for the app. Structure is documented below.
- Conversation
Logging []AppSettings Version Snapshot App Logging Setting Conversation Logging Setting - (Output) Settings to describe the conversation logging behaviors for the app. Structure is documented below.
- Redaction
Configs []AppVersion Snapshot App Logging Setting Redaction Config - (Output) Configuration to instruct how sensitive data should be handled. Structure is documented below.
- audio
Recording List<AppConfigs Version Snapshot App Logging Setting Audio Recording Config> - (Output) Configuration for how the audio interactions should be recorded. Structure is documented below.
- bigquery
Export List<AppSettings Version Snapshot App Logging Setting Bigquery Export Setting> - (Output) Settings to describe the BigQuery export behaviors for the app. Structure is documented below.
- cloud
Logging List<AppSettings Version Snapshot App Logging Setting Cloud Logging Setting> - (Output) Settings to describe the Cloud Logging behaviors for the app. Structure is documented below.
- conversation
Logging List<AppSettings Version Snapshot App Logging Setting Conversation Logging Setting> - (Output) Settings to describe the conversation logging behaviors for the app. Structure is documented below.
- redaction
Configs List<AppVersion Snapshot App Logging Setting Redaction Config> - (Output) Configuration to instruct how sensitive data should be handled. Structure is documented below.
- audio
Recording AppConfigs Version Snapshot App Logging Setting Audio Recording Config[] - (Output) Configuration for how the audio interactions should be recorded. Structure is documented below.
- bigquery
Export AppSettings Version Snapshot App Logging Setting Bigquery Export Setting[] - (Output) Settings to describe the BigQuery export behaviors for the app. Structure is documented below.
- cloud
Logging AppSettings Version Snapshot App Logging Setting Cloud Logging Setting[] - (Output) Settings to describe the Cloud Logging behaviors for the app. Structure is documented below.
- conversation
Logging AppSettings Version Snapshot App Logging Setting Conversation Logging Setting[] - (Output) Settings to describe the conversation logging behaviors for the app. Structure is documented below.
- redaction
Configs AppVersion Snapshot App Logging Setting Redaction Config[] - (Output) Configuration to instruct how sensitive data should be handled. Structure is documented below.
- audio_
recording_ Sequence[Appconfigs Version Snapshot App Logging Setting Audio Recording Config] - (Output) Configuration for how the audio interactions should be recorded. Structure is documented below.
- bigquery_
export_ Sequence[Appsettings Version Snapshot App Logging Setting Bigquery Export Setting] - (Output) Settings to describe the BigQuery export behaviors for the app. Structure is documented below.
- cloud_
logging_ Sequence[Appsettings Version Snapshot App Logging Setting Cloud Logging Setting] - (Output) Settings to describe the Cloud Logging behaviors for the app. Structure is documented below.
- conversation_
logging_ Sequence[Appsettings Version Snapshot App Logging Setting Conversation Logging Setting] - (Output) Settings to describe the conversation logging behaviors for the app. Structure is documented below.
- redaction_
configs Sequence[AppVersion Snapshot App Logging Setting Redaction Config] - (Output) Configuration to instruct how sensitive data should be handled. Structure is documented below.
- audio
Recording List<Property Map>Configs - (Output) Configuration for how the audio interactions should be recorded. Structure is documented below.
- bigquery
Export List<Property Map>Settings - (Output) Settings to describe the BigQuery export behaviors for the app. Structure is documented below.
- cloud
Logging List<Property Map>Settings - (Output) Settings to describe the Cloud Logging behaviors for the app. Structure is documented below.
- conversation
Logging List<Property Map>Settings - (Output) Settings to describe the conversation logging behaviors for the app. Structure is documented below.
- redaction
Configs List<Property Map> - (Output) Configuration to instruct how sensitive data should be handled. Structure is documented below.
AppVersionSnapshotAppLoggingSettingAudioRecordingConfig, AppVersionSnapshotAppLoggingSettingAudioRecordingConfigArgs
- Gcs
Bucket string - (Output)
The Cloud Storage bucket to store the
session audio recordings. The URI must start with "gs://".
Note: If the Cloud Storage bucket is in a different project from the app,
you should grant
storage.objects.createpermission to the CES service agentservice-@gcp-sa-ces.iam.gserviceaccount.com. - Gcs
Path stringPrefix - (Output)
The Cloud Storage path prefix for audio recordings.
This prefix can include the following placeholders, which will be
dynamically substituted at serving time:
- $project: project ID
- $location: app location
- $app: app ID
- $date: session date in YYYY-MM-DD format
- $session: session ID
If the path prefix is not specified, the default prefix
$project/$location/$app/$date/$session/will be used.
- Gcs
Bucket string - (Output)
The Cloud Storage bucket to store the
session audio recordings. The URI must start with "gs://".
Note: If the Cloud Storage bucket is in a different project from the app,
you should grant
storage.objects.createpermission to the CES service agentservice-@gcp-sa-ces.iam.gserviceaccount.com. - Gcs
Path stringPrefix - (Output)
The Cloud Storage path prefix for audio recordings.
This prefix can include the following placeholders, which will be
dynamically substituted at serving time:
- $project: project ID
- $location: app location
- $app: app ID
- $date: session date in YYYY-MM-DD format
- $session: session ID
If the path prefix is not specified, the default prefix
$project/$location/$app/$date/$session/will be used.
- gcs
Bucket String - (Output)
The Cloud Storage bucket to store the
session audio recordings. The URI must start with "gs://".
Note: If the Cloud Storage bucket is in a different project from the app,
you should grant
storage.objects.createpermission to the CES service agentservice-@gcp-sa-ces.iam.gserviceaccount.com. - gcs
Path StringPrefix - (Output)
The Cloud Storage path prefix for audio recordings.
This prefix can include the following placeholders, which will be
dynamically substituted at serving time:
- $project: project ID
- $location: app location
- $app: app ID
- $date: session date in YYYY-MM-DD format
- $session: session ID
If the path prefix is not specified, the default prefix
$project/$location/$app/$date/$session/will be used.
- gcs
Bucket string - (Output)
The Cloud Storage bucket to store the
session audio recordings. The URI must start with "gs://".
Note: If the Cloud Storage bucket is in a different project from the app,
you should grant
storage.objects.createpermission to the CES service agentservice-@gcp-sa-ces.iam.gserviceaccount.com. - gcs
Path stringPrefix - (Output)
The Cloud Storage path prefix for audio recordings.
This prefix can include the following placeholders, which will be
dynamically substituted at serving time:
- $project: project ID
- $location: app location
- $app: app ID
- $date: session date in YYYY-MM-DD format
- $session: session ID
If the path prefix is not specified, the default prefix
$project/$location/$app/$date/$session/will be used.
- gcs_
bucket str - (Output)
The Cloud Storage bucket to store the
session audio recordings. The URI must start with "gs://".
Note: If the Cloud Storage bucket is in a different project from the app,
you should grant
storage.objects.createpermission to the CES service agentservice-@gcp-sa-ces.iam.gserviceaccount.com. - gcs_
path_ strprefix - (Output)
The Cloud Storage path prefix for audio recordings.
This prefix can include the following placeholders, which will be
dynamically substituted at serving time:
- $project: project ID
- $location: app location
- $app: app ID
- $date: session date in YYYY-MM-DD format
- $session: session ID
If the path prefix is not specified, the default prefix
$project/$location/$app/$date/$session/will be used.
- gcs
Bucket String - (Output)
The Cloud Storage bucket to store the
session audio recordings. The URI must start with "gs://".
Note: If the Cloud Storage bucket is in a different project from the app,
you should grant
storage.objects.createpermission to the CES service agentservice-@gcp-sa-ces.iam.gserviceaccount.com. - gcs
Path StringPrefix - (Output)
The Cloud Storage path prefix for audio recordings.
This prefix can include the following placeholders, which will be
dynamically substituted at serving time:
- $project: project ID
- $location: app location
- $app: app ID
- $date: session date in YYYY-MM-DD format
- $session: session ID
If the path prefix is not specified, the default prefix
$project/$location/$app/$date/$session/will be used.
AppVersionSnapshotAppLoggingSettingBigqueryExportSetting, AppVersionSnapshotAppLoggingSettingBigqueryExportSettingArgs
AppVersionSnapshotAppLoggingSettingCloudLoggingSetting, AppVersionSnapshotAppLoggingSettingCloudLoggingSettingArgs
- Enable
Cloud boolLogging - (Output) Whether to enable Cloud Logging for the sessions.
- Enable
Cloud boolLogging - (Output) Whether to enable Cloud Logging for the sessions.
- enable
Cloud BooleanLogging - (Output) Whether to enable Cloud Logging for the sessions.
- enable
Cloud booleanLogging - (Output) Whether to enable Cloud Logging for the sessions.
- enable_
cloud_ boollogging - (Output) Whether to enable Cloud Logging for the sessions.
- enable
Cloud BooleanLogging - (Output) Whether to enable Cloud Logging for the sessions.
AppVersionSnapshotAppLoggingSettingConversationLoggingSetting, AppVersionSnapshotAppLoggingSettingConversationLoggingSettingArgs
- Disable
Conversation boolLogging - (Output) Whether to disable conversation logging for the sessions.
- Disable
Conversation boolLogging - (Output) Whether to disable conversation logging for the sessions.
- disable
Conversation BooleanLogging - (Output) Whether to disable conversation logging for the sessions.
- disable
Conversation booleanLogging - (Output) Whether to disable conversation logging for the sessions.
- disable_
conversation_ boollogging - (Output) Whether to disable conversation logging for the sessions.
- disable
Conversation BooleanLogging - (Output) Whether to disable conversation logging for the sessions.
AppVersionSnapshotAppLoggingSettingRedactionConfig, AppVersionSnapshotAppLoggingSettingRedactionConfigArgs
- Deidentify
Template string - (Output)
DLP deidentify template name to
instruct on how to de-identify content.
Format:
projects/{project}/locations/{location}/deidentifyTemplates/{deidentify_template} - Enable
Redaction bool - (Output) If true, redaction will be applied in various logging scenarios, including conversation history, Cloud Logging and audio recording.
- Inspect
Template string - (Output)
DLP inspect template name to configure
detection of sensitive data types.
Format:
projects/{project}/locations/{location}/inspectTemplates/{inspect_template}
- Deidentify
Template string - (Output)
DLP deidentify template name to
instruct on how to de-identify content.
Format:
projects/{project}/locations/{location}/deidentifyTemplates/{deidentify_template} - Enable
Redaction bool - (Output) If true, redaction will be applied in various logging scenarios, including conversation history, Cloud Logging and audio recording.
- Inspect
Template string - (Output)
DLP inspect template name to configure
detection of sensitive data types.
Format:
projects/{project}/locations/{location}/inspectTemplates/{inspect_template}
- deidentify
Template String - (Output)
DLP deidentify template name to
instruct on how to de-identify content.
Format:
projects/{project}/locations/{location}/deidentifyTemplates/{deidentify_template} - enable
Redaction Boolean - (Output) If true, redaction will be applied in various logging scenarios, including conversation history, Cloud Logging and audio recording.
- inspect
Template String - (Output)
DLP inspect template name to configure
detection of sensitive data types.
Format:
projects/{project}/locations/{location}/inspectTemplates/{inspect_template}
- deidentify
Template string - (Output)
DLP deidentify template name to
instruct on how to de-identify content.
Format:
projects/{project}/locations/{location}/deidentifyTemplates/{deidentify_template} - enable
Redaction boolean - (Output) If true, redaction will be applied in various logging scenarios, including conversation history, Cloud Logging and audio recording.
- inspect
Template string - (Output)
DLP inspect template name to configure
detection of sensitive data types.
Format:
projects/{project}/locations/{location}/inspectTemplates/{inspect_template}
- deidentify_
template str - (Output)
DLP deidentify template name to
instruct on how to de-identify content.
Format:
projects/{project}/locations/{location}/deidentifyTemplates/{deidentify_template} - enable_
redaction bool - (Output) If true, redaction will be applied in various logging scenarios, including conversation history, Cloud Logging and audio recording.
- inspect_
template str - (Output)
DLP inspect template name to configure
detection of sensitive data types.
Format:
projects/{project}/locations/{location}/inspectTemplates/{inspect_template}
- deidentify
Template String - (Output)
DLP deidentify template name to
instruct on how to de-identify content.
Format:
projects/{project}/locations/{location}/deidentifyTemplates/{deidentify_template} - enable
Redaction Boolean - (Output) If true, redaction will be applied in various logging scenarios, including conversation history, Cloud Logging and audio recording.
- inspect
Template String - (Output)
DLP inspect template name to configure
detection of sensitive data types.
Format:
projects/{project}/locations/{location}/inspectTemplates/{inspect_template}
AppVersionSnapshotAppModelSetting, AppVersionSnapshotAppModelSettingArgs
- Model string
- (Output) The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
- Temperature double
- (Output) If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
- Model string
- (Output) The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
- Temperature float64
- (Output) If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
- model String
- (Output) The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
- temperature Double
- (Output) If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
- model string
- (Output) The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
- temperature number
- (Output) If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
- model str
- (Output) The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
- temperature float
- (Output) If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
- model String
- (Output) The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
- temperature Number
- (Output) If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
AppVersionSnapshotAppTimeZoneSetting, AppVersionSnapshotAppTimeZoneSettingArgs
- Time
Zone string - (Output) The time zone of the app from the time zone database, e.g., America/Los_Angeles, Europe/Paris.
- Time
Zone string - (Output) The time zone of the app from the time zone database, e.g., America/Los_Angeles, Europe/Paris.
- time
Zone String - (Output) The time zone of the app from the time zone database, e.g., America/Los_Angeles, Europe/Paris.
- time
Zone string - (Output) The time zone of the app from the time zone database, e.g., America/Los_Angeles, Europe/Paris.
- time_
zone str - (Output) The time zone of the app from the time zone database, e.g., America/Los_Angeles, Europe/Paris.
- time
Zone String - (Output) The time zone of the app from the time zone database, e.g., America/Los_Angeles, Europe/Paris.
AppVersionSnapshotAppVariableDeclaration, AppVersionSnapshotAppVariableDeclarationArgs
- Description string
- The description of the app version.
- Name string
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - Schemas
List<App
Version Snapshot App Variable Declaration Schema> - (Output) Represents a select subset of an OpenAPI 3.0 schema object. Structure is documented below.
- Description string
- The description of the app version.
- Name string
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - Schemas
[]App
Version Snapshot App Variable Declaration Schema - (Output) Represents a select subset of an OpenAPI 3.0 schema object. Structure is documented below.
- description String
- The description of the app version.
- name String
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - schemas
List<App
Version Snapshot App Variable Declaration Schema> - (Output) Represents a select subset of an OpenAPI 3.0 schema object. Structure is documented below.
- description string
- The description of the app version.
- name string
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - schemas
App
Version Snapshot App Variable Declaration Schema[] - (Output) Represents a select subset of an OpenAPI 3.0 schema object. Structure is documented below.
- description str
- The description of the app version.
- name str
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - schemas
Sequence[App
Version Snapshot App Variable Declaration Schema] - (Output) Represents a select subset of an OpenAPI 3.0 schema object. Structure is documented below.
- description String
- The description of the app version.
- name String
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - schemas List<Property Map>
- (Output) Represents a select subset of an OpenAPI 3.0 schema object. Structure is documented below.
AppVersionSnapshotAppVariableDeclarationSchema, AppVersionSnapshotAppVariableDeclarationSchemaArgs
- Additional
Properties string - (Output) Optional. Defines the schema for additional properties allowed in an object. The value must be a valid JSON string representing the Schema object. (Note: OpenAPI also allows a boolean, this definition expects a Schema JSON).
- Any
Of string - (Output) Optional. The instance value should be valid against at least one of the schemas in this list.
- Default string
- (Output) Optional. Default value of the data. Represents a dynamically typed value which can be either null, a number, a string, a boolean, a struct, or a list of values. The provided default value must be compatible with the defined 'type' and other schema constraints.
- Defs string
- (Output) A map of definitions for use by ref. Only allowed at the root of the schema.
- Description string
- The description of the app version.
- Enums List<string>
- (Output)
Possible values of the element of primitive type with enum format.
Examples:
- We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
- We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
- Items string
- (Output) Schema of the elements of Type.ARRAY.
- Nullable bool
- (Output) Indicates if the value may be null.
- Prefix
Items string - (Output) Optional. Schemas of initial elements of Type.ARRAY.
- Properties string
- (Output) Properties of Type.OBJECT.
- Ref string
- (Output)
Allows indirect references between schema nodes. The value should be a
valid reference to a child of the root
defs. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring. - Requireds List<string>
- (Output) Required properties of Type.OBJECT.
- Type string
- (Output) The type of the data store. This field is readonly and populated by the server. Possible values: PUBLIC_WEB UNSTRUCTURED FAQ CONNECTOR
- Unique
Items bool - (Output) Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
- Additional
Properties string - (Output) Optional. Defines the schema for additional properties allowed in an object. The value must be a valid JSON string representing the Schema object. (Note: OpenAPI also allows a boolean, this definition expects a Schema JSON).
- Any
Of string - (Output) Optional. The instance value should be valid against at least one of the schemas in this list.
- Default string
- (Output) Optional. Default value of the data. Represents a dynamically typed value which can be either null, a number, a string, a boolean, a struct, or a list of values. The provided default value must be compatible with the defined 'type' and other schema constraints.
- Defs string
- (Output) A map of definitions for use by ref. Only allowed at the root of the schema.
- Description string
- The description of the app version.
- Enums []string
- (Output)
Possible values of the element of primitive type with enum format.
Examples:
- We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
- We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
- Items string
- (Output) Schema of the elements of Type.ARRAY.
- Nullable bool
- (Output) Indicates if the value may be null.
- Prefix
Items string - (Output) Optional. Schemas of initial elements of Type.ARRAY.
- Properties string
- (Output) Properties of Type.OBJECT.
- Ref string
- (Output)
Allows indirect references between schema nodes. The value should be a
valid reference to a child of the root
defs. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring. - Requireds []string
- (Output) Required properties of Type.OBJECT.
- Type string
- (Output) The type of the data store. This field is readonly and populated by the server. Possible values: PUBLIC_WEB UNSTRUCTURED FAQ CONNECTOR
- Unique
Items bool - (Output) Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
- additional
Properties String - (Output) Optional. Defines the schema for additional properties allowed in an object. The value must be a valid JSON string representing the Schema object. (Note: OpenAPI also allows a boolean, this definition expects a Schema JSON).
- any
Of String - (Output) Optional. The instance value should be valid against at least one of the schemas in this list.
- default_ String
- (Output) Optional. Default value of the data. Represents a dynamically typed value which can be either null, a number, a string, a boolean, a struct, or a list of values. The provided default value must be compatible with the defined 'type' and other schema constraints.
- defs String
- (Output) A map of definitions for use by ref. Only allowed at the root of the schema.
- description String
- The description of the app version.
- enums List<String>
- (Output)
Possible values of the element of primitive type with enum format.
Examples:
- We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
- We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
- items String
- (Output) Schema of the elements of Type.ARRAY.
- nullable Boolean
- (Output) Indicates if the value may be null.
- prefix
Items String - (Output) Optional. Schemas of initial elements of Type.ARRAY.
- properties String
- (Output) Properties of Type.OBJECT.
- ref String
- (Output)
Allows indirect references between schema nodes. The value should be a
valid reference to a child of the root
defs. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring. - requireds List<String>
- (Output) Required properties of Type.OBJECT.
- type String
- (Output) The type of the data store. This field is readonly and populated by the server. Possible values: PUBLIC_WEB UNSTRUCTURED FAQ CONNECTOR
- unique
Items Boolean - (Output) Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
- additional
Properties string - (Output) Optional. Defines the schema for additional properties allowed in an object. The value must be a valid JSON string representing the Schema object. (Note: OpenAPI also allows a boolean, this definition expects a Schema JSON).
- any
Of string - (Output) Optional. The instance value should be valid against at least one of the schemas in this list.
- default string
- (Output) Optional. Default value of the data. Represents a dynamically typed value which can be either null, a number, a string, a boolean, a struct, or a list of values. The provided default value must be compatible with the defined 'type' and other schema constraints.
- defs string
- (Output) A map of definitions for use by ref. Only allowed at the root of the schema.
- description string
- The description of the app version.
- enums string[]
- (Output)
Possible values of the element of primitive type with enum format.
Examples:
- We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
- We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
- items string
- (Output) Schema of the elements of Type.ARRAY.
- nullable boolean
- (Output) Indicates if the value may be null.
- prefix
Items string - (Output) Optional. Schemas of initial elements of Type.ARRAY.
- properties string
- (Output) Properties of Type.OBJECT.
- ref string
- (Output)
Allows indirect references between schema nodes. The value should be a
valid reference to a child of the root
defs. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring. - requireds string[]
- (Output) Required properties of Type.OBJECT.
- type string
- (Output) The type of the data store. This field is readonly and populated by the server. Possible values: PUBLIC_WEB UNSTRUCTURED FAQ CONNECTOR
- unique
Items boolean - (Output) Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
- additional_
properties str - (Output) Optional. Defines the schema for additional properties allowed in an object. The value must be a valid JSON string representing the Schema object. (Note: OpenAPI also allows a boolean, this definition expects a Schema JSON).
- any_
of str - (Output) Optional. The instance value should be valid against at least one of the schemas in this list.
- default str
- (Output) Optional. Default value of the data. Represents a dynamically typed value which can be either null, a number, a string, a boolean, a struct, or a list of values. The provided default value must be compatible with the defined 'type' and other schema constraints.
- defs str
- (Output) A map of definitions for use by ref. Only allowed at the root of the schema.
- description str
- The description of the app version.
- enums Sequence[str]
- (Output)
Possible values of the element of primitive type with enum format.
Examples:
- We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
- We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
- items str
- (Output) Schema of the elements of Type.ARRAY.
- nullable bool
- (Output) Indicates if the value may be null.
- prefix_
items str - (Output) Optional. Schemas of initial elements of Type.ARRAY.
- properties str
- (Output) Properties of Type.OBJECT.
- ref str
- (Output)
Allows indirect references between schema nodes. The value should be a
valid reference to a child of the root
defs. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring. - requireds Sequence[str]
- (Output) Required properties of Type.OBJECT.
- type str
- (Output) The type of the data store. This field is readonly and populated by the server. Possible values: PUBLIC_WEB UNSTRUCTURED FAQ CONNECTOR
- unique_
items bool - (Output) Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
- additional
Properties String - (Output) Optional. Defines the schema for additional properties allowed in an object. The value must be a valid JSON string representing the Schema object. (Note: OpenAPI also allows a boolean, this definition expects a Schema JSON).
- any
Of String - (Output) Optional. The instance value should be valid against at least one of the schemas in this list.
- default String
- (Output) Optional. Default value of the data. Represents a dynamically typed value which can be either null, a number, a string, a boolean, a struct, or a list of values. The provided default value must be compatible with the defined 'type' and other schema constraints.
- defs String
- (Output) A map of definitions for use by ref. Only allowed at the root of the schema.
- description String
- The description of the app version.
- enums List<String>
- (Output)
Possible values of the element of primitive type with enum format.
Examples:
- We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
- We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
- items String
- (Output) Schema of the elements of Type.ARRAY.
- nullable Boolean
- (Output) Indicates if the value may be null.
- prefix
Items String - (Output) Optional. Schemas of initial elements of Type.ARRAY.
- properties String
- (Output) Properties of Type.OBJECT.
- ref String
- (Output)
Allows indirect references between schema nodes. The value should be a
valid reference to a child of the root
defs. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring. - requireds List<String>
- (Output) Required properties of Type.OBJECT.
- type String
- (Output) The type of the data store. This field is readonly and populated by the server. Possible values: PUBLIC_WEB UNSTRUCTURED FAQ CONNECTOR
- unique
Items Boolean - (Output) Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
AppVersionSnapshotExample, AppVersionSnapshotExampleArgs
- Create
Time string - (Output) Timestamp when the toolset was created.
- Description string
- The description of the app version.
- Display
Name string - The display name of the app version.
- Entry
Agent string - (Output)
The agent that initially handles the conversation. If not specified, the
example represents a conversation that is handled by the root agent.
Format:
projects/{project}/locations/{location}/apps/{app}/agents/{agent} - Etag string
- (Output) ETag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
- Invalid bool
- (Output) The example may become invalid if referencing resources are deleted. Invalid examples will not be used as few-shot examples.
- Messages
List<App
Version Snapshot Example Message> - (Output) The collection of messages that make up the conversation. Structure is documented below.
- Name string
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - Update
Time string - (Output) Timestamp when the toolset was last updated.
- Create
Time string - (Output) Timestamp when the toolset was created.
- Description string
- The description of the app version.
- Display
Name string - The display name of the app version.
- Entry
Agent string - (Output)
The agent that initially handles the conversation. If not specified, the
example represents a conversation that is handled by the root agent.
Format:
projects/{project}/locations/{location}/apps/{app}/agents/{agent} - Etag string
- (Output) ETag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
- Invalid bool
- (Output) The example may become invalid if referencing resources are deleted. Invalid examples will not be used as few-shot examples.
- Messages
[]App
Version Snapshot Example Message - (Output) The collection of messages that make up the conversation. Structure is documented below.
- Name string
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - Update
Time string - (Output) Timestamp when the toolset was last updated.
- create
Time String - (Output) Timestamp when the toolset was created.
- description String
- The description of the app version.
- display
Name String - The display name of the app version.
- entry
Agent String - (Output)
The agent that initially handles the conversation. If not specified, the
example represents a conversation that is handled by the root agent.
Format:
projects/{project}/locations/{location}/apps/{app}/agents/{agent} - etag String
- (Output) ETag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
- invalid Boolean
- (Output) The example may become invalid if referencing resources are deleted. Invalid examples will not be used as few-shot examples.
- messages
List<App
Version Snapshot Example Message> - (Output) The collection of messages that make up the conversation. Structure is documented below.
- name String
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - update
Time String - (Output) Timestamp when the toolset was last updated.
- create
Time string - (Output) Timestamp when the toolset was created.
- description string
- The description of the app version.
- display
Name string - The display name of the app version.
- entry
Agent string - (Output)
The agent that initially handles the conversation. If not specified, the
example represents a conversation that is handled by the root agent.
Format:
projects/{project}/locations/{location}/apps/{app}/agents/{agent} - etag string
- (Output) ETag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
- invalid boolean
- (Output) The example may become invalid if referencing resources are deleted. Invalid examples will not be used as few-shot examples.
- messages
App
Version Snapshot Example Message[] - (Output) The collection of messages that make up the conversation. Structure is documented below.
- name string
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - update
Time string - (Output) Timestamp when the toolset was last updated.
- create_
time str - (Output) Timestamp when the toolset was created.
- description str
- The description of the app version.
- display_
name str - The display name of the app version.
- entry_
agent str - (Output)
The agent that initially handles the conversation. If not specified, the
example represents a conversation that is handled by the root agent.
Format:
projects/{project}/locations/{location}/apps/{app}/agents/{agent} - etag str
- (Output) ETag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
- invalid bool
- (Output) The example may become invalid if referencing resources are deleted. Invalid examples will not be used as few-shot examples.
- messages
Sequence[App
Version Snapshot Example Message] - (Output) The collection of messages that make up the conversation. Structure is documented below.
- name str
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - update_
time str - (Output) Timestamp when the toolset was last updated.
- create
Time String - (Output) Timestamp when the toolset was created.
- description String
- The description of the app version.
- display
Name String - The display name of the app version.
- entry
Agent String - (Output)
The agent that initially handles the conversation. If not specified, the
example represents a conversation that is handled by the root agent.
Format:
projects/{project}/locations/{location}/apps/{app}/agents/{agent} - etag String
- (Output) ETag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
- invalid Boolean
- (Output) The example may become invalid if referencing resources are deleted. Invalid examples will not be used as few-shot examples.
- messages List<Property Map>
- (Output) The collection of messages that make up the conversation. Structure is documented below.
- name String
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - update
Time String - (Output) Timestamp when the toolset was last updated.
AppVersionSnapshotExampleMessage, AppVersionSnapshotExampleMessageArgs
- Chunks
List<App
Version Snapshot Example Message Chunk> - (Output) Content of the message as a series of chunks. Structure is documented below.
- Role string
- (Output) The role within the conversation, e.g., user, agent.
- Chunks
[]App
Version Snapshot Example Message Chunk - (Output) Content of the message as a series of chunks. Structure is documented below.
- Role string
- (Output) The role within the conversation, e.g., user, agent.
- chunks
List<App
Version Snapshot Example Message Chunk> - (Output) Content of the message as a series of chunks. Structure is documented below.
- role String
- (Output) The role within the conversation, e.g., user, agent.
- chunks
App
Version Snapshot Example Message Chunk[] - (Output) Content of the message as a series of chunks. Structure is documented below.
- role string
- (Output) The role within the conversation, e.g., user, agent.
- chunks
Sequence[App
Version Snapshot Example Message Chunk] - (Output) Content of the message as a series of chunks. Structure is documented below.
- role str
- (Output) The role within the conversation, e.g., user, agent.
- chunks List<Property Map>
- (Output) Content of the message as a series of chunks. Structure is documented below.
- role String
- (Output) The role within the conversation, e.g., user, agent.
AppVersionSnapshotExampleMessageChunk, AppVersionSnapshotExampleMessageChunkArgs
- Agent
Transfers List<AppVersion Snapshot Example Message Chunk Agent Transfer> - (Output) Represents an event indicating the transfer of a conversation to a different agent. Structure is documented below.
- Images
List<App
Version Snapshot Example Message Chunk Image> - (Output) Represents an image input or output in the conversation. Structure is documented below.
- Text string
- (Output) Text for the agent to respond with.
- Tool
Calls List<AppVersion Snapshot Example Message Chunk Tool Call> - (Output) Request for the client or the agent to execute the specified tool. Structure is documented below.
- Tool
Responses List<AppVersion Snapshot Example Message Chunk Tool Response> - (Output) The execution result of a specific tool from the client or the agent. Structure is documented below.
- Updated
Variables string - (Output) A struct represents variables that were updated in the conversation, keyed by variable names.
- Agent
Transfers []AppVersion Snapshot Example Message Chunk Agent Transfer - (Output) Represents an event indicating the transfer of a conversation to a different agent. Structure is documented below.
- Images
[]App
Version Snapshot Example Message Chunk Image - (Output) Represents an image input or output in the conversation. Structure is documented below.
- Text string
- (Output) Text for the agent to respond with.
- Tool
Calls []AppVersion Snapshot Example Message Chunk Tool Call - (Output) Request for the client or the agent to execute the specified tool. Structure is documented below.
- Tool
Responses []AppVersion Snapshot Example Message Chunk Tool Response - (Output) The execution result of a specific tool from the client or the agent. Structure is documented below.
- Updated
Variables string - (Output) A struct represents variables that were updated in the conversation, keyed by variable names.
- agent
Transfers List<AppVersion Snapshot Example Message Chunk Agent Transfer> - (Output) Represents an event indicating the transfer of a conversation to a different agent. Structure is documented below.
- images
List<App
Version Snapshot Example Message Chunk Image> - (Output) Represents an image input or output in the conversation. Structure is documented below.
- text String
- (Output) Text for the agent to respond with.
- tool
Calls List<AppVersion Snapshot Example Message Chunk Tool Call> - (Output) Request for the client or the agent to execute the specified tool. Structure is documented below.
- tool
Responses List<AppVersion Snapshot Example Message Chunk Tool Response> - (Output) The execution result of a specific tool from the client or the agent. Structure is documented below.
- updated
Variables String - (Output) A struct represents variables that were updated in the conversation, keyed by variable names.
- agent
Transfers AppVersion Snapshot Example Message Chunk Agent Transfer[] - (Output) Represents an event indicating the transfer of a conversation to a different agent. Structure is documented below.
- images
App
Version Snapshot Example Message Chunk Image[] - (Output) Represents an image input or output in the conversation. Structure is documented below.
- text string
- (Output) Text for the agent to respond with.
- tool
Calls AppVersion Snapshot Example Message Chunk Tool Call[] - (Output) Request for the client or the agent to execute the specified tool. Structure is documented below.
- tool
Responses AppVersion Snapshot Example Message Chunk Tool Response[] - (Output) The execution result of a specific tool from the client or the agent. Structure is documented below.
- updated
Variables string - (Output) A struct represents variables that were updated in the conversation, keyed by variable names.
- agent_
transfers Sequence[AppVersion Snapshot Example Message Chunk Agent Transfer] - (Output) Represents an event indicating the transfer of a conversation to a different agent. Structure is documented below.
- images
Sequence[App
Version Snapshot Example Message Chunk Image] - (Output) Represents an image input or output in the conversation. Structure is documented below.
- text str
- (Output) Text for the agent to respond with.
- tool_
calls Sequence[AppVersion Snapshot Example Message Chunk Tool Call] - (Output) Request for the client or the agent to execute the specified tool. Structure is documented below.
- tool_
responses Sequence[AppVersion Snapshot Example Message Chunk Tool Response] - (Output) The execution result of a specific tool from the client or the agent. Structure is documented below.
- updated_
variables str - (Output) A struct represents variables that were updated in the conversation, keyed by variable names.
- agent
Transfers List<Property Map> - (Output) Represents an event indicating the transfer of a conversation to a different agent. Structure is documented below.
- images List<Property Map>
- (Output) Represents an image input or output in the conversation. Structure is documented below.
- text String
- (Output) Text for the agent to respond with.
- tool
Calls List<Property Map> - (Output) Request for the client or the agent to execute the specified tool. Structure is documented below.
- tool
Responses List<Property Map> - (Output) The execution result of a specific tool from the client or the agent. Structure is documented below.
- updated
Variables String - (Output) A struct represents variables that were updated in the conversation, keyed by variable names.
AppVersionSnapshotExampleMessageChunkAgentTransfer, AppVersionSnapshotExampleMessageChunkAgentTransferArgs
- Display
Name string - The display name of the app version.
- Target
Agent string - (Output)
The agent to which the conversation is being transferred. The agent will
handle the conversation from this point forward.
Format:
projects/{project}/locations/{location}/apps/{app}/agents/{agent}
- Display
Name string - The display name of the app version.
- Target
Agent string - (Output)
The agent to which the conversation is being transferred. The agent will
handle the conversation from this point forward.
Format:
projects/{project}/locations/{location}/apps/{app}/agents/{agent}
- display
Name String - The display name of the app version.
- target
Agent String - (Output)
The agent to which the conversation is being transferred. The agent will
handle the conversation from this point forward.
Format:
projects/{project}/locations/{location}/apps/{app}/agents/{agent}
- display
Name string - The display name of the app version.
- target
Agent string - (Output)
The agent to which the conversation is being transferred. The agent will
handle the conversation from this point forward.
Format:
projects/{project}/locations/{location}/apps/{app}/agents/{agent}
- display_
name str - The display name of the app version.
- target_
agent str - (Output)
The agent to which the conversation is being transferred. The agent will
handle the conversation from this point forward.
Format:
projects/{project}/locations/{location}/apps/{app}/agents/{agent}
- display
Name String - The display name of the app version.
- target
Agent String - (Output)
The agent to which the conversation is being transferred. The agent will
handle the conversation from this point forward.
Format:
projects/{project}/locations/{location}/apps/{app}/agents/{agent}
AppVersionSnapshotExampleMessageChunkImage, AppVersionSnapshotExampleMessageChunkImageArgs
AppVersionSnapshotExampleMessageChunkToolCall, AppVersionSnapshotExampleMessageChunkToolCallArgs
- Args string
- (Output) The input parameters and values for the tool in JSON object format.
- Display
Name string - The display name of the app version.
- Id string
- (Output) The matching ID of the tool call the response is for.
- Tool string
- (Output)
The name of the tool to execute.
Format:
projects/{project}/locations/{location}/apps/{app}/tools/{tool} - Toolset
Tools List<AppVersion Snapshot Example Message Chunk Tool Call Toolset Tool> - (Output) A tool that is created from a toolset. Structure is documented below.
- Args string
- (Output) The input parameters and values for the tool in JSON object format.
- Display
Name string - The display name of the app version.
- Id string
- (Output) The matching ID of the tool call the response is for.
- Tool string
- (Output)
The name of the tool to execute.
Format:
projects/{project}/locations/{location}/apps/{app}/tools/{tool} - Toolset
Tools []AppVersion Snapshot Example Message Chunk Tool Call Toolset Tool - (Output) A tool that is created from a toolset. Structure is documented below.
- args String
- (Output) The input parameters and values for the tool in JSON object format.
- display
Name String - The display name of the app version.
- id String
- (Output) The matching ID of the tool call the response is for.
- tool String
- (Output)
The name of the tool to execute.
Format:
projects/{project}/locations/{location}/apps/{app}/tools/{tool} - toolset
Tools List<AppVersion Snapshot Example Message Chunk Tool Call Toolset Tool> - (Output) A tool that is created from a toolset. Structure is documented below.
- args string
- (Output) The input parameters and values for the tool in JSON object format.
- display
Name string - The display name of the app version.
- id string
- (Output) The matching ID of the tool call the response is for.
- tool string
- (Output)
The name of the tool to execute.
Format:
projects/{project}/locations/{location}/apps/{app}/tools/{tool} - toolset
Tools AppVersion Snapshot Example Message Chunk Tool Call Toolset Tool[] - (Output) A tool that is created from a toolset. Structure is documented below.
- args str
- (Output) The input parameters and values for the tool in JSON object format.
- display_
name str - The display name of the app version.
- id str
- (Output) The matching ID of the tool call the response is for.
- tool str
- (Output)
The name of the tool to execute.
Format:
projects/{project}/locations/{location}/apps/{app}/tools/{tool} - toolset_
tools Sequence[AppVersion Snapshot Example Message Chunk Tool Call Toolset Tool] - (Output) A tool that is created from a toolset. Structure is documented below.
- args String
- (Output) The input parameters and values for the tool in JSON object format.
- display
Name String - The display name of the app version.
- id String
- (Output) The matching ID of the tool call the response is for.
- tool String
- (Output)
The name of the tool to execute.
Format:
projects/{project}/locations/{location}/apps/{app}/tools/{tool} - toolset
Tools List<Property Map> - (Output) A tool that is created from a toolset. Structure is documented below.
AppVersionSnapshotExampleMessageChunkToolCallToolsetTool, AppVersionSnapshotExampleMessageChunkToolCallToolsetToolArgs
AppVersionSnapshotExampleMessageChunkToolResponse, AppVersionSnapshotExampleMessageChunkToolResponseArgs
- Display
Name string - The display name of the app version.
- Id string
- (Output) The matching ID of the tool call the response is for.
- Response string
- (Output) Represents a select subset of an OpenAPI 3.0 schema object. Structure is documented below.
- Tool string
- (Output)
The name of the tool to execute.
Format:
projects/{project}/locations/{location}/apps/{app}/tools/{tool} - Toolset
Tools List<AppVersion Snapshot Example Message Chunk Tool Response Toolset Tool> - (Output) A tool that is created from a toolset. Structure is documented below.
- Display
Name string - The display name of the app version.
- Id string
- (Output) The matching ID of the tool call the response is for.
- Response string
- (Output) Represents a select subset of an OpenAPI 3.0 schema object. Structure is documented below.
- Tool string
- (Output)
The name of the tool to execute.
Format:
projects/{project}/locations/{location}/apps/{app}/tools/{tool} - Toolset
Tools []AppVersion Snapshot Example Message Chunk Tool Response Toolset Tool - (Output) A tool that is created from a toolset. Structure is documented below.
- display
Name String - The display name of the app version.
- id String
- (Output) The matching ID of the tool call the response is for.
- response String
- (Output) Represents a select subset of an OpenAPI 3.0 schema object. Structure is documented below.
- tool String
- (Output)
The name of the tool to execute.
Format:
projects/{project}/locations/{location}/apps/{app}/tools/{tool} - toolset
Tools List<AppVersion Snapshot Example Message Chunk Tool Response Toolset Tool> - (Output) A tool that is created from a toolset. Structure is documented below.
- display
Name string - The display name of the app version.
- id string
- (Output) The matching ID of the tool call the response is for.
- response string
- (Output) Represents a select subset of an OpenAPI 3.0 schema object. Structure is documented below.
- tool string
- (Output)
The name of the tool to execute.
Format:
projects/{project}/locations/{location}/apps/{app}/tools/{tool} - toolset
Tools AppVersion Snapshot Example Message Chunk Tool Response Toolset Tool[] - (Output) A tool that is created from a toolset. Structure is documented below.
- display_
name str - The display name of the app version.
- id str
- (Output) The matching ID of the tool call the response is for.
- response str
- (Output) Represents a select subset of an OpenAPI 3.0 schema object. Structure is documented below.
- tool str
- (Output)
The name of the tool to execute.
Format:
projects/{project}/locations/{location}/apps/{app}/tools/{tool} - toolset_
tools Sequence[AppVersion Snapshot Example Message Chunk Tool Response Toolset Tool] - (Output) A tool that is created from a toolset. Structure is documented below.
- display
Name String - The display name of the app version.
- id String
- (Output) The matching ID of the tool call the response is for.
- response String
- (Output) Represents a select subset of an OpenAPI 3.0 schema object. Structure is documented below.
- tool String
- (Output)
The name of the tool to execute.
Format:
projects/{project}/locations/{location}/apps/{app}/tools/{tool} - toolset
Tools List<Property Map> - (Output) A tool that is created from a toolset. Structure is documented below.
AppVersionSnapshotExampleMessageChunkToolResponseToolsetTool, AppVersionSnapshotExampleMessageChunkToolResponseToolsetToolArgs
AppVersionSnapshotGuardrail, AppVersionSnapshotGuardrailArgs
- Actions
List<App
Version Snapshot Guardrail Action> - (Output) Action that is taken when a certain precondition is met. Structure is documented below.
- Code
Callbacks List<AppVersion Snapshot Guardrail Code Callback> - (Output) Guardrail that blocks the conversation based on the code callbacks provided. Structure is documented below.
- Content
Filters List<AppVersion Snapshot Guardrail Content Filter> - (Output) Guardrail that bans certain content from being used in the conversation. Structure is documented below.
- Create
Time string - (Output) Timestamp when the toolset was created.
- Description string
- The description of the app version.
- Display
Name string - The display name of the app version.
- Enabled bool
- (Output) Whether the guardrail is enabled.
- Etag string
- (Output) ETag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
- Llm
Policies List<AppVersion Snapshot Guardrail Llm Policy> - (Output) Guardrail that blocks the conversation if the LLM response is considered violating the policy based on the LLM classification. Structure is documented below.
- Llm
Prompt List<AppSecurities Version Snapshot Guardrail Llm Prompt Security> - (Output) Guardrail that blocks the conversation if the input is considered unsafe based on the LLM classification. Structure is documented below.
- Model
Safeties List<AppVersion Snapshot Guardrail Model Safety> - (Output) Model safety settings overrides. When this is set, it will override the default settings and trigger the guardrail if the response is considered unsafe. Structure is documented below.
- Name string
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - Update
Time string - (Output) Timestamp when the toolset was last updated.
- Actions
[]App
Version Snapshot Guardrail Action - (Output) Action that is taken when a certain precondition is met. Structure is documented below.
- Code
Callbacks []AppVersion Snapshot Guardrail Code Callback - (Output) Guardrail that blocks the conversation based on the code callbacks provided. Structure is documented below.
- Content
Filters []AppVersion Snapshot Guardrail Content Filter - (Output) Guardrail that bans certain content from being used in the conversation. Structure is documented below.
- Create
Time string - (Output) Timestamp when the toolset was created.
- Description string
- The description of the app version.
- Display
Name string - The display name of the app version.
- Enabled bool
- (Output) Whether the guardrail is enabled.
- Etag string
- (Output) ETag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
- Llm
Policies []AppVersion Snapshot Guardrail Llm Policy - (Output) Guardrail that blocks the conversation if the LLM response is considered violating the policy based on the LLM classification. Structure is documented below.
- Llm
Prompt []AppSecurities Version Snapshot Guardrail Llm Prompt Security - (Output) Guardrail that blocks the conversation if the input is considered unsafe based on the LLM classification. Structure is documented below.
- Model
Safeties []AppVersion Snapshot Guardrail Model Safety - (Output) Model safety settings overrides. When this is set, it will override the default settings and trigger the guardrail if the response is considered unsafe. Structure is documented below.
- Name string
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - Update
Time string - (Output) Timestamp when the toolset was last updated.
- actions
List<App
Version Snapshot Guardrail Action> - (Output) Action that is taken when a certain precondition is met. Structure is documented below.
- code
Callbacks List<AppVersion Snapshot Guardrail Code Callback> - (Output) Guardrail that blocks the conversation based on the code callbacks provided. Structure is documented below.
- content
Filters List<AppVersion Snapshot Guardrail Content Filter> - (Output) Guardrail that bans certain content from being used in the conversation. Structure is documented below.
- create
Time String - (Output) Timestamp when the toolset was created.
- description String
- The description of the app version.
- display
Name String - The display name of the app version.
- enabled Boolean
- (Output) Whether the guardrail is enabled.
- etag String
- (Output) ETag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
- llm
Policies List<AppVersion Snapshot Guardrail Llm Policy> - (Output) Guardrail that blocks the conversation if the LLM response is considered violating the policy based on the LLM classification. Structure is documented below.
- llm
Prompt List<AppSecurities Version Snapshot Guardrail Llm Prompt Security> - (Output) Guardrail that blocks the conversation if the input is considered unsafe based on the LLM classification. Structure is documented below.
- model
Safeties List<AppVersion Snapshot Guardrail Model Safety> - (Output) Model safety settings overrides. When this is set, it will override the default settings and trigger the guardrail if the response is considered unsafe. Structure is documented below.
- name String
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - update
Time String - (Output) Timestamp when the toolset was last updated.
- actions
App
Version Snapshot Guardrail Action[] - (Output) Action that is taken when a certain precondition is met. Structure is documented below.
- code
Callbacks AppVersion Snapshot Guardrail Code Callback[] - (Output) Guardrail that blocks the conversation based on the code callbacks provided. Structure is documented below.
- content
Filters AppVersion Snapshot Guardrail Content Filter[] - (Output) Guardrail that bans certain content from being used in the conversation. Structure is documented below.
- create
Time string - (Output) Timestamp when the toolset was created.
- description string
- The description of the app version.
- display
Name string - The display name of the app version.
- enabled boolean
- (Output) Whether the guardrail is enabled.
- etag string
- (Output) ETag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
- llm
Policies AppVersion Snapshot Guardrail Llm Policy[] - (Output) Guardrail that blocks the conversation if the LLM response is considered violating the policy based on the LLM classification. Structure is documented below.
- llm
Prompt AppSecurities Version Snapshot Guardrail Llm Prompt Security[] - (Output) Guardrail that blocks the conversation if the input is considered unsafe based on the LLM classification. Structure is documented below.
- model
Safeties AppVersion Snapshot Guardrail Model Safety[] - (Output) Model safety settings overrides. When this is set, it will override the default settings and trigger the guardrail if the response is considered unsafe. Structure is documented below.
- name string
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - update
Time string - (Output) Timestamp when the toolset was last updated.
- actions
Sequence[App
Version Snapshot Guardrail Action] - (Output) Action that is taken when a certain precondition is met. Structure is documented below.
- code_
callbacks Sequence[AppVersion Snapshot Guardrail Code Callback] - (Output) Guardrail that blocks the conversation based on the code callbacks provided. Structure is documented below.
- content_
filters Sequence[AppVersion Snapshot Guardrail Content Filter] - (Output) Guardrail that bans certain content from being used in the conversation. Structure is documented below.
- create_
time str - (Output) Timestamp when the toolset was created.
- description str
- The description of the app version.
- display_
name str - The display name of the app version.
- enabled bool
- (Output) Whether the guardrail is enabled.
- etag str
- (Output) ETag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
- llm_
policies Sequence[AppVersion Snapshot Guardrail Llm Policy] - (Output) Guardrail that blocks the conversation if the LLM response is considered violating the policy based on the LLM classification. Structure is documented below.
- llm_
prompt_ Sequence[Appsecurities Version Snapshot Guardrail Llm Prompt Security] - (Output) Guardrail that blocks the conversation if the input is considered unsafe based on the LLM classification. Structure is documented below.
- model_
safeties Sequence[AppVersion Snapshot Guardrail Model Safety] - (Output) Model safety settings overrides. When this is set, it will override the default settings and trigger the guardrail if the response is considered unsafe. Structure is documented below.
- name str
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - update_
time str - (Output) Timestamp when the toolset was last updated.
- actions List<Property Map>
- (Output) Action that is taken when a certain precondition is met. Structure is documented below.
- code
Callbacks List<Property Map> - (Output) Guardrail that blocks the conversation based on the code callbacks provided. Structure is documented below.
- content
Filters List<Property Map> - (Output) Guardrail that bans certain content from being used in the conversation. Structure is documented below.
- create
Time String - (Output) Timestamp when the toolset was created.
- description String
- The description of the app version.
- display
Name String - The display name of the app version.
- enabled Boolean
- (Output) Whether the guardrail is enabled.
- etag String
- (Output) ETag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
- llm
Policies List<Property Map> - (Output) Guardrail that blocks the conversation if the LLM response is considered violating the policy based on the LLM classification. Structure is documented below.
- llm
Prompt List<Property Map>Securities - (Output) Guardrail that blocks the conversation if the input is considered unsafe based on the LLM classification. Structure is documented below.
- model
Safeties List<Property Map> - (Output) Model safety settings overrides. When this is set, it will override the default settings and trigger the guardrail if the response is considered unsafe. Structure is documented below.
- name String
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - update
Time String - (Output) Timestamp when the toolset was last updated.
AppVersionSnapshotGuardrailAction, AppVersionSnapshotGuardrailActionArgs
- Generative
Answers List<AppVersion Snapshot Guardrail Action Generative Answer> - (Output) The agent will immediately respond with a generative answer. Structure is documented below.
- Respond
Immediatelies List<AppVersion Snapshot Guardrail Action Respond Immediately> - (Output) The agent will immediately respond with a preconfigured response. Structure is documented below.
- Transfer
Agents List<AppVersion Snapshot Guardrail Action Transfer Agent> - (Output) The agent will transfer the conversation to a different agent. Structure is documented below.
- Generative
Answers []AppVersion Snapshot Guardrail Action Generative Answer - (Output) The agent will immediately respond with a generative answer. Structure is documented below.
- Respond
Immediatelies []AppVersion Snapshot Guardrail Action Respond Immediately - (Output) The agent will immediately respond with a preconfigured response. Structure is documented below.
- Transfer
Agents []AppVersion Snapshot Guardrail Action Transfer Agent - (Output) The agent will transfer the conversation to a different agent. Structure is documented below.
- generative
Answers List<AppVersion Snapshot Guardrail Action Generative Answer> - (Output) The agent will immediately respond with a generative answer. Structure is documented below.
- respond
Immediatelies List<AppVersion Snapshot Guardrail Action Respond Immediately> - (Output) The agent will immediately respond with a preconfigured response. Structure is documented below.
- transfer
Agents List<AppVersion Snapshot Guardrail Action Transfer Agent> - (Output) The agent will transfer the conversation to a different agent. Structure is documented below.
- generative
Answers AppVersion Snapshot Guardrail Action Generative Answer[] - (Output) The agent will immediately respond with a generative answer. Structure is documented below.
- respond
Immediatelies AppVersion Snapshot Guardrail Action Respond Immediately[] - (Output) The agent will immediately respond with a preconfigured response. Structure is documented below.
- transfer
Agents AppVersion Snapshot Guardrail Action Transfer Agent[] - (Output) The agent will transfer the conversation to a different agent. Structure is documented below.
- generative_
answers Sequence[AppVersion Snapshot Guardrail Action Generative Answer] - (Output) The agent will immediately respond with a generative answer. Structure is documented below.
- respond_
immediatelies Sequence[AppVersion Snapshot Guardrail Action Respond Immediately] - (Output) The agent will immediately respond with a preconfigured response. Structure is documented below.
- transfer_
agents Sequence[AppVersion Snapshot Guardrail Action Transfer Agent] - (Output) The agent will transfer the conversation to a different agent. Structure is documented below.
- generative
Answers List<Property Map> - (Output) The agent will immediately respond with a generative answer. Structure is documented below.
- respond
Immediatelies List<Property Map> - (Output) The agent will immediately respond with a preconfigured response. Structure is documented below.
- transfer
Agents List<Property Map> - (Output) The agent will transfer the conversation to a different agent. Structure is documented below.
AppVersionSnapshotGuardrailActionGenerativeAnswer, AppVersionSnapshotGuardrailActionGenerativeAnswerArgs
- Prompt string
- (Output) The prompt definition. If not set, default prompt will be used.
- Prompt string
- (Output) The prompt definition. If not set, default prompt will be used.
- prompt String
- (Output) The prompt definition. If not set, default prompt will be used.
- prompt string
- (Output) The prompt definition. If not set, default prompt will be used.
- prompt str
- (Output) The prompt definition. If not set, default prompt will be used.
- prompt String
- (Output) The prompt definition. If not set, default prompt will be used.
AppVersionSnapshotGuardrailActionRespondImmediately, AppVersionSnapshotGuardrailActionRespondImmediatelyArgs
- Responses
List<App
Version Snapshot Guardrail Action Respond Immediately Response> - (Output) The canned responses for the agent to choose from. The response is chosen randomly. Structure is documented below.
- Responses
[]App
Version Snapshot Guardrail Action Respond Immediately Response - (Output) The canned responses for the agent to choose from. The response is chosen randomly. Structure is documented below.
- responses
List<App
Version Snapshot Guardrail Action Respond Immediately Response> - (Output) The canned responses for the agent to choose from. The response is chosen randomly. Structure is documented below.
- responses
App
Version Snapshot Guardrail Action Respond Immediately Response[] - (Output) The canned responses for the agent to choose from. The response is chosen randomly. Structure is documented below.
- responses
Sequence[App
Version Snapshot Guardrail Action Respond Immediately Response] - (Output) The canned responses for the agent to choose from. The response is chosen randomly. Structure is documented below.
- responses List<Property Map>
- (Output) The canned responses for the agent to choose from. The response is chosen randomly. Structure is documented below.
AppVersionSnapshotGuardrailActionRespondImmediatelyResponse, AppVersionSnapshotGuardrailActionRespondImmediatelyResponseArgs
AppVersionSnapshotGuardrailActionTransferAgent, AppVersionSnapshotGuardrailActionTransferAgentArgs
- Agent string
- (Output)
The name of the agent to transfer the conversation to. The agent must be
in the same app as the current agent.
Format:
projects/{project}/locations/{location}/apps/{app}/agents/{agent}
- Agent string
- (Output)
The name of the agent to transfer the conversation to. The agent must be
in the same app as the current agent.
Format:
projects/{project}/locations/{location}/apps/{app}/agents/{agent}
- agent String
- (Output)
The name of the agent to transfer the conversation to. The agent must be
in the same app as the current agent.
Format:
projects/{project}/locations/{location}/apps/{app}/agents/{agent}
- agent string
- (Output)
The name of the agent to transfer the conversation to. The agent must be
in the same app as the current agent.
Format:
projects/{project}/locations/{location}/apps/{app}/agents/{agent}
- agent str
- (Output)
The name of the agent to transfer the conversation to. The agent must be
in the same app as the current agent.
Format:
projects/{project}/locations/{location}/apps/{app}/agents/{agent}
- agent String
- (Output)
The name of the agent to transfer the conversation to. The agent must be
in the same app as the current agent.
Format:
projects/{project}/locations/{location}/apps/{app}/agents/{agent}
AppVersionSnapshotGuardrailCodeCallback, AppVersionSnapshotGuardrailCodeCallbackArgs
- After
Agent List<AppCallbacks Version Snapshot Guardrail Code Callback After Agent Callback> - (Output) A callback defines the custom logic to be executed at various stages of agent interaction. Structure is documented below.
- After
Model List<AppCallbacks Version Snapshot Guardrail Code Callback After Model Callback> - (Output) A callback defines the custom logic to be executed at various stages of agent interaction. Structure is documented below.
- Before
Agent List<AppCallbacks Version Snapshot Guardrail Code Callback Before Agent Callback> - (Output) A callback defines the custom logic to be executed at various stages of agent interaction. Structure is documented below.
- Before
Model List<AppCallbacks Version Snapshot Guardrail Code Callback Before Model Callback> - (Output) A callback defines the custom logic to be executed at various stages of agent interaction. Structure is documented below.
- After
Agent []AppCallbacks Version Snapshot Guardrail Code Callback After Agent Callback - (Output) A callback defines the custom logic to be executed at various stages of agent interaction. Structure is documented below.
- After
Model []AppCallbacks Version Snapshot Guardrail Code Callback After Model Callback - (Output) A callback defines the custom logic to be executed at various stages of agent interaction. Structure is documented below.
- Before
Agent []AppCallbacks Version Snapshot Guardrail Code Callback Before Agent Callback - (Output) A callback defines the custom logic to be executed at various stages of agent interaction. Structure is documented below.
- Before
Model []AppCallbacks Version Snapshot Guardrail Code Callback Before Model Callback - (Output) A callback defines the custom logic to be executed at various stages of agent interaction. Structure is documented below.
- after
Agent List<AppCallbacks Version Snapshot Guardrail Code Callback After Agent Callback> - (Output) A callback defines the custom logic to be executed at various stages of agent interaction. Structure is documented below.
- after
Model List<AppCallbacks Version Snapshot Guardrail Code Callback After Model Callback> - (Output) A callback defines the custom logic to be executed at various stages of agent interaction. Structure is documented below.
- before
Agent List<AppCallbacks Version Snapshot Guardrail Code Callback Before Agent Callback> - (Output) A callback defines the custom logic to be executed at various stages of agent interaction. Structure is documented below.
- before
Model List<AppCallbacks Version Snapshot Guardrail Code Callback Before Model Callback> - (Output) A callback defines the custom logic to be executed at various stages of agent interaction. Structure is documented below.
- after
Agent AppCallbacks Version Snapshot Guardrail Code Callback After Agent Callback[] - (Output) A callback defines the custom logic to be executed at various stages of agent interaction. Structure is documented below.
- after
Model AppCallbacks Version Snapshot Guardrail Code Callback After Model Callback[] - (Output) A callback defines the custom logic to be executed at various stages of agent interaction. Structure is documented below.
- before
Agent AppCallbacks Version Snapshot Guardrail Code Callback Before Agent Callback[] - (Output) A callback defines the custom logic to be executed at various stages of agent interaction. Structure is documented below.
- before
Model AppCallbacks Version Snapshot Guardrail Code Callback Before Model Callback[] - (Output) A callback defines the custom logic to be executed at various stages of agent interaction. Structure is documented below.
- after_
agent_ Sequence[Appcallbacks Version Snapshot Guardrail Code Callback After Agent Callback] - (Output) A callback defines the custom logic to be executed at various stages of agent interaction. Structure is documented below.
- after_
model_ Sequence[Appcallbacks Version Snapshot Guardrail Code Callback After Model Callback] - (Output) A callback defines the custom logic to be executed at various stages of agent interaction. Structure is documented below.
- before_
agent_ Sequence[Appcallbacks Version Snapshot Guardrail Code Callback Before Agent Callback] - (Output) A callback defines the custom logic to be executed at various stages of agent interaction. Structure is documented below.
- before_
model_ Sequence[Appcallbacks Version Snapshot Guardrail Code Callback Before Model Callback] - (Output) A callback defines the custom logic to be executed at various stages of agent interaction. Structure is documented below.
- after
Agent List<Property Map>Callbacks - (Output) A callback defines the custom logic to be executed at various stages of agent interaction. Structure is documented below.
- after
Model List<Property Map>Callbacks - (Output) A callback defines the custom logic to be executed at various stages of agent interaction. Structure is documented below.
- before
Agent List<Property Map>Callbacks - (Output) A callback defines the custom logic to be executed at various stages of agent interaction. Structure is documented below.
- before
Model List<Property Map>Callbacks - (Output) A callback defines the custom logic to be executed at various stages of agent interaction. Structure is documented below.
AppVersionSnapshotGuardrailCodeCallbackAfterAgentCallback, AppVersionSnapshotGuardrailCodeCallbackAfterAgentCallbackArgs
- Description string
- The description of the app version.
- Disabled bool
- (Output) Whether summarization is disabled.
- Python
Code string - (Output) The Python code to execute for the tool.
- Description string
- The description of the app version.
- Disabled bool
- (Output) Whether summarization is disabled.
- Python
Code string - (Output) The Python code to execute for the tool.
- description String
- The description of the app version.
- disabled Boolean
- (Output) Whether summarization is disabled.
- python
Code String - (Output) The Python code to execute for the tool.
- description string
- The description of the app version.
- disabled boolean
- (Output) Whether summarization is disabled.
- python
Code string - (Output) The Python code to execute for the tool.
- description str
- The description of the app version.
- disabled bool
- (Output) Whether summarization is disabled.
- python_
code str - (Output) The Python code to execute for the tool.
- description String
- The description of the app version.
- disabled Boolean
- (Output) Whether summarization is disabled.
- python
Code String - (Output) The Python code to execute for the tool.
AppVersionSnapshotGuardrailCodeCallbackAfterModelCallback, AppVersionSnapshotGuardrailCodeCallbackAfterModelCallbackArgs
- Description string
- The description of the app version.
- Disabled bool
- (Output) Whether summarization is disabled.
- Python
Code string - (Output) The Python code to execute for the tool.
- Description string
- The description of the app version.
- Disabled bool
- (Output) Whether summarization is disabled.
- Python
Code string - (Output) The Python code to execute for the tool.
- description String
- The description of the app version.
- disabled Boolean
- (Output) Whether summarization is disabled.
- python
Code String - (Output) The Python code to execute for the tool.
- description string
- The description of the app version.
- disabled boolean
- (Output) Whether summarization is disabled.
- python
Code string - (Output) The Python code to execute for the tool.
- description str
- The description of the app version.
- disabled bool
- (Output) Whether summarization is disabled.
- python_
code str - (Output) The Python code to execute for the tool.
- description String
- The description of the app version.
- disabled Boolean
- (Output) Whether summarization is disabled.
- python
Code String - (Output) The Python code to execute for the tool.
AppVersionSnapshotGuardrailCodeCallbackBeforeAgentCallback, AppVersionSnapshotGuardrailCodeCallbackBeforeAgentCallbackArgs
- Description string
- The description of the app version.
- Disabled bool
- (Output) Whether summarization is disabled.
- Python
Code string - (Output) The Python code to execute for the tool.
- Description string
- The description of the app version.
- Disabled bool
- (Output) Whether summarization is disabled.
- Python
Code string - (Output) The Python code to execute for the tool.
- description String
- The description of the app version.
- disabled Boolean
- (Output) Whether summarization is disabled.
- python
Code String - (Output) The Python code to execute for the tool.
- description string
- The description of the app version.
- disabled boolean
- (Output) Whether summarization is disabled.
- python
Code string - (Output) The Python code to execute for the tool.
- description str
- The description of the app version.
- disabled bool
- (Output) Whether summarization is disabled.
- python_
code str - (Output) The Python code to execute for the tool.
- description String
- The description of the app version.
- disabled Boolean
- (Output) Whether summarization is disabled.
- python
Code String - (Output) The Python code to execute for the tool.
AppVersionSnapshotGuardrailCodeCallbackBeforeModelCallback, AppVersionSnapshotGuardrailCodeCallbackBeforeModelCallbackArgs
- Description string
- The description of the app version.
- Disabled bool
- (Output) Whether summarization is disabled.
- Python
Code string - (Output) The Python code to execute for the tool.
- Description string
- The description of the app version.
- Disabled bool
- (Output) Whether summarization is disabled.
- Python
Code string - (Output) The Python code to execute for the tool.
- description String
- The description of the app version.
- disabled Boolean
- (Output) Whether summarization is disabled.
- python
Code String - (Output) The Python code to execute for the tool.
- description string
- The description of the app version.
- disabled boolean
- (Output) Whether summarization is disabled.
- python
Code string - (Output) The Python code to execute for the tool.
- description str
- The description of the app version.
- disabled bool
- (Output) Whether summarization is disabled.
- python_
code str - (Output) The Python code to execute for the tool.
- description String
- The description of the app version.
- disabled Boolean
- (Output) Whether summarization is disabled.
- python
Code String - (Output) The Python code to execute for the tool.
AppVersionSnapshotGuardrailContentFilter, AppVersionSnapshotGuardrailContentFilterArgs
- Banned
Contents List<string> - (Output) List of banned phrases. Applies to both user inputs and agent responses.
- Banned
Contents List<string>In Agent Responses - (Output) List of banned phrases. Applies only to agent responses.
- Banned
Contents List<string>In User Inputs - (Output) List of banned phrases. Applies only to user inputs.
- Disregard
Diacritics bool - (Output) If true, diacritics are ignored during matching.
- Match
Type string - (Output) Match type for the content filter. Possible values: SIMPLE_STRING_MATCH WORD_BOUNDARY_STRING_MATCH REGEXP_MATCH
- Banned
Contents []string - (Output) List of banned phrases. Applies to both user inputs and agent responses.
- Banned
Contents []stringIn Agent Responses - (Output) List of banned phrases. Applies only to agent responses.
- Banned
Contents []stringIn User Inputs - (Output) List of banned phrases. Applies only to user inputs.
- Disregard
Diacritics bool - (Output) If true, diacritics are ignored during matching.
- Match
Type string - (Output) Match type for the content filter. Possible values: SIMPLE_STRING_MATCH WORD_BOUNDARY_STRING_MATCH REGEXP_MATCH
- banned
Contents List<String> - (Output) List of banned phrases. Applies to both user inputs and agent responses.
- banned
Contents List<String>In Agent Responses - (Output) List of banned phrases. Applies only to agent responses.
- banned
Contents List<String>In User Inputs - (Output) List of banned phrases. Applies only to user inputs.
- disregard
Diacritics Boolean - (Output) If true, diacritics are ignored during matching.
- match
Type String - (Output) Match type for the content filter. Possible values: SIMPLE_STRING_MATCH WORD_BOUNDARY_STRING_MATCH REGEXP_MATCH
- banned
Contents string[] - (Output) List of banned phrases. Applies to both user inputs and agent responses.
- banned
Contents string[]In Agent Responses - (Output) List of banned phrases. Applies only to agent responses.
- banned
Contents string[]In User Inputs - (Output) List of banned phrases. Applies only to user inputs.
- disregard
Diacritics boolean - (Output) If true, diacritics are ignored during matching.
- match
Type string - (Output) Match type for the content filter. Possible values: SIMPLE_STRING_MATCH WORD_BOUNDARY_STRING_MATCH REGEXP_MATCH
- banned_
contents Sequence[str] - (Output) List of banned phrases. Applies to both user inputs and agent responses.
- banned_
contents_ Sequence[str]in_ agent_ responses - (Output) List of banned phrases. Applies only to agent responses.
- banned_
contents_ Sequence[str]in_ user_ inputs - (Output) List of banned phrases. Applies only to user inputs.
- disregard_
diacritics bool - (Output) If true, diacritics are ignored during matching.
- match_
type str - (Output) Match type for the content filter. Possible values: SIMPLE_STRING_MATCH WORD_BOUNDARY_STRING_MATCH REGEXP_MATCH
- banned
Contents List<String> - (Output) List of banned phrases. Applies to both user inputs and agent responses.
- banned
Contents List<String>In Agent Responses - (Output) List of banned phrases. Applies only to agent responses.
- banned
Contents List<String>In User Inputs - (Output) List of banned phrases. Applies only to user inputs.
- disregard
Diacritics Boolean - (Output) If true, diacritics are ignored during matching.
- match
Type String - (Output) Match type for the content filter. Possible values: SIMPLE_STRING_MATCH WORD_BOUNDARY_STRING_MATCH REGEXP_MATCH
AppVersionSnapshotGuardrailLlmPolicy, AppVersionSnapshotGuardrailLlmPolicyArgs
- Fail
Open bool - (Output) If an error occurs during the policy check, fail open and do not trigger the guardrail.
- Max
Conversation intMessages - (Output) When checking this policy, consider the last 'n' messages in the conversation. When not set a default value of 10 will be used.
- Model
Settings List<AppVersion Snapshot Guardrail Llm Policy Model Setting> - (Output) Model settings contains various configurations for the LLM model. Structure is documented below.
- Policy
Scope string - (Output)
Defines when to apply the policy check during the conversation. If set to
POLICY_SCOPE_UNSPECIFIED, the policy will be applied to the user input. When applying the policy to the agent response, additional latency will be introduced before the agent can respond. Possible values: USER_QUERY AGENT_RESPONSE USER_QUERY_AND_AGENT_RESPONSE - Prompt string
- (Output) The prompt definition. If not set, default prompt will be used.
- Fail
Open bool - (Output) If an error occurs during the policy check, fail open and do not trigger the guardrail.
- Max
Conversation intMessages - (Output) When checking this policy, consider the last 'n' messages in the conversation. When not set a default value of 10 will be used.
- Model
Settings []AppVersion Snapshot Guardrail Llm Policy Model Setting - (Output) Model settings contains various configurations for the LLM model. Structure is documented below.
- Policy
Scope string - (Output)
Defines when to apply the policy check during the conversation. If set to
POLICY_SCOPE_UNSPECIFIED, the policy will be applied to the user input. When applying the policy to the agent response, additional latency will be introduced before the agent can respond. Possible values: USER_QUERY AGENT_RESPONSE USER_QUERY_AND_AGENT_RESPONSE - Prompt string
- (Output) The prompt definition. If not set, default prompt will be used.
- fail
Open Boolean - (Output) If an error occurs during the policy check, fail open and do not trigger the guardrail.
- max
Conversation IntegerMessages - (Output) When checking this policy, consider the last 'n' messages in the conversation. When not set a default value of 10 will be used.
- model
Settings List<AppVersion Snapshot Guardrail Llm Policy Model Setting> - (Output) Model settings contains various configurations for the LLM model. Structure is documented below.
- policy
Scope String - (Output)
Defines when to apply the policy check during the conversation. If set to
POLICY_SCOPE_UNSPECIFIED, the policy will be applied to the user input. When applying the policy to the agent response, additional latency will be introduced before the agent can respond. Possible values: USER_QUERY AGENT_RESPONSE USER_QUERY_AND_AGENT_RESPONSE - prompt String
- (Output) The prompt definition. If not set, default prompt will be used.
- fail
Open boolean - (Output) If an error occurs during the policy check, fail open and do not trigger the guardrail.
- max
Conversation numberMessages - (Output) When checking this policy, consider the last 'n' messages in the conversation. When not set a default value of 10 will be used.
- model
Settings AppVersion Snapshot Guardrail Llm Policy Model Setting[] - (Output) Model settings contains various configurations for the LLM model. Structure is documented below.
- policy
Scope string - (Output)
Defines when to apply the policy check during the conversation. If set to
POLICY_SCOPE_UNSPECIFIED, the policy will be applied to the user input. When applying the policy to the agent response, additional latency will be introduced before the agent can respond. Possible values: USER_QUERY AGENT_RESPONSE USER_QUERY_AND_AGENT_RESPONSE - prompt string
- (Output) The prompt definition. If not set, default prompt will be used.
- fail_
open bool - (Output) If an error occurs during the policy check, fail open and do not trigger the guardrail.
- max_
conversation_ intmessages - (Output) When checking this policy, consider the last 'n' messages in the conversation. When not set a default value of 10 will be used.
- model_
settings Sequence[AppVersion Snapshot Guardrail Llm Policy Model Setting] - (Output) Model settings contains various configurations for the LLM model. Structure is documented below.
- policy_
scope str - (Output)
Defines when to apply the policy check during the conversation. If set to
POLICY_SCOPE_UNSPECIFIED, the policy will be applied to the user input. When applying the policy to the agent response, additional latency will be introduced before the agent can respond. Possible values: USER_QUERY AGENT_RESPONSE USER_QUERY_AND_AGENT_RESPONSE - prompt str
- (Output) The prompt definition. If not set, default prompt will be used.
- fail
Open Boolean - (Output) If an error occurs during the policy check, fail open and do not trigger the guardrail.
- max
Conversation NumberMessages - (Output) When checking this policy, consider the last 'n' messages in the conversation. When not set a default value of 10 will be used.
- model
Settings List<Property Map> - (Output) Model settings contains various configurations for the LLM model. Structure is documented below.
- policy
Scope String - (Output)
Defines when to apply the policy check during the conversation. If set to
POLICY_SCOPE_UNSPECIFIED, the policy will be applied to the user input. When applying the policy to the agent response, additional latency will be introduced before the agent can respond. Possible values: USER_QUERY AGENT_RESPONSE USER_QUERY_AND_AGENT_RESPONSE - prompt String
- (Output) The prompt definition. If not set, default prompt will be used.
AppVersionSnapshotGuardrailLlmPolicyModelSetting, AppVersionSnapshotGuardrailLlmPolicyModelSettingArgs
- Model string
- (Output) The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
- Temperature double
- (Output) If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
- Model string
- (Output) The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
- Temperature float64
- (Output) If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
- model String
- (Output) The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
- temperature Double
- (Output) If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
- model string
- (Output) The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
- temperature number
- (Output) If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
- model str
- (Output) The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
- temperature float
- (Output) If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
- model String
- (Output) The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
- temperature Number
- (Output) If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
AppVersionSnapshotGuardrailLlmPromptSecurity, AppVersionSnapshotGuardrailLlmPromptSecurityArgs
- Custom
Policies List<AppVersion Snapshot Guardrail Llm Prompt Security Custom Policy> - (Output) Guardrail that blocks the conversation if the LLM response is considered violating the policy based on the LLM classification. Structure is documented below.
- Default
Settings List<AppVersion Snapshot Guardrail Llm Prompt Security Default Setting> - (Output) Configuration for default system security settings. Structure is documented below.
- Custom
Policies []AppVersion Snapshot Guardrail Llm Prompt Security Custom Policy - (Output) Guardrail that blocks the conversation if the LLM response is considered violating the policy based on the LLM classification. Structure is documented below.
- Default
Settings []AppVersion Snapshot Guardrail Llm Prompt Security Default Setting - (Output) Configuration for default system security settings. Structure is documented below.
- custom
Policies List<AppVersion Snapshot Guardrail Llm Prompt Security Custom Policy> - (Output) Guardrail that blocks the conversation if the LLM response is considered violating the policy based on the LLM classification. Structure is documented below.
- default
Settings List<AppVersion Snapshot Guardrail Llm Prompt Security Default Setting> - (Output) Configuration for default system security settings. Structure is documented below.
- custom
Policies AppVersion Snapshot Guardrail Llm Prompt Security Custom Policy[] - (Output) Guardrail that blocks the conversation if the LLM response is considered violating the policy based on the LLM classification. Structure is documented below.
- default
Settings AppVersion Snapshot Guardrail Llm Prompt Security Default Setting[] - (Output) Configuration for default system security settings. Structure is documented below.
- custom_
policies Sequence[AppVersion Snapshot Guardrail Llm Prompt Security Custom Policy] - (Output) Guardrail that blocks the conversation if the LLM response is considered violating the policy based on the LLM classification. Structure is documented below.
- default_
settings Sequence[AppVersion Snapshot Guardrail Llm Prompt Security Default Setting] - (Output) Configuration for default system security settings. Structure is documented below.
- custom
Policies List<Property Map> - (Output) Guardrail that blocks the conversation if the LLM response is considered violating the policy based on the LLM classification. Structure is documented below.
- default
Settings List<Property Map> - (Output) Configuration for default system security settings. Structure is documented below.
AppVersionSnapshotGuardrailLlmPromptSecurityCustomPolicy, AppVersionSnapshotGuardrailLlmPromptSecurityCustomPolicyArgs
- Fail
Open bool - (Output) If an error occurs during the policy check, fail open and do not trigger the guardrail.
- Max
Conversation intMessages - (Output) When checking this policy, consider the last 'n' messages in the conversation. When not set a default value of 10 will be used.
- Model
Settings List<AppVersion Snapshot Guardrail Llm Prompt Security Custom Policy Model Setting> - (Output) Model settings contains various configurations for the LLM model. Structure is documented below.
- Policy
Scope string - (Output)
Defines when to apply the policy check during the conversation. If set to
POLICY_SCOPE_UNSPECIFIED, the policy will be applied to the user input. When applying the policy to the agent response, additional latency will be introduced before the agent can respond. Possible values: USER_QUERY AGENT_RESPONSE USER_QUERY_AND_AGENT_RESPONSE - Prompt string
- (Output) The prompt definition. If not set, default prompt will be used.
- Fail
Open bool - (Output) If an error occurs during the policy check, fail open and do not trigger the guardrail.
- Max
Conversation intMessages - (Output) When checking this policy, consider the last 'n' messages in the conversation. When not set a default value of 10 will be used.
- Model
Settings []AppVersion Snapshot Guardrail Llm Prompt Security Custom Policy Model Setting - (Output) Model settings contains various configurations for the LLM model. Structure is documented below.
- Policy
Scope string - (Output)
Defines when to apply the policy check during the conversation. If set to
POLICY_SCOPE_UNSPECIFIED, the policy will be applied to the user input. When applying the policy to the agent response, additional latency will be introduced before the agent can respond. Possible values: USER_QUERY AGENT_RESPONSE USER_QUERY_AND_AGENT_RESPONSE - Prompt string
- (Output) The prompt definition. If not set, default prompt will be used.
- fail
Open Boolean - (Output) If an error occurs during the policy check, fail open and do not trigger the guardrail.
- max
Conversation IntegerMessages - (Output) When checking this policy, consider the last 'n' messages in the conversation. When not set a default value of 10 will be used.
- model
Settings List<AppVersion Snapshot Guardrail Llm Prompt Security Custom Policy Model Setting> - (Output) Model settings contains various configurations for the LLM model. Structure is documented below.
- policy
Scope String - (Output)
Defines when to apply the policy check during the conversation. If set to
POLICY_SCOPE_UNSPECIFIED, the policy will be applied to the user input. When applying the policy to the agent response, additional latency will be introduced before the agent can respond. Possible values: USER_QUERY AGENT_RESPONSE USER_QUERY_AND_AGENT_RESPONSE - prompt String
- (Output) The prompt definition. If not set, default prompt will be used.
- fail
Open boolean - (Output) If an error occurs during the policy check, fail open and do not trigger the guardrail.
- max
Conversation numberMessages - (Output) When checking this policy, consider the last 'n' messages in the conversation. When not set a default value of 10 will be used.
- model
Settings AppVersion Snapshot Guardrail Llm Prompt Security Custom Policy Model Setting[] - (Output) Model settings contains various configurations for the LLM model. Structure is documented below.
- policy
Scope string - (Output)
Defines when to apply the policy check during the conversation. If set to
POLICY_SCOPE_UNSPECIFIED, the policy will be applied to the user input. When applying the policy to the agent response, additional latency will be introduced before the agent can respond. Possible values: USER_QUERY AGENT_RESPONSE USER_QUERY_AND_AGENT_RESPONSE - prompt string
- (Output) The prompt definition. If not set, default prompt will be used.
- fail_
open bool - (Output) If an error occurs during the policy check, fail open and do not trigger the guardrail.
- max_
conversation_ intmessages - (Output) When checking this policy, consider the last 'n' messages in the conversation. When not set a default value of 10 will be used.
- model_
settings Sequence[AppVersion Snapshot Guardrail Llm Prompt Security Custom Policy Model Setting] - (Output) Model settings contains various configurations for the LLM model. Structure is documented below.
- policy_
scope str - (Output)
Defines when to apply the policy check during the conversation. If set to
POLICY_SCOPE_UNSPECIFIED, the policy will be applied to the user input. When applying the policy to the agent response, additional latency will be introduced before the agent can respond. Possible values: USER_QUERY AGENT_RESPONSE USER_QUERY_AND_AGENT_RESPONSE - prompt str
- (Output) The prompt definition. If not set, default prompt will be used.
- fail
Open Boolean - (Output) If an error occurs during the policy check, fail open and do not trigger the guardrail.
- max
Conversation NumberMessages - (Output) When checking this policy, consider the last 'n' messages in the conversation. When not set a default value of 10 will be used.
- model
Settings List<Property Map> - (Output) Model settings contains various configurations for the LLM model. Structure is documented below.
- policy
Scope String - (Output)
Defines when to apply the policy check during the conversation. If set to
POLICY_SCOPE_UNSPECIFIED, the policy will be applied to the user input. When applying the policy to the agent response, additional latency will be introduced before the agent can respond. Possible values: USER_QUERY AGENT_RESPONSE USER_QUERY_AND_AGENT_RESPONSE - prompt String
- (Output) The prompt definition. If not set, default prompt will be used.
AppVersionSnapshotGuardrailLlmPromptSecurityCustomPolicyModelSetting, AppVersionSnapshotGuardrailLlmPromptSecurityCustomPolicyModelSettingArgs
- Model string
- (Output) The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
- Temperature double
- (Output) If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
- Model string
- (Output) The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
- Temperature float64
- (Output) If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
- model String
- (Output) The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
- temperature Double
- (Output) If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
- model string
- (Output) The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
- temperature number
- (Output) If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
- model str
- (Output) The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
- temperature float
- (Output) If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
- model String
- (Output) The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
- temperature Number
- (Output) If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
AppVersionSnapshotGuardrailLlmPromptSecurityDefaultSetting, AppVersionSnapshotGuardrailLlmPromptSecurityDefaultSettingArgs
- Default
Prompt stringTemplate - (Output) The default prompt template used by the system. This field is for display purposes to show the user what prompt the system uses by default. It is OUTPUT_ONLY.
- Default
Prompt stringTemplate - (Output) The default prompt template used by the system. This field is for display purposes to show the user what prompt the system uses by default. It is OUTPUT_ONLY.
- default
Prompt StringTemplate - (Output) The default prompt template used by the system. This field is for display purposes to show the user what prompt the system uses by default. It is OUTPUT_ONLY.
- default
Prompt stringTemplate - (Output) The default prompt template used by the system. This field is for display purposes to show the user what prompt the system uses by default. It is OUTPUT_ONLY.
- default_
prompt_ strtemplate - (Output) The default prompt template used by the system. This field is for display purposes to show the user what prompt the system uses by default. It is OUTPUT_ONLY.
- default
Prompt StringTemplate - (Output) The default prompt template used by the system. This field is for display purposes to show the user what prompt the system uses by default. It is OUTPUT_ONLY.
AppVersionSnapshotGuardrailModelSafety, AppVersionSnapshotGuardrailModelSafetyArgs
- Safety
Settings List<AppVersion Snapshot Guardrail Model Safety Safety Setting> - (Output) List of safety settings. Structure is documented below.
- Safety
Settings []AppVersion Snapshot Guardrail Model Safety Safety Setting - (Output) List of safety settings. Structure is documented below.
- safety
Settings List<AppVersion Snapshot Guardrail Model Safety Safety Setting> - (Output) List of safety settings. Structure is documented below.
- safety
Settings AppVersion Snapshot Guardrail Model Safety Safety Setting[] - (Output) List of safety settings. Structure is documented below.
- safety_
settings Sequence[AppVersion Snapshot Guardrail Model Safety Safety Setting] - (Output) List of safety settings. Structure is documented below.
- safety
Settings List<Property Map> - (Output) List of safety settings. Structure is documented below.
AppVersionSnapshotGuardrailModelSafetySafetySetting, AppVersionSnapshotGuardrailModelSafetySafetySettingArgs
- Category string
- (Output) The harm category. Possible values: HARM_CATEGORY_HATE_SPEECH HARM_CATEGORY_DANGEROUS_CONTENT HARM_CATEGORY_HARASSMENT HARM_CATEGORY_SEXUALLY_EXPLICIT
- Threshold string
- (Output) The harm block threshold. Possible values: BLOCK_LOW_AND_ABOVE BLOCK_MEDIUM_AND_ABOVE BLOCK_ONLY_HIGH BLOCK_NONE OFF
- Category string
- (Output) The harm category. Possible values: HARM_CATEGORY_HATE_SPEECH HARM_CATEGORY_DANGEROUS_CONTENT HARM_CATEGORY_HARASSMENT HARM_CATEGORY_SEXUALLY_EXPLICIT
- Threshold string
- (Output) The harm block threshold. Possible values: BLOCK_LOW_AND_ABOVE BLOCK_MEDIUM_AND_ABOVE BLOCK_ONLY_HIGH BLOCK_NONE OFF
- category String
- (Output) The harm category. Possible values: HARM_CATEGORY_HATE_SPEECH HARM_CATEGORY_DANGEROUS_CONTENT HARM_CATEGORY_HARASSMENT HARM_CATEGORY_SEXUALLY_EXPLICIT
- threshold String
- (Output) The harm block threshold. Possible values: BLOCK_LOW_AND_ABOVE BLOCK_MEDIUM_AND_ABOVE BLOCK_ONLY_HIGH BLOCK_NONE OFF
- category string
- (Output) The harm category. Possible values: HARM_CATEGORY_HATE_SPEECH HARM_CATEGORY_DANGEROUS_CONTENT HARM_CATEGORY_HARASSMENT HARM_CATEGORY_SEXUALLY_EXPLICIT
- threshold string
- (Output) The harm block threshold. Possible values: BLOCK_LOW_AND_ABOVE BLOCK_MEDIUM_AND_ABOVE BLOCK_ONLY_HIGH BLOCK_NONE OFF
- category str
- (Output) The harm category. Possible values: HARM_CATEGORY_HATE_SPEECH HARM_CATEGORY_DANGEROUS_CONTENT HARM_CATEGORY_HARASSMENT HARM_CATEGORY_SEXUALLY_EXPLICIT
- threshold str
- (Output) The harm block threshold. Possible values: BLOCK_LOW_AND_ABOVE BLOCK_MEDIUM_AND_ABOVE BLOCK_ONLY_HIGH BLOCK_NONE OFF
- category String
- (Output) The harm category. Possible values: HARM_CATEGORY_HATE_SPEECH HARM_CATEGORY_DANGEROUS_CONTENT HARM_CATEGORY_HARASSMENT HARM_CATEGORY_SEXUALLY_EXPLICIT
- threshold String
- (Output) The harm block threshold. Possible values: BLOCK_LOW_AND_ABOVE BLOCK_MEDIUM_AND_ABOVE BLOCK_ONLY_HIGH BLOCK_NONE OFF
AppVersionSnapshotTool, AppVersionSnapshotToolArgs
- Client
Functions List<AppVersion Snapshot Tool Client Function> - (Output) Represents a client-side function that the agent can invoke. When the tool is chosen by the agent, control is handed off to the client. The client is responsible for executing the function and returning the result as a ToolResponse to continue the interaction with the agent. Structure is documented below.
- Create
Time string - (Output) Timestamp when the toolset was created.
- Data
Store List<AppTools Version Snapshot Tool Data Store Tool> - (Output) Tool to retrieve from Vertex AI Search datastore or engine for grounding. Accepts either a datastore or an engine, but not both. See Vertex AI Search: https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction. Structure is documented below.
- Display
Name string - The display name of the app version.
- Etag string
- (Output) ETag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
- Execution
Type string - (Output) Possible values: SYNCHRONOUS ASYNCHRONOUS
- Generated
Summary string - (Output) If the tool is generated by the LLM assistant, this field contains a descriptive summary of the generation.
- Google
Search List<AppTools Version Snapshot Tool Google Search Tool> - (Output) Represents a tool to perform Google web searches for grounding. See https://cloud.google.com/vertex-ai/generative-ai/docs/grounding/grounding-with-google-search. Structure is documented below.
- Name string
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - Open
Api List<AppTools Version Snapshot Tool Open Api Tool> - (Output) A remote API tool defined by an OpenAPI schema. Structure is documented below.
- Python
Functions List<AppVersion Snapshot Tool Python Function> - (Output) A Python function tool. Structure is documented below.
- System
Tools List<AppVersion Snapshot Tool System Tool> - (Output) The system tool. Structure is documented below.
- Update
Time string - (Output) Timestamp when the toolset was last updated.
- Client
Functions []AppVersion Snapshot Tool Client Function - (Output) Represents a client-side function that the agent can invoke. When the tool is chosen by the agent, control is handed off to the client. The client is responsible for executing the function and returning the result as a ToolResponse to continue the interaction with the agent. Structure is documented below.
- Create
Time string - (Output) Timestamp when the toolset was created.
- Data
Store []AppTools Version Snapshot Tool Data Store Tool - (Output) Tool to retrieve from Vertex AI Search datastore or engine for grounding. Accepts either a datastore or an engine, but not both. See Vertex AI Search: https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction. Structure is documented below.
- Display
Name string - The display name of the app version.
- Etag string
- (Output) ETag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
- Execution
Type string - (Output) Possible values: SYNCHRONOUS ASYNCHRONOUS
- Generated
Summary string - (Output) If the tool is generated by the LLM assistant, this field contains a descriptive summary of the generation.
- Google
Search []AppTools Version Snapshot Tool Google Search Tool - (Output) Represents a tool to perform Google web searches for grounding. See https://cloud.google.com/vertex-ai/generative-ai/docs/grounding/grounding-with-google-search. Structure is documented below.
- Name string
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - Open
Api []AppTools Version Snapshot Tool Open Api Tool - (Output) A remote API tool defined by an OpenAPI schema. Structure is documented below.
- Python
Functions []AppVersion Snapshot Tool Python Function - (Output) A Python function tool. Structure is documented below.
- System
Tools []AppVersion Snapshot Tool System Tool - (Output) The system tool. Structure is documented below.
- Update
Time string - (Output) Timestamp when the toolset was last updated.
- client
Functions List<AppVersion Snapshot Tool Client Function> - (Output) Represents a client-side function that the agent can invoke. When the tool is chosen by the agent, control is handed off to the client. The client is responsible for executing the function and returning the result as a ToolResponse to continue the interaction with the agent. Structure is documented below.
- create
Time String - (Output) Timestamp when the toolset was created.
- data
Store List<AppTools Version Snapshot Tool Data Store Tool> - (Output) Tool to retrieve from Vertex AI Search datastore or engine for grounding. Accepts either a datastore or an engine, but not both. See Vertex AI Search: https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction. Structure is documented below.
- display
Name String - The display name of the app version.
- etag String
- (Output) ETag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
- execution
Type String - (Output) Possible values: SYNCHRONOUS ASYNCHRONOUS
- generated
Summary String - (Output) If the tool is generated by the LLM assistant, this field contains a descriptive summary of the generation.
- google
Search List<AppTools Version Snapshot Tool Google Search Tool> - (Output) Represents a tool to perform Google web searches for grounding. See https://cloud.google.com/vertex-ai/generative-ai/docs/grounding/grounding-with-google-search. Structure is documented below.
- name String
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - open
Api List<AppTools Version Snapshot Tool Open Api Tool> - (Output) A remote API tool defined by an OpenAPI schema. Structure is documented below.
- python
Functions List<AppVersion Snapshot Tool Python Function> - (Output) A Python function tool. Structure is documented below.
- system
Tools List<AppVersion Snapshot Tool System Tool> - (Output) The system tool. Structure is documented below.
- update
Time String - (Output) Timestamp when the toolset was last updated.
- client
Functions AppVersion Snapshot Tool Client Function[] - (Output) Represents a client-side function that the agent can invoke. When the tool is chosen by the agent, control is handed off to the client. The client is responsible for executing the function and returning the result as a ToolResponse to continue the interaction with the agent. Structure is documented below.
- create
Time string - (Output) Timestamp when the toolset was created.
- data
Store AppTools Version Snapshot Tool Data Store Tool[] - (Output) Tool to retrieve from Vertex AI Search datastore or engine for grounding. Accepts either a datastore or an engine, but not both. See Vertex AI Search: https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction. Structure is documented below.
- display
Name string - The display name of the app version.
- etag string
- (Output) ETag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
- execution
Type string - (Output) Possible values: SYNCHRONOUS ASYNCHRONOUS
- generated
Summary string - (Output) If the tool is generated by the LLM assistant, this field contains a descriptive summary of the generation.
- google
Search AppTools Version Snapshot Tool Google Search Tool[] - (Output) Represents a tool to perform Google web searches for grounding. See https://cloud.google.com/vertex-ai/generative-ai/docs/grounding/grounding-with-google-search. Structure is documented below.
- name string
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - open
Api AppTools Version Snapshot Tool Open Api Tool[] - (Output) A remote API tool defined by an OpenAPI schema. Structure is documented below.
- python
Functions AppVersion Snapshot Tool Python Function[] - (Output) A Python function tool. Structure is documented below.
- system
Tools AppVersion Snapshot Tool System Tool[] - (Output) The system tool. Structure is documented below.
- update
Time string - (Output) Timestamp when the toolset was last updated.
- client_
functions Sequence[AppVersion Snapshot Tool Client Function] - (Output) Represents a client-side function that the agent can invoke. When the tool is chosen by the agent, control is handed off to the client. The client is responsible for executing the function and returning the result as a ToolResponse to continue the interaction with the agent. Structure is documented below.
- create_
time str - (Output) Timestamp when the toolset was created.
- data_
store_ Sequence[Apptools Version Snapshot Tool Data Store Tool] - (Output) Tool to retrieve from Vertex AI Search datastore or engine for grounding. Accepts either a datastore or an engine, but not both. See Vertex AI Search: https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction. Structure is documented below.
- display_
name str - The display name of the app version.
- etag str
- (Output) ETag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
- execution_
type str - (Output) Possible values: SYNCHRONOUS ASYNCHRONOUS
- generated_
summary str - (Output) If the tool is generated by the LLM assistant, this field contains a descriptive summary of the generation.
- google_
search_ Sequence[Apptools Version Snapshot Tool Google Search Tool] - (Output) Represents a tool to perform Google web searches for grounding. See https://cloud.google.com/vertex-ai/generative-ai/docs/grounding/grounding-with-google-search. Structure is documented below.
- name str
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - open_
api_ Sequence[Apptools Version Snapshot Tool Open Api Tool] - (Output) A remote API tool defined by an OpenAPI schema. Structure is documented below.
- python_
functions Sequence[AppVersion Snapshot Tool Python Function] - (Output) A Python function tool. Structure is documented below.
- system_
tools Sequence[AppVersion Snapshot Tool System Tool] - (Output) The system tool. Structure is documented below.
- update_
time str - (Output) Timestamp when the toolset was last updated.
- client
Functions List<Property Map> - (Output) Represents a client-side function that the agent can invoke. When the tool is chosen by the agent, control is handed off to the client. The client is responsible for executing the function and returning the result as a ToolResponse to continue the interaction with the agent. Structure is documented below.
- create
Time String - (Output) Timestamp when the toolset was created.
- data
Store List<Property Map>Tools - (Output) Tool to retrieve from Vertex AI Search datastore or engine for grounding. Accepts either a datastore or an engine, but not both. See Vertex AI Search: https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction. Structure is documented below.
- display
Name String - The display name of the app version.
- etag String
- (Output) ETag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
- execution
Type String - (Output) Possible values: SYNCHRONOUS ASYNCHRONOUS
- generated
Summary String - (Output) If the tool is generated by the LLM assistant, this field contains a descriptive summary of the generation.
- google
Search List<Property Map>Tools - (Output) Represents a tool to perform Google web searches for grounding. See https://cloud.google.com/vertex-ai/generative-ai/docs/grounding/grounding-with-google-search. Structure is documented below.
- name String
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - open
Api List<Property Map>Tools - (Output) A remote API tool defined by an OpenAPI schema. Structure is documented below.
- python
Functions List<Property Map> - (Output) A Python function tool. Structure is documented below.
- system
Tools List<Property Map> - (Output) The system tool. Structure is documented below.
- update
Time String - (Output) Timestamp when the toolset was last updated.
AppVersionSnapshotToolClientFunction, AppVersionSnapshotToolClientFunctionArgs
- Description string
- The description of the app version.
- Name string
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - Parameters
List<App
Version Snapshot Tool Client Function Parameter> - (Output) Represents a select subset of an OpenAPI 3.0 schema object. Structure is documented below.
- Responses
List<App
Version Snapshot Tool Client Function Response> - (Output) Represents a select subset of an OpenAPI 3.0 schema object. Structure is documented below.
- Description string
- The description of the app version.
- Name string
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - Parameters
[]App
Version Snapshot Tool Client Function Parameter - (Output) Represents a select subset of an OpenAPI 3.0 schema object. Structure is documented below.
- Responses
[]App
Version Snapshot Tool Client Function Response - (Output) Represents a select subset of an OpenAPI 3.0 schema object. Structure is documented below.
- description String
- The description of the app version.
- name String
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - parameters
List<App
Version Snapshot Tool Client Function Parameter> - (Output) Represents a select subset of an OpenAPI 3.0 schema object. Structure is documented below.
- responses
List<App
Version Snapshot Tool Client Function Response> - (Output) Represents a select subset of an OpenAPI 3.0 schema object. Structure is documented below.
- description string
- The description of the app version.
- name string
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - parameters
App
Version Snapshot Tool Client Function Parameter[] - (Output) Represents a select subset of an OpenAPI 3.0 schema object. Structure is documented below.
- responses
App
Version Snapshot Tool Client Function Response[] - (Output) Represents a select subset of an OpenAPI 3.0 schema object. Structure is documented below.
- description str
- The description of the app version.
- name str
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - parameters
Sequence[App
Version Snapshot Tool Client Function Parameter] - (Output) Represents a select subset of an OpenAPI 3.0 schema object. Structure is documented below.
- responses
Sequence[App
Version Snapshot Tool Client Function Response] - (Output) Represents a select subset of an OpenAPI 3.0 schema object. Structure is documented below.
- description String
- The description of the app version.
- name String
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - parameters List<Property Map>
- (Output) Represents a select subset of an OpenAPI 3.0 schema object. Structure is documented below.
- responses List<Property Map>
- (Output) Represents a select subset of an OpenAPI 3.0 schema object. Structure is documented below.
AppVersionSnapshotToolClientFunctionParameter, AppVersionSnapshotToolClientFunctionParameterArgs
- Additional
Properties string - (Output) Optional. Defines the schema for additional properties allowed in an object. The value must be a valid JSON string representing the Schema object. (Note: OpenAPI also allows a boolean, this definition expects a Schema JSON).
- Any
Of string - (Output) Optional. The instance value should be valid against at least one of the schemas in this list.
- Default string
- (Output) Optional. Default value of the data. Represents a dynamically typed value which can be either null, a number, a string, a boolean, a struct, or a list of values. The provided default value must be compatible with the defined 'type' and other schema constraints.
- Defs string
- (Output) A map of definitions for use by ref. Only allowed at the root of the schema.
- Description string
- The description of the app version.
- Enums List<string>
- (Output)
Possible values of the element of primitive type with enum format.
Examples:
- We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
- We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
- Items string
- (Output) Schema of the elements of Type.ARRAY.
- Nullable bool
- (Output) Indicates if the value may be null.
- Prefix
Items string - (Output) Optional. Schemas of initial elements of Type.ARRAY.
- Properties string
- (Output) Properties of Type.OBJECT.
- Ref string
- (Output)
Allows indirect references between schema nodes. The value should be a
valid reference to a child of the root
defs. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring. - Requireds List<string>
- (Output) Required properties of Type.OBJECT.
- Type string
- (Output) The type of the data store. This field is readonly and populated by the server. Possible values: PUBLIC_WEB UNSTRUCTURED FAQ CONNECTOR
- Unique
Items bool - (Output) Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
- Additional
Properties string - (Output) Optional. Defines the schema for additional properties allowed in an object. The value must be a valid JSON string representing the Schema object. (Note: OpenAPI also allows a boolean, this definition expects a Schema JSON).
- Any
Of string - (Output) Optional. The instance value should be valid against at least one of the schemas in this list.
- Default string
- (Output) Optional. Default value of the data. Represents a dynamically typed value which can be either null, a number, a string, a boolean, a struct, or a list of values. The provided default value must be compatible with the defined 'type' and other schema constraints.
- Defs string
- (Output) A map of definitions for use by ref. Only allowed at the root of the schema.
- Description string
- The description of the app version.
- Enums []string
- (Output)
Possible values of the element of primitive type with enum format.
Examples:
- We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
- We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
- Items string
- (Output) Schema of the elements of Type.ARRAY.
- Nullable bool
- (Output) Indicates if the value may be null.
- Prefix
Items string - (Output) Optional. Schemas of initial elements of Type.ARRAY.
- Properties string
- (Output) Properties of Type.OBJECT.
- Ref string
- (Output)
Allows indirect references between schema nodes. The value should be a
valid reference to a child of the root
defs. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring. - Requireds []string
- (Output) Required properties of Type.OBJECT.
- Type string
- (Output) The type of the data store. This field is readonly and populated by the server. Possible values: PUBLIC_WEB UNSTRUCTURED FAQ CONNECTOR
- Unique
Items bool - (Output) Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
- additional
Properties String - (Output) Optional. Defines the schema for additional properties allowed in an object. The value must be a valid JSON string representing the Schema object. (Note: OpenAPI also allows a boolean, this definition expects a Schema JSON).
- any
Of String - (Output) Optional. The instance value should be valid against at least one of the schemas in this list.
- default_ String
- (Output) Optional. Default value of the data. Represents a dynamically typed value which can be either null, a number, a string, a boolean, a struct, or a list of values. The provided default value must be compatible with the defined 'type' and other schema constraints.
- defs String
- (Output) A map of definitions for use by ref. Only allowed at the root of the schema.
- description String
- The description of the app version.
- enums List<String>
- (Output)
Possible values of the element of primitive type with enum format.
Examples:
- We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
- We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
- items String
- (Output) Schema of the elements of Type.ARRAY.
- nullable Boolean
- (Output) Indicates if the value may be null.
- prefix
Items String - (Output) Optional. Schemas of initial elements of Type.ARRAY.
- properties String
- (Output) Properties of Type.OBJECT.
- ref String
- (Output)
Allows indirect references between schema nodes. The value should be a
valid reference to a child of the root
defs. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring. - requireds List<String>
- (Output) Required properties of Type.OBJECT.
- type String
- (Output) The type of the data store. This field is readonly and populated by the server. Possible values: PUBLIC_WEB UNSTRUCTURED FAQ CONNECTOR
- unique
Items Boolean - (Output) Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
- additional
Properties string - (Output) Optional. Defines the schema for additional properties allowed in an object. The value must be a valid JSON string representing the Schema object. (Note: OpenAPI also allows a boolean, this definition expects a Schema JSON).
- any
Of string - (Output) Optional. The instance value should be valid against at least one of the schemas in this list.
- default string
- (Output) Optional. Default value of the data. Represents a dynamically typed value which can be either null, a number, a string, a boolean, a struct, or a list of values. The provided default value must be compatible with the defined 'type' and other schema constraints.
- defs string
- (Output) A map of definitions for use by ref. Only allowed at the root of the schema.
- description string
- The description of the app version.
- enums string[]
- (Output)
Possible values of the element of primitive type with enum format.
Examples:
- We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
- We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
- items string
- (Output) Schema of the elements of Type.ARRAY.
- nullable boolean
- (Output) Indicates if the value may be null.
- prefix
Items string - (Output) Optional. Schemas of initial elements of Type.ARRAY.
- properties string
- (Output) Properties of Type.OBJECT.
- ref string
- (Output)
Allows indirect references between schema nodes. The value should be a
valid reference to a child of the root
defs. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring. - requireds string[]
- (Output) Required properties of Type.OBJECT.
- type string
- (Output) The type of the data store. This field is readonly and populated by the server. Possible values: PUBLIC_WEB UNSTRUCTURED FAQ CONNECTOR
- unique
Items boolean - (Output) Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
- additional_
properties str - (Output) Optional. Defines the schema for additional properties allowed in an object. The value must be a valid JSON string representing the Schema object. (Note: OpenAPI also allows a boolean, this definition expects a Schema JSON).
- any_
of str - (Output) Optional. The instance value should be valid against at least one of the schemas in this list.
- default str
- (Output) Optional. Default value of the data. Represents a dynamically typed value which can be either null, a number, a string, a boolean, a struct, or a list of values. The provided default value must be compatible with the defined 'type' and other schema constraints.
- defs str
- (Output) A map of definitions for use by ref. Only allowed at the root of the schema.
- description str
- The description of the app version.
- enums Sequence[str]
- (Output)
Possible values of the element of primitive type with enum format.
Examples:
- We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
- We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
- items str
- (Output) Schema of the elements of Type.ARRAY.
- nullable bool
- (Output) Indicates if the value may be null.
- prefix_
items str - (Output) Optional. Schemas of initial elements of Type.ARRAY.
- properties str
- (Output) Properties of Type.OBJECT.
- ref str
- (Output)
Allows indirect references between schema nodes. The value should be a
valid reference to a child of the root
defs. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring. - requireds Sequence[str]
- (Output) Required properties of Type.OBJECT.
- type str
- (Output) The type of the data store. This field is readonly and populated by the server. Possible values: PUBLIC_WEB UNSTRUCTURED FAQ CONNECTOR
- unique_
items bool - (Output) Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
- additional
Properties String - (Output) Optional. Defines the schema for additional properties allowed in an object. The value must be a valid JSON string representing the Schema object. (Note: OpenAPI also allows a boolean, this definition expects a Schema JSON).
- any
Of String - (Output) Optional. The instance value should be valid against at least one of the schemas in this list.
- default String
- (Output) Optional. Default value of the data. Represents a dynamically typed value which can be either null, a number, a string, a boolean, a struct, or a list of values. The provided default value must be compatible with the defined 'type' and other schema constraints.
- defs String
- (Output) A map of definitions for use by ref. Only allowed at the root of the schema.
- description String
- The description of the app version.
- enums List<String>
- (Output)
Possible values of the element of primitive type with enum format.
Examples:
- We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
- We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
- items String
- (Output) Schema of the elements of Type.ARRAY.
- nullable Boolean
- (Output) Indicates if the value may be null.
- prefix
Items String - (Output) Optional. Schemas of initial elements of Type.ARRAY.
- properties String
- (Output) Properties of Type.OBJECT.
- ref String
- (Output)
Allows indirect references between schema nodes. The value should be a
valid reference to a child of the root
defs. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring. - requireds List<String>
- (Output) Required properties of Type.OBJECT.
- type String
- (Output) The type of the data store. This field is readonly and populated by the server. Possible values: PUBLIC_WEB UNSTRUCTURED FAQ CONNECTOR
- unique
Items Boolean - (Output) Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
AppVersionSnapshotToolClientFunctionResponse, AppVersionSnapshotToolClientFunctionResponseArgs
- Additional
Properties string - (Output) Optional. Defines the schema for additional properties allowed in an object. The value must be a valid JSON string representing the Schema object. (Note: OpenAPI also allows a boolean, this definition expects a Schema JSON).
- Any
Of string - (Output) Optional. The instance value should be valid against at least one of the schemas in this list.
- Default string
- (Output) Optional. Default value of the data. Represents a dynamically typed value which can be either null, a number, a string, a boolean, a struct, or a list of values. The provided default value must be compatible with the defined 'type' and other schema constraints.
- Defs string
- (Output) A map of definitions for use by ref. Only allowed at the root of the schema.
- Description string
- The description of the app version.
- Enums List<string>
- (Output)
Possible values of the element of primitive type with enum format.
Examples:
- We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
- We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
- Items string
- (Output) Schema of the elements of Type.ARRAY.
- Nullable bool
- (Output) Indicates if the value may be null.
- Prefix
Items string - (Output) Optional. Schemas of initial elements of Type.ARRAY.
- Properties string
- (Output) Properties of Type.OBJECT.
- Ref string
- (Output)
Allows indirect references between schema nodes. The value should be a
valid reference to a child of the root
defs. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring. - Requireds List<string>
- (Output) Required properties of Type.OBJECT.
- Type string
- (Output) The type of the data store. This field is readonly and populated by the server. Possible values: PUBLIC_WEB UNSTRUCTURED FAQ CONNECTOR
- Unique
Items bool - (Output) Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
- Additional
Properties string - (Output) Optional. Defines the schema for additional properties allowed in an object. The value must be a valid JSON string representing the Schema object. (Note: OpenAPI also allows a boolean, this definition expects a Schema JSON).
- Any
Of string - (Output) Optional. The instance value should be valid against at least one of the schemas in this list.
- Default string
- (Output) Optional. Default value of the data. Represents a dynamically typed value which can be either null, a number, a string, a boolean, a struct, or a list of values. The provided default value must be compatible with the defined 'type' and other schema constraints.
- Defs string
- (Output) A map of definitions for use by ref. Only allowed at the root of the schema.
- Description string
- The description of the app version.
- Enums []string
- (Output)
Possible values of the element of primitive type with enum format.
Examples:
- We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
- We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
- Items string
- (Output) Schema of the elements of Type.ARRAY.
- Nullable bool
- (Output) Indicates if the value may be null.
- Prefix
Items string - (Output) Optional. Schemas of initial elements of Type.ARRAY.
- Properties string
- (Output) Properties of Type.OBJECT.
- Ref string
- (Output)
Allows indirect references between schema nodes. The value should be a
valid reference to a child of the root
defs. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring. - Requireds []string
- (Output) Required properties of Type.OBJECT.
- Type string
- (Output) The type of the data store. This field is readonly and populated by the server. Possible values: PUBLIC_WEB UNSTRUCTURED FAQ CONNECTOR
- Unique
Items bool - (Output) Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
- additional
Properties String - (Output) Optional. Defines the schema for additional properties allowed in an object. The value must be a valid JSON string representing the Schema object. (Note: OpenAPI also allows a boolean, this definition expects a Schema JSON).
- any
Of String - (Output) Optional. The instance value should be valid against at least one of the schemas in this list.
- default_ String
- (Output) Optional. Default value of the data. Represents a dynamically typed value which can be either null, a number, a string, a boolean, a struct, or a list of values. The provided default value must be compatible with the defined 'type' and other schema constraints.
- defs String
- (Output) A map of definitions for use by ref. Only allowed at the root of the schema.
- description String
- The description of the app version.
- enums List<String>
- (Output)
Possible values of the element of primitive type with enum format.
Examples:
- We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
- We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
- items String
- (Output) Schema of the elements of Type.ARRAY.
- nullable Boolean
- (Output) Indicates if the value may be null.
- prefix
Items String - (Output) Optional. Schemas of initial elements of Type.ARRAY.
- properties String
- (Output) Properties of Type.OBJECT.
- ref String
- (Output)
Allows indirect references between schema nodes. The value should be a
valid reference to a child of the root
defs. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring. - requireds List<String>
- (Output) Required properties of Type.OBJECT.
- type String
- (Output) The type of the data store. This field is readonly and populated by the server. Possible values: PUBLIC_WEB UNSTRUCTURED FAQ CONNECTOR
- unique
Items Boolean - (Output) Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
- additional
Properties string - (Output) Optional. Defines the schema for additional properties allowed in an object. The value must be a valid JSON string representing the Schema object. (Note: OpenAPI also allows a boolean, this definition expects a Schema JSON).
- any
Of string - (Output) Optional. The instance value should be valid against at least one of the schemas in this list.
- default string
- (Output) Optional. Default value of the data. Represents a dynamically typed value which can be either null, a number, a string, a boolean, a struct, or a list of values. The provided default value must be compatible with the defined 'type' and other schema constraints.
- defs string
- (Output) A map of definitions for use by ref. Only allowed at the root of the schema.
- description string
- The description of the app version.
- enums string[]
- (Output)
Possible values of the element of primitive type with enum format.
Examples:
- We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
- We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
- items string
- (Output) Schema of the elements of Type.ARRAY.
- nullable boolean
- (Output) Indicates if the value may be null.
- prefix
Items string - (Output) Optional. Schemas of initial elements of Type.ARRAY.
- properties string
- (Output) Properties of Type.OBJECT.
- ref string
- (Output)
Allows indirect references between schema nodes. The value should be a
valid reference to a child of the root
defs. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring. - requireds string[]
- (Output) Required properties of Type.OBJECT.
- type string
- (Output) The type of the data store. This field is readonly and populated by the server. Possible values: PUBLIC_WEB UNSTRUCTURED FAQ CONNECTOR
- unique
Items boolean - (Output) Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
- additional_
properties str - (Output) Optional. Defines the schema for additional properties allowed in an object. The value must be a valid JSON string representing the Schema object. (Note: OpenAPI also allows a boolean, this definition expects a Schema JSON).
- any_
of str - (Output) Optional. The instance value should be valid against at least one of the schemas in this list.
- default str
- (Output) Optional. Default value of the data. Represents a dynamically typed value which can be either null, a number, a string, a boolean, a struct, or a list of values. The provided default value must be compatible with the defined 'type' and other schema constraints.
- defs str
- (Output) A map of definitions for use by ref. Only allowed at the root of the schema.
- description str
- The description of the app version.
- enums Sequence[str]
- (Output)
Possible values of the element of primitive type with enum format.
Examples:
- We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
- We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
- items str
- (Output) Schema of the elements of Type.ARRAY.
- nullable bool
- (Output) Indicates if the value may be null.
- prefix_
items str - (Output) Optional. Schemas of initial elements of Type.ARRAY.
- properties str
- (Output) Properties of Type.OBJECT.
- ref str
- (Output)
Allows indirect references between schema nodes. The value should be a
valid reference to a child of the root
defs. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring. - requireds Sequence[str]
- (Output) Required properties of Type.OBJECT.
- type str
- (Output) The type of the data store. This field is readonly and populated by the server. Possible values: PUBLIC_WEB UNSTRUCTURED FAQ CONNECTOR
- unique_
items bool - (Output) Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
- additional
Properties String - (Output) Optional. Defines the schema for additional properties allowed in an object. The value must be a valid JSON string representing the Schema object. (Note: OpenAPI also allows a boolean, this definition expects a Schema JSON).
- any
Of String - (Output) Optional. The instance value should be valid against at least one of the schemas in this list.
- default String
- (Output) Optional. Default value of the data. Represents a dynamically typed value which can be either null, a number, a string, a boolean, a struct, or a list of values. The provided default value must be compatible with the defined 'type' and other schema constraints.
- defs String
- (Output) A map of definitions for use by ref. Only allowed at the root of the schema.
- description String
- The description of the app version.
- enums List<String>
- (Output)
Possible values of the element of primitive type with enum format.
Examples:
- We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
- We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
- items String
- (Output) Schema of the elements of Type.ARRAY.
- nullable Boolean
- (Output) Indicates if the value may be null.
- prefix
Items String - (Output) Optional. Schemas of initial elements of Type.ARRAY.
- properties String
- (Output) Properties of Type.OBJECT.
- ref String
- (Output)
Allows indirect references between schema nodes. The value should be a
valid reference to a child of the root
defs. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring. - requireds List<String>
- (Output) Required properties of Type.OBJECT.
- type String
- (Output) The type of the data store. This field is readonly and populated by the server. Possible values: PUBLIC_WEB UNSTRUCTURED FAQ CONNECTOR
- unique
Items Boolean - (Output) Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
AppVersionSnapshotToolDataStoreTool, AppVersionSnapshotToolDataStoreToolArgs
- Boost
Specs List<AppVersion Snapshot Tool Data Store Tool Boost Spec> - (Output) Boost specification to boost certain documents. Structure is documented below.
- Description string
- The description of the app version.
- Engine
Sources List<AppVersion Snapshot Tool Data Store Tool Engine Source> - (Output) Configuration for searching within an Engine, potentially targeting specific DataStores. Structure is documented below.
- Max
Results int - (Output) Number of search results to return per query. The default value is 10. The maximum allowed value is 10.
- Modality
Configs List<AppVersion Snapshot Tool Data Store Tool Modality Config> - (Output) The modality configs for the data store. Structure is documented below.
- Name string
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
- Boost
Specs []AppVersion Snapshot Tool Data Store Tool Boost Spec - (Output) Boost specification to boost certain documents. Structure is documented below.
- Description string
- The description of the app version.
- Engine
Sources []AppVersion Snapshot Tool Data Store Tool Engine Source - (Output) Configuration for searching within an Engine, potentially targeting specific DataStores. Structure is documented below.
- Max
Results int - (Output) Number of search results to return per query. The default value is 10. The maximum allowed value is 10.
- Modality
Configs []AppVersion Snapshot Tool Data Store Tool Modality Config - (Output) The modality configs for the data store. Structure is documented below.
- Name string
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
- boost
Specs List<AppVersion Snapshot Tool Data Store Tool Boost Spec> - (Output) Boost specification to boost certain documents. Structure is documented below.
- description String
- The description of the app version.
- engine
Sources List<AppVersion Snapshot Tool Data Store Tool Engine Source> - (Output) Configuration for searching within an Engine, potentially targeting specific DataStores. Structure is documented below.
- max
Results Integer - (Output) Number of search results to return per query. The default value is 10. The maximum allowed value is 10.
- modality
Configs List<AppVersion Snapshot Tool Data Store Tool Modality Config> - (Output) The modality configs for the data store. Structure is documented below.
- name String
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
- boost
Specs AppVersion Snapshot Tool Data Store Tool Boost Spec[] - (Output) Boost specification to boost certain documents. Structure is documented below.
- description string
- The description of the app version.
- engine
Sources AppVersion Snapshot Tool Data Store Tool Engine Source[] - (Output) Configuration for searching within an Engine, potentially targeting specific DataStores. Structure is documented below.
- max
Results number - (Output) Number of search results to return per query. The default value is 10. The maximum allowed value is 10.
- modality
Configs AppVersion Snapshot Tool Data Store Tool Modality Config[] - (Output) The modality configs for the data store. Structure is documented below.
- name string
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
- boost_
specs Sequence[AppVersion Snapshot Tool Data Store Tool Boost Spec] - (Output) Boost specification to boost certain documents. Structure is documented below.
- description str
- The description of the app version.
- engine_
sources Sequence[AppVersion Snapshot Tool Data Store Tool Engine Source] - (Output) Configuration for searching within an Engine, potentially targeting specific DataStores. Structure is documented below.
- max_
results int - (Output) Number of search results to return per query. The default value is 10. The maximum allowed value is 10.
- modality_
configs Sequence[AppVersion Snapshot Tool Data Store Tool Modality Config] - (Output) The modality configs for the data store. Structure is documented below.
- name str
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
- boost
Specs List<Property Map> - (Output) Boost specification to boost certain documents. Structure is documented below.
- description String
- The description of the app version.
- engine
Sources List<Property Map> - (Output) Configuration for searching within an Engine, potentially targeting specific DataStores. Structure is documented below.
- max
Results Number - (Output) Number of search results to return per query. The default value is 10. The maximum allowed value is 10.
- modality
Configs List<Property Map> - (Output) The modality configs for the data store. Structure is documented below.
- name String
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
AppVersionSnapshotToolDataStoreToolBoostSpec, AppVersionSnapshotToolDataStoreToolBoostSpecArgs
- Data
Stores List<string> - (Output) The Data Store where the boosting configuration is applied. Full resource name of DataStore, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}.
- Specs
List<App
Version Snapshot Tool Data Store Tool Boost Spec Spec> - (Output) A list of boosting specifications. Structure is documented below.
- Data
Stores []string - (Output) The Data Store where the boosting configuration is applied. Full resource name of DataStore, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}.
- Specs
[]App
Version Snapshot Tool Data Store Tool Boost Spec Spec - (Output) A list of boosting specifications. Structure is documented below.
- data
Stores List<String> - (Output) The Data Store where the boosting configuration is applied. Full resource name of DataStore, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}.
- specs
List<App
Version Snapshot Tool Data Store Tool Boost Spec Spec> - (Output) A list of boosting specifications. Structure is documented below.
- data
Stores string[] - (Output) The Data Store where the boosting configuration is applied. Full resource name of DataStore, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}.
- specs
App
Version Snapshot Tool Data Store Tool Boost Spec Spec[] - (Output) A list of boosting specifications. Structure is documented below.
- data_
stores Sequence[str] - (Output) The Data Store where the boosting configuration is applied. Full resource name of DataStore, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}.
- specs
Sequence[App
Version Snapshot Tool Data Store Tool Boost Spec Spec] - (Output) A list of boosting specifications. Structure is documented below.
- data
Stores List<String> - (Output) The Data Store where the boosting configuration is applied. Full resource name of DataStore, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}.
- specs List<Property Map>
- (Output) A list of boosting specifications. Structure is documented below.
AppVersionSnapshotToolDataStoreToolBoostSpecSpec, AppVersionSnapshotToolDataStoreToolBoostSpecSpecArgs
- Condition
Boost List<AppSpecs Version Snapshot Tool Data Store Tool Boost Spec Spec Condition Boost Spec> - (Output) A list of boosting specifications. Structure is documented below.
- Condition
Boost []AppSpecs Version Snapshot Tool Data Store Tool Boost Spec Spec Condition Boost Spec - (Output) A list of boosting specifications. Structure is documented below.
- condition
Boost List<AppSpecs Version Snapshot Tool Data Store Tool Boost Spec Spec Condition Boost Spec> - (Output) A list of boosting specifications. Structure is documented below.
- condition
Boost AppSpecs Version Snapshot Tool Data Store Tool Boost Spec Spec Condition Boost Spec[] - (Output) A list of boosting specifications. Structure is documented below.
- condition_
boost_ Sequence[Appspecs Version Snapshot Tool Data Store Tool Boost Spec Spec Condition Boost Spec] - (Output) A list of boosting specifications. Structure is documented below.
- condition
Boost List<Property Map>Specs - (Output) A list of boosting specifications. Structure is documented below.
AppVersionSnapshotToolDataStoreToolBoostSpecSpecConditionBoostSpec, AppVersionSnapshotToolDataStoreToolBoostSpecSpecConditionBoostSpecArgs
- Boost double
- (Output) Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the suggestions a big promotion. However, it does not necessarily mean that the top result will be a boosted suggestion. Setting to -1.0 gives the suggestions a big demotion. However, other suggestions that are relevant might still be shown. Setting to 0.0 means no boost applied. The boosting condition is ignored.
- Boost
Control List<AppSpecs Version Snapshot Tool Data Store Tool Boost Spec Spec Condition Boost Spec Boost Control Spec> - (Output) Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. Structure is documented below.
- Condition string
- (Output) An expression which specifies a boost condition. The syntax is the same as filter expression syntax. Currently, the only supported condition is a list of BCP-47 lang codes. Example: To boost suggestions in languages en or fr: (lang_code: ANY("en", "fr"))
- Boost float64
- (Output) Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the suggestions a big promotion. However, it does not necessarily mean that the top result will be a boosted suggestion. Setting to -1.0 gives the suggestions a big demotion. However, other suggestions that are relevant might still be shown. Setting to 0.0 means no boost applied. The boosting condition is ignored.
- Boost
Control []AppSpecs Version Snapshot Tool Data Store Tool Boost Spec Spec Condition Boost Spec Boost Control Spec - (Output) Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. Structure is documented below.
- Condition string
- (Output) An expression which specifies a boost condition. The syntax is the same as filter expression syntax. Currently, the only supported condition is a list of BCP-47 lang codes. Example: To boost suggestions in languages en or fr: (lang_code: ANY("en", "fr"))
- boost Double
- (Output) Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the suggestions a big promotion. However, it does not necessarily mean that the top result will be a boosted suggestion. Setting to -1.0 gives the suggestions a big demotion. However, other suggestions that are relevant might still be shown. Setting to 0.0 means no boost applied. The boosting condition is ignored.
- boost
Control List<AppSpecs Version Snapshot Tool Data Store Tool Boost Spec Spec Condition Boost Spec Boost Control Spec> - (Output) Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. Structure is documented below.
- condition String
- (Output) An expression which specifies a boost condition. The syntax is the same as filter expression syntax. Currently, the only supported condition is a list of BCP-47 lang codes. Example: To boost suggestions in languages en or fr: (lang_code: ANY("en", "fr"))
- boost number
- (Output) Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the suggestions a big promotion. However, it does not necessarily mean that the top result will be a boosted suggestion. Setting to -1.0 gives the suggestions a big demotion. However, other suggestions that are relevant might still be shown. Setting to 0.0 means no boost applied. The boosting condition is ignored.
- boost
Control AppSpecs Version Snapshot Tool Data Store Tool Boost Spec Spec Condition Boost Spec Boost Control Spec[] - (Output) Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. Structure is documented below.
- condition string
- (Output) An expression which specifies a boost condition. The syntax is the same as filter expression syntax. Currently, the only supported condition is a list of BCP-47 lang codes. Example: To boost suggestions in languages en or fr: (lang_code: ANY("en", "fr"))
- boost float
- (Output) Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the suggestions a big promotion. However, it does not necessarily mean that the top result will be a boosted suggestion. Setting to -1.0 gives the suggestions a big demotion. However, other suggestions that are relevant might still be shown. Setting to 0.0 means no boost applied. The boosting condition is ignored.
- boost_
control_ Sequence[Appspecs Version Snapshot Tool Data Store Tool Boost Spec Spec Condition Boost Spec Boost Control Spec] - (Output) Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. Structure is documented below.
- condition str
- (Output) An expression which specifies a boost condition. The syntax is the same as filter expression syntax. Currently, the only supported condition is a list of BCP-47 lang codes. Example: To boost suggestions in languages en or fr: (lang_code: ANY("en", "fr"))
- boost Number
- (Output) Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the suggestions a big promotion. However, it does not necessarily mean that the top result will be a boosted suggestion. Setting to -1.0 gives the suggestions a big demotion. However, other suggestions that are relevant might still be shown. Setting to 0.0 means no boost applied. The boosting condition is ignored.
- boost
Control List<Property Map>Specs - (Output) Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. Structure is documented below.
- condition String
- (Output) An expression which specifies a boost condition. The syntax is the same as filter expression syntax. Currently, the only supported condition is a list of BCP-47 lang codes. Example: To boost suggestions in languages en or fr: (lang_code: ANY("en", "fr"))
AppVersionSnapshotToolDataStoreToolBoostSpecSpecConditionBoostSpecBoostControlSpec, AppVersionSnapshotToolDataStoreToolBoostSpecSpecConditionBoostSpecBoostControlSpecArgs
- Attribute
Type string - (Output) The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value). Possible values: NUMERICAL FRESHNESS
- Control
Points List<AppVersion Snapshot Tool Data Store Tool Boost Spec Spec Condition Boost Spec Boost Control Spec Control Point> - (Output) The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. Structure is documented below.
- Field
Name string - (Output) The name of the field whose value will be used to determine the boost amount.
- Interpolation
Type string - (Output) The interpolation type to be applied to connect the control points listed below. Possible values: LINEAR
- Attribute
Type string - (Output) The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value). Possible values: NUMERICAL FRESHNESS
- Control
Points []AppVersion Snapshot Tool Data Store Tool Boost Spec Spec Condition Boost Spec Boost Control Spec Control Point - (Output) The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. Structure is documented below.
- Field
Name string - (Output) The name of the field whose value will be used to determine the boost amount.
- Interpolation
Type string - (Output) The interpolation type to be applied to connect the control points listed below. Possible values: LINEAR
- attribute
Type String - (Output) The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value). Possible values: NUMERICAL FRESHNESS
- control
Points List<AppVersion Snapshot Tool Data Store Tool Boost Spec Spec Condition Boost Spec Boost Control Spec Control Point> - (Output) The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. Structure is documented below.
- field
Name String - (Output) The name of the field whose value will be used to determine the boost amount.
- interpolation
Type String - (Output) The interpolation type to be applied to connect the control points listed below. Possible values: LINEAR
- attribute
Type string - (Output) The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value). Possible values: NUMERICAL FRESHNESS
- control
Points AppVersion Snapshot Tool Data Store Tool Boost Spec Spec Condition Boost Spec Boost Control Spec Control Point[] - (Output) The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. Structure is documented below.
- field
Name string - (Output) The name of the field whose value will be used to determine the boost amount.
- interpolation
Type string - (Output) The interpolation type to be applied to connect the control points listed below. Possible values: LINEAR
- attribute_
type str - (Output) The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value). Possible values: NUMERICAL FRESHNESS
- control_
points Sequence[AppVersion Snapshot Tool Data Store Tool Boost Spec Spec Condition Boost Spec Boost Control Spec Control Point] - (Output) The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. Structure is documented below.
- field_
name str - (Output) The name of the field whose value will be used to determine the boost amount.
- interpolation_
type str - (Output) The interpolation type to be applied to connect the control points listed below. Possible values: LINEAR
- attribute
Type String - (Output) The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value). Possible values: NUMERICAL FRESHNESS
- control
Points List<Property Map> - (Output) The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. Structure is documented below.
- field
Name String - (Output) The name of the field whose value will be used to determine the boost amount.
- interpolation
Type String - (Output) The interpolation type to be applied to connect the control points listed below. Possible values: LINEAR
AppVersionSnapshotToolDataStoreToolBoostSpecSpecConditionBoostSpecBoostControlSpecControlPoint, AppVersionSnapshotToolDataStoreToolBoostSpecSpecConditionBoostSpecBoostControlSpecControlPointArgs
- Attribute
Value string - (Output)
Can be one of:
- The numerical field value.
- The duration spec for freshness:
The value must be formatted as an XSD
dayTimeDurationvalue (a restricted subset of an ISO 8601 duration value). The pattern for this is:nDnM].
- Boost
Amount double - (Output) The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.
- Attribute
Value string - (Output)
Can be one of:
- The numerical field value.
- The duration spec for freshness:
The value must be formatted as an XSD
dayTimeDurationvalue (a restricted subset of an ISO 8601 duration value). The pattern for this is:nDnM].
- Boost
Amount float64 - (Output) The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.
- attribute
Value String - (Output)
Can be one of:
- The numerical field value.
- The duration spec for freshness:
The value must be formatted as an XSD
dayTimeDurationvalue (a restricted subset of an ISO 8601 duration value). The pattern for this is:nDnM].
- boost
Amount Double - (Output) The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.
- attribute
Value string - (Output)
Can be one of:
- The numerical field value.
- The duration spec for freshness:
The value must be formatted as an XSD
dayTimeDurationvalue (a restricted subset of an ISO 8601 duration value). The pattern for this is:nDnM].
- boost
Amount number - (Output) The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.
- attribute_
value str - (Output)
Can be one of:
- The numerical field value.
- The duration spec for freshness:
The value must be formatted as an XSD
dayTimeDurationvalue (a restricted subset of an ISO 8601 duration value). The pattern for this is:nDnM].
- boost_
amount float - (Output) The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.
- attribute
Value String - (Output)
Can be one of:
- The numerical field value.
- The duration spec for freshness:
The value must be formatted as an XSD
dayTimeDurationvalue (a restricted subset of an ISO 8601 duration value). The pattern for this is:nDnM].
- boost
Amount Number - (Output) The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.
AppVersionSnapshotToolDataStoreToolEngineSource, AppVersionSnapshotToolDataStoreToolEngineSourceArgs
- Data
Store List<AppSources Version Snapshot Tool Data Store Tool Engine Source Data Store Source> - (Output) Use to target specific DataStores within the Engine. If empty, the search applies to all DataStores associated with the Engine. Structure is documented below.
- Engine string
- (Output)
Full resource name of the Engine.
Format:
projects/{project}/locations/{location}/collections/{collection}/engines/{engine} - Filter string
- (Output) Filter specification for the DataStore. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
- Data
Store []AppSources Version Snapshot Tool Data Store Tool Engine Source Data Store Source - (Output) Use to target specific DataStores within the Engine. If empty, the search applies to all DataStores associated with the Engine. Structure is documented below.
- Engine string
- (Output)
Full resource name of the Engine.
Format:
projects/{project}/locations/{location}/collections/{collection}/engines/{engine} - Filter string
- (Output) Filter specification for the DataStore. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
- data
Store List<AppSources Version Snapshot Tool Data Store Tool Engine Source Data Store Source> - (Output) Use to target specific DataStores within the Engine. If empty, the search applies to all DataStores associated with the Engine. Structure is documented below.
- engine String
- (Output)
Full resource name of the Engine.
Format:
projects/{project}/locations/{location}/collections/{collection}/engines/{engine} - filter String
- (Output) Filter specification for the DataStore. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
- data
Store AppSources Version Snapshot Tool Data Store Tool Engine Source Data Store Source[] - (Output) Use to target specific DataStores within the Engine. If empty, the search applies to all DataStores associated with the Engine. Structure is documented below.
- engine string
- (Output)
Full resource name of the Engine.
Format:
projects/{project}/locations/{location}/collections/{collection}/engines/{engine} - filter string
- (Output) Filter specification for the DataStore. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
- data_
store_ Sequence[Appsources Version Snapshot Tool Data Store Tool Engine Source Data Store Source] - (Output) Use to target specific DataStores within the Engine. If empty, the search applies to all DataStores associated with the Engine. Structure is documented below.
- engine str
- (Output)
Full resource name of the Engine.
Format:
projects/{project}/locations/{location}/collections/{collection}/engines/{engine} - filter str
- (Output) Filter specification for the DataStore. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
- data
Store List<Property Map>Sources - (Output) Use to target specific DataStores within the Engine. If empty, the search applies to all DataStores associated with the Engine. Structure is documented below.
- engine String
- (Output)
Full resource name of the Engine.
Format:
projects/{project}/locations/{location}/collections/{collection}/engines/{engine} - filter String
- (Output) Filter specification for the DataStore. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
AppVersionSnapshotToolDataStoreToolEngineSourceDataStoreSource, AppVersionSnapshotToolDataStoreToolEngineSourceDataStoreSourceArgs
- Data
Stores List<AppVersion Snapshot Tool Data Store Tool Engine Source Data Store Source Data Store> - (Output) A DataStore resource in Vertex AI Search. Structure is documented below.
- Filter string
- (Output) Filter specification for the DataStore. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
- Data
Stores []AppVersion Snapshot Tool Data Store Tool Engine Source Data Store Source Data Store - (Output) A DataStore resource in Vertex AI Search. Structure is documented below.
- Filter string
- (Output) Filter specification for the DataStore. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
- data
Stores List<AppVersion Snapshot Tool Data Store Tool Engine Source Data Store Source Data Store> - (Output) A DataStore resource in Vertex AI Search. Structure is documented below.
- filter String
- (Output) Filter specification for the DataStore. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
- data
Stores AppVersion Snapshot Tool Data Store Tool Engine Source Data Store Source Data Store[] - (Output) A DataStore resource in Vertex AI Search. Structure is documented below.
- filter string
- (Output) Filter specification for the DataStore. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
- data_
stores Sequence[AppVersion Snapshot Tool Data Store Tool Engine Source Data Store Source Data Store] - (Output) A DataStore resource in Vertex AI Search. Structure is documented below.
- filter str
- (Output) Filter specification for the DataStore. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
- data
Stores List<Property Map> - (Output) A DataStore resource in Vertex AI Search. Structure is documented below.
- filter String
- (Output) Filter specification for the DataStore. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
AppVersionSnapshotToolDataStoreToolEngineSourceDataStoreSourceDataStore, AppVersionSnapshotToolDataStoreToolEngineSourceDataStoreSourceDataStoreArgs
- Connector
Configs List<AppVersion Snapshot Tool Data Store Tool Engine Source Data Store Source Data Store Connector Config> - (Output) The connector config for the data store connection. Structure is documented below.
- Create
Time string - (Output) Timestamp when the toolset was created.
- Display
Name string - The display name of the app version.
- Document
Processing stringMode - (Output) The document processing mode for the data store connection. Only set for PUBLIC_WEB and UNSTRUCTURED data stores. Possible values: DOCUMENTS CHUNKS
- Name string
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - Type string
- (Output) The type of the data store. This field is readonly and populated by the server. Possible values: PUBLIC_WEB UNSTRUCTURED FAQ CONNECTOR
- Connector
Configs []AppVersion Snapshot Tool Data Store Tool Engine Source Data Store Source Data Store Connector Config - (Output) The connector config for the data store connection. Structure is documented below.
- Create
Time string - (Output) Timestamp when the toolset was created.
- Display
Name string - The display name of the app version.
- Document
Processing stringMode - (Output) The document processing mode for the data store connection. Only set for PUBLIC_WEB and UNSTRUCTURED data stores. Possible values: DOCUMENTS CHUNKS
- Name string
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - Type string
- (Output) The type of the data store. This field is readonly and populated by the server. Possible values: PUBLIC_WEB UNSTRUCTURED FAQ CONNECTOR
- connector
Configs List<AppVersion Snapshot Tool Data Store Tool Engine Source Data Store Source Data Store Connector Config> - (Output) The connector config for the data store connection. Structure is documented below.
- create
Time String - (Output) Timestamp when the toolset was created.
- display
Name String - The display name of the app version.
- document
Processing StringMode - (Output) The document processing mode for the data store connection. Only set for PUBLIC_WEB and UNSTRUCTURED data stores. Possible values: DOCUMENTS CHUNKS
- name String
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - type String
- (Output) The type of the data store. This field is readonly and populated by the server. Possible values: PUBLIC_WEB UNSTRUCTURED FAQ CONNECTOR
- connector
Configs AppVersion Snapshot Tool Data Store Tool Engine Source Data Store Source Data Store Connector Config[] - (Output) The connector config for the data store connection. Structure is documented below.
- create
Time string - (Output) Timestamp when the toolset was created.
- display
Name string - The display name of the app version.
- document
Processing stringMode - (Output) The document processing mode for the data store connection. Only set for PUBLIC_WEB and UNSTRUCTURED data stores. Possible values: DOCUMENTS CHUNKS
- name string
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - type string
- (Output) The type of the data store. This field is readonly and populated by the server. Possible values: PUBLIC_WEB UNSTRUCTURED FAQ CONNECTOR
- connector_
configs Sequence[AppVersion Snapshot Tool Data Store Tool Engine Source Data Store Source Data Store Connector Config] - (Output) The connector config for the data store connection. Structure is documented below.
- create_
time str - (Output) Timestamp when the toolset was created.
- display_
name str - The display name of the app version.
- document_
processing_ strmode - (Output) The document processing mode for the data store connection. Only set for PUBLIC_WEB and UNSTRUCTURED data stores. Possible values: DOCUMENTS CHUNKS
- name str
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - type str
- (Output) The type of the data store. This field is readonly and populated by the server. Possible values: PUBLIC_WEB UNSTRUCTURED FAQ CONNECTOR
- connector
Configs List<Property Map> - (Output) The connector config for the data store connection. Structure is documented below.
- create
Time String - (Output) Timestamp when the toolset was created.
- display
Name String - The display name of the app version.
- document
Processing StringMode - (Output) The document processing mode for the data store connection. Only set for PUBLIC_WEB and UNSTRUCTURED data stores. Possible values: DOCUMENTS CHUNKS
- name String
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - type String
- (Output) The type of the data store. This field is readonly and populated by the server. Possible values: PUBLIC_WEB UNSTRUCTURED FAQ CONNECTOR
AppVersionSnapshotToolDataStoreToolEngineSourceDataStoreSourceDataStoreConnectorConfig, AppVersionSnapshotToolDataStoreToolEngineSourceDataStoreSourceDataStoreConnectorConfigArgs
- Collection string
- (Output) Resource name of the collection the data store belongs to.
- Collection
Display stringName - (Output) Display name of the collection the data store belongs to.
- Data
Source string - (Output)
The name of the data source.
Example:
salesforce,jira,confluence,bigquery.
- Collection string
- (Output) Resource name of the collection the data store belongs to.
- Collection
Display stringName - (Output) Display name of the collection the data store belongs to.
- Data
Source string - (Output)
The name of the data source.
Example:
salesforce,jira,confluence,bigquery.
- collection String
- (Output) Resource name of the collection the data store belongs to.
- collection
Display StringName - (Output) Display name of the collection the data store belongs to.
- data
Source String - (Output)
The name of the data source.
Example:
salesforce,jira,confluence,bigquery.
- collection string
- (Output) Resource name of the collection the data store belongs to.
- collection
Display stringName - (Output) Display name of the collection the data store belongs to.
- data
Source string - (Output)
The name of the data source.
Example:
salesforce,jira,confluence,bigquery.
- collection str
- (Output) Resource name of the collection the data store belongs to.
- collection_
display_ strname - (Output) Display name of the collection the data store belongs to.
- data_
source str - (Output)
The name of the data source.
Example:
salesforce,jira,confluence,bigquery.
- collection String
- (Output) Resource name of the collection the data store belongs to.
- collection
Display StringName - (Output) Display name of the collection the data store belongs to.
- data
Source String - (Output)
The name of the data source.
Example:
salesforce,jira,confluence,bigquery.
AppVersionSnapshotToolDataStoreToolModalityConfig, AppVersionSnapshotToolDataStoreToolModalityConfigArgs
- Grounding
Configs List<AppVersion Snapshot Tool Data Store Tool Modality Config Grounding Config> - (Output) Grounding configuration. Structure is documented below.
- Modality
Type string - (Output) The modality type. Possible values: TEXT AUDIO
- Rewriter
Configs List<AppVersion Snapshot Tool Data Store Tool Modality Config Rewriter Config> - (Output) Rewriter configuration. Structure is documented below.
- Summarization
Configs List<AppVersion Snapshot Tool Data Store Tool Modality Config Summarization Config> - (Output) Summarization configuration. Structure is documented below.
- Grounding
Configs []AppVersion Snapshot Tool Data Store Tool Modality Config Grounding Config - (Output) Grounding configuration. Structure is documented below.
- Modality
Type string - (Output) The modality type. Possible values: TEXT AUDIO
- Rewriter
Configs []AppVersion Snapshot Tool Data Store Tool Modality Config Rewriter Config - (Output) Rewriter configuration. Structure is documented below.
- Summarization
Configs []AppVersion Snapshot Tool Data Store Tool Modality Config Summarization Config - (Output) Summarization configuration. Structure is documented below.
- grounding
Configs List<AppVersion Snapshot Tool Data Store Tool Modality Config Grounding Config> - (Output) Grounding configuration. Structure is documented below.
- modality
Type String - (Output) The modality type. Possible values: TEXT AUDIO
- rewriter
Configs List<AppVersion Snapshot Tool Data Store Tool Modality Config Rewriter Config> - (Output) Rewriter configuration. Structure is documented below.
- summarization
Configs List<AppVersion Snapshot Tool Data Store Tool Modality Config Summarization Config> - (Output) Summarization configuration. Structure is documented below.
- grounding
Configs AppVersion Snapshot Tool Data Store Tool Modality Config Grounding Config[] - (Output) Grounding configuration. Structure is documented below.
- modality
Type string - (Output) The modality type. Possible values: TEXT AUDIO
- rewriter
Configs AppVersion Snapshot Tool Data Store Tool Modality Config Rewriter Config[] - (Output) Rewriter configuration. Structure is documented below.
- summarization
Configs AppVersion Snapshot Tool Data Store Tool Modality Config Summarization Config[] - (Output) Summarization configuration. Structure is documented below.
- grounding_
configs Sequence[AppVersion Snapshot Tool Data Store Tool Modality Config Grounding Config] - (Output) Grounding configuration. Structure is documented below.
- modality_
type str - (Output) The modality type. Possible values: TEXT AUDIO
- rewriter_
configs Sequence[AppVersion Snapshot Tool Data Store Tool Modality Config Rewriter Config] - (Output) Rewriter configuration. Structure is documented below.
- summarization_
configs Sequence[AppVersion Snapshot Tool Data Store Tool Modality Config Summarization Config] - (Output) Summarization configuration. Structure is documented below.
- grounding
Configs List<Property Map> - (Output) Grounding configuration. Structure is documented below.
- modality
Type String - (Output) The modality type. Possible values: TEXT AUDIO
- rewriter
Configs List<Property Map> - (Output) Rewriter configuration. Structure is documented below.
- summarization
Configs List<Property Map> - (Output) Summarization configuration. Structure is documented below.
AppVersionSnapshotToolDataStoreToolModalityConfigGroundingConfig, AppVersionSnapshotToolDataStoreToolModalityConfigGroundingConfigArgs
- Disabled bool
- (Output) Whether summarization is disabled.
- Grounding
Level double - (Output) The groundedness threshold of the answer based on the retrieved sources. The value has a configurable range of [1, 5]. The level is used to threshold the groundedness of the answer, meaning that all responses with a groundedness score below the threshold will fall back to returning relevant snippets only. For example, a level of 3 means that the groundedness score must be 3 or higher for the response to be returned.
- Disabled bool
- (Output) Whether summarization is disabled.
- Grounding
Level float64 - (Output) The groundedness threshold of the answer based on the retrieved sources. The value has a configurable range of [1, 5]. The level is used to threshold the groundedness of the answer, meaning that all responses with a groundedness score below the threshold will fall back to returning relevant snippets only. For example, a level of 3 means that the groundedness score must be 3 or higher for the response to be returned.
- disabled Boolean
- (Output) Whether summarization is disabled.
- grounding
Level Double - (Output) The groundedness threshold of the answer based on the retrieved sources. The value has a configurable range of [1, 5]. The level is used to threshold the groundedness of the answer, meaning that all responses with a groundedness score below the threshold will fall back to returning relevant snippets only. For example, a level of 3 means that the groundedness score must be 3 or higher for the response to be returned.
- disabled boolean
- (Output) Whether summarization is disabled.
- grounding
Level number - (Output) The groundedness threshold of the answer based on the retrieved sources. The value has a configurable range of [1, 5]. The level is used to threshold the groundedness of the answer, meaning that all responses with a groundedness score below the threshold will fall back to returning relevant snippets only. For example, a level of 3 means that the groundedness score must be 3 or higher for the response to be returned.
- disabled bool
- (Output) Whether summarization is disabled.
- grounding_
level float - (Output) The groundedness threshold of the answer based on the retrieved sources. The value has a configurable range of [1, 5]. The level is used to threshold the groundedness of the answer, meaning that all responses with a groundedness score below the threshold will fall back to returning relevant snippets only. For example, a level of 3 means that the groundedness score must be 3 or higher for the response to be returned.
- disabled Boolean
- (Output) Whether summarization is disabled.
- grounding
Level Number - (Output) The groundedness threshold of the answer based on the retrieved sources. The value has a configurable range of [1, 5]. The level is used to threshold the groundedness of the answer, meaning that all responses with a groundedness score below the threshold will fall back to returning relevant snippets only. For example, a level of 3 means that the groundedness score must be 3 or higher for the response to be returned.
AppVersionSnapshotToolDataStoreToolModalityConfigRewriterConfig, AppVersionSnapshotToolDataStoreToolModalityConfigRewriterConfigArgs
- Disabled bool
- (Output) Whether summarization is disabled.
- Model
Settings List<AppVersion Snapshot Tool Data Store Tool Modality Config Rewriter Config Model Setting> - (Output) Model settings contains various configurations for the LLM model. Structure is documented below.
- Prompt string
- (Output) The prompt definition. If not set, default prompt will be used.
- Disabled bool
- (Output) Whether summarization is disabled.
- Model
Settings []AppVersion Snapshot Tool Data Store Tool Modality Config Rewriter Config Model Setting - (Output) Model settings contains various configurations for the LLM model. Structure is documented below.
- Prompt string
- (Output) The prompt definition. If not set, default prompt will be used.
- disabled Boolean
- (Output) Whether summarization is disabled.
- model
Settings List<AppVersion Snapshot Tool Data Store Tool Modality Config Rewriter Config Model Setting> - (Output) Model settings contains various configurations for the LLM model. Structure is documented below.
- prompt String
- (Output) The prompt definition. If not set, default prompt will be used.
- disabled boolean
- (Output) Whether summarization is disabled.
- model
Settings AppVersion Snapshot Tool Data Store Tool Modality Config Rewriter Config Model Setting[] - (Output) Model settings contains various configurations for the LLM model. Structure is documented below.
- prompt string
- (Output) The prompt definition. If not set, default prompt will be used.
- disabled bool
- (Output) Whether summarization is disabled.
- model_
settings Sequence[AppVersion Snapshot Tool Data Store Tool Modality Config Rewriter Config Model Setting] - (Output) Model settings contains various configurations for the LLM model. Structure is documented below.
- prompt str
- (Output) The prompt definition. If not set, default prompt will be used.
- disabled Boolean
- (Output) Whether summarization is disabled.
- model
Settings List<Property Map> - (Output) Model settings contains various configurations for the LLM model. Structure is documented below.
- prompt String
- (Output) The prompt definition. If not set, default prompt will be used.
AppVersionSnapshotToolDataStoreToolModalityConfigRewriterConfigModelSetting, AppVersionSnapshotToolDataStoreToolModalityConfigRewriterConfigModelSettingArgs
- Model string
- (Output) The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
- Temperature double
- (Output) If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
- Model string
- (Output) The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
- Temperature float64
- (Output) If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
- model String
- (Output) The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
- temperature Double
- (Output) If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
- model string
- (Output) The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
- temperature number
- (Output) If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
- model str
- (Output) The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
- temperature float
- (Output) If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
- model String
- (Output) The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
- temperature Number
- (Output) If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
AppVersionSnapshotToolDataStoreToolModalityConfigSummarizationConfig, AppVersionSnapshotToolDataStoreToolModalityConfigSummarizationConfigArgs
- Disabled bool
- (Output) Whether summarization is disabled.
- Model
Settings List<AppVersion Snapshot Tool Data Store Tool Modality Config Summarization Config Model Setting> - (Output) Model settings contains various configurations for the LLM model. Structure is documented below.
- Prompt string
- (Output) The prompt definition. If not set, default prompt will be used.
- Disabled bool
- (Output) Whether summarization is disabled.
- Model
Settings []AppVersion Snapshot Tool Data Store Tool Modality Config Summarization Config Model Setting - (Output) Model settings contains various configurations for the LLM model. Structure is documented below.
- Prompt string
- (Output) The prompt definition. If not set, default prompt will be used.
- disabled Boolean
- (Output) Whether summarization is disabled.
- model
Settings List<AppVersion Snapshot Tool Data Store Tool Modality Config Summarization Config Model Setting> - (Output) Model settings contains various configurations for the LLM model. Structure is documented below.
- prompt String
- (Output) The prompt definition. If not set, default prompt will be used.
- disabled boolean
- (Output) Whether summarization is disabled.
- model
Settings AppVersion Snapshot Tool Data Store Tool Modality Config Summarization Config Model Setting[] - (Output) Model settings contains various configurations for the LLM model. Structure is documented below.
- prompt string
- (Output) The prompt definition. If not set, default prompt will be used.
- disabled bool
- (Output) Whether summarization is disabled.
- model_
settings Sequence[AppVersion Snapshot Tool Data Store Tool Modality Config Summarization Config Model Setting] - (Output) Model settings contains various configurations for the LLM model. Structure is documented below.
- prompt str
- (Output) The prompt definition. If not set, default prompt will be used.
- disabled Boolean
- (Output) Whether summarization is disabled.
- model
Settings List<Property Map> - (Output) Model settings contains various configurations for the LLM model. Structure is documented below.
- prompt String
- (Output) The prompt definition. If not set, default prompt will be used.
AppVersionSnapshotToolDataStoreToolModalityConfigSummarizationConfigModelSetting, AppVersionSnapshotToolDataStoreToolModalityConfigSummarizationConfigModelSettingArgs
- Model string
- (Output) The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
- Temperature double
- (Output) If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
- Model string
- (Output) The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
- Temperature float64
- (Output) If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
- model String
- (Output) The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
- temperature Double
- (Output) If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
- model string
- (Output) The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
- temperature number
- (Output) If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
- model str
- (Output) The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
- temperature float
- (Output) If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
- model String
- (Output) The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
- temperature Number
- (Output) If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
AppVersionSnapshotToolGoogleSearchTool, AppVersionSnapshotToolGoogleSearchToolArgs
- Description string
- The description of the app version.
- Exclude
Domains List<string> - (Output) List of domains to be excluded from the search results. Example: "example.com". A maximum of 2000 domains can be excluded.
- Name string
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
- Description string
- The description of the app version.
- Exclude
Domains []string - (Output) List of domains to be excluded from the search results. Example: "example.com". A maximum of 2000 domains can be excluded.
- Name string
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
- description String
- The description of the app version.
- exclude
Domains List<String> - (Output) List of domains to be excluded from the search results. Example: "example.com". A maximum of 2000 domains can be excluded.
- name String
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
- description string
- The description of the app version.
- exclude
Domains string[] - (Output) List of domains to be excluded from the search results. Example: "example.com". A maximum of 2000 domains can be excluded.
- name string
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
- description str
- The description of the app version.
- exclude_
domains Sequence[str] - (Output) List of domains to be excluded from the search results. Example: "example.com". A maximum of 2000 domains can be excluded.
- name str
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
- description String
- The description of the app version.
- exclude
Domains List<String> - (Output) List of domains to be excluded from the search results. Example: "example.com". A maximum of 2000 domains can be excluded.
- name String
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
AppVersionSnapshotToolOpenApiTool, AppVersionSnapshotToolOpenApiToolArgs
- Api
Authentications List<AppVersion Snapshot Tool Open Api Tool Api Authentication> - (Output) Authentication information required for API calls. Structure is documented below.
- Description string
- The description of the app version.
- Ignore
Unknown boolFields - (Output) If true, the agent will ignore unknown fields in the API response for all operations defined in the OpenAPI schema.
- Name string
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - Open
Api stringSchema - (Output) The OpenAPI schema of the toolset.
- Service
Directory List<AppConfigs Version Snapshot Tool Open Api Tool Service Directory Config> - (Output) Configuration for tools using Service Directory. Structure is documented below.
- Tls
Configs List<AppVersion Snapshot Tool Open Api Tool Tls Config> - (Output) The TLS configuration. Structure is documented below.
- Url string
- (Output) The server URL of the Open API schema. This field is only set in toolsets in the environment dependencies during the export process if the schema contains a server url. During the import process, if this url is present in the environment dependencies and the schema has the $env_var placeholder, it will replace the placeholder in the schema.
- Api
Authentications []AppVersion Snapshot Tool Open Api Tool Api Authentication - (Output) Authentication information required for API calls. Structure is documented below.
- Description string
- The description of the app version.
- Ignore
Unknown boolFields - (Output) If true, the agent will ignore unknown fields in the API response for all operations defined in the OpenAPI schema.
- Name string
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - Open
Api stringSchema - (Output) The OpenAPI schema of the toolset.
- Service
Directory []AppConfigs Version Snapshot Tool Open Api Tool Service Directory Config - (Output) Configuration for tools using Service Directory. Structure is documented below.
- Tls
Configs []AppVersion Snapshot Tool Open Api Tool Tls Config - (Output) The TLS configuration. Structure is documented below.
- Url string
- (Output) The server URL of the Open API schema. This field is only set in toolsets in the environment dependencies during the export process if the schema contains a server url. During the import process, if this url is present in the environment dependencies and the schema has the $env_var placeholder, it will replace the placeholder in the schema.
- api
Authentications List<AppVersion Snapshot Tool Open Api Tool Api Authentication> - (Output) Authentication information required for API calls. Structure is documented below.
- description String
- The description of the app version.
- ignore
Unknown BooleanFields - (Output) If true, the agent will ignore unknown fields in the API response for all operations defined in the OpenAPI schema.
- name String
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - open
Api StringSchema - (Output) The OpenAPI schema of the toolset.
- service
Directory List<AppConfigs Version Snapshot Tool Open Api Tool Service Directory Config> - (Output) Configuration for tools using Service Directory. Structure is documented below.
- tls
Configs List<AppVersion Snapshot Tool Open Api Tool Tls Config> - (Output) The TLS configuration. Structure is documented below.
- url String
- (Output) The server URL of the Open API schema. This field is only set in toolsets in the environment dependencies during the export process if the schema contains a server url. During the import process, if this url is present in the environment dependencies and the schema has the $env_var placeholder, it will replace the placeholder in the schema.
- api
Authentications AppVersion Snapshot Tool Open Api Tool Api Authentication[] - (Output) Authentication information required for API calls. Structure is documented below.
- description string
- The description of the app version.
- ignore
Unknown booleanFields - (Output) If true, the agent will ignore unknown fields in the API response for all operations defined in the OpenAPI schema.
- name string
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - open
Api stringSchema - (Output) The OpenAPI schema of the toolset.
- service
Directory AppConfigs Version Snapshot Tool Open Api Tool Service Directory Config[] - (Output) Configuration for tools using Service Directory. Structure is documented below.
- tls
Configs AppVersion Snapshot Tool Open Api Tool Tls Config[] - (Output) The TLS configuration. Structure is documented below.
- url string
- (Output) The server URL of the Open API schema. This field is only set in toolsets in the environment dependencies during the export process if the schema contains a server url. During the import process, if this url is present in the environment dependencies and the schema has the $env_var placeholder, it will replace the placeholder in the schema.
- api_
authentications Sequence[AppVersion Snapshot Tool Open Api Tool Api Authentication] - (Output) Authentication information required for API calls. Structure is documented below.
- description str
- The description of the app version.
- ignore_
unknown_ boolfields - (Output) If true, the agent will ignore unknown fields in the API response for all operations defined in the OpenAPI schema.
- name str
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - open_
api_ strschema - (Output) The OpenAPI schema of the toolset.
- service_
directory_ Sequence[Appconfigs Version Snapshot Tool Open Api Tool Service Directory Config] - (Output) Configuration for tools using Service Directory. Structure is documented below.
- tls_
configs Sequence[AppVersion Snapshot Tool Open Api Tool Tls Config] - (Output) The TLS configuration. Structure is documented below.
- url str
- (Output) The server URL of the Open API schema. This field is only set in toolsets in the environment dependencies during the export process if the schema contains a server url. During the import process, if this url is present in the environment dependencies and the schema has the $env_var placeholder, it will replace the placeholder in the schema.
- api
Authentications List<Property Map> - (Output) Authentication information required for API calls. Structure is documented below.
- description String
- The description of the app version.
- ignore
Unknown BooleanFields - (Output) If true, the agent will ignore unknown fields in the API response for all operations defined in the OpenAPI schema.
- name String
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - open
Api StringSchema - (Output) The OpenAPI schema of the toolset.
- service
Directory List<Property Map>Configs - (Output) Configuration for tools using Service Directory. Structure is documented below.
- tls
Configs List<Property Map> - (Output) The TLS configuration. Structure is documented below.
- url String
- (Output) The server URL of the Open API schema. This field is only set in toolsets in the environment dependencies during the export process if the schema contains a server url. During the import process, if this url is present in the environment dependencies and the schema has the $env_var placeholder, it will replace the placeholder in the schema.
AppVersionSnapshotToolOpenApiToolApiAuthentication, AppVersionSnapshotToolOpenApiToolApiAuthenticationArgs
- Api
Key List<AppConfigs Version Snapshot Tool Open Api Tool Api Authentication Api Key Config> - (Output) Configurations for authentication with API key. Structure is documented below.
- Oauth
Configs List<AppVersion Snapshot Tool Open Api Tool Api Authentication Oauth Config> - (Output) Configurations for authentication with OAuth. Structure is documented below.
- Service
Account List<AppAuth Configs Version Snapshot Tool Open Api Tool Api Authentication Service Account Auth Config> - (Output) Configurations for authentication using a custom service account. Structure is documented below.
- Service
Agent List<AppId Token Auth Configs Version Snapshot Tool Open Api Tool Api Authentication Service Agent Id Token Auth Config> - (Output) Configurations for authentication with ID token generated from service agent.
- Api
Key []AppConfigs Version Snapshot Tool Open Api Tool Api Authentication Api Key Config - (Output) Configurations for authentication with API key. Structure is documented below.
- Oauth
Configs []AppVersion Snapshot Tool Open Api Tool Api Authentication Oauth Config - (Output) Configurations for authentication with OAuth. Structure is documented below.
- Service
Account []AppAuth Configs Version Snapshot Tool Open Api Tool Api Authentication Service Account Auth Config - (Output) Configurations for authentication using a custom service account. Structure is documented below.
- Service
Agent []AppId Token Auth Configs Version Snapshot Tool Open Api Tool Api Authentication Service Agent Id Token Auth Config - (Output) Configurations for authentication with ID token generated from service agent.
- api
Key List<AppConfigs Version Snapshot Tool Open Api Tool Api Authentication Api Key Config> - (Output) Configurations for authentication with API key. Structure is documented below.
- oauth
Configs List<AppVersion Snapshot Tool Open Api Tool Api Authentication Oauth Config> - (Output) Configurations for authentication with OAuth. Structure is documented below.
- service
Account List<AppAuth Configs Version Snapshot Tool Open Api Tool Api Authentication Service Account Auth Config> - (Output) Configurations for authentication using a custom service account. Structure is documented below.
- service
Agent List<AppId Token Auth Configs Version Snapshot Tool Open Api Tool Api Authentication Service Agent Id Token Auth Config> - (Output) Configurations for authentication with ID token generated from service agent.
- api
Key AppConfigs Version Snapshot Tool Open Api Tool Api Authentication Api Key Config[] - (Output) Configurations for authentication with API key. Structure is documented below.
- oauth
Configs AppVersion Snapshot Tool Open Api Tool Api Authentication Oauth Config[] - (Output) Configurations for authentication with OAuth. Structure is documented below.
- service
Account AppAuth Configs Version Snapshot Tool Open Api Tool Api Authentication Service Account Auth Config[] - (Output) Configurations for authentication using a custom service account. Structure is documented below.
- service
Agent AppId Token Auth Configs Version Snapshot Tool Open Api Tool Api Authentication Service Agent Id Token Auth Config[] - (Output) Configurations for authentication with ID token generated from service agent.
- api_
key_ Sequence[Appconfigs Version Snapshot Tool Open Api Tool Api Authentication Api Key Config] - (Output) Configurations for authentication with API key. Structure is documented below.
- oauth_
configs Sequence[AppVersion Snapshot Tool Open Api Tool Api Authentication Oauth Config] - (Output) Configurations for authentication with OAuth. Structure is documented below.
- service_
account_ Sequence[Appauth_ configs Version Snapshot Tool Open Api Tool Api Authentication Service Account Auth Config] - (Output) Configurations for authentication using a custom service account. Structure is documented below.
- service_
agent_ Sequence[Appid_ token_ auth_ configs Version Snapshot Tool Open Api Tool Api Authentication Service Agent Id Token Auth Config] - (Output) Configurations for authentication with ID token generated from service agent.
- api
Key List<Property Map>Configs - (Output) Configurations for authentication with API key. Structure is documented below.
- oauth
Configs List<Property Map> - (Output) Configurations for authentication with OAuth. Structure is documented below.
- service
Account List<Property Map>Auth Configs - (Output) Configurations for authentication using a custom service account. Structure is documented below.
- service
Agent List<Property Map>Id Token Auth Configs - (Output) Configurations for authentication with ID token generated from service agent.
AppVersionSnapshotToolOpenApiToolApiAuthenticationApiKeyConfig, AppVersionSnapshotToolOpenApiToolApiAuthenticationApiKeyConfigArgs
- Api
Key stringSecret Version - (Output)
The name of the SecretManager secret version resource storing the API key.
Format:
projects/{project}/secrets/{secret}/versions/{version}Note: You should grantroles/secretmanager.secretAccessorrole to the CES service agentservice-@gcp-sa-ces.iam.gserviceaccount.com. - Key
Name string - (Output) The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name.
- Request
Location string - (Output) Key location in the request. Possible values: HEADER QUERY_STRING
- Api
Key stringSecret Version - (Output)
The name of the SecretManager secret version resource storing the API key.
Format:
projects/{project}/secrets/{secret}/versions/{version}Note: You should grantroles/secretmanager.secretAccessorrole to the CES service agentservice-@gcp-sa-ces.iam.gserviceaccount.com. - Key
Name string - (Output) The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name.
- Request
Location string - (Output) Key location in the request. Possible values: HEADER QUERY_STRING
- api
Key StringSecret Version - (Output)
The name of the SecretManager secret version resource storing the API key.
Format:
projects/{project}/secrets/{secret}/versions/{version}Note: You should grantroles/secretmanager.secretAccessorrole to the CES service agentservice-@gcp-sa-ces.iam.gserviceaccount.com. - key
Name String - (Output) The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name.
- request
Location String - (Output) Key location in the request. Possible values: HEADER QUERY_STRING
- api
Key stringSecret Version - (Output)
The name of the SecretManager secret version resource storing the API key.
Format:
projects/{project}/secrets/{secret}/versions/{version}Note: You should grantroles/secretmanager.secretAccessorrole to the CES service agentservice-@gcp-sa-ces.iam.gserviceaccount.com. - key
Name string - (Output) The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name.
- request
Location string - (Output) Key location in the request. Possible values: HEADER QUERY_STRING
- api_
key_ strsecret_ version - (Output)
The name of the SecretManager secret version resource storing the API key.
Format:
projects/{project}/secrets/{secret}/versions/{version}Note: You should grantroles/secretmanager.secretAccessorrole to the CES service agentservice-@gcp-sa-ces.iam.gserviceaccount.com. - key_
name str - (Output) The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name.
- request_
location str - (Output) Key location in the request. Possible values: HEADER QUERY_STRING
- api
Key StringSecret Version - (Output)
The name of the SecretManager secret version resource storing the API key.
Format:
projects/{project}/secrets/{secret}/versions/{version}Note: You should grantroles/secretmanager.secretAccessorrole to the CES service agentservice-@gcp-sa-ces.iam.gserviceaccount.com. - key
Name String - (Output) The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name.
- request
Location String - (Output) Key location in the request. Possible values: HEADER QUERY_STRING
AppVersionSnapshotToolOpenApiToolApiAuthenticationOauthConfig, AppVersionSnapshotToolOpenApiToolApiAuthenticationOauthConfigArgs
- Client
Id string - (Output) The client ID from the OAuth provider.
- Client
Secret stringVersion - (Output)
The name of the SecretManager secret version resource storing the
client secret.
Format:
projects/{project}/secrets/{secret}/versions/{version}Note: You should grantroles/secretmanager.secretAccessorrole to the CES service agentservice-@gcp-sa-ces.iam.gserviceaccount.com. - Oauth
Grant stringType - (Output) OAuth grant types. Possible values: CLIENT_CREDENTIAL
- Scopes List<string>
- (Output) The OAuth scopes to grant.
- Token
Endpoint string - (Output) The token endpoint in the OAuth provider to exchange for an access token.
- Client
Id string - (Output) The client ID from the OAuth provider.
- Client
Secret stringVersion - (Output)
The name of the SecretManager secret version resource storing the
client secret.
Format:
projects/{project}/secrets/{secret}/versions/{version}Note: You should grantroles/secretmanager.secretAccessorrole to the CES service agentservice-@gcp-sa-ces.iam.gserviceaccount.com. - Oauth
Grant stringType - (Output) OAuth grant types. Possible values: CLIENT_CREDENTIAL
- Scopes []string
- (Output) The OAuth scopes to grant.
- Token
Endpoint string - (Output) The token endpoint in the OAuth provider to exchange for an access token.
- client
Id String - (Output) The client ID from the OAuth provider.
- client
Secret StringVersion - (Output)
The name of the SecretManager secret version resource storing the
client secret.
Format:
projects/{project}/secrets/{secret}/versions/{version}Note: You should grantroles/secretmanager.secretAccessorrole to the CES service agentservice-@gcp-sa-ces.iam.gserviceaccount.com. - oauth
Grant StringType - (Output) OAuth grant types. Possible values: CLIENT_CREDENTIAL
- scopes List<String>
- (Output) The OAuth scopes to grant.
- token
Endpoint String - (Output) The token endpoint in the OAuth provider to exchange for an access token.
- client
Id string - (Output) The client ID from the OAuth provider.
- client
Secret stringVersion - (Output)
The name of the SecretManager secret version resource storing the
client secret.
Format:
projects/{project}/secrets/{secret}/versions/{version}Note: You should grantroles/secretmanager.secretAccessorrole to the CES service agentservice-@gcp-sa-ces.iam.gserviceaccount.com. - oauth
Grant stringType - (Output) OAuth grant types. Possible values: CLIENT_CREDENTIAL
- scopes string[]
- (Output) The OAuth scopes to grant.
- token
Endpoint string - (Output) The token endpoint in the OAuth provider to exchange for an access token.
- client_
id str - (Output) The client ID from the OAuth provider.
- client_
secret_ strversion - (Output)
The name of the SecretManager secret version resource storing the
client secret.
Format:
projects/{project}/secrets/{secret}/versions/{version}Note: You should grantroles/secretmanager.secretAccessorrole to the CES service agentservice-@gcp-sa-ces.iam.gserviceaccount.com. - oauth_
grant_ strtype - (Output) OAuth grant types. Possible values: CLIENT_CREDENTIAL
- scopes Sequence[str]
- (Output) The OAuth scopes to grant.
- token_
endpoint str - (Output) The token endpoint in the OAuth provider to exchange for an access token.
- client
Id String - (Output) The client ID from the OAuth provider.
- client
Secret StringVersion - (Output)
The name of the SecretManager secret version resource storing the
client secret.
Format:
projects/{project}/secrets/{secret}/versions/{version}Note: You should grantroles/secretmanager.secretAccessorrole to the CES service agentservice-@gcp-sa-ces.iam.gserviceaccount.com. - oauth
Grant StringType - (Output) OAuth grant types. Possible values: CLIENT_CREDENTIAL
- scopes List<String>
- (Output) The OAuth scopes to grant.
- token
Endpoint String - (Output) The token endpoint in the OAuth provider to exchange for an access token.
AppVersionSnapshotToolOpenApiToolApiAuthenticationServiceAccountAuthConfig, AppVersionSnapshotToolOpenApiToolApiAuthenticationServiceAccountAuthConfigArgs
- Service
Account string - (Output)
The email address of the service account used for authenticatation. CES
uses this service account to exchange an access token and the access token
is then sent in the
Authorizationheader of the request. The service account must have theroles/iam.serviceAccountTokenCreatorrole granted to the CES service agentservice-@gcp-sa-ces.iam.gserviceaccount.com.
- Service
Account string - (Output)
The email address of the service account used for authenticatation. CES
uses this service account to exchange an access token and the access token
is then sent in the
Authorizationheader of the request. The service account must have theroles/iam.serviceAccountTokenCreatorrole granted to the CES service agentservice-@gcp-sa-ces.iam.gserviceaccount.com.
- service
Account String - (Output)
The email address of the service account used for authenticatation. CES
uses this service account to exchange an access token and the access token
is then sent in the
Authorizationheader of the request. The service account must have theroles/iam.serviceAccountTokenCreatorrole granted to the CES service agentservice-@gcp-sa-ces.iam.gserviceaccount.com.
- service
Account string - (Output)
The email address of the service account used for authenticatation. CES
uses this service account to exchange an access token and the access token
is then sent in the
Authorizationheader of the request. The service account must have theroles/iam.serviceAccountTokenCreatorrole granted to the CES service agentservice-@gcp-sa-ces.iam.gserviceaccount.com.
- service_
account str - (Output)
The email address of the service account used for authenticatation. CES
uses this service account to exchange an access token and the access token
is then sent in the
Authorizationheader of the request. The service account must have theroles/iam.serviceAccountTokenCreatorrole granted to the CES service agentservice-@gcp-sa-ces.iam.gserviceaccount.com.
- service
Account String - (Output)
The email address of the service account used for authenticatation. CES
uses this service account to exchange an access token and the access token
is then sent in the
Authorizationheader of the request. The service account must have theroles/iam.serviceAccountTokenCreatorrole granted to the CES service agentservice-@gcp-sa-ces.iam.gserviceaccount.com.
AppVersionSnapshotToolOpenApiToolServiceDirectoryConfig, AppVersionSnapshotToolOpenApiToolServiceDirectoryConfigArgs
- Service string
- (Output)
The name of Service
Directory service.
Format:
projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}. Location of the service directory must be the same as the location of the app.
- Service string
- (Output)
The name of Service
Directory service.
Format:
projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}. Location of the service directory must be the same as the location of the app.
- service String
- (Output)
The name of Service
Directory service.
Format:
projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}. Location of the service directory must be the same as the location of the app.
- service string
- (Output)
The name of Service
Directory service.
Format:
projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}. Location of the service directory must be the same as the location of the app.
- service str
- (Output)
The name of Service
Directory service.
Format:
projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}. Location of the service directory must be the same as the location of the app.
- service String
- (Output)
The name of Service
Directory service.
Format:
projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}. Location of the service directory must be the same as the location of the app.
AppVersionSnapshotToolOpenApiToolTlsConfig, AppVersionSnapshotToolOpenApiToolTlsConfigArgs
- Ca
Certs List<AppVersion Snapshot Tool Open Api Tool Tls Config Ca Cert> - (Output) Specifies a list of allowed custom CA certificates for HTTPS verification. Structure is documented below.
- Ca
Certs []AppVersion Snapshot Tool Open Api Tool Tls Config Ca Cert - (Output) Specifies a list of allowed custom CA certificates for HTTPS verification. Structure is documented below.
- ca
Certs List<AppVersion Snapshot Tool Open Api Tool Tls Config Ca Cert> - (Output) Specifies a list of allowed custom CA certificates for HTTPS verification. Structure is documented below.
- ca
Certs AppVersion Snapshot Tool Open Api Tool Tls Config Ca Cert[] - (Output) Specifies a list of allowed custom CA certificates for HTTPS verification. Structure is documented below.
- ca_
certs Sequence[AppVersion Snapshot Tool Open Api Tool Tls Config Ca Cert] - (Output) Specifies a list of allowed custom CA certificates for HTTPS verification. Structure is documented below.
- ca
Certs List<Property Map> - (Output) Specifies a list of allowed custom CA certificates for HTTPS verification. Structure is documented below.
AppVersionSnapshotToolOpenApiToolTlsConfigCaCert, AppVersionSnapshotToolOpenApiToolTlsConfigCaCertArgs
- Cert string
- (Output)
The allowed custom CA certificates (in DER format) for
HTTPS verification. This overrides the default SSL trust store. If this
is empty or unspecified, CES will use Google's default trust
store to verify certificates. N.B. Make sure the HTTPS server
certificates are signed with "subject alt name". For instance a
certificate can be self-signed using the following command,
openssl x509 -req -days 200 -in example.com.csr
-signkey example.com.key
-out example.com.crt
-extfile <(printf "\nsubjectAltName='DNS:www.example.com'") - Display
Name string - The display name of the app version.
- Cert string
- (Output)
The allowed custom CA certificates (in DER format) for
HTTPS verification. This overrides the default SSL trust store. If this
is empty or unspecified, CES will use Google's default trust
store to verify certificates. N.B. Make sure the HTTPS server
certificates are signed with "subject alt name". For instance a
certificate can be self-signed using the following command,
openssl x509 -req -days 200 -in example.com.csr
-signkey example.com.key
-out example.com.crt
-extfile <(printf "\nsubjectAltName='DNS:www.example.com'") - Display
Name string - The display name of the app version.
- cert String
- (Output)
The allowed custom CA certificates (in DER format) for
HTTPS verification. This overrides the default SSL trust store. If this
is empty or unspecified, CES will use Google's default trust
store to verify certificates. N.B. Make sure the HTTPS server
certificates are signed with "subject alt name". For instance a
certificate can be self-signed using the following command,
openssl x509 -req -days 200 -in example.com.csr
-signkey example.com.key
-out example.com.crt
-extfile <(printf "\nsubjectAltName='DNS:www.example.com'") - display
Name String - The display name of the app version.
- cert string
- (Output)
The allowed custom CA certificates (in DER format) for
HTTPS verification. This overrides the default SSL trust store. If this
is empty or unspecified, CES will use Google's default trust
store to verify certificates. N.B. Make sure the HTTPS server
certificates are signed with "subject alt name". For instance a
certificate can be self-signed using the following command,
openssl x509 -req -days 200 -in example.com.csr
-signkey example.com.key
-out example.com.crt
-extfile <(printf "\nsubjectAltName='DNS:www.example.com'") - display
Name string - The display name of the app version.
- cert str
- (Output)
The allowed custom CA certificates (in DER format) for
HTTPS verification. This overrides the default SSL trust store. If this
is empty or unspecified, CES will use Google's default trust
store to verify certificates. N.B. Make sure the HTTPS server
certificates are signed with "subject alt name". For instance a
certificate can be self-signed using the following command,
openssl x509 -req -days 200 -in example.com.csr
-signkey example.com.key
-out example.com.crt
-extfile <(printf "\nsubjectAltName='DNS:www.example.com'") - display_
name str - The display name of the app version.
- cert String
- (Output)
The allowed custom CA certificates (in DER format) for
HTTPS verification. This overrides the default SSL trust store. If this
is empty or unspecified, CES will use Google's default trust
store to verify certificates. N.B. Make sure the HTTPS server
certificates are signed with "subject alt name". For instance a
certificate can be self-signed using the following command,
openssl x509 -req -days 200 -in example.com.csr
-signkey example.com.key
-out example.com.crt
-extfile <(printf "\nsubjectAltName='DNS:www.example.com'") - display
Name String - The display name of the app version.
AppVersionSnapshotToolPythonFunction, AppVersionSnapshotToolPythonFunctionArgs
- Description string
- The description of the app version.
- Name string
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - Python
Code string - (Output) The Python code to execute for the tool.
- Description string
- The description of the app version.
- Name string
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - Python
Code string - (Output) The Python code to execute for the tool.
- description String
- The description of the app version.
- name String
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - python
Code String - (Output) The Python code to execute for the tool.
- description string
- The description of the app version.
- name string
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - python
Code string - (Output) The Python code to execute for the tool.
- description str
- The description of the app version.
- name str
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - python_
code str - (Output) The Python code to execute for the tool.
- description String
- The description of the app version.
- name String
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - python
Code String - (Output) The Python code to execute for the tool.
AppVersionSnapshotToolSystemTool, AppVersionSnapshotToolSystemToolArgs
- Description string
- The description of the app version.
- Name string
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
- Description string
- The description of the app version.
- Name string
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
- description String
- The description of the app version.
- name String
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
- description string
- The description of the app version.
- name string
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
- description str
- The description of the app version.
- name str
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
- description String
- The description of the app version.
- name String
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
AppVersionSnapshotToolset, AppVersionSnapshotToolsetArgs
- Create
Time string - (Output) Timestamp when the toolset was created.
- Description string
- The description of the app version.
- Display
Name string - The display name of the app version.
- Etag string
- (Output) ETag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
- Execution
Type string - (Output) Possible values: SYNCHRONOUS ASYNCHRONOUS
- Name string
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - Open
Api List<AppToolsets Version Snapshot Toolset Open Api Toolset> - (Output) A toolset that contains a list of tools that are defined by an OpenAPI schema. Structure is documented below.
- Update
Time string - (Output) Timestamp when the toolset was last updated.
- Create
Time string - (Output) Timestamp when the toolset was created.
- Description string
- The description of the app version.
- Display
Name string - The display name of the app version.
- Etag string
- (Output) ETag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
- Execution
Type string - (Output) Possible values: SYNCHRONOUS ASYNCHRONOUS
- Name string
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - Open
Api []AppToolsets Version Snapshot Toolset Open Api Toolset - (Output) A toolset that contains a list of tools that are defined by an OpenAPI schema. Structure is documented below.
- Update
Time string - (Output) Timestamp when the toolset was last updated.
- create
Time String - (Output) Timestamp when the toolset was created.
- description String
- The description of the app version.
- display
Name String - The display name of the app version.
- etag String
- (Output) ETag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
- execution
Type String - (Output) Possible values: SYNCHRONOUS ASYNCHRONOUS
- name String
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - open
Api List<AppToolsets Version Snapshot Toolset Open Api Toolset> - (Output) A toolset that contains a list of tools that are defined by an OpenAPI schema. Structure is documented below.
- update
Time String - (Output) Timestamp when the toolset was last updated.
- create
Time string - (Output) Timestamp when the toolset was created.
- description string
- The description of the app version.
- display
Name string - The display name of the app version.
- etag string
- (Output) ETag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
- execution
Type string - (Output) Possible values: SYNCHRONOUS ASYNCHRONOUS
- name string
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - open
Api AppToolsets Version Snapshot Toolset Open Api Toolset[] - (Output) A toolset that contains a list of tools that are defined by an OpenAPI schema. Structure is documented below.
- update
Time string - (Output) Timestamp when the toolset was last updated.
- create_
time str - (Output) Timestamp when the toolset was created.
- description str
- The description of the app version.
- display_
name str - The display name of the app version.
- etag str
- (Output) ETag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
- execution_
type str - (Output) Possible values: SYNCHRONOUS ASYNCHRONOUS
- name str
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - open_
api_ Sequence[Apptoolsets Version Snapshot Toolset Open Api Toolset] - (Output) A toolset that contains a list of tools that are defined by an OpenAPI schema. Structure is documented below.
- update_
time str - (Output) Timestamp when the toolset was last updated.
- create
Time String - (Output) Timestamp when the toolset was created.
- description String
- The description of the app version.
- display
Name String - The display name of the app version.
- etag String
- (Output) ETag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
- execution
Type String - (Output) Possible values: SYNCHRONOUS ASYNCHRONOUS
- name String
- (Output)
Identifier. The unique identifier of the toolset.
Format:
projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset} - open
Api List<Property Map>Toolsets - (Output) A toolset that contains a list of tools that are defined by an OpenAPI schema. Structure is documented below.
- update
Time String - (Output) Timestamp when the toolset was last updated.
AppVersionSnapshotToolsetOpenApiToolset, AppVersionSnapshotToolsetOpenApiToolsetArgs
- Api
Authentications List<AppVersion Snapshot Toolset Open Api Toolset Api Authentication> - (Output) Authentication information required for API calls. Structure is documented below.
- Ignore
Unknown boolFields - (Output) If true, the agent will ignore unknown fields in the API response for all operations defined in the OpenAPI schema.
- Open
Api stringSchema - (Output) The OpenAPI schema of the toolset.
- Service
Directory List<AppConfigs Version Snapshot Toolset Open Api Toolset Service Directory Config> - (Output) Configuration for tools using Service Directory. Structure is documented below.
- Tls
Configs List<AppVersion Snapshot Toolset Open Api Toolset Tls Config> - (Output) The TLS configuration. Structure is documented below.
- Url string
- (Output) The server URL of the Open API schema. This field is only set in toolsets in the environment dependencies during the export process if the schema contains a server url. During the import process, if this url is present in the environment dependencies and the schema has the $env_var placeholder, it will replace the placeholder in the schema.
- Api
Authentications []AppVersion Snapshot Toolset Open Api Toolset Api Authentication - (Output) Authentication information required for API calls. Structure is documented below.
- Ignore
Unknown boolFields - (Output) If true, the agent will ignore unknown fields in the API response for all operations defined in the OpenAPI schema.
- Open
Api stringSchema - (Output) The OpenAPI schema of the toolset.
- Service
Directory []AppConfigs Version Snapshot Toolset Open Api Toolset Service Directory Config - (Output) Configuration for tools using Service Directory. Structure is documented below.
- Tls
Configs []AppVersion Snapshot Toolset Open Api Toolset Tls Config - (Output) The TLS configuration. Structure is documented below.
- Url string
- (Output) The server URL of the Open API schema. This field is only set in toolsets in the environment dependencies during the export process if the schema contains a server url. During the import process, if this url is present in the environment dependencies and the schema has the $env_var placeholder, it will replace the placeholder in the schema.
- api
Authentications List<AppVersion Snapshot Toolset Open Api Toolset Api Authentication> - (Output) Authentication information required for API calls. Structure is documented below.
- ignore
Unknown BooleanFields - (Output) If true, the agent will ignore unknown fields in the API response for all operations defined in the OpenAPI schema.
- open
Api StringSchema - (Output) The OpenAPI schema of the toolset.
- service
Directory List<AppConfigs Version Snapshot Toolset Open Api Toolset Service Directory Config> - (Output) Configuration for tools using Service Directory. Structure is documented below.
- tls
Configs List<AppVersion Snapshot Toolset Open Api Toolset Tls Config> - (Output) The TLS configuration. Structure is documented below.
- url String
- (Output) The server URL of the Open API schema. This field is only set in toolsets in the environment dependencies during the export process if the schema contains a server url. During the import process, if this url is present in the environment dependencies and the schema has the $env_var placeholder, it will replace the placeholder in the schema.
- api
Authentications AppVersion Snapshot Toolset Open Api Toolset Api Authentication[] - (Output) Authentication information required for API calls. Structure is documented below.
- ignore
Unknown booleanFields - (Output) If true, the agent will ignore unknown fields in the API response for all operations defined in the OpenAPI schema.
- open
Api stringSchema - (Output) The OpenAPI schema of the toolset.
- service
Directory AppConfigs Version Snapshot Toolset Open Api Toolset Service Directory Config[] - (Output) Configuration for tools using Service Directory. Structure is documented below.
- tls
Configs AppVersion Snapshot Toolset Open Api Toolset Tls Config[] - (Output) The TLS configuration. Structure is documented below.
- url string
- (Output) The server URL of the Open API schema. This field is only set in toolsets in the environment dependencies during the export process if the schema contains a server url. During the import process, if this url is present in the environment dependencies and the schema has the $env_var placeholder, it will replace the placeholder in the schema.
- api_
authentications Sequence[AppVersion Snapshot Toolset Open Api Toolset Api Authentication] - (Output) Authentication information required for API calls. Structure is documented below.
- ignore_
unknown_ boolfields - (Output) If true, the agent will ignore unknown fields in the API response for all operations defined in the OpenAPI schema.
- open_
api_ strschema - (Output) The OpenAPI schema of the toolset.
- service_
directory_ Sequence[Appconfigs Version Snapshot Toolset Open Api Toolset Service Directory Config] - (Output) Configuration for tools using Service Directory. Structure is documented below.
- tls_
configs Sequence[AppVersion Snapshot Toolset Open Api Toolset Tls Config] - (Output) The TLS configuration. Structure is documented below.
- url str
- (Output) The server URL of the Open API schema. This field is only set in toolsets in the environment dependencies during the export process if the schema contains a server url. During the import process, if this url is present in the environment dependencies and the schema has the $env_var placeholder, it will replace the placeholder in the schema.
- api
Authentications List<Property Map> - (Output) Authentication information required for API calls. Structure is documented below.
- ignore
Unknown BooleanFields - (Output) If true, the agent will ignore unknown fields in the API response for all operations defined in the OpenAPI schema.
- open
Api StringSchema - (Output) The OpenAPI schema of the toolset.
- service
Directory List<Property Map>Configs - (Output) Configuration for tools using Service Directory. Structure is documented below.
- tls
Configs List<Property Map> - (Output) The TLS configuration. Structure is documented below.
- url String
- (Output) The server URL of the Open API schema. This field is only set in toolsets in the environment dependencies during the export process if the schema contains a server url. During the import process, if this url is present in the environment dependencies and the schema has the $env_var placeholder, it will replace the placeholder in the schema.
AppVersionSnapshotToolsetOpenApiToolsetApiAuthentication, AppVersionSnapshotToolsetOpenApiToolsetApiAuthenticationArgs
- Api
Key List<AppConfigs Version Snapshot Toolset Open Api Toolset Api Authentication Api Key Config> - (Output) Configurations for authentication with API key. Structure is documented below.
- Bearer
Token List<AppConfigs Version Snapshot Toolset Open Api Toolset Api Authentication Bearer Token Config> - (Output) Configurations for authentication with a bearer token. Structure is documented below.
- Oauth
Configs List<AppVersion Snapshot Toolset Open Api Toolset Api Authentication Oauth Config> - (Output) Configurations for authentication with OAuth. Structure is documented below.
- Service
Account List<AppAuth Configs Version Snapshot Toolset Open Api Toolset Api Authentication Service Account Auth Config> - (Output) Configurations for authentication using a custom service account. Structure is documented below.
- Service
Agent List<AppId Token Auth Configs Version Snapshot Toolset Open Api Toolset Api Authentication Service Agent Id Token Auth Config> - (Output) Configurations for authentication with ID token generated from service agent.
- Api
Key []AppConfigs Version Snapshot Toolset Open Api Toolset Api Authentication Api Key Config - (Output) Configurations for authentication with API key. Structure is documented below.
- Bearer
Token []AppConfigs Version Snapshot Toolset Open Api Toolset Api Authentication Bearer Token Config - (Output) Configurations for authentication with a bearer token. Structure is documented below.
- Oauth
Configs []AppVersion Snapshot Toolset Open Api Toolset Api Authentication Oauth Config - (Output) Configurations for authentication with OAuth. Structure is documented below.
- Service
Account []AppAuth Configs Version Snapshot Toolset Open Api Toolset Api Authentication Service Account Auth Config - (Output) Configurations for authentication using a custom service account. Structure is documented below.
- Service
Agent []AppId Token Auth Configs Version Snapshot Toolset Open Api Toolset Api Authentication Service Agent Id Token Auth Config - (Output) Configurations for authentication with ID token generated from service agent.
- api
Key List<AppConfigs Version Snapshot Toolset Open Api Toolset Api Authentication Api Key Config> - (Output) Configurations for authentication with API key. Structure is documented below.
- bearer
Token List<AppConfigs Version Snapshot Toolset Open Api Toolset Api Authentication Bearer Token Config> - (Output) Configurations for authentication with a bearer token. Structure is documented below.
- oauth
Configs List<AppVersion Snapshot Toolset Open Api Toolset Api Authentication Oauth Config> - (Output) Configurations for authentication with OAuth. Structure is documented below.
- service
Account List<AppAuth Configs Version Snapshot Toolset Open Api Toolset Api Authentication Service Account Auth Config> - (Output) Configurations for authentication using a custom service account. Structure is documented below.
- service
Agent List<AppId Token Auth Configs Version Snapshot Toolset Open Api Toolset Api Authentication Service Agent Id Token Auth Config> - (Output) Configurations for authentication with ID token generated from service agent.
- api
Key AppConfigs Version Snapshot Toolset Open Api Toolset Api Authentication Api Key Config[] - (Output) Configurations for authentication with API key. Structure is documented below.
- bearer
Token AppConfigs Version Snapshot Toolset Open Api Toolset Api Authentication Bearer Token Config[] - (Output) Configurations for authentication with a bearer token. Structure is documented below.
- oauth
Configs AppVersion Snapshot Toolset Open Api Toolset Api Authentication Oauth Config[] - (Output) Configurations for authentication with OAuth. Structure is documented below.
- service
Account AppAuth Configs Version Snapshot Toolset Open Api Toolset Api Authentication Service Account Auth Config[] - (Output) Configurations for authentication using a custom service account. Structure is documented below.
- service
Agent AppId Token Auth Configs Version Snapshot Toolset Open Api Toolset Api Authentication Service Agent Id Token Auth Config[] - (Output) Configurations for authentication with ID token generated from service agent.
- api_
key_ Sequence[Appconfigs Version Snapshot Toolset Open Api Toolset Api Authentication Api Key Config] - (Output) Configurations for authentication with API key. Structure is documented below.
- bearer_
token_ Sequence[Appconfigs Version Snapshot Toolset Open Api Toolset Api Authentication Bearer Token Config] - (Output) Configurations for authentication with a bearer token. Structure is documented below.
- oauth_
configs Sequence[AppVersion Snapshot Toolset Open Api Toolset Api Authentication Oauth Config] - (Output) Configurations for authentication with OAuth. Structure is documented below.
- service_
account_ Sequence[Appauth_ configs Version Snapshot Toolset Open Api Toolset Api Authentication Service Account Auth Config] - (Output) Configurations for authentication using a custom service account. Structure is documented below.
- service_
agent_ Sequence[Appid_ token_ auth_ configs Version Snapshot Toolset Open Api Toolset Api Authentication Service Agent Id Token Auth Config] - (Output) Configurations for authentication with ID token generated from service agent.
- api
Key List<Property Map>Configs - (Output) Configurations for authentication with API key. Structure is documented below.
- bearer
Token List<Property Map>Configs - (Output) Configurations for authentication with a bearer token. Structure is documented below.
- oauth
Configs List<Property Map> - (Output) Configurations for authentication with OAuth. Structure is documented below.
- service
Account List<Property Map>Auth Configs - (Output) Configurations for authentication using a custom service account. Structure is documented below.
- service
Agent List<Property Map>Id Token Auth Configs - (Output) Configurations for authentication with ID token generated from service agent.
AppVersionSnapshotToolsetOpenApiToolsetApiAuthenticationApiKeyConfig, AppVersionSnapshotToolsetOpenApiToolsetApiAuthenticationApiKeyConfigArgs
- Api
Key stringSecret Version - (Output)
The name of the SecretManager secret version resource storing the API key.
Format:
projects/{project}/secrets/{secret}/versions/{version}Note: You should grantroles/secretmanager.secretAccessorrole to the CES service agentservice-@gcp-sa-ces.iam.gserviceaccount.com. - Key
Name string - (Output) The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name.
- Request
Location string - (Output) Key location in the request. Possible values: HEADER QUERY_STRING
- Api
Key stringSecret Version - (Output)
The name of the SecretManager secret version resource storing the API key.
Format:
projects/{project}/secrets/{secret}/versions/{version}Note: You should grantroles/secretmanager.secretAccessorrole to the CES service agentservice-@gcp-sa-ces.iam.gserviceaccount.com. - Key
Name string - (Output) The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name.
- Request
Location string - (Output) Key location in the request. Possible values: HEADER QUERY_STRING
- api
Key StringSecret Version - (Output)
The name of the SecretManager secret version resource storing the API key.
Format:
projects/{project}/secrets/{secret}/versions/{version}Note: You should grantroles/secretmanager.secretAccessorrole to the CES service agentservice-@gcp-sa-ces.iam.gserviceaccount.com. - key
Name String - (Output) The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name.
- request
Location String - (Output) Key location in the request. Possible values: HEADER QUERY_STRING
- api
Key stringSecret Version - (Output)
The name of the SecretManager secret version resource storing the API key.
Format:
projects/{project}/secrets/{secret}/versions/{version}Note: You should grantroles/secretmanager.secretAccessorrole to the CES service agentservice-@gcp-sa-ces.iam.gserviceaccount.com. - key
Name string - (Output) The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name.
- request
Location string - (Output) Key location in the request. Possible values: HEADER QUERY_STRING
- api_
key_ strsecret_ version - (Output)
The name of the SecretManager secret version resource storing the API key.
Format:
projects/{project}/secrets/{secret}/versions/{version}Note: You should grantroles/secretmanager.secretAccessorrole to the CES service agentservice-@gcp-sa-ces.iam.gserviceaccount.com. - key_
name str - (Output) The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name.
- request_
location str - (Output) Key location in the request. Possible values: HEADER QUERY_STRING
- api
Key StringSecret Version - (Output)
The name of the SecretManager secret version resource storing the API key.
Format:
projects/{project}/secrets/{secret}/versions/{version}Note: You should grantroles/secretmanager.secretAccessorrole to the CES service agentservice-@gcp-sa-ces.iam.gserviceaccount.com. - key
Name String - (Output) The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name.
- request
Location String - (Output) Key location in the request. Possible values: HEADER QUERY_STRING
AppVersionSnapshotToolsetOpenApiToolsetApiAuthenticationBearerTokenConfig, AppVersionSnapshotToolsetOpenApiToolsetApiAuthenticationBearerTokenConfigArgs
- Token string
- (Output)
- Token string
- (Output)
- token String
- (Output)
- token string
- (Output)
- token str
- (Output)
- token String
- (Output)
AppVersionSnapshotToolsetOpenApiToolsetApiAuthenticationOauthConfig, AppVersionSnapshotToolsetOpenApiToolsetApiAuthenticationOauthConfigArgs
- Client
Id string - (Output) The client ID from the OAuth provider.
- Client
Secret stringVersion - (Output)
The name of the SecretManager secret version resource storing the
client secret.
Format:
projects/{project}/secrets/{secret}/versions/{version}Note: You should grantroles/secretmanager.secretAccessorrole to the CES service agentservice-@gcp-sa-ces.iam.gserviceaccount.com. - Oauth
Grant stringType - (Output) OAuth grant types. Possible values: CLIENT_CREDENTIAL
- Scopes List<string>
- (Output) The OAuth scopes to grant.
- Token
Endpoint string - (Output) The token endpoint in the OAuth provider to exchange for an access token.
- Client
Id string - (Output) The client ID from the OAuth provider.
- Client
Secret stringVersion - (Output)
The name of the SecretManager secret version resource storing the
client secret.
Format:
projects/{project}/secrets/{secret}/versions/{version}Note: You should grantroles/secretmanager.secretAccessorrole to the CES service agentservice-@gcp-sa-ces.iam.gserviceaccount.com. - Oauth
Grant stringType - (Output) OAuth grant types. Possible values: CLIENT_CREDENTIAL
- Scopes []string
- (Output) The OAuth scopes to grant.
- Token
Endpoint string - (Output) The token endpoint in the OAuth provider to exchange for an access token.
- client
Id String - (Output) The client ID from the OAuth provider.
- client
Secret StringVersion - (Output)
The name of the SecretManager secret version resource storing the
client secret.
Format:
projects/{project}/secrets/{secret}/versions/{version}Note: You should grantroles/secretmanager.secretAccessorrole to the CES service agentservice-@gcp-sa-ces.iam.gserviceaccount.com. - oauth
Grant StringType - (Output) OAuth grant types. Possible values: CLIENT_CREDENTIAL
- scopes List<String>
- (Output) The OAuth scopes to grant.
- token
Endpoint String - (Output) The token endpoint in the OAuth provider to exchange for an access token.
- client
Id string - (Output) The client ID from the OAuth provider.
- client
Secret stringVersion - (Output)
The name of the SecretManager secret version resource storing the
client secret.
Format:
projects/{project}/secrets/{secret}/versions/{version}Note: You should grantroles/secretmanager.secretAccessorrole to the CES service agentservice-@gcp-sa-ces.iam.gserviceaccount.com. - oauth
Grant stringType - (Output) OAuth grant types. Possible values: CLIENT_CREDENTIAL
- scopes string[]
- (Output) The OAuth scopes to grant.
- token
Endpoint string - (Output) The token endpoint in the OAuth provider to exchange for an access token.
- client_
id str - (Output) The client ID from the OAuth provider.
- client_
secret_ strversion - (Output)
The name of the SecretManager secret version resource storing the
client secret.
Format:
projects/{project}/secrets/{secret}/versions/{version}Note: You should grantroles/secretmanager.secretAccessorrole to the CES service agentservice-@gcp-sa-ces.iam.gserviceaccount.com. - oauth_
grant_ strtype - (Output) OAuth grant types. Possible values: CLIENT_CREDENTIAL
- scopes Sequence[str]
- (Output) The OAuth scopes to grant.
- token_
endpoint str - (Output) The token endpoint in the OAuth provider to exchange for an access token.
- client
Id String - (Output) The client ID from the OAuth provider.
- client
Secret StringVersion - (Output)
The name of the SecretManager secret version resource storing the
client secret.
Format:
projects/{project}/secrets/{secret}/versions/{version}Note: You should grantroles/secretmanager.secretAccessorrole to the CES service agentservice-@gcp-sa-ces.iam.gserviceaccount.com. - oauth
Grant StringType - (Output) OAuth grant types. Possible values: CLIENT_CREDENTIAL
- scopes List<String>
- (Output) The OAuth scopes to grant.
- token
Endpoint String - (Output) The token endpoint in the OAuth provider to exchange for an access token.
AppVersionSnapshotToolsetOpenApiToolsetApiAuthenticationServiceAccountAuthConfig, AppVersionSnapshotToolsetOpenApiToolsetApiAuthenticationServiceAccountAuthConfigArgs
- Service
Account string - (Output)
The email address of the service account used for authenticatation. CES
uses this service account to exchange an access token and the access token
is then sent in the
Authorizationheader of the request. The service account must have theroles/iam.serviceAccountTokenCreatorrole granted to the CES service agentservice-@gcp-sa-ces.iam.gserviceaccount.com.
- Service
Account string - (Output)
The email address of the service account used for authenticatation. CES
uses this service account to exchange an access token and the access token
is then sent in the
Authorizationheader of the request. The service account must have theroles/iam.serviceAccountTokenCreatorrole granted to the CES service agentservice-@gcp-sa-ces.iam.gserviceaccount.com.
- service
Account String - (Output)
The email address of the service account used for authenticatation. CES
uses this service account to exchange an access token and the access token
is then sent in the
Authorizationheader of the request. The service account must have theroles/iam.serviceAccountTokenCreatorrole granted to the CES service agentservice-@gcp-sa-ces.iam.gserviceaccount.com.
- service
Account string - (Output)
The email address of the service account used for authenticatation. CES
uses this service account to exchange an access token and the access token
is then sent in the
Authorizationheader of the request. The service account must have theroles/iam.serviceAccountTokenCreatorrole granted to the CES service agentservice-@gcp-sa-ces.iam.gserviceaccount.com.
- service_
account str - (Output)
The email address of the service account used for authenticatation. CES
uses this service account to exchange an access token and the access token
is then sent in the
Authorizationheader of the request. The service account must have theroles/iam.serviceAccountTokenCreatorrole granted to the CES service agentservice-@gcp-sa-ces.iam.gserviceaccount.com.
- service
Account String - (Output)
The email address of the service account used for authenticatation. CES
uses this service account to exchange an access token and the access token
is then sent in the
Authorizationheader of the request. The service account must have theroles/iam.serviceAccountTokenCreatorrole granted to the CES service agentservice-@gcp-sa-ces.iam.gserviceaccount.com.
AppVersionSnapshotToolsetOpenApiToolsetServiceDirectoryConfig, AppVersionSnapshotToolsetOpenApiToolsetServiceDirectoryConfigArgs
- Service string
- (Output)
The name of Service
Directory service.
Format:
projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}. Location of the service directory must be the same as the location of the app.
- Service string
- (Output)
The name of Service
Directory service.
Format:
projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}. Location of the service directory must be the same as the location of the app.
- service String
- (Output)
The name of Service
Directory service.
Format:
projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}. Location of the service directory must be the same as the location of the app.
- service string
- (Output)
The name of Service
Directory service.
Format:
projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}. Location of the service directory must be the same as the location of the app.
- service str
- (Output)
The name of Service
Directory service.
Format:
projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}. Location of the service directory must be the same as the location of the app.
- service String
- (Output)
The name of Service
Directory service.
Format:
projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}. Location of the service directory must be the same as the location of the app.
AppVersionSnapshotToolsetOpenApiToolsetTlsConfig, AppVersionSnapshotToolsetOpenApiToolsetTlsConfigArgs
- Ca
Certs List<AppVersion Snapshot Toolset Open Api Toolset Tls Config Ca Cert> - (Output) Specifies a list of allowed custom CA certificates for HTTPS verification. Structure is documented below.
- Ca
Certs []AppVersion Snapshot Toolset Open Api Toolset Tls Config Ca Cert - (Output) Specifies a list of allowed custom CA certificates for HTTPS verification. Structure is documented below.
- ca
Certs List<AppVersion Snapshot Toolset Open Api Toolset Tls Config Ca Cert> - (Output) Specifies a list of allowed custom CA certificates for HTTPS verification. Structure is documented below.
- ca
Certs AppVersion Snapshot Toolset Open Api Toolset Tls Config Ca Cert[] - (Output) Specifies a list of allowed custom CA certificates for HTTPS verification. Structure is documented below.
- ca_
certs Sequence[AppVersion Snapshot Toolset Open Api Toolset Tls Config Ca Cert] - (Output) Specifies a list of allowed custom CA certificates for HTTPS verification. Structure is documented below.
- ca
Certs List<Property Map> - (Output) Specifies a list of allowed custom CA certificates for HTTPS verification. Structure is documented below.
AppVersionSnapshotToolsetOpenApiToolsetTlsConfigCaCert, AppVersionSnapshotToolsetOpenApiToolsetTlsConfigCaCertArgs
- Cert string
- (Output)
The allowed custom CA certificates (in DER format) for
HTTPS verification. This overrides the default SSL trust store. If this
is empty or unspecified, CES will use Google's default trust
store to verify certificates. N.B. Make sure the HTTPS server
certificates are signed with "subject alt name". For instance a
certificate can be self-signed using the following command,
openssl x509 -req -days 200 -in example.com.csr
-signkey example.com.key
-out example.com.crt
-extfile <(printf "\nsubjectAltName='DNS:www.example.com'") - Display
Name string - The display name of the app version.
- Cert string
- (Output)
The allowed custom CA certificates (in DER format) for
HTTPS verification. This overrides the default SSL trust store. If this
is empty or unspecified, CES will use Google's default trust
store to verify certificates. N.B. Make sure the HTTPS server
certificates are signed with "subject alt name". For instance a
certificate can be self-signed using the following command,
openssl x509 -req -days 200 -in example.com.csr
-signkey example.com.key
-out example.com.crt
-extfile <(printf "\nsubjectAltName='DNS:www.example.com'") - Display
Name string - The display name of the app version.
- cert String
- (Output)
The allowed custom CA certificates (in DER format) for
HTTPS verification. This overrides the default SSL trust store. If this
is empty or unspecified, CES will use Google's default trust
store to verify certificates. N.B. Make sure the HTTPS server
certificates are signed with "subject alt name". For instance a
certificate can be self-signed using the following command,
openssl x509 -req -days 200 -in example.com.csr
-signkey example.com.key
-out example.com.crt
-extfile <(printf "\nsubjectAltName='DNS:www.example.com'") - display
Name String - The display name of the app version.
- cert string
- (Output)
The allowed custom CA certificates (in DER format) for
HTTPS verification. This overrides the default SSL trust store. If this
is empty or unspecified, CES will use Google's default trust
store to verify certificates. N.B. Make sure the HTTPS server
certificates are signed with "subject alt name". For instance a
certificate can be self-signed using the following command,
openssl x509 -req -days 200 -in example.com.csr
-signkey example.com.key
-out example.com.crt
-extfile <(printf "\nsubjectAltName='DNS:www.example.com'") - display
Name string - The display name of the app version.
- cert str
- (Output)
The allowed custom CA certificates (in DER format) for
HTTPS verification. This overrides the default SSL trust store. If this
is empty or unspecified, CES will use Google's default trust
store to verify certificates. N.B. Make sure the HTTPS server
certificates are signed with "subject alt name". For instance a
certificate can be self-signed using the following command,
openssl x509 -req -days 200 -in example.com.csr
-signkey example.com.key
-out example.com.crt
-extfile <(printf "\nsubjectAltName='DNS:www.example.com'") - display_
name str - The display name of the app version.
- cert String
- (Output)
The allowed custom CA certificates (in DER format) for
HTTPS verification. This overrides the default SSL trust store. If this
is empty or unspecified, CES will use Google's default trust
store to verify certificates. N.B. Make sure the HTTPS server
certificates are signed with "subject alt name". For instance a
certificate can be self-signed using the following command,
openssl x509 -req -days 200 -in example.com.csr
-signkey example.com.key
-out example.com.crt
-extfile <(printf "\nsubjectAltName='DNS:www.example.com'") - display
Name String - The display name of the app version.
Import
AppVersion can be imported using any of these accepted formats:
projects/{{project}}/locations/{{location}}/apps/{{app}}/versions/{{name}}{{project}}/{{location}}/{{app}}/{{name}}{{location}}/{{app}}/{{name}}
When using the pulumi import command, AppVersion can be imported using one of the formats above. For example:
$ pulumi import gcp:ces/appVersion:AppVersion default projects/{{project}}/locations/{{location}}/apps/{{app}}/versions/{{name}}
$ pulumi import gcp:ces/appVersion:AppVersion default {{project}}/{{location}}/{{app}}/{{name}}
$ pulumi import gcp:ces/appVersion:AppVersion default {{location}}/{{app}}/{{name}}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Google Cloud (GCP) Classic pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
google-betaTerraform Provider.
