Description
Example Usage
Ces Tool Client Function 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 cesToolClientFunctionBasic = new gcp.ces.Tool("ces_tool_client_function_basic", {
location: "us",
app: my_app.name,
toolId: "ces_tool_basic1",
executionType: "SYNCHRONOUS",
clientFunction: {
name: "ces_tool_client_function_basic",
description: "example-description",
parameters: {
description: "schema description",
type: "ARRAY",
nullable: true,
requireds: ["some_property"],
enums: [
"VALUE_A",
"VALUE_B",
],
ref: "#/defs/MyDefinition",
uniqueItems: true,
defs: JSON.stringify({
SimpleString: {
type: "STRING",
description: "A simple string definition",
},
}),
anyOf: JSON.stringify([{
type: "STRING",
description: "any_of option 1: string",
}]),
"default": JSON.stringify(false),
prefixItems: JSON.stringify([{
type: "ARRAY",
description: "prefix item 1",
}]),
additionalProperties: JSON.stringify({
type: "BOOLEAN",
}),
properties: JSON.stringify({
name: {
type: "STRING",
description: "A name",
},
}),
items: JSON.stringify({
type: "ARRAY",
description: "An array",
}),
},
response: {
description: "schema description",
type: "ARRAY",
nullable: true,
requireds: ["some_property"],
enums: [
"VALUE_A",
"VALUE_B",
],
ref: "#/defs/MyDefinition",
uniqueItems: true,
defs: JSON.stringify({
SimpleString: {
type: "STRING",
description: "A simple string definition",
},
}),
anyOf: JSON.stringify([{
type: "STRING",
description: "any_of option 1: string",
}]),
"default": JSON.stringify(false),
prefixItems: JSON.stringify([{
type: "ARRAY",
description: "prefix item 1",
}]),
additionalProperties: JSON.stringify({
type: "BOOLEAN",
}),
properties: JSON.stringify({
name: {
type: "STRING",
description: "A name",
},
}),
items: JSON.stringify({
type: "ARRAY",
description: "An array",
}),
},
},
});
import pulumi
import json
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",
})
ces_tool_client_function_basic = gcp.ces.Tool("ces_tool_client_function_basic",
location="us",
app=my_app.name,
tool_id="ces_tool_basic1",
execution_type="SYNCHRONOUS",
client_function={
"name": "ces_tool_client_function_basic",
"description": "example-description",
"parameters": {
"description": "schema description",
"type": "ARRAY",
"nullable": True,
"requireds": ["some_property"],
"enums": [
"VALUE_A",
"VALUE_B",
],
"ref": "#/defs/MyDefinition",
"unique_items": True,
"defs": json.dumps({
"SimpleString": {
"type": "STRING",
"description": "A simple string definition",
},
}),
"any_of": json.dumps([{
"type": "STRING",
"description": "any_of option 1: string",
}]),
"default": json.dumps(False),
"prefix_items": json.dumps([{
"type": "ARRAY",
"description": "prefix item 1",
}]),
"additional_properties": json.dumps({
"type": "BOOLEAN",
}),
"properties": json.dumps({
"name": {
"type": "STRING",
"description": "A name",
},
}),
"items": json.dumps({
"type": "ARRAY",
"description": "An array",
}),
},
"response": {
"description": "schema description",
"type": "ARRAY",
"nullable": True,
"requireds": ["some_property"],
"enums": [
"VALUE_A",
"VALUE_B",
],
"ref": "#/defs/MyDefinition",
"unique_items": True,
"defs": json.dumps({
"SimpleString": {
"type": "STRING",
"description": "A simple string definition",
},
}),
"any_of": json.dumps([{
"type": "STRING",
"description": "any_of option 1: string",
}]),
"default": json.dumps(False),
"prefix_items": json.dumps([{
"type": "ARRAY",
"description": "prefix item 1",
}]),
"additional_properties": json.dumps({
"type": "BOOLEAN",
}),
"properties": json.dumps({
"name": {
"type": "STRING",
"description": "A name",
},
}),
"items": json.dumps({
"type": "ARRAY",
"description": "An array",
}),
},
})
package main
import (
"encoding/json"
"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
}
tmpJSON0, err := json.Marshal(map[string]interface{}{
"SimpleString": map[string]interface{}{
"type": "STRING",
"description": "A simple string definition",
},
})
if err != nil {
return err
}
json0 := string(tmpJSON0)
tmpJSON1, err := json.Marshal([]map[string]interface{}{
map[string]interface{}{
"type": "STRING",
"description": "any_of option 1: string",
},
})
if err != nil {
return err
}
json1 := string(tmpJSON1)
tmpJSON2, err := json.Marshal(false)
if err != nil {
return err
}
json2 := string(tmpJSON2)
tmpJSON3, err := json.Marshal([]map[string]interface{}{
map[string]interface{}{
"type": "ARRAY",
"description": "prefix item 1",
},
})
if err != nil {
return err
}
json3 := string(tmpJSON3)
tmpJSON4, err := json.Marshal(map[string]interface{}{
"type": "BOOLEAN",
})
if err != nil {
return err
}
json4 := string(tmpJSON4)
tmpJSON5, err := json.Marshal(map[string]interface{}{
"name": map[string]interface{}{
"type": "STRING",
"description": "A name",
},
})
if err != nil {
return err
}
json5 := string(tmpJSON5)
tmpJSON6, err := json.Marshal(map[string]interface{}{
"type": "ARRAY",
"description": "An array",
})
if err != nil {
return err
}
json6 := string(tmpJSON6)
tmpJSON7, err := json.Marshal(map[string]interface{}{
"SimpleString": map[string]interface{}{
"type": "STRING",
"description": "A simple string definition",
},
})
if err != nil {
return err
}
json7 := string(tmpJSON7)
tmpJSON8, err := json.Marshal([]map[string]interface{}{
map[string]interface{}{
"type": "STRING",
"description": "any_of option 1: string",
},
})
if err != nil {
return err
}
json8 := string(tmpJSON8)
tmpJSON9, err := json.Marshal(false)
if err != nil {
return err
}
json9 := string(tmpJSON9)
tmpJSON10, err := json.Marshal([]map[string]interface{}{
map[string]interface{}{
"type": "ARRAY",
"description": "prefix item 1",
},
})
if err != nil {
return err
}
json10 := string(tmpJSON10)
tmpJSON11, err := json.Marshal(map[string]interface{}{
"type": "BOOLEAN",
})
if err != nil {
return err
}
json11 := string(tmpJSON11)
tmpJSON12, err := json.Marshal(map[string]interface{}{
"name": map[string]interface{}{
"type": "STRING",
"description": "A name",
},
})
if err != nil {
return err
}
json12 := string(tmpJSON12)
tmpJSON13, err := json.Marshal(map[string]interface{}{
"type": "ARRAY",
"description": "An array",
})
if err != nil {
return err
}
json13 := string(tmpJSON13)
_, err = ces.NewTool(ctx, "ces_tool_client_function_basic", &ces.ToolArgs{
Location: pulumi.String("us"),
App: my_app.Name,
ToolId: pulumi.String("ces_tool_basic1"),
ExecutionType: pulumi.String("SYNCHRONOUS"),
ClientFunction: &ces.ToolClientFunctionArgs{
Name: pulumi.String("ces_tool_client_function_basic"),
Description: pulumi.String("example-description"),
Parameters: &ces.ToolClientFunctionParametersArgs{
Description: pulumi.String("schema description"),
Type: pulumi.String("ARRAY"),
Nullable: pulumi.Bool(true),
Requireds: pulumi.StringArray{
pulumi.String("some_property"),
},
Enums: pulumi.StringArray{
pulumi.String("VALUE_A"),
pulumi.String("VALUE_B"),
},
Ref: pulumi.String("#/defs/MyDefinition"),
UniqueItems: pulumi.Bool(true),
Defs: pulumi.String(json0),
AnyOf: pulumi.String(json1),
Default: pulumi.String(json2),
PrefixItems: pulumi.String(json3),
AdditionalProperties: pulumi.String(json4),
Properties: pulumi.String(json5),
Items: pulumi.String(json6),
},
Response: &ces.ToolClientFunctionResponseArgs{
Description: pulumi.String("schema description"),
Type: pulumi.String("ARRAY"),
Nullable: pulumi.Bool(true),
Requireds: pulumi.StringArray{
pulumi.String("some_property"),
},
Enums: pulumi.StringArray{
pulumi.String("VALUE_A"),
pulumi.String("VALUE_B"),
},
Ref: pulumi.String("#/defs/MyDefinition"),
UniqueItems: pulumi.Bool(true),
Defs: pulumi.String(json7),
AnyOf: pulumi.String(json8),
Default: pulumi.String(json9),
PrefixItems: pulumi.String(json10),
AdditionalProperties: pulumi.String(json11),
Properties: pulumi.String(json12),
Items: pulumi.String(json13),
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
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 cesToolClientFunctionBasic = new Gcp.Ces.Tool("ces_tool_client_function_basic", new()
{
Location = "us",
App = my_app.Name,
ToolId = "ces_tool_basic1",
ExecutionType = "SYNCHRONOUS",
ClientFunction = new Gcp.Ces.Inputs.ToolClientFunctionArgs
{
Name = "ces_tool_client_function_basic",
Description = "example-description",
Parameters = new Gcp.Ces.Inputs.ToolClientFunctionParametersArgs
{
Description = "schema description",
Type = "ARRAY",
Nullable = true,
Requireds = new[]
{
"some_property",
},
Enums = new[]
{
"VALUE_A",
"VALUE_B",
},
Ref = "#/defs/MyDefinition",
UniqueItems = true,
Defs = JsonSerializer.Serialize(new Dictionary<string, object?>
{
["SimpleString"] = new Dictionary<string, object?>
{
["type"] = "STRING",
["description"] = "A simple string definition",
},
}),
AnyOf = JsonSerializer.Serialize(new[]
{
new Dictionary<string, object?>
{
["type"] = "STRING",
["description"] = "any_of option 1: string",
},
}),
Default = JsonSerializer.Serialize(false),
PrefixItems = JsonSerializer.Serialize(new[]
{
new Dictionary<string, object?>
{
["type"] = "ARRAY",
["description"] = "prefix item 1",
},
}),
AdditionalProperties = JsonSerializer.Serialize(new Dictionary<string, object?>
{
["type"] = "BOOLEAN",
}),
Properties = JsonSerializer.Serialize(new Dictionary<string, object?>
{
["name"] = new Dictionary<string, object?>
{
["type"] = "STRING",
["description"] = "A name",
},
}),
Items = JsonSerializer.Serialize(new Dictionary<string, object?>
{
["type"] = "ARRAY",
["description"] = "An array",
}),
},
Response = new Gcp.Ces.Inputs.ToolClientFunctionResponseArgs
{
Description = "schema description",
Type = "ARRAY",
Nullable = true,
Requireds = new[]
{
"some_property",
},
Enums = new[]
{
"VALUE_A",
"VALUE_B",
},
Ref = "#/defs/MyDefinition",
UniqueItems = true,
Defs = JsonSerializer.Serialize(new Dictionary<string, object?>
{
["SimpleString"] = new Dictionary<string, object?>
{
["type"] = "STRING",
["description"] = "A simple string definition",
},
}),
AnyOf = JsonSerializer.Serialize(new[]
{
new Dictionary<string, object?>
{
["type"] = "STRING",
["description"] = "any_of option 1: string",
},
}),
Default = JsonSerializer.Serialize(false),
PrefixItems = JsonSerializer.Serialize(new[]
{
new Dictionary<string, object?>
{
["type"] = "ARRAY",
["description"] = "prefix item 1",
},
}),
AdditionalProperties = JsonSerializer.Serialize(new Dictionary<string, object?>
{
["type"] = "BOOLEAN",
}),
Properties = JsonSerializer.Serialize(new Dictionary<string, object?>
{
["name"] = new Dictionary<string, object?>
{
["type"] = "STRING",
["description"] = "A name",
},
}),
Items = JsonSerializer.Serialize(new Dictionary<string, object?>
{
["type"] = "ARRAY",
["description"] = "An array",
}),
},
},
});
});
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.Tool;
import com.pulumi.gcp.ces.ToolArgs;
import com.pulumi.gcp.ces.inputs.ToolClientFunctionArgs;
import com.pulumi.gcp.ces.inputs.ToolClientFunctionParametersArgs;
import com.pulumi.gcp.ces.inputs.ToolClientFunctionResponseArgs;
import static com.pulumi.codegen.internal.Serialization.*;
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 cesToolClientFunctionBasic = new Tool("cesToolClientFunctionBasic", ToolArgs.builder()
.location("us")
.app(my_app.name())
.toolId("ces_tool_basic1")
.executionType("SYNCHRONOUS")
.clientFunction(ToolClientFunctionArgs.builder()
.name("ces_tool_client_function_basic")
.description("example-description")
.parameters(ToolClientFunctionParametersArgs.builder()
.description("schema description")
.type("ARRAY")
.nullable(true)
.requireds("some_property")
.enums(
"VALUE_A",
"VALUE_B")
.ref("#/defs/MyDefinition")
.uniqueItems(true)
.defs(serializeJson(
jsonObject(
jsonProperty("SimpleString", jsonObject(
jsonProperty("type", "STRING"),
jsonProperty("description", "A simple string definition")
))
)))
.anyOf(serializeJson(
jsonArray(jsonObject(
jsonProperty("type", "STRING"),
jsonProperty("description", "any_of option 1: string")
))))
.default_(serializeJson(
false))
.prefixItems(serializeJson(
jsonArray(jsonObject(
jsonProperty("type", "ARRAY"),
jsonProperty("description", "prefix item 1")
))))
.additionalProperties(serializeJson(
jsonObject(
jsonProperty("type", "BOOLEAN")
)))
.properties(serializeJson(
jsonObject(
jsonProperty("name", jsonObject(
jsonProperty("type", "STRING"),
jsonProperty("description", "A name")
))
)))
.items(serializeJson(
jsonObject(
jsonProperty("type", "ARRAY"),
jsonProperty("description", "An array")
)))
.build())
.response(ToolClientFunctionResponseArgs.builder()
.description("schema description")
.type("ARRAY")
.nullable(true)
.requireds("some_property")
.enums(
"VALUE_A",
"VALUE_B")
.ref("#/defs/MyDefinition")
.uniqueItems(true)
.defs(serializeJson(
jsonObject(
jsonProperty("SimpleString", jsonObject(
jsonProperty("type", "STRING"),
jsonProperty("description", "A simple string definition")
))
)))
.anyOf(serializeJson(
jsonArray(jsonObject(
jsonProperty("type", "STRING"),
jsonProperty("description", "any_of option 1: string")
))))
.default_(serializeJson(
false))
.prefixItems(serializeJson(
jsonArray(jsonObject(
jsonProperty("type", "ARRAY"),
jsonProperty("description", "prefix item 1")
))))
.additionalProperties(serializeJson(
jsonObject(
jsonProperty("type", "BOOLEAN")
)))
.properties(serializeJson(
jsonObject(
jsonProperty("name", jsonObject(
jsonProperty("type", "STRING"),
jsonProperty("description", "A name")
))
)))
.items(serializeJson(
jsonObject(
jsonProperty("type", "ARRAY"),
jsonProperty("description", "An array")
)))
.build())
.build())
.build());
}
}
resources:
my-app:
type: gcp:ces:App
properties:
location: us
displayName: my-app
appId: app-id
timeZoneSettings:
timeZone: America/Los_Angeles
cesToolClientFunctionBasic:
type: gcp:ces:Tool
name: ces_tool_client_function_basic
properties:
location: us
app: ${["my-app"].name}
toolId: ces_tool_basic1
executionType: SYNCHRONOUS
clientFunction:
name: ces_tool_client_function_basic
description: example-description
parameters:
description: schema description
type: ARRAY
nullable: true
requireds:
- some_property
enums:
- VALUE_A
- VALUE_B
ref: '#/defs/MyDefinition'
uniqueItems: true
defs:
fn::toJSON:
SimpleString:
type: STRING
description: A simple string definition
anyOf:
fn::toJSON:
- type: STRING
description: 'any_of option 1: string'
default:
fn::toJSON: false
prefixItems:
fn::toJSON:
- type: ARRAY
description: prefix item 1
additionalProperties:
fn::toJSON:
type: BOOLEAN
properties:
fn::toJSON:
name:
type: STRING
description: A name
items:
fn::toJSON:
type: ARRAY
description: An array
response:
description: schema description
type: ARRAY
nullable: true
requireds:
- some_property
enums:
- VALUE_A
- VALUE_B
ref: '#/defs/MyDefinition'
uniqueItems: true
defs:
fn::toJSON:
SimpleString:
type: STRING
description: A simple string definition
anyOf:
fn::toJSON:
- type: STRING
description: 'any_of option 1: string'
default:
fn::toJSON: false
prefixItems:
fn::toJSON:
- type: ARRAY
description: prefix item 1
additionalProperties:
fn::toJSON:
type: BOOLEAN
properties:
fn::toJSON:
name:
type: STRING
description: A name
items:
fn::toJSON:
type: ARRAY
description: An array
Ces Tool Data Store Tool Engine Source Basic
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const basic = new gcp.discoveryengine.DataStore("basic", {
location: "global",
dataStoreId: "tool_data_store_id",
displayName: "tf-test-structured-datastore",
industryVertical: "GENERIC",
contentConfig: "NO_CONTENT",
solutionTypes: ["SOLUTION_TYPE_SEARCH"],
createAdvancedSiteSearch: false,
});
const basicSearchEngine = new gcp.discoveryengine.SearchEngine("basic", {
engineId: "tool_engine_id",
collectionId: "default_collection",
location: basic.location,
displayName: "Example Display Name",
dataStoreIds: [basic.dataStoreId],
searchEngineConfig: {},
});
const my_app = new gcp.ces.App("my-app", {
location: "us",
displayName: "my-app",
appId: "app-id",
timeZoneSettings: {
timeZone: "America/Los_Angeles",
},
});
const cesToolDataStoreToolEngineSourceBasic = new gcp.ces.Tool("ces_tool_data_store_tool_engine_source_basic", {
location: "us",
app: my_app.name,
toolId: "ces_tool_basic2",
executionType: "SYNCHRONOUS",
dataStoreTool: {
name: "example-tool",
description: "example-description",
boostSpecs: [{
dataStores: [basic.name],
specs: [{
conditionBoostSpecs: [{
condition: "(lang_code: ANY(\"en\", \"fr\"))",
boost: 1,
boostControlSpec: {
fieldName: "example-field",
attributeType: "NUMERICAL",
interpolationType: "LINEAR",
controlPoints: [{
attributeValue: "1",
boostAmount: 1,
}],
},
}],
}],
}],
modalityConfigs: [{
modalityType: "TEXT",
rewriterConfig: {
modelSettings: {
model: "gemini-2.5-flash",
temperature: 1,
},
prompt: "example-prompt",
disabled: false,
},
summarizationConfig: {
modelSettings: {
model: "gemini-2.5-flash",
temperature: 1,
},
prompt: "example-prompt",
disabled: false,
},
groundingConfig: {
groundingLevel: 3,
disabled: false,
},
}],
engineSource: {
engine: basicSearchEngine.name,
dataStoreSources: [{
filter: "example_field: ANY(\"specific_example\")",
dataStore: {
name: basic.name,
},
}],
filter: "example_field: ANY(\"specific_example\")",
},
maxResults: 5,
},
});
import pulumi
import pulumi_gcp as gcp
basic = gcp.discoveryengine.DataStore("basic",
location="global",
data_store_id="tool_data_store_id",
display_name="tf-test-structured-datastore",
industry_vertical="GENERIC",
content_config="NO_CONTENT",
solution_types=["SOLUTION_TYPE_SEARCH"],
create_advanced_site_search=False)
basic_search_engine = gcp.discoveryengine.SearchEngine("basic",
engine_id="tool_engine_id",
collection_id="default_collection",
location=basic.location,
display_name="Example Display Name",
data_store_ids=[basic.data_store_id],
search_engine_config={})
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",
})
ces_tool_data_store_tool_engine_source_basic = gcp.ces.Tool("ces_tool_data_store_tool_engine_source_basic",
location="us",
app=my_app.name,
tool_id="ces_tool_basic2",
execution_type="SYNCHRONOUS",
data_store_tool={
"name": "example-tool",
"description": "example-description",
"boost_specs": [{
"data_stores": [basic.name],
"specs": [{
"condition_boost_specs": [{
"condition": "(lang_code: ANY(\"en\", \"fr\"))",
"boost": 1,
"boost_control_spec": {
"field_name": "example-field",
"attribute_type": "NUMERICAL",
"interpolation_type": "LINEAR",
"control_points": [{
"attribute_value": "1",
"boost_amount": 1,
}],
},
}],
}],
}],
"modality_configs": [{
"modality_type": "TEXT",
"rewriter_config": {
"model_settings": {
"model": "gemini-2.5-flash",
"temperature": 1,
},
"prompt": "example-prompt",
"disabled": False,
},
"summarization_config": {
"model_settings": {
"model": "gemini-2.5-flash",
"temperature": 1,
},
"prompt": "example-prompt",
"disabled": False,
},
"grounding_config": {
"grounding_level": 3,
"disabled": False,
},
}],
"engine_source": {
"engine": basic_search_engine.name,
"data_store_sources": [{
"filter": "example_field: ANY(\"specific_example\")",
"data_store": {
"name": basic.name,
},
}],
"filter": "example_field: ANY(\"specific_example\")",
},
"max_results": 5,
})
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/ces"
"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/discoveryengine"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
basic, err := discoveryengine.NewDataStore(ctx, "basic", &discoveryengine.DataStoreArgs{
Location: pulumi.String("global"),
DataStoreId: pulumi.String("tool_data_store_id"),
DisplayName: pulumi.String("tf-test-structured-datastore"),
IndustryVertical: pulumi.String("GENERIC"),
ContentConfig: pulumi.String("NO_CONTENT"),
SolutionTypes: pulumi.StringArray{
pulumi.String("SOLUTION_TYPE_SEARCH"),
},
CreateAdvancedSiteSearch: pulumi.Bool(false),
})
if err != nil {
return err
}
basicSearchEngine, err := discoveryengine.NewSearchEngine(ctx, "basic", &discoveryengine.SearchEngineArgs{
EngineId: pulumi.String("tool_engine_id"),
CollectionId: pulumi.String("default_collection"),
Location: basic.Location,
DisplayName: pulumi.String("Example Display Name"),
DataStoreIds: pulumi.StringArray{
basic.DataStoreId,
},
SearchEngineConfig: &discoveryengine.SearchEngineSearchEngineConfigArgs{},
})
if err != nil {
return err
}
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.NewTool(ctx, "ces_tool_data_store_tool_engine_source_basic", &ces.ToolArgs{
Location: pulumi.String("us"),
App: my_app.Name,
ToolId: pulumi.String("ces_tool_basic2"),
ExecutionType: pulumi.String("SYNCHRONOUS"),
DataStoreTool: &ces.ToolDataStoreToolArgs{
Name: pulumi.String("example-tool"),
Description: pulumi.String("example-description"),
BoostSpecs: ces.ToolDataStoreToolBoostSpecArray{
&ces.ToolDataStoreToolBoostSpecArgs{
DataStores: pulumi.StringArray{
basic.Name,
},
Specs: ces.ToolDataStoreToolBoostSpecSpecArray{
&ces.ToolDataStoreToolBoostSpecSpecArgs{
ConditionBoostSpecs: ces.ToolDataStoreToolBoostSpecSpecConditionBoostSpecArray{
&ces.ToolDataStoreToolBoostSpecSpecConditionBoostSpecArgs{
Condition: pulumi.String("(lang_code: ANY(\"en\", \"fr\"))"),
Boost: pulumi.Float64(1),
BoostControlSpec: &ces.ToolDataStoreToolBoostSpecSpecConditionBoostSpecBoostControlSpecArgs{
FieldName: pulumi.String("example-field"),
AttributeType: pulumi.String("NUMERICAL"),
InterpolationType: pulumi.String("LINEAR"),
ControlPoints: ces.ToolDataStoreToolBoostSpecSpecConditionBoostSpecBoostControlSpecControlPointArray{
&ces.ToolDataStoreToolBoostSpecSpecConditionBoostSpecBoostControlSpecControlPointArgs{
AttributeValue: pulumi.String("1"),
BoostAmount: pulumi.Float64(1),
},
},
},
},
},
},
},
},
},
ModalityConfigs: ces.ToolDataStoreToolModalityConfigArray{
&ces.ToolDataStoreToolModalityConfigArgs{
ModalityType: pulumi.String("TEXT"),
RewriterConfig: &ces.ToolDataStoreToolModalityConfigRewriterConfigArgs{
ModelSettings: &ces.ToolDataStoreToolModalityConfigRewriterConfigModelSettingsArgs{
Model: pulumi.String("gemini-2.5-flash"),
Temperature: pulumi.Float64(1),
},
Prompt: pulumi.String("example-prompt"),
Disabled: pulumi.Bool(false),
},
SummarizationConfig: &ces.ToolDataStoreToolModalityConfigSummarizationConfigArgs{
ModelSettings: &ces.ToolDataStoreToolModalityConfigSummarizationConfigModelSettingsArgs{
Model: pulumi.String("gemini-2.5-flash"),
Temperature: pulumi.Float64(1),
},
Prompt: pulumi.String("example-prompt"),
Disabled: pulumi.Bool(false),
},
GroundingConfig: &ces.ToolDataStoreToolModalityConfigGroundingConfigArgs{
GroundingLevel: pulumi.Float64(3),
Disabled: pulumi.Bool(false),
},
},
},
EngineSource: &ces.ToolDataStoreToolEngineSourceArgs{
Engine: basicSearchEngine.Name,
DataStoreSources: ces.ToolDataStoreToolEngineSourceDataStoreSourceArray{
&ces.ToolDataStoreToolEngineSourceDataStoreSourceArgs{
Filter: pulumi.String("example_field: ANY(\"specific_example\")"),
DataStore: &ces.ToolDataStoreToolEngineSourceDataStoreSourceDataStoreArgs{
Name: basic.Name,
},
},
},
Filter: pulumi.String("example_field: ANY(\"specific_example\")"),
},
MaxResults: pulumi.Int(5),
},
})
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 basic = new Gcp.DiscoveryEngine.DataStore("basic", new()
{
Location = "global",
DataStoreId = "tool_data_store_id",
DisplayName = "tf-test-structured-datastore",
IndustryVertical = "GENERIC",
ContentConfig = "NO_CONTENT",
SolutionTypes = new[]
{
"SOLUTION_TYPE_SEARCH",
},
CreateAdvancedSiteSearch = false,
});
var basicSearchEngine = new Gcp.DiscoveryEngine.SearchEngine("basic", new()
{
EngineId = "tool_engine_id",
CollectionId = "default_collection",
Location = basic.Location,
DisplayName = "Example Display Name",
DataStoreIds = new[]
{
basic.DataStoreId,
},
SearchEngineConfig = null,
});
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 cesToolDataStoreToolEngineSourceBasic = new Gcp.Ces.Tool("ces_tool_data_store_tool_engine_source_basic", new()
{
Location = "us",
App = my_app.Name,
ToolId = "ces_tool_basic2",
ExecutionType = "SYNCHRONOUS",
DataStoreTool = new Gcp.Ces.Inputs.ToolDataStoreToolArgs
{
Name = "example-tool",
Description = "example-description",
BoostSpecs = new[]
{
new Gcp.Ces.Inputs.ToolDataStoreToolBoostSpecArgs
{
DataStores = new[]
{
basic.Name,
},
Specs = new[]
{
new Gcp.Ces.Inputs.ToolDataStoreToolBoostSpecSpecArgs
{
ConditionBoostSpecs = new[]
{
new Gcp.Ces.Inputs.ToolDataStoreToolBoostSpecSpecConditionBoostSpecArgs
{
Condition = "(lang_code: ANY(\"en\", \"fr\"))",
Boost = 1,
BoostControlSpec = new Gcp.Ces.Inputs.ToolDataStoreToolBoostSpecSpecConditionBoostSpecBoostControlSpecArgs
{
FieldName = "example-field",
AttributeType = "NUMERICAL",
InterpolationType = "LINEAR",
ControlPoints = new[]
{
new Gcp.Ces.Inputs.ToolDataStoreToolBoostSpecSpecConditionBoostSpecBoostControlSpecControlPointArgs
{
AttributeValue = "1",
BoostAmount = 1,
},
},
},
},
},
},
},
},
},
ModalityConfigs = new[]
{
new Gcp.Ces.Inputs.ToolDataStoreToolModalityConfigArgs
{
ModalityType = "TEXT",
RewriterConfig = new Gcp.Ces.Inputs.ToolDataStoreToolModalityConfigRewriterConfigArgs
{
ModelSettings = new Gcp.Ces.Inputs.ToolDataStoreToolModalityConfigRewriterConfigModelSettingsArgs
{
Model = "gemini-2.5-flash",
Temperature = 1,
},
Prompt = "example-prompt",
Disabled = false,
},
SummarizationConfig = new Gcp.Ces.Inputs.ToolDataStoreToolModalityConfigSummarizationConfigArgs
{
ModelSettings = new Gcp.Ces.Inputs.ToolDataStoreToolModalityConfigSummarizationConfigModelSettingsArgs
{
Model = "gemini-2.5-flash",
Temperature = 1,
},
Prompt = "example-prompt",
Disabled = false,
},
GroundingConfig = new Gcp.Ces.Inputs.ToolDataStoreToolModalityConfigGroundingConfigArgs
{
GroundingLevel = 3,
Disabled = false,
},
},
},
EngineSource = new Gcp.Ces.Inputs.ToolDataStoreToolEngineSourceArgs
{
Engine = basicSearchEngine.Name,
DataStoreSources = new[]
{
new Gcp.Ces.Inputs.ToolDataStoreToolEngineSourceDataStoreSourceArgs
{
Filter = "example_field: ANY(\"specific_example\")",
DataStore = new Gcp.Ces.Inputs.ToolDataStoreToolEngineSourceDataStoreSourceDataStoreArgs
{
Name = basic.Name,
},
},
},
Filter = "example_field: ANY(\"specific_example\")",
},
MaxResults = 5,
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.discoveryengine.DataStore;
import com.pulumi.gcp.discoveryengine.DataStoreArgs;
import com.pulumi.gcp.discoveryengine.SearchEngine;
import com.pulumi.gcp.discoveryengine.SearchEngineArgs;
import com.pulumi.gcp.discoveryengine.inputs.SearchEngineSearchEngineConfigArgs;
import com.pulumi.gcp.ces.App;
import com.pulumi.gcp.ces.AppArgs;
import com.pulumi.gcp.ces.inputs.AppTimeZoneSettingsArgs;
import com.pulumi.gcp.ces.Tool;
import com.pulumi.gcp.ces.ToolArgs;
import com.pulumi.gcp.ces.inputs.ToolDataStoreToolArgs;
import com.pulumi.gcp.ces.inputs.ToolDataStoreToolEngineSourceArgs;
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 basic = new DataStore("basic", DataStoreArgs.builder()
.location("global")
.dataStoreId("tool_data_store_id")
.displayName("tf-test-structured-datastore")
.industryVertical("GENERIC")
.contentConfig("NO_CONTENT")
.solutionTypes("SOLUTION_TYPE_SEARCH")
.createAdvancedSiteSearch(false)
.build());
var basicSearchEngine = new SearchEngine("basicSearchEngine", SearchEngineArgs.builder()
.engineId("tool_engine_id")
.collectionId("default_collection")
.location(basic.location())
.displayName("Example Display Name")
.dataStoreIds(basic.dataStoreId())
.searchEngineConfig(SearchEngineSearchEngineConfigArgs.builder()
.build())
.build());
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 cesToolDataStoreToolEngineSourceBasic = new Tool("cesToolDataStoreToolEngineSourceBasic", ToolArgs.builder()
.location("us")
.app(my_app.name())
.toolId("ces_tool_basic2")
.executionType("SYNCHRONOUS")
.dataStoreTool(ToolDataStoreToolArgs.builder()
.name("example-tool")
.description("example-description")
.boostSpecs(ToolDataStoreToolBoostSpecArgs.builder()
.dataStores(basic.name())
.specs(ToolDataStoreToolBoostSpecSpecArgs.builder()
.conditionBoostSpecs(ToolDataStoreToolBoostSpecSpecConditionBoostSpecArgs.builder()
.condition("(lang_code: ANY(\"en\", \"fr\"))")
.boost(1.0)
.boostControlSpec(ToolDataStoreToolBoostSpecSpecConditionBoostSpecBoostControlSpecArgs.builder()
.fieldName("example-field")
.attributeType("NUMERICAL")
.interpolationType("LINEAR")
.controlPoints(ToolDataStoreToolBoostSpecSpecConditionBoostSpecBoostControlSpecControlPointArgs.builder()
.attributeValue("1")
.boostAmount(1.0)
.build())
.build())
.build())
.build())
.build())
.modalityConfigs(ToolDataStoreToolModalityConfigArgs.builder()
.modalityType("TEXT")
.rewriterConfig(ToolDataStoreToolModalityConfigRewriterConfigArgs.builder()
.modelSettings(ToolDataStoreToolModalityConfigRewriterConfigModelSettingsArgs.builder()
.model("gemini-2.5-flash")
.temperature(1.0)
.build())
.prompt("example-prompt")
.disabled(false)
.build())
.summarizationConfig(ToolDataStoreToolModalityConfigSummarizationConfigArgs.builder()
.modelSettings(ToolDataStoreToolModalityConfigSummarizationConfigModelSettingsArgs.builder()
.model("gemini-2.5-flash")
.temperature(1.0)
.build())
.prompt("example-prompt")
.disabled(false)
.build())
.groundingConfig(ToolDataStoreToolModalityConfigGroundingConfigArgs.builder()
.groundingLevel(3.0)
.disabled(false)
.build())
.build())
.engineSource(ToolDataStoreToolEngineSourceArgs.builder()
.engine(basicSearchEngine.name())
.dataStoreSources(ToolDataStoreToolEngineSourceDataStoreSourceArgs.builder()
.filter("example_field: ANY(\"specific_example\")")
.dataStore(ToolDataStoreToolEngineSourceDataStoreSourceDataStoreArgs.builder()
.name(basic.name())
.build())
.build())
.filter("example_field: ANY(\"specific_example\")")
.build())
.maxResults(5)
.build())
.build());
}
}
resources:
basic:
type: gcp:discoveryengine:DataStore
properties:
location: global
dataStoreId: tool_data_store_id
displayName: tf-test-structured-datastore
industryVertical: GENERIC
contentConfig: NO_CONTENT
solutionTypes:
- SOLUTION_TYPE_SEARCH
createAdvancedSiteSearch: false
basicSearchEngine:
type: gcp:discoveryengine:SearchEngine
name: basic
properties:
engineId: tool_engine_id
collectionId: default_collection
location: ${basic.location}
displayName: Example Display Name
dataStoreIds:
- ${basic.dataStoreId}
searchEngineConfig: {}
my-app:
type: gcp:ces:App
properties:
location: us
displayName: my-app
appId: app-id
timeZoneSettings:
timeZone: America/Los_Angeles
cesToolDataStoreToolEngineSourceBasic:
type: gcp:ces:Tool
name: ces_tool_data_store_tool_engine_source_basic
properties:
location: us
app: ${["my-app"].name}
toolId: ces_tool_basic2
executionType: SYNCHRONOUS
dataStoreTool:
name: example-tool
description: example-description
boostSpecs:
- dataStores:
- ${basic.name}
specs:
- conditionBoostSpecs:
- condition: '(lang_code: ANY("en", "fr"))'
boost: 1
boostControlSpec:
fieldName: example-field
attributeType: NUMERICAL
interpolationType: LINEAR
controlPoints:
- attributeValue: 1
boostAmount: 1
modalityConfigs:
- modalityType: TEXT
rewriterConfig:
modelSettings:
model: gemini-2.5-flash
temperature: 1
prompt: example-prompt
disabled: false
summarizationConfig:
modelSettings:
model: gemini-2.5-flash
temperature: 1
prompt: example-prompt
disabled: false
groundingConfig:
groundingLevel: 3
disabled: false
engineSource:
engine: ${basicSearchEngine.name}
dataStoreSources:
- filter: 'example_field: ANY("specific_example")'
dataStore:
name: ${basic.name}
filter: 'example_field: ANY("specific_example")'
maxResults: 5
Ces Tool Google Search Tool 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 cesToolGoogleSearchToolBasic = new gcp.ces.Tool("ces_tool_google_search_tool_basic", {
location: "us",
app: my_app.name,
toolId: "ces_tool_basic3",
executionType: "SYNCHRONOUS",
googleSearchTool: {
name: "example-tool",
description: "example-description",
excludeDomains: [
"example.com",
"example2.com",
],
},
});
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",
})
ces_tool_google_search_tool_basic = gcp.ces.Tool("ces_tool_google_search_tool_basic",
location="us",
app=my_app.name,
tool_id="ces_tool_basic3",
execution_type="SYNCHRONOUS",
google_search_tool={
"name": "example-tool",
"description": "example-description",
"exclude_domains": [
"example.com",
"example2.com",
],
})
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.NewTool(ctx, "ces_tool_google_search_tool_basic", &ces.ToolArgs{
Location: pulumi.String("us"),
App: my_app.Name,
ToolId: pulumi.String("ces_tool_basic3"),
ExecutionType: pulumi.String("SYNCHRONOUS"),
GoogleSearchTool: &ces.ToolGoogleSearchToolArgs{
Name: pulumi.String("example-tool"),
Description: pulumi.String("example-description"),
ExcludeDomains: pulumi.StringArray{
pulumi.String("example.com"),
pulumi.String("example2.com"),
},
},
})
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 cesToolGoogleSearchToolBasic = new Gcp.Ces.Tool("ces_tool_google_search_tool_basic", new()
{
Location = "us",
App = my_app.Name,
ToolId = "ces_tool_basic3",
ExecutionType = "SYNCHRONOUS",
GoogleSearchTool = new Gcp.Ces.Inputs.ToolGoogleSearchToolArgs
{
Name = "example-tool",
Description = "example-description",
ExcludeDomains = new[]
{
"example.com",
"example2.com",
},
},
});
});
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.Tool;
import com.pulumi.gcp.ces.ToolArgs;
import com.pulumi.gcp.ces.inputs.ToolGoogleSearchToolArgs;
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 cesToolGoogleSearchToolBasic = new Tool("cesToolGoogleSearchToolBasic", ToolArgs.builder()
.location("us")
.app(my_app.name())
.toolId("ces_tool_basic3")
.executionType("SYNCHRONOUS")
.googleSearchTool(ToolGoogleSearchToolArgs.builder()
.name("example-tool")
.description("example-description")
.excludeDomains(
"example.com",
"example2.com")
.build())
.build());
}
}
resources:
my-app:
type: gcp:ces:App
properties:
location: us
displayName: my-app
appId: app-id
timeZoneSettings:
timeZone: America/Los_Angeles
cesToolGoogleSearchToolBasic:
type: gcp:ces:Tool
name: ces_tool_google_search_tool_basic
properties:
location: us
app: ${["my-app"].name}
toolId: ces_tool_basic3
executionType: SYNCHRONOUS
googleSearchTool:
name: example-tool
description: example-description
excludeDomains:
- example.com
- example2.com
Ces Tool Python Function 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 cesToolPythonFunctionBasic = new gcp.ces.Tool("ces_tool_python_function_basic", {
location: "us",
app: my_app.name,
toolId: "ces_tool_basic4",
executionType: "SYNCHRONOUS",
pythonFunction: {
name: "example_function",
pythonCode: "def example_function() -> int: return 0",
},
});
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",
})
ces_tool_python_function_basic = gcp.ces.Tool("ces_tool_python_function_basic",
location="us",
app=my_app.name,
tool_id="ces_tool_basic4",
execution_type="SYNCHRONOUS",
python_function={
"name": "example_function",
"python_code": "def example_function() -> int: return 0",
})
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.NewTool(ctx, "ces_tool_python_function_basic", &ces.ToolArgs{
Location: pulumi.String("us"),
App: my_app.Name,
ToolId: pulumi.String("ces_tool_basic4"),
ExecutionType: pulumi.String("SYNCHRONOUS"),
PythonFunction: &ces.ToolPythonFunctionArgs{
Name: pulumi.String("example_function"),
PythonCode: pulumi.String("def example_function() -> int: return 0"),
},
})
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 cesToolPythonFunctionBasic = new Gcp.Ces.Tool("ces_tool_python_function_basic", new()
{
Location = "us",
App = my_app.Name,
ToolId = "ces_tool_basic4",
ExecutionType = "SYNCHRONOUS",
PythonFunction = new Gcp.Ces.Inputs.ToolPythonFunctionArgs
{
Name = "example_function",
PythonCode = "def example_function() -> int: return 0",
},
});
});
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.Tool;
import com.pulumi.gcp.ces.ToolArgs;
import com.pulumi.gcp.ces.inputs.ToolPythonFunctionArgs;
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 cesToolPythonFunctionBasic = new Tool("cesToolPythonFunctionBasic", ToolArgs.builder()
.location("us")
.app(my_app.name())
.toolId("ces_tool_basic4")
.executionType("SYNCHRONOUS")
.pythonFunction(ToolPythonFunctionArgs.builder()
.name("example_function")
.pythonCode("def example_function() -> int: return 0")
.build())
.build());
}
}
resources:
my-app:
type: gcp:ces:App
properties:
location: us
displayName: my-app
appId: app-id
timeZoneSettings:
timeZone: America/Los_Angeles
cesToolPythonFunctionBasic:
type: gcp:ces:Tool
name: ces_tool_python_function_basic
properties:
location: us
app: ${["my-app"].name}
toolId: ces_tool_basic4
executionType: SYNCHRONOUS
pythonFunction:
name: example_function
pythonCode: 'def example_function() -> int: return 0'
Create Tool Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Tool(name: string, args: ToolArgs, opts?: CustomResourceOptions);@overload
def Tool(resource_name: str,
args: ToolArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Tool(resource_name: str,
opts: Optional[ResourceOptions] = None,
app: Optional[str] = None,
location: Optional[str] = None,
tool_id: Optional[str] = None,
client_function: Optional[ToolClientFunctionArgs] = None,
data_store_tool: Optional[ToolDataStoreToolArgs] = None,
execution_type: Optional[str] = None,
google_search_tool: Optional[ToolGoogleSearchToolArgs] = None,
project: Optional[str] = None,
python_function: Optional[ToolPythonFunctionArgs] = None)func NewTool(ctx *Context, name string, args ToolArgs, opts ...ResourceOption) (*Tool, error)public Tool(string name, ToolArgs args, CustomResourceOptions? opts = null)type: gcp:ces:Tool
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 ToolArgs
- 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 ToolArgs
- 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 ToolArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ToolArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ToolArgs
- 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 toolResource = new Gcp.Ces.Tool("toolResource", new()
{
App = "string",
Location = "string",
ToolId = "string",
ClientFunction = new Gcp.Ces.Inputs.ToolClientFunctionArgs
{
Name = "string",
Description = "string",
Parameters = new Gcp.Ces.Inputs.ToolClientFunctionParametersArgs
{
Type = "string",
Items = "string",
Default = "string",
Defs = "string",
Description = "string",
Enums = new[]
{
"string",
},
AdditionalProperties = "string",
Nullable = false,
PrefixItems = "string",
Properties = "string",
Ref = "string",
Requireds = new[]
{
"string",
},
AnyOf = "string",
UniqueItems = false,
},
Response = new Gcp.Ces.Inputs.ToolClientFunctionResponseArgs
{
Type = "string",
Items = "string",
Default = "string",
Defs = "string",
Description = "string",
Enums = new[]
{
"string",
},
AdditionalProperties = "string",
Nullable = false,
PrefixItems = "string",
Properties = "string",
Ref = "string",
Requireds = new[]
{
"string",
},
AnyOf = "string",
UniqueItems = false,
},
},
DataStoreTool = new Gcp.Ces.Inputs.ToolDataStoreToolArgs
{
Name = "string",
BoostSpecs = new[]
{
new Gcp.Ces.Inputs.ToolDataStoreToolBoostSpecArgs
{
DataStores = new[]
{
"string",
},
Specs = new[]
{
new Gcp.Ces.Inputs.ToolDataStoreToolBoostSpecSpecArgs
{
ConditionBoostSpecs = new[]
{
new Gcp.Ces.Inputs.ToolDataStoreToolBoostSpecSpecConditionBoostSpecArgs
{
Condition = "string",
Boost = 0,
BoostControlSpec = new Gcp.Ces.Inputs.ToolDataStoreToolBoostSpecSpecConditionBoostSpecBoostControlSpecArgs
{
AttributeType = "string",
ControlPoints = new[]
{
new Gcp.Ces.Inputs.ToolDataStoreToolBoostSpecSpecConditionBoostSpecBoostControlSpecControlPointArgs
{
AttributeValue = "string",
BoostAmount = 0,
},
},
FieldName = "string",
InterpolationType = "string",
},
},
},
},
},
},
},
Description = "string",
EngineSource = new Gcp.Ces.Inputs.ToolDataStoreToolEngineSourceArgs
{
Engine = "string",
DataStoreSources = new[]
{
new Gcp.Ces.Inputs.ToolDataStoreToolEngineSourceDataStoreSourceArgs
{
DataStore = new Gcp.Ces.Inputs.ToolDataStoreToolEngineSourceDataStoreSourceDataStoreArgs
{
Name = "string",
ConnectorConfigs = new[]
{
new Gcp.Ces.Inputs.ToolDataStoreToolEngineSourceDataStoreSourceDataStoreConnectorConfigArgs
{
Collection = "string",
CollectionDisplayName = "string",
DataSource = "string",
},
},
CreateTime = "string",
DisplayName = "string",
DocumentProcessingMode = "string",
Type = "string",
},
Filter = "string",
},
},
Filter = "string",
},
MaxResults = 0,
ModalityConfigs = new[]
{
new Gcp.Ces.Inputs.ToolDataStoreToolModalityConfigArgs
{
ModalityType = "string",
GroundingConfig = new Gcp.Ces.Inputs.ToolDataStoreToolModalityConfigGroundingConfigArgs
{
Disabled = false,
GroundingLevel = 0,
},
RewriterConfig = new Gcp.Ces.Inputs.ToolDataStoreToolModalityConfigRewriterConfigArgs
{
ModelSettings = new Gcp.Ces.Inputs.ToolDataStoreToolModalityConfigRewriterConfigModelSettingsArgs
{
Model = "string",
Temperature = 0,
},
Disabled = false,
Prompt = "string",
},
SummarizationConfig = new Gcp.Ces.Inputs.ToolDataStoreToolModalityConfigSummarizationConfigArgs
{
Disabled = false,
ModelSettings = new Gcp.Ces.Inputs.ToolDataStoreToolModalityConfigSummarizationConfigModelSettingsArgs
{
Model = "string",
Temperature = 0,
},
Prompt = "string",
},
},
},
},
ExecutionType = "string",
GoogleSearchTool = new Gcp.Ces.Inputs.ToolGoogleSearchToolArgs
{
Name = "string",
Description = "string",
ExcludeDomains = new[]
{
"string",
},
},
Project = "string",
PythonFunction = new Gcp.Ces.Inputs.ToolPythonFunctionArgs
{
Description = "string",
Name = "string",
PythonCode = "string",
},
});
example, err := ces.NewTool(ctx, "toolResource", &ces.ToolArgs{
App: pulumi.String("string"),
Location: pulumi.String("string"),
ToolId: pulumi.String("string"),
ClientFunction: &ces.ToolClientFunctionArgs{
Name: pulumi.String("string"),
Description: pulumi.String("string"),
Parameters: &ces.ToolClientFunctionParametersArgs{
Type: pulumi.String("string"),
Items: pulumi.String("string"),
Default: pulumi.String("string"),
Defs: pulumi.String("string"),
Description: pulumi.String("string"),
Enums: pulumi.StringArray{
pulumi.String("string"),
},
AdditionalProperties: pulumi.String("string"),
Nullable: pulumi.Bool(false),
PrefixItems: pulumi.String("string"),
Properties: pulumi.String("string"),
Ref: pulumi.String("string"),
Requireds: pulumi.StringArray{
pulumi.String("string"),
},
AnyOf: pulumi.String("string"),
UniqueItems: pulumi.Bool(false),
},
Response: &ces.ToolClientFunctionResponseArgs{
Type: pulumi.String("string"),
Items: pulumi.String("string"),
Default: pulumi.String("string"),
Defs: pulumi.String("string"),
Description: pulumi.String("string"),
Enums: pulumi.StringArray{
pulumi.String("string"),
},
AdditionalProperties: pulumi.String("string"),
Nullable: pulumi.Bool(false),
PrefixItems: pulumi.String("string"),
Properties: pulumi.String("string"),
Ref: pulumi.String("string"),
Requireds: pulumi.StringArray{
pulumi.String("string"),
},
AnyOf: pulumi.String("string"),
UniqueItems: pulumi.Bool(false),
},
},
DataStoreTool: &ces.ToolDataStoreToolArgs{
Name: pulumi.String("string"),
BoostSpecs: ces.ToolDataStoreToolBoostSpecArray{
&ces.ToolDataStoreToolBoostSpecArgs{
DataStores: pulumi.StringArray{
pulumi.String("string"),
},
Specs: ces.ToolDataStoreToolBoostSpecSpecArray{
&ces.ToolDataStoreToolBoostSpecSpecArgs{
ConditionBoostSpecs: ces.ToolDataStoreToolBoostSpecSpecConditionBoostSpecArray{
&ces.ToolDataStoreToolBoostSpecSpecConditionBoostSpecArgs{
Condition: pulumi.String("string"),
Boost: pulumi.Float64(0),
BoostControlSpec: &ces.ToolDataStoreToolBoostSpecSpecConditionBoostSpecBoostControlSpecArgs{
AttributeType: pulumi.String("string"),
ControlPoints: ces.ToolDataStoreToolBoostSpecSpecConditionBoostSpecBoostControlSpecControlPointArray{
&ces.ToolDataStoreToolBoostSpecSpecConditionBoostSpecBoostControlSpecControlPointArgs{
AttributeValue: pulumi.String("string"),
BoostAmount: pulumi.Float64(0),
},
},
FieldName: pulumi.String("string"),
InterpolationType: pulumi.String("string"),
},
},
},
},
},
},
},
Description: pulumi.String("string"),
EngineSource: &ces.ToolDataStoreToolEngineSourceArgs{
Engine: pulumi.String("string"),
DataStoreSources: ces.ToolDataStoreToolEngineSourceDataStoreSourceArray{
&ces.ToolDataStoreToolEngineSourceDataStoreSourceArgs{
DataStore: &ces.ToolDataStoreToolEngineSourceDataStoreSourceDataStoreArgs{
Name: pulumi.String("string"),
ConnectorConfigs: ces.ToolDataStoreToolEngineSourceDataStoreSourceDataStoreConnectorConfigArray{
&ces.ToolDataStoreToolEngineSourceDataStoreSourceDataStoreConnectorConfigArgs{
Collection: pulumi.String("string"),
CollectionDisplayName: pulumi.String("string"),
DataSource: pulumi.String("string"),
},
},
CreateTime: pulumi.String("string"),
DisplayName: pulumi.String("string"),
DocumentProcessingMode: pulumi.String("string"),
Type: pulumi.String("string"),
},
Filter: pulumi.String("string"),
},
},
Filter: pulumi.String("string"),
},
MaxResults: pulumi.Int(0),
ModalityConfigs: ces.ToolDataStoreToolModalityConfigArray{
&ces.ToolDataStoreToolModalityConfigArgs{
ModalityType: pulumi.String("string"),
GroundingConfig: &ces.ToolDataStoreToolModalityConfigGroundingConfigArgs{
Disabled: pulumi.Bool(false),
GroundingLevel: pulumi.Float64(0),
},
RewriterConfig: &ces.ToolDataStoreToolModalityConfigRewriterConfigArgs{
ModelSettings: &ces.ToolDataStoreToolModalityConfigRewriterConfigModelSettingsArgs{
Model: pulumi.String("string"),
Temperature: pulumi.Float64(0),
},
Disabled: pulumi.Bool(false),
Prompt: pulumi.String("string"),
},
SummarizationConfig: &ces.ToolDataStoreToolModalityConfigSummarizationConfigArgs{
Disabled: pulumi.Bool(false),
ModelSettings: &ces.ToolDataStoreToolModalityConfigSummarizationConfigModelSettingsArgs{
Model: pulumi.String("string"),
Temperature: pulumi.Float64(0),
},
Prompt: pulumi.String("string"),
},
},
},
},
ExecutionType: pulumi.String("string"),
GoogleSearchTool: &ces.ToolGoogleSearchToolArgs{
Name: pulumi.String("string"),
Description: pulumi.String("string"),
ExcludeDomains: pulumi.StringArray{
pulumi.String("string"),
},
},
Project: pulumi.String("string"),
PythonFunction: &ces.ToolPythonFunctionArgs{
Description: pulumi.String("string"),
Name: pulumi.String("string"),
PythonCode: pulumi.String("string"),
},
})
var toolResource = new Tool("toolResource", ToolArgs.builder()
.app("string")
.location("string")
.toolId("string")
.clientFunction(ToolClientFunctionArgs.builder()
.name("string")
.description("string")
.parameters(ToolClientFunctionParametersArgs.builder()
.type("string")
.items("string")
.default_("string")
.defs("string")
.description("string")
.enums("string")
.additionalProperties("string")
.nullable(false)
.prefixItems("string")
.properties("string")
.ref("string")
.requireds("string")
.anyOf("string")
.uniqueItems(false)
.build())
.response(ToolClientFunctionResponseArgs.builder()
.type("string")
.items("string")
.default_("string")
.defs("string")
.description("string")
.enums("string")
.additionalProperties("string")
.nullable(false)
.prefixItems("string")
.properties("string")
.ref("string")
.requireds("string")
.anyOf("string")
.uniqueItems(false)
.build())
.build())
.dataStoreTool(ToolDataStoreToolArgs.builder()
.name("string")
.boostSpecs(ToolDataStoreToolBoostSpecArgs.builder()
.dataStores("string")
.specs(ToolDataStoreToolBoostSpecSpecArgs.builder()
.conditionBoostSpecs(ToolDataStoreToolBoostSpecSpecConditionBoostSpecArgs.builder()
.condition("string")
.boost(0.0)
.boostControlSpec(ToolDataStoreToolBoostSpecSpecConditionBoostSpecBoostControlSpecArgs.builder()
.attributeType("string")
.controlPoints(ToolDataStoreToolBoostSpecSpecConditionBoostSpecBoostControlSpecControlPointArgs.builder()
.attributeValue("string")
.boostAmount(0.0)
.build())
.fieldName("string")
.interpolationType("string")
.build())
.build())
.build())
.build())
.description("string")
.engineSource(ToolDataStoreToolEngineSourceArgs.builder()
.engine("string")
.dataStoreSources(ToolDataStoreToolEngineSourceDataStoreSourceArgs.builder()
.dataStore(ToolDataStoreToolEngineSourceDataStoreSourceDataStoreArgs.builder()
.name("string")
.connectorConfigs(ToolDataStoreToolEngineSourceDataStoreSourceDataStoreConnectorConfigArgs.builder()
.collection("string")
.collectionDisplayName("string")
.dataSource("string")
.build())
.createTime("string")
.displayName("string")
.documentProcessingMode("string")
.type("string")
.build())
.filter("string")
.build())
.filter("string")
.build())
.maxResults(0)
.modalityConfigs(ToolDataStoreToolModalityConfigArgs.builder()
.modalityType("string")
.groundingConfig(ToolDataStoreToolModalityConfigGroundingConfigArgs.builder()
.disabled(false)
.groundingLevel(0.0)
.build())
.rewriterConfig(ToolDataStoreToolModalityConfigRewriterConfigArgs.builder()
.modelSettings(ToolDataStoreToolModalityConfigRewriterConfigModelSettingsArgs.builder()
.model("string")
.temperature(0.0)
.build())
.disabled(false)
.prompt("string")
.build())
.summarizationConfig(ToolDataStoreToolModalityConfigSummarizationConfigArgs.builder()
.disabled(false)
.modelSettings(ToolDataStoreToolModalityConfigSummarizationConfigModelSettingsArgs.builder()
.model("string")
.temperature(0.0)
.build())
.prompt("string")
.build())
.build())
.build())
.executionType("string")
.googleSearchTool(ToolGoogleSearchToolArgs.builder()
.name("string")
.description("string")
.excludeDomains("string")
.build())
.project("string")
.pythonFunction(ToolPythonFunctionArgs.builder()
.description("string")
.name("string")
.pythonCode("string")
.build())
.build());
tool_resource = gcp.ces.Tool("toolResource",
app="string",
location="string",
tool_id="string",
client_function={
"name": "string",
"description": "string",
"parameters": {
"type": "string",
"items": "string",
"default": "string",
"defs": "string",
"description": "string",
"enums": ["string"],
"additional_properties": "string",
"nullable": False,
"prefix_items": "string",
"properties": "string",
"ref": "string",
"requireds": ["string"],
"any_of": "string",
"unique_items": False,
},
"response": {
"type": "string",
"items": "string",
"default": "string",
"defs": "string",
"description": "string",
"enums": ["string"],
"additional_properties": "string",
"nullable": False,
"prefix_items": "string",
"properties": "string",
"ref": "string",
"requireds": ["string"],
"any_of": "string",
"unique_items": False,
},
},
data_store_tool={
"name": "string",
"boost_specs": [{
"data_stores": ["string"],
"specs": [{
"condition_boost_specs": [{
"condition": "string",
"boost": 0,
"boost_control_spec": {
"attribute_type": "string",
"control_points": [{
"attribute_value": "string",
"boost_amount": 0,
}],
"field_name": "string",
"interpolation_type": "string",
},
}],
}],
}],
"description": "string",
"engine_source": {
"engine": "string",
"data_store_sources": [{
"data_store": {
"name": "string",
"connector_configs": [{
"collection": "string",
"collection_display_name": "string",
"data_source": "string",
}],
"create_time": "string",
"display_name": "string",
"document_processing_mode": "string",
"type": "string",
},
"filter": "string",
}],
"filter": "string",
},
"max_results": 0,
"modality_configs": [{
"modality_type": "string",
"grounding_config": {
"disabled": False,
"grounding_level": 0,
},
"rewriter_config": {
"model_settings": {
"model": "string",
"temperature": 0,
},
"disabled": False,
"prompt": "string",
},
"summarization_config": {
"disabled": False,
"model_settings": {
"model": "string",
"temperature": 0,
},
"prompt": "string",
},
}],
},
execution_type="string",
google_search_tool={
"name": "string",
"description": "string",
"exclude_domains": ["string"],
},
project="string",
python_function={
"description": "string",
"name": "string",
"python_code": "string",
})
const toolResource = new gcp.ces.Tool("toolResource", {
app: "string",
location: "string",
toolId: "string",
clientFunction: {
name: "string",
description: "string",
parameters: {
type: "string",
items: "string",
"default": "string",
defs: "string",
description: "string",
enums: ["string"],
additionalProperties: "string",
nullable: false,
prefixItems: "string",
properties: "string",
ref: "string",
requireds: ["string"],
anyOf: "string",
uniqueItems: false,
},
response: {
type: "string",
items: "string",
"default": "string",
defs: "string",
description: "string",
enums: ["string"],
additionalProperties: "string",
nullable: false,
prefixItems: "string",
properties: "string",
ref: "string",
requireds: ["string"],
anyOf: "string",
uniqueItems: false,
},
},
dataStoreTool: {
name: "string",
boostSpecs: [{
dataStores: ["string"],
specs: [{
conditionBoostSpecs: [{
condition: "string",
boost: 0,
boostControlSpec: {
attributeType: "string",
controlPoints: [{
attributeValue: "string",
boostAmount: 0,
}],
fieldName: "string",
interpolationType: "string",
},
}],
}],
}],
description: "string",
engineSource: {
engine: "string",
dataStoreSources: [{
dataStore: {
name: "string",
connectorConfigs: [{
collection: "string",
collectionDisplayName: "string",
dataSource: "string",
}],
createTime: "string",
displayName: "string",
documentProcessingMode: "string",
type: "string",
},
filter: "string",
}],
filter: "string",
},
maxResults: 0,
modalityConfigs: [{
modalityType: "string",
groundingConfig: {
disabled: false,
groundingLevel: 0,
},
rewriterConfig: {
modelSettings: {
model: "string",
temperature: 0,
},
disabled: false,
prompt: "string",
},
summarizationConfig: {
disabled: false,
modelSettings: {
model: "string",
temperature: 0,
},
prompt: "string",
},
}],
},
executionType: "string",
googleSearchTool: {
name: "string",
description: "string",
excludeDomains: ["string"],
},
project: "string",
pythonFunction: {
description: "string",
name: "string",
pythonCode: "string",
},
});
type: gcp:ces:Tool
properties:
app: string
clientFunction:
description: string
name: string
parameters:
additionalProperties: string
anyOf: string
default: string
defs: string
description: string
enums:
- string
items: string
nullable: false
prefixItems: string
properties: string
ref: string
requireds:
- string
type: string
uniqueItems: false
response:
additionalProperties: string
anyOf: string
default: string
defs: string
description: string
enums:
- string
items: string
nullable: false
prefixItems: string
properties: string
ref: string
requireds:
- string
type: string
uniqueItems: false
dataStoreTool:
boostSpecs:
- dataStores:
- string
specs:
- conditionBoostSpecs:
- boost: 0
boostControlSpec:
attributeType: string
controlPoints:
- attributeValue: string
boostAmount: 0
fieldName: string
interpolationType: string
condition: string
description: string
engineSource:
dataStoreSources:
- dataStore:
connectorConfigs:
- collection: string
collectionDisplayName: string
dataSource: string
createTime: string
displayName: string
documentProcessingMode: string
name: string
type: string
filter: string
engine: string
filter: string
maxResults: 0
modalityConfigs:
- groundingConfig:
disabled: false
groundingLevel: 0
modalityType: string
rewriterConfig:
disabled: false
modelSettings:
model: string
temperature: 0
prompt: string
summarizationConfig:
disabled: false
modelSettings:
model: string
temperature: 0
prompt: string
name: string
executionType: string
googleSearchTool:
description: string
excludeDomains:
- string
name: string
location: string
project: string
pythonFunction:
description: string
name: string
pythonCode: string
toolId: string
Tool 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 Tool 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. - 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. - Tool
Id string - The ID to use for the tool, which will become the final component of the tool's resource name. If not provided, a unique ID will be automatically assigned for the tool.
- Client
Function ToolClient Function - 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.
- Data
Store ToolTool Data Store Tool - 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.
- Execution
Type string - Possible values: SYNCHRONOUS ASYNCHRONOUS
- Google
Search ToolTool Google Search Tool - 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.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Python
Function ToolPython Function - A Python function tool. 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. - 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. - Tool
Id string - The ID to use for the tool, which will become the final component of the tool's resource name. If not provided, a unique ID will be automatically assigned for the tool.
- Client
Function ToolClient Function Args - 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.
- Data
Store ToolTool Data Store Tool Args - 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.
- Execution
Type string - Possible values: SYNCHRONOUS ASYNCHRONOUS
- Google
Search ToolTool Google Search Tool Args - 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.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Python
Function ToolPython Function Args - A Python function tool. 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. - 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. - tool
Id String - The ID to use for the tool, which will become the final component of the tool's resource name. If not provided, a unique ID will be automatically assigned for the tool.
- client
Function ToolClient Function - 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.
- data
Store ToolTool Data Store Tool - 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.
- execution
Type String - Possible values: SYNCHRONOUS ASYNCHRONOUS
- google
Search ToolTool Google Search Tool - 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.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- python
Function ToolPython Function - A Python function tool. 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. - 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. - tool
Id string - The ID to use for the tool, which will become the final component of the tool's resource name. If not provided, a unique ID will be automatically assigned for the tool.
- client
Function ToolClient Function - 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.
- data
Store ToolTool Data Store Tool - 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.
- execution
Type string - Possible values: SYNCHRONOUS ASYNCHRONOUS
- google
Search ToolTool Google Search Tool - 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.
- project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- python
Function ToolPython Function - A Python function tool. 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. - 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. - tool_
id str - The ID to use for the tool, which will become the final component of the tool's resource name. If not provided, a unique ID will be automatically assigned for the tool.
- client_
function ToolClient Function Args - 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.
- data_
store_ Tooltool Data Store Tool Args - 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.
- execution_
type str - Possible values: SYNCHRONOUS ASYNCHRONOUS
- google_
search_ Tooltool Google Search Tool Args - 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.
- project str
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- python_
function ToolPython Function Args - A Python function tool. 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. - 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. - tool
Id String - The ID to use for the tool, which will become the final component of the tool's resource name. If not provided, a unique ID will be automatically assigned for the tool.
- client
Function Property Map - 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.
- data
Store Property MapTool - 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.
- execution
Type String - Possible values: SYNCHRONOUS ASYNCHRONOUS
- google
Search Property MapTool - 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.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- python
Function Property Map - A Python function tool. Structure is documented below.
Outputs
All input properties are implicitly available as output properties. Additionally, the Tool resource produces the following output properties:
- Create
Time string - Timestamp when the tool was created.
- Display
Name string - (Output) The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
- Etag string
- 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 - If the tool is generated by the LLM assistant, this field contains a descriptive summary of the generation.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- (Output) The name of the system tool.
- Open
Api List<ToolTools Open Api Tool> - A remote API tool defined by an OpenAPI schema. Structure is documented below.
- System
Tools List<ToolSystem Tool> - The system tool. Structure is documented below.
- Update
Time string - Timestamp when the tool was last updated.
- Create
Time string - Timestamp when the tool was created.
- Display
Name string - (Output) The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
- Etag string
- 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 - If the tool is generated by the LLM assistant, this field contains a descriptive summary of the generation.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- (Output) The name of the system tool.
- Open
Api []ToolTools Open Api Tool - A remote API tool defined by an OpenAPI schema. Structure is documented below.
- System
Tools []ToolSystem Tool - The system tool. Structure is documented below.
- Update
Time string - Timestamp when the tool was last updated.
- create
Time String - Timestamp when the tool was created.
- display
Name String - (Output) The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
- etag String
- 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 - If the tool is generated by the LLM assistant, this field contains a descriptive summary of the generation.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- (Output) The name of the system tool.
- open
Api List<ToolTools Open Api Tool> - A remote API tool defined by an OpenAPI schema. Structure is documented below.
- system
Tools List<ToolSystem Tool> - The system tool. Structure is documented below.
- update
Time String - Timestamp when the tool was last updated.
- create
Time string - Timestamp when the tool was created.
- display
Name string - (Output) The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
- etag string
- 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 - If the tool is generated by the LLM assistant, this field contains a descriptive summary of the generation.
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- (Output) The name of the system tool.
- open
Api ToolTools Open Api Tool[] - A remote API tool defined by an OpenAPI schema. Structure is documented below.
- system
Tools ToolSystem Tool[] - The system tool. Structure is documented below.
- update
Time string - Timestamp when the tool was last updated.
- create_
time str - Timestamp when the tool was created.
- display_
name str - (Output) The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
- etag str
- 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 - If the tool is generated by the LLM assistant, this field contains a descriptive summary of the generation.
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- (Output) The name of the system tool.
- open_
api_ Sequence[Tooltools Open Api Tool] - A remote API tool defined by an OpenAPI schema. Structure is documented below.
- system_
tools Sequence[ToolSystem Tool] - The system tool. Structure is documented below.
- update_
time str - Timestamp when the tool was last updated.
- create
Time String - Timestamp when the tool was created.
- display
Name String - (Output) The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
- etag String
- 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 - If the tool is generated by the LLM assistant, this field contains a descriptive summary of the generation.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- (Output) The name of the system tool.
- open
Api List<Property Map>Tools - A remote API tool defined by an OpenAPI schema. Structure is documented below.
- system
Tools List<Property Map> - The system tool. Structure is documented below.
- update
Time String - Timestamp when the tool was last updated.
Look up Existing Tool Resource
Get an existing Tool 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?: ToolState, opts?: CustomResourceOptions): Tool@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
app: Optional[str] = None,
client_function: Optional[ToolClientFunctionArgs] = None,
create_time: Optional[str] = None,
data_store_tool: Optional[ToolDataStoreToolArgs] = None,
display_name: Optional[str] = None,
etag: Optional[str] = None,
execution_type: Optional[str] = None,
generated_summary: Optional[str] = None,
google_search_tool: Optional[ToolGoogleSearchToolArgs] = None,
location: Optional[str] = None,
name: Optional[str] = None,
open_api_tools: Optional[Sequence[ToolOpenApiToolArgs]] = None,
project: Optional[str] = None,
python_function: Optional[ToolPythonFunctionArgs] = None,
system_tools: Optional[Sequence[ToolSystemToolArgs]] = None,
tool_id: Optional[str] = None,
update_time: Optional[str] = None) -> Toolfunc GetTool(ctx *Context, name string, id IDInput, state *ToolState, opts ...ResourceOption) (*Tool, error)public static Tool Get(string name, Input<string> id, ToolState? state, CustomResourceOptions? opts = null)public static Tool get(String name, Output<String> id, ToolState state, CustomResourceOptions options)resources: _: type: gcp:ces:Tool 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. - Client
Function ToolClient Function - 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 - Timestamp when the tool was created.
- Data
Store ToolTool Data Store Tool - 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 - (Output) The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
- Etag string
- 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 - Possible values: SYNCHRONOUS ASYNCHRONOUS
- Generated
Summary string - If the tool is generated by the LLM assistant, this field contains a descriptive summary of the generation.
- Google
Search ToolTool Google Search Tool - 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.
- 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) The name of the system tool.
- Open
Api List<ToolTools Open Api Tool> - A remote API tool defined by an OpenAPI schema. Structure is documented below.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Python
Function ToolPython Function - A Python function tool. Structure is documented below.
- System
Tools List<ToolSystem Tool> - The system tool. Structure is documented below.
- Tool
Id string - The ID to use for the tool, which will become the final component of the tool's resource name. If not provided, a unique ID will be automatically assigned for the tool.
- Update
Time string - Timestamp when the tool was last updated.
- 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. - Client
Function ToolClient Function Args - 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 - Timestamp when the tool was created.
- Data
Store ToolTool Data Store Tool Args - 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 - (Output) The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
- Etag string
- 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 - Possible values: SYNCHRONOUS ASYNCHRONOUS
- Generated
Summary string - If the tool is generated by the LLM assistant, this field contains a descriptive summary of the generation.
- Google
Search ToolTool Google Search Tool Args - 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.
- 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) The name of the system tool.
- Open
Api []ToolTools Open Api Tool Args - A remote API tool defined by an OpenAPI schema. Structure is documented below.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Python
Function ToolPython Function Args - A Python function tool. Structure is documented below.
- System
Tools []ToolSystem Tool Args - The system tool. Structure is documented below.
- Tool
Id string - The ID to use for the tool, which will become the final component of the tool's resource name. If not provided, a unique ID will be automatically assigned for the tool.
- Update
Time string - Timestamp when the tool was last updated.
- 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. - client
Function ToolClient Function - 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 - Timestamp when the tool was created.
- data
Store ToolTool Data Store Tool - 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 - (Output) The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
- etag String
- 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 - Possible values: SYNCHRONOUS ASYNCHRONOUS
- generated
Summary String - If the tool is generated by the LLM assistant, this field contains a descriptive summary of the generation.
- google
Search ToolTool Google Search Tool - 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.
- 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) The name of the system tool.
- open
Api List<ToolTools Open Api Tool> - A remote API tool defined by an OpenAPI schema. Structure is documented below.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- python
Function ToolPython Function - A Python function tool. Structure is documented below.
- system
Tools List<ToolSystem Tool> - The system tool. Structure is documented below.
- tool
Id String - The ID to use for the tool, which will become the final component of the tool's resource name. If not provided, a unique ID will be automatically assigned for the tool.
- update
Time String - Timestamp when the tool was last updated.
- 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. - client
Function ToolClient Function - 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 - Timestamp when the tool was created.
- data
Store ToolTool Data Store Tool - 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 - (Output) The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
- etag string
- 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 - Possible values: SYNCHRONOUS ASYNCHRONOUS
- generated
Summary string - If the tool is generated by the LLM assistant, this field contains a descriptive summary of the generation.
- google
Search ToolTool Google Search Tool - 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.
- 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) The name of the system tool.
- open
Api ToolTools Open Api Tool[] - A remote API tool defined by an OpenAPI schema. Structure is documented below.
- project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- python
Function ToolPython Function - A Python function tool. Structure is documented below.
- system
Tools ToolSystem Tool[] - The system tool. Structure is documented below.
- tool
Id string - The ID to use for the tool, which will become the final component of the tool's resource name. If not provided, a unique ID will be automatically assigned for the tool.
- update
Time string - Timestamp when the tool was last updated.
- 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. - client_
function ToolClient Function Args - 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 - Timestamp when the tool was created.
- data_
store_ Tooltool Data Store Tool Args - 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 - (Output) The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
- etag str
- 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 - Possible values: SYNCHRONOUS ASYNCHRONOUS
- generated_
summary str - If the tool is generated by the LLM assistant, this field contains a descriptive summary of the generation.
- google_
search_ Tooltool Google Search Tool Args - 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.
- 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) The name of the system tool.
- open_
api_ Sequence[Tooltools Open Api Tool Args] - A remote API tool defined by an OpenAPI schema. Structure is documented below.
- project str
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- python_
function ToolPython Function Args - A Python function tool. Structure is documented below.
- system_
tools Sequence[ToolSystem Tool Args] - The system tool. Structure is documented below.
- tool_
id str - The ID to use for the tool, which will become the final component of the tool's resource name. If not provided, a unique ID will be automatically assigned for the tool.
- update_
time str - Timestamp when the tool was last updated.
- 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. - client
Function Property Map - 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 - Timestamp when the tool was created.
- data
Store Property MapTool - 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 - (Output) The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
- etag String
- 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 - Possible values: SYNCHRONOUS ASYNCHRONOUS
- generated
Summary String - If the tool is generated by the LLM assistant, this field contains a descriptive summary of the generation.
- google
Search Property MapTool - 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.
- 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) The name of the system tool.
- open
Api List<Property Map>Tools - A remote API tool defined by an OpenAPI schema. Structure is documented below.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- python
Function Property Map - A Python function tool. Structure is documented below.
- system
Tools List<Property Map> - The system tool. Structure is documented below.
- tool
Id String - The ID to use for the tool, which will become the final component of the tool's resource name. If not provided, a unique ID will be automatically assigned for the tool.
- update
Time String - Timestamp when the tool was last updated.
Supporting Types
ToolClientFunction, ToolClientFunctionArgs
- Name string
- The function name.
- Description string
- The function description.
- Parameters
Tool
Client Function Parameters - Represents a select subset of an OpenAPI 3.0 schema object. Structure is documented below.
- Response
Tool
Client Function Response - Represents a select subset of an OpenAPI 3.0 schema object. Structure is documented below.
- Name string
- The function name.
- Description string
- The function description.
- Parameters
Tool
Client Function Parameters - Represents a select subset of an OpenAPI 3.0 schema object. Structure is documented below.
- Response
Tool
Client Function Response - Represents a select subset of an OpenAPI 3.0 schema object. Structure is documented below.
- name String
- The function name.
- description String
- The function description.
- parameters
Tool
Client Function Parameters - Represents a select subset of an OpenAPI 3.0 schema object. Structure is documented below.
- response
Tool
Client Function Response - Represents a select subset of an OpenAPI 3.0 schema object. Structure is documented below.
- name string
- The function name.
- description string
- The function description.
- parameters
Tool
Client Function Parameters - Represents a select subset of an OpenAPI 3.0 schema object. Structure is documented below.
- response
Tool
Client Function Response - Represents a select subset of an OpenAPI 3.0 schema object. Structure is documented below.
- name str
- The function name.
- description str
- The function description.
- parameters
Tool
Client Function Parameters - Represents a select subset of an OpenAPI 3.0 schema object. Structure is documented below.
- response
Tool
Client Function Response - Represents a select subset of an OpenAPI 3.0 schema object. Structure is documented below.
- name String
- The function name.
- description String
- The function description.
- parameters Property Map
- Represents a select subset of an OpenAPI 3.0 schema object. Structure is documented below.
- response Property Map
- Represents a select subset of an OpenAPI 3.0 schema object. Structure is documented below.
ToolClientFunctionParameters, ToolClientFunctionParametersArgs
- Type string
- The type of the data. Possible values: STRING INTEGER NUMBER BOOLEAN OBJECT ARRAY
- Additional
Properties string - 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 - Optional. The instance value should be valid against at least one of the schemas in this list.
- Default string
- 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
- A map of definitions for use by ref. Only allowed at the root of the schema.
- Description string
- The description of the data.
- Enums List<string>
- 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
- Schema of the elements of Type.ARRAY.
- Nullable bool
- Indicates if the value may be null.
- Prefix
Items string - Optional. Schemas of initial elements of Type.ARRAY.
- Properties string
- Properties of Type.OBJECT.
- Ref string
- 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>
- Required properties of Type.OBJECT.
- Unique
Items bool - Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
- Type string
- The type of the data. Possible values: STRING INTEGER NUMBER BOOLEAN OBJECT ARRAY
- Additional
Properties string - 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 - Optional. The instance value should be valid against at least one of the schemas in this list.
- Default string
- 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
- A map of definitions for use by ref. Only allowed at the root of the schema.
- Description string
- The description of the data.
- Enums []string
- 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
- Schema of the elements of Type.ARRAY.
- Nullable bool
- Indicates if the value may be null.
- Prefix
Items string - Optional. Schemas of initial elements of Type.ARRAY.
- Properties string
- Properties of Type.OBJECT.
- Ref string
- 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
- Required properties of Type.OBJECT.
- Unique
Items bool - Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
- type String
- The type of the data. Possible values: STRING INTEGER NUMBER BOOLEAN OBJECT ARRAY
- additional
Properties String - 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 - Optional. The instance value should be valid against at least one of the schemas in this list.
- default_ String
- 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
- A map of definitions for use by ref. Only allowed at the root of the schema.
- description String
- The description of the data.
- enums List<String>
- 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
- Schema of the elements of Type.ARRAY.
- nullable Boolean
- Indicates if the value may be null.
- prefix
Items String - Optional. Schemas of initial elements of Type.ARRAY.
- properties String
- Properties of Type.OBJECT.
- ref String
- 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>
- Required properties of Type.OBJECT.
- unique
Items Boolean - Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
- type string
- The type of the data. Possible values: STRING INTEGER NUMBER BOOLEAN OBJECT ARRAY
- additional
Properties string - 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 - Optional. The instance value should be valid against at least one of the schemas in this list.
- default string
- 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
- A map of definitions for use by ref. Only allowed at the root of the schema.
- description string
- The description of the data.
- enums string[]
- 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
- Schema of the elements of Type.ARRAY.
- nullable boolean
- Indicates if the value may be null.
- prefix
Items string - Optional. Schemas of initial elements of Type.ARRAY.
- properties string
- Properties of Type.OBJECT.
- ref string
- 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[]
- Required properties of Type.OBJECT.
- unique
Items boolean - Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
- type str
- The type of the data. Possible values: STRING INTEGER NUMBER BOOLEAN OBJECT ARRAY
- additional_
properties str - 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 - Optional. The instance value should be valid against at least one of the schemas in this list.
- default str
- 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
- A map of definitions for use by ref. Only allowed at the root of the schema.
- description str
- The description of the data.
- enums Sequence[str]
- 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
- Schema of the elements of Type.ARRAY.
- nullable bool
- Indicates if the value may be null.
- prefix_
items str - Optional. Schemas of initial elements of Type.ARRAY.
- properties str
- Properties of Type.OBJECT.
- ref str
- 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]
- Required properties of Type.OBJECT.
- unique_
items bool - Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
- type String
- The type of the data. Possible values: STRING INTEGER NUMBER BOOLEAN OBJECT ARRAY
- additional
Properties String - 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 - Optional. The instance value should be valid against at least one of the schemas in this list.
- default String
- 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
- A map of definitions for use by ref. Only allowed at the root of the schema.
- description String
- The description of the data.
- enums List<String>
- 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
- Schema of the elements of Type.ARRAY.
- nullable Boolean
- Indicates if the value may be null.
- prefix
Items String - Optional. Schemas of initial elements of Type.ARRAY.
- properties String
- Properties of Type.OBJECT.
- ref String
- 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>
- Required properties of Type.OBJECT.
- unique
Items Boolean - Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
ToolClientFunctionResponse, ToolClientFunctionResponseArgs
- Type string
- The type of the data. Possible values: STRING INTEGER NUMBER BOOLEAN OBJECT ARRAY
- Additional
Properties string - 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 - Optional. The instance value should be valid against at least one of the schemas in this list.
- Default string
- 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
- A map of definitions for use by ref. Only allowed at the root of the schema.
- Description string
- The description of the data.
- Enums List<string>
- 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
- Schema of the elements of Type.ARRAY.
- Nullable bool
- Indicates if the value may be null.
- Prefix
Items string - Optional. Schemas of initial elements of Type.ARRAY.
- Properties string
- Properties of Type.OBJECT.
- Ref string
- 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>
- Required properties of Type.OBJECT.
- Unique
Items bool - Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
- Type string
- The type of the data. Possible values: STRING INTEGER NUMBER BOOLEAN OBJECT ARRAY
- Additional
Properties string - 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 - Optional. The instance value should be valid against at least one of the schemas in this list.
- Default string
- 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
- A map of definitions for use by ref. Only allowed at the root of the schema.
- Description string
- The description of the data.
- Enums []string
- 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
- Schema of the elements of Type.ARRAY.
- Nullable bool
- Indicates if the value may be null.
- Prefix
Items string - Optional. Schemas of initial elements of Type.ARRAY.
- Properties string
- Properties of Type.OBJECT.
- Ref string
- 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
- Required properties of Type.OBJECT.
- Unique
Items bool - Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
- type String
- The type of the data. Possible values: STRING INTEGER NUMBER BOOLEAN OBJECT ARRAY
- additional
Properties String - 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 - Optional. The instance value should be valid against at least one of the schemas in this list.
- default_ String
- 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
- A map of definitions for use by ref. Only allowed at the root of the schema.
- description String
- The description of the data.
- enums List<String>
- 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
- Schema of the elements of Type.ARRAY.
- nullable Boolean
- Indicates if the value may be null.
- prefix
Items String - Optional. Schemas of initial elements of Type.ARRAY.
- properties String
- Properties of Type.OBJECT.
- ref String
- 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>
- Required properties of Type.OBJECT.
- unique
Items Boolean - Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
- type string
- The type of the data. Possible values: STRING INTEGER NUMBER BOOLEAN OBJECT ARRAY
- additional
Properties string - 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 - Optional. The instance value should be valid against at least one of the schemas in this list.
- default string
- 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
- A map of definitions for use by ref. Only allowed at the root of the schema.
- description string
- The description of the data.
- enums string[]
- 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
- Schema of the elements of Type.ARRAY.
- nullable boolean
- Indicates if the value may be null.
- prefix
Items string - Optional. Schemas of initial elements of Type.ARRAY.
- properties string
- Properties of Type.OBJECT.
- ref string
- 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[]
- Required properties of Type.OBJECT.
- unique
Items boolean - Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
- type str
- The type of the data. Possible values: STRING INTEGER NUMBER BOOLEAN OBJECT ARRAY
- additional_
properties str - 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 - Optional. The instance value should be valid against at least one of the schemas in this list.
- default str
- 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
- A map of definitions for use by ref. Only allowed at the root of the schema.
- description str
- The description of the data.
- enums Sequence[str]
- 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
- Schema of the elements of Type.ARRAY.
- nullable bool
- Indicates if the value may be null.
- prefix_
items str - Optional. Schemas of initial elements of Type.ARRAY.
- properties str
- Properties of Type.OBJECT.
- ref str
- 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]
- Required properties of Type.OBJECT.
- unique_
items bool - Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
- type String
- The type of the data. Possible values: STRING INTEGER NUMBER BOOLEAN OBJECT ARRAY
- additional
Properties String - 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 - Optional. The instance value should be valid against at least one of the schemas in this list.
- default String
- 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
- A map of definitions for use by ref. Only allowed at the root of the schema.
- description String
- The description of the data.
- enums List<String>
- 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
- Schema of the elements of Type.ARRAY.
- nullable Boolean
- Indicates if the value may be null.
- prefix
Items String - Optional. Schemas of initial elements of Type.ARRAY.
- properties String
- Properties of Type.OBJECT.
- ref String
- 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>
- Required properties of Type.OBJECT.
- unique
Items Boolean - Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
ToolDataStoreTool, ToolDataStoreToolArgs
- Name string
- The data store tool name.
- Boost
Specs List<ToolData Store Tool Boost Spec> - Boost specification to boost certain documents. Structure is documented below.
- Description string
- The tool description.
- Engine
Source ToolData Store Tool Engine Source - Configuration for searching within an Engine, potentially targeting specific DataStores. Structure is documented below.
- Max
Results int - Number of search results to return per query. The default value is 10. The maximum allowed value is 10.
- Modality
Configs List<ToolData Store Tool Modality Config> - The modality configs for the data store. Structure is documented below.
- Name string
- The data store tool name.
- Boost
Specs []ToolData Store Tool Boost Spec - Boost specification to boost certain documents. Structure is documented below.
- Description string
- The tool description.
- Engine
Source ToolData Store Tool Engine Source - Configuration for searching within an Engine, potentially targeting specific DataStores. Structure is documented below.
- Max
Results int - Number of search results to return per query. The default value is 10. The maximum allowed value is 10.
- Modality
Configs []ToolData Store Tool Modality Config - The modality configs for the data store. Structure is documented below.
- name String
- The data store tool name.
- boost
Specs List<ToolData Store Tool Boost Spec> - Boost specification to boost certain documents. Structure is documented below.
- description String
- The tool description.
- engine
Source ToolData Store Tool Engine Source - Configuration for searching within an Engine, potentially targeting specific DataStores. Structure is documented below.
- max
Results Integer - Number of search results to return per query. The default value is 10. The maximum allowed value is 10.
- modality
Configs List<ToolData Store Tool Modality Config> - The modality configs for the data store. Structure is documented below.
- name string
- The data store tool name.
- boost
Specs ToolData Store Tool Boost Spec[] - Boost specification to boost certain documents. Structure is documented below.
- description string
- The tool description.
- engine
Source ToolData Store Tool Engine Source - Configuration for searching within an Engine, potentially targeting specific DataStores. Structure is documented below.
- max
Results number - Number of search results to return per query. The default value is 10. The maximum allowed value is 10.
- modality
Configs ToolData Store Tool Modality Config[] - The modality configs for the data store. Structure is documented below.
- name str
- The data store tool name.
- boost_
specs Sequence[ToolData Store Tool Boost Spec] - Boost specification to boost certain documents. Structure is documented below.
- description str
- The tool description.
- engine_
source ToolData Store Tool Engine Source - Configuration for searching within an Engine, potentially targeting specific DataStores. Structure is documented below.
- max_
results int - Number of search results to return per query. The default value is 10. The maximum allowed value is 10.
- modality_
configs Sequence[ToolData Store Tool Modality Config] - The modality configs for the data store. Structure is documented below.
- name String
- The data store tool name.
- boost
Specs List<Property Map> - Boost specification to boost certain documents. Structure is documented below.
- description String
- The tool description.
- engine
Source Property Map - Configuration for searching within an Engine, potentially targeting specific DataStores. Structure is documented below.
- max
Results Number - Number of search results to return per query. The default value is 10. The maximum allowed value is 10.
- modality
Configs List<Property Map> - The modality configs for the data store. Structure is documented below.
ToolDataStoreToolBoostSpec, ToolDataStoreToolBoostSpecArgs
- Data
Stores List<string> - 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<Tool
Data Store Tool Boost Spec Spec> - A list of boosting specifications. Structure is documented below.
- Data
Stores []string - 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
[]Tool
Data Store Tool Boost Spec Spec - A list of boosting specifications. Structure is documented below.
- data
Stores List<String> - 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<Tool
Data Store Tool Boost Spec Spec> - A list of boosting specifications. Structure is documented below.
- data
Stores string[] - 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
Tool
Data Store Tool Boost Spec Spec[] - A list of boosting specifications. Structure is documented below.
- data_
stores Sequence[str] - 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[Tool
Data Store Tool Boost Spec Spec] - A list of boosting specifications. Structure is documented below.
- data
Stores List<String> - 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>
- A list of boosting specifications. Structure is documented below.
ToolDataStoreToolBoostSpecSpec, ToolDataStoreToolBoostSpecSpecArgs
- Condition
Boost List<ToolSpecs Data Store Tool Boost Spec Spec Condition Boost Spec> - A list of boosting specifications. Structure is documented below.
- Condition
Boost []ToolSpecs Data Store Tool Boost Spec Spec Condition Boost Spec - A list of boosting specifications. Structure is documented below.
- condition
Boost List<ToolSpecs Data Store Tool Boost Spec Spec Condition Boost Spec> - A list of boosting specifications. Structure is documented below.
- condition
Boost ToolSpecs Data Store Tool Boost Spec Spec Condition Boost Spec[] - A list of boosting specifications. Structure is documented below.
- condition_
boost_ Sequence[Toolspecs Data Store Tool Boost Spec Spec Condition Boost Spec] - A list of boosting specifications. Structure is documented below.
- condition
Boost List<Property Map>Specs - A list of boosting specifications. Structure is documented below.
ToolDataStoreToolBoostSpecSpecConditionBoostSpec, ToolDataStoreToolBoostSpecSpecConditionBoostSpecArgs
- Condition string
- 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
- 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 ToolSpec Data Store Tool Boost Spec Spec Condition Boost Spec Boost Control Spec - 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
- 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
- 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 ToolSpec Data Store Tool Boost Spec Spec Condition Boost Spec Boost Control Spec - 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
- 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
- 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 ToolSpec Data Store Tool Boost Spec Spec Condition Boost Spec Boost Control Spec - 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
- 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
- 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 ToolSpec Data Store Tool Boost Spec Spec Condition Boost Spec Boost Control Spec - 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
- 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
- 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_ Toolspec Data Store Tool Boost Spec Spec Condition Boost Spec Boost Control Spec - 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
- 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
- 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 Property MapSpec - 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.
ToolDataStoreToolBoostSpecSpecConditionBoostSpecBoostControlSpec, ToolDataStoreToolBoostSpecSpecConditionBoostSpecBoostControlSpecArgs
- Attribute
Type string - 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<ToolData Store Tool Boost Spec Spec Condition Boost Spec Boost Control Spec Control Point> - 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 - The name of the field whose value will be used to determine the boost amount.
- Interpolation
Type string - The interpolation type to be applied to connect the control points listed below. Possible values: LINEAR
- Attribute
Type string - 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 []ToolData Store Tool Boost Spec Spec Condition Boost Spec Boost Control Spec Control Point - 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 - The name of the field whose value will be used to determine the boost amount.
- Interpolation
Type string - The interpolation type to be applied to connect the control points listed below. Possible values: LINEAR
- attribute
Type String - 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<ToolData Store Tool Boost Spec Spec Condition Boost Spec Boost Control Spec Control Point> - 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 - The name of the field whose value will be used to determine the boost amount.
- interpolation
Type String - The interpolation type to be applied to connect the control points listed below. Possible values: LINEAR
- attribute
Type string - 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 ToolData Store Tool Boost Spec Spec Condition Boost Spec Boost Control Spec Control Point[] - 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 - The name of the field whose value will be used to determine the boost amount.
- interpolation
Type string - The interpolation type to be applied to connect the control points listed below. Possible values: LINEAR
- attribute_
type str - 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[ToolData Store Tool Boost Spec Spec Condition Boost Spec Boost Control Spec Control Point] - 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 - The name of the field whose value will be used to determine the boost amount.
- interpolation_
type str - The interpolation type to be applied to connect the control points listed below. Possible values: LINEAR
- attribute
Type String - 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> - 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 - The name of the field whose value will be used to determine the boost amount.
- interpolation
Type String - The interpolation type to be applied to connect the control points listed below. Possible values: LINEAR
ToolDataStoreToolBoostSpecSpecConditionBoostSpecBoostControlSpecControlPoint, ToolDataStoreToolBoostSpecSpecConditionBoostSpecBoostControlSpecControlPointArgs
- Attribute
Value string - 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 - The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.
ToolDataStoreToolEngineSource, ToolDataStoreToolEngineSourceArgs
- Engine string
- Full resource name of the Engine.
Format:
projects/{project}/locations/{location}/collections/{collection}/engines/{engine} - Data
Store List<ToolSources Data Store Tool Engine Source Data Store Source> - Use to target specific DataStores within the Engine. If empty, the search applies to all DataStores associated with the Engine. Structure is documented below.
- Filter string
- A filter applied to the search across the Engine. Not relevant and not used if 'data_store_sources' is provided. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
- Engine string
- Full resource name of the Engine.
Format:
projects/{project}/locations/{location}/collections/{collection}/engines/{engine} - Data
Store []ToolSources Data Store Tool Engine Source Data Store Source - Use to target specific DataStores within the Engine. If empty, the search applies to all DataStores associated with the Engine. Structure is documented below.
- Filter string
- A filter applied to the search across the Engine. Not relevant and not used if 'data_store_sources' is provided. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
- engine String
- Full resource name of the Engine.
Format:
projects/{project}/locations/{location}/collections/{collection}/engines/{engine} - data
Store List<ToolSources Data Store Tool Engine Source Data Store Source> - Use to target specific DataStores within the Engine. If empty, the search applies to all DataStores associated with the Engine. Structure is documented below.
- filter String
- A filter applied to the search across the Engine. Not relevant and not used if 'data_store_sources' is provided. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
- engine string
- Full resource name of the Engine.
Format:
projects/{project}/locations/{location}/collections/{collection}/engines/{engine} - data
Store ToolSources Data Store Tool Engine Source Data Store Source[] - Use to target specific DataStores within the Engine. If empty, the search applies to all DataStores associated with the Engine. Structure is documented below.
- filter string
- A filter applied to the search across the Engine. Not relevant and not used if 'data_store_sources' is provided. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
- engine str
- Full resource name of the Engine.
Format:
projects/{project}/locations/{location}/collections/{collection}/engines/{engine} - data_
store_ Sequence[Toolsources Data Store Tool Engine Source Data Store Source] - Use to target specific DataStores within the Engine. If empty, the search applies to all DataStores associated with the Engine. Structure is documented below.
- filter str
- A filter applied to the search across the Engine. Not relevant and not used if 'data_store_sources' is provided. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
- engine String
- Full resource name of the Engine.
Format:
projects/{project}/locations/{location}/collections/{collection}/engines/{engine} - data
Store List<Property Map>Sources - Use to target specific DataStores within the Engine. If empty, the search applies to all DataStores associated with the Engine. Structure is documented below.
- filter String
- A filter applied to the search across the Engine. Not relevant and not used if 'data_store_sources' is provided. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
ToolDataStoreToolEngineSourceDataStoreSource, ToolDataStoreToolEngineSourceDataStoreSourceArgs
- Data
Store ToolData Store Tool Engine Source Data Store Source Data Store - A DataStore resource in Vertex AI Search. Structure is documented below.
- Filter string
- Filter specification for the DataStore. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
- Data
Store ToolData Store Tool Engine Source Data Store Source Data Store - A DataStore resource in Vertex AI Search. Structure is documented below.
- Filter string
- Filter specification for the DataStore. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
- data
Store ToolData Store Tool Engine Source Data Store Source Data Store - A DataStore resource in Vertex AI Search. Structure is documented below.
- filter String
- Filter specification for the DataStore. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
- data
Store ToolData Store Tool Engine Source Data Store Source Data Store - A DataStore resource in Vertex AI Search. Structure is documented below.
- filter string
- Filter specification for the DataStore. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
- data_
store ToolData Store Tool Engine Source Data Store Source Data Store - A DataStore resource in Vertex AI Search. Structure is documented below.
- filter str
- Filter specification for the DataStore. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
- data
Store Property Map - A DataStore resource in Vertex AI Search. Structure is documented below.
- filter String
- Filter specification for the DataStore. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
ToolDataStoreToolEngineSourceDataStoreSourceDataStore, ToolDataStoreToolEngineSourceDataStoreSourceDataStoreArgs
- Name string
- Full resource name of the DataStore.
Format:
projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore} - Connector
Configs List<ToolData 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 data store was created.
- Display
Name string - (Output) The display name of the data store.
- 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
- 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
<a name=<span pulumi-lang-nodejs=""nestedDataStoreToolEngineSourceDataStoreSourcesDataStoreSourcesDataStoreConnectorConfig"" pulumi-lang-dotnet=""NestedDataStoreToolEngineSourceDataStoreSourcesDataStoreSourcesDataStoreConnectorConfig"" pulumi-lang-go=""nestedDataStoreToolEngineSourceDataStoreSourcesDataStoreSourcesDataStoreConnectorConfig"" pulumi-lang-python=""nested_data_store_tool_engine_source_data_store_sources_data_store_sources_data_store_connector_config"" pulumi-lang-yaml=""nestedDataStoreToolEngineSourceDataStoreSourcesDataStoreSourcesDataStoreConnectorConfig"" pulumi-lang-java=""nestedDataStoreToolEngineSourceDataStoreSourcesDataStoreSourcesDataStoreConnectorConfig"">"nested_data_store_tool_engine_source_data_store_sources_data_store_sources_data_store_connector_config">The
connector_configblock contains:
- Name string
- Full resource name of the DataStore.
Format:
projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore} - Connector
Configs []ToolData 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 data store was created.
- Display
Name string - (Output) The display name of the data store.
- 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
- 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
<a name=<span pulumi-lang-nodejs=""nestedDataStoreToolEngineSourceDataStoreSourcesDataStoreSourcesDataStoreConnectorConfig"" pulumi-lang-dotnet=""NestedDataStoreToolEngineSourceDataStoreSourcesDataStoreSourcesDataStoreConnectorConfig"" pulumi-lang-go=""nestedDataStoreToolEngineSourceDataStoreSourcesDataStoreSourcesDataStoreConnectorConfig"" pulumi-lang-python=""nested_data_store_tool_engine_source_data_store_sources_data_store_sources_data_store_connector_config"" pulumi-lang-yaml=""nestedDataStoreToolEngineSourceDataStoreSourcesDataStoreSourcesDataStoreConnectorConfig"" pulumi-lang-java=""nestedDataStoreToolEngineSourceDataStoreSourcesDataStoreSourcesDataStoreConnectorConfig"">"nested_data_store_tool_engine_source_data_store_sources_data_store_sources_data_store_connector_config">The
connector_configblock contains:
- name String
- Full resource name of the DataStore.
Format:
projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore} - connector
Configs List<ToolData 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 data store was created.
- display
Name String - (Output) The display name of the data store.
- 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
- 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
<a name=<span pulumi-lang-nodejs=""nestedDataStoreToolEngineSourceDataStoreSourcesDataStoreSourcesDataStoreConnectorConfig"" pulumi-lang-dotnet=""NestedDataStoreToolEngineSourceDataStoreSourcesDataStoreSourcesDataStoreConnectorConfig"" pulumi-lang-go=""nestedDataStoreToolEngineSourceDataStoreSourcesDataStoreSourcesDataStoreConnectorConfig"" pulumi-lang-python=""nested_data_store_tool_engine_source_data_store_sources_data_store_sources_data_store_connector_config"" pulumi-lang-yaml=""nestedDataStoreToolEngineSourceDataStoreSourcesDataStoreSourcesDataStoreConnectorConfig"" pulumi-lang-java=""nestedDataStoreToolEngineSourceDataStoreSourcesDataStoreSourcesDataStoreConnectorConfig"">"nested_data_store_tool_engine_source_data_store_sources_data_store_sources_data_store_connector_config">The
connector_configblock contains:
- name string
- Full resource name of the DataStore.
Format:
projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore} - connector
Configs ToolData 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 data store was created.
- display
Name string - (Output) The display name of the data store.
- 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
- 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
<a name=<span pulumi-lang-nodejs=""nestedDataStoreToolEngineSourceDataStoreSourcesDataStoreSourcesDataStoreConnectorConfig"" pulumi-lang-dotnet=""NestedDataStoreToolEngineSourceDataStoreSourcesDataStoreSourcesDataStoreConnectorConfig"" pulumi-lang-go=""nestedDataStoreToolEngineSourceDataStoreSourcesDataStoreSourcesDataStoreConnectorConfig"" pulumi-lang-python=""nested_data_store_tool_engine_source_data_store_sources_data_store_sources_data_store_connector_config"" pulumi-lang-yaml=""nestedDataStoreToolEngineSourceDataStoreSourcesDataStoreSourcesDataStoreConnectorConfig"" pulumi-lang-java=""nestedDataStoreToolEngineSourceDataStoreSourcesDataStoreSourcesDataStoreConnectorConfig"">"nested_data_store_tool_engine_source_data_store_sources_data_store_sources_data_store_connector_config">The
connector_configblock contains:
- name str
- Full resource name of the DataStore.
Format:
projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore} - connector_
configs Sequence[ToolData 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 data store was created.
- display_
name str - (Output) The display name of the data store.
- 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
- 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
<a name=<span pulumi-lang-nodejs=""nestedDataStoreToolEngineSourceDataStoreSourcesDataStoreSourcesDataStoreConnectorConfig"" pulumi-lang-dotnet=""NestedDataStoreToolEngineSourceDataStoreSourcesDataStoreSourcesDataStoreConnectorConfig"" pulumi-lang-go=""nestedDataStoreToolEngineSourceDataStoreSourcesDataStoreSourcesDataStoreConnectorConfig"" pulumi-lang-python=""nested_data_store_tool_engine_source_data_store_sources_data_store_sources_data_store_connector_config"" pulumi-lang-yaml=""nestedDataStoreToolEngineSourceDataStoreSourcesDataStoreSourcesDataStoreConnectorConfig"" pulumi-lang-java=""nestedDataStoreToolEngineSourceDataStoreSourcesDataStoreSourcesDataStoreConnectorConfig"">"nested_data_store_tool_engine_source_data_store_sources_data_store_sources_data_store_connector_config">The
connector_configblock contains:
- name String
- Full resource name of the DataStore.
Format:
projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore} - 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 data store was created.
- display
Name String - (Output) The display name of the data store.
- 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
- 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
<a name=<span pulumi-lang-nodejs=""nestedDataStoreToolEngineSourceDataStoreSourcesDataStoreSourcesDataStoreConnectorConfig"" pulumi-lang-dotnet=""NestedDataStoreToolEngineSourceDataStoreSourcesDataStoreSourcesDataStoreConnectorConfig"" pulumi-lang-go=""nestedDataStoreToolEngineSourceDataStoreSourcesDataStoreSourcesDataStoreConnectorConfig"" pulumi-lang-python=""nested_data_store_tool_engine_source_data_store_sources_data_store_sources_data_store_connector_config"" pulumi-lang-yaml=""nestedDataStoreToolEngineSourceDataStoreSourcesDataStoreSourcesDataStoreConnectorConfig"" pulumi-lang-java=""nestedDataStoreToolEngineSourceDataStoreSourcesDataStoreSourcesDataStoreConnectorConfig"">"nested_data_store_tool_engine_source_data_store_sources_data_store_sources_data_store_connector_config">The
connector_configblock contains:
ToolDataStoreToolEngineSourceDataStoreSourceDataStoreConnectorConfig, ToolDataStoreToolEngineSourceDataStoreSourceDataStoreConnectorConfigArgs
- Collection string
- Resource name of the collection the data store belongs to.
- Collection
Display stringName - Display name of the collection the data store belongs to.
- Data
Source string - The name of the data source. Example: 'salesforce', 'jira', 'confluence', 'bigquery'.
- Collection string
- Resource name of the collection the data store belongs to.
- Collection
Display stringName - Display name of the collection the data store belongs to.
- Data
Source string - The name of the data source. Example: 'salesforce', 'jira', 'confluence', 'bigquery'.
- collection String
- Resource name of the collection the data store belongs to.
- collection
Display StringName - Display name of the collection the data store belongs to.
- data
Source String - The name of the data source. Example: 'salesforce', 'jira', 'confluence', 'bigquery'.
- collection string
- Resource name of the collection the data store belongs to.
- collection
Display stringName - Display name of the collection the data store belongs to.
- data
Source string - The name of the data source. Example: 'salesforce', 'jira', 'confluence', 'bigquery'.
- collection str
- Resource name of the collection the data store belongs to.
- collection_
display_ strname - Display name of the collection the data store belongs to.
- data_
source str - The name of the data source. Example: 'salesforce', 'jira', 'confluence', 'bigquery'.
- collection String
- Resource name of the collection the data store belongs to.
- collection
Display StringName - Display name of the collection the data store belongs to.
- data
Source String - The name of the data source. Example: 'salesforce', 'jira', 'confluence', 'bigquery'.
ToolDataStoreToolModalityConfig, ToolDataStoreToolModalityConfigArgs
- Modality
Type string - The modality type. Possible values: TEXT AUDIO
- Grounding
Config ToolData Store Tool Modality Config Grounding Config - Grounding configuration. Structure is documented below.
- Rewriter
Config ToolData Store Tool Modality Config Rewriter Config - Rewriter configuration. Structure is documented below.
- Summarization
Config ToolData Store Tool Modality Config Summarization Config - Summarization configuration. Structure is documented below.
- Modality
Type string - The modality type. Possible values: TEXT AUDIO
- Grounding
Config ToolData Store Tool Modality Config Grounding Config - Grounding configuration. Structure is documented below.
- Rewriter
Config ToolData Store Tool Modality Config Rewriter Config - Rewriter configuration. Structure is documented below.
- Summarization
Config ToolData Store Tool Modality Config Summarization Config - Summarization configuration. Structure is documented below.
- modality
Type String - The modality type. Possible values: TEXT AUDIO
- grounding
Config ToolData Store Tool Modality Config Grounding Config - Grounding configuration. Structure is documented below.
- rewriter
Config ToolData Store Tool Modality Config Rewriter Config - Rewriter configuration. Structure is documented below.
- summarization
Config ToolData Store Tool Modality Config Summarization Config - Summarization configuration. Structure is documented below.
- modality
Type string - The modality type. Possible values: TEXT AUDIO
- grounding
Config ToolData Store Tool Modality Config Grounding Config - Grounding configuration. Structure is documented below.
- rewriter
Config ToolData Store Tool Modality Config Rewriter Config - Rewriter configuration. Structure is documented below.
- summarization
Config ToolData Store Tool Modality Config Summarization Config - Summarization configuration. Structure is documented below.
- modality_
type str - The modality type. Possible values: TEXT AUDIO
- grounding_
config ToolData Store Tool Modality Config Grounding Config - Grounding configuration. Structure is documented below.
- rewriter_
config ToolData Store Tool Modality Config Rewriter Config - Rewriter configuration. Structure is documented below.
- summarization_
config ToolData Store Tool Modality Config Summarization Config - Summarization configuration. Structure is documented below.
- modality
Type String - The modality type. Possible values: TEXT AUDIO
- grounding
Config Property Map - Grounding configuration. Structure is documented below.
- rewriter
Config Property Map - Rewriter configuration. Structure is documented below.
- summarization
Config Property Map - Summarization configuration. Structure is documented below.
ToolDataStoreToolModalityConfigGroundingConfig, ToolDataStoreToolModalityConfigGroundingConfigArgs
- Disabled bool
- Whether grounding is disabled.
- Grounding
Level double - 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
- Whether grounding is disabled.
- Grounding
Level float64 - 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
- Whether grounding is disabled.
- grounding
Level Double - 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
- Whether grounding is disabled.
- grounding
Level number - 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
- Whether grounding is disabled.
- grounding_
level float - 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
- Whether grounding is disabled.
- grounding
Level Number - 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.
ToolDataStoreToolModalityConfigRewriterConfig, ToolDataStoreToolModalityConfigRewriterConfigArgs
- Model
Settings ToolData Store Tool Modality Config Rewriter Config Model Settings - Model settings contains various configurations for the LLM model. Structure is documented below.
- Disabled bool
- Whether the rewriter is disabled.
- Prompt string
- The prompt definition. If not set, default prompt will be used.
- Model
Settings ToolData Store Tool Modality Config Rewriter Config Model Settings - Model settings contains various configurations for the LLM model. Structure is documented below.
- Disabled bool
- Whether the rewriter is disabled.
- Prompt string
- The prompt definition. If not set, default prompt will be used.
- model
Settings ToolData Store Tool Modality Config Rewriter Config Model Settings - Model settings contains various configurations for the LLM model. Structure is documented below.
- disabled Boolean
- Whether the rewriter is disabled.
- prompt String
- The prompt definition. If not set, default prompt will be used.
- model
Settings ToolData Store Tool Modality Config Rewriter Config Model Settings - Model settings contains various configurations for the LLM model. Structure is documented below.
- disabled boolean
- Whether the rewriter is disabled.
- prompt string
- The prompt definition. If not set, default prompt will be used.
- model_
settings ToolData Store Tool Modality Config Rewriter Config Model Settings - Model settings contains various configurations for the LLM model. Structure is documented below.
- disabled bool
- Whether the rewriter is disabled.
- prompt str
- The prompt definition. If not set, default prompt will be used.
- model
Settings Property Map - Model settings contains various configurations for the LLM model. Structure is documented below.
- disabled Boolean
- Whether the rewriter is disabled.
- prompt String
- The prompt definition. If not set, default prompt will be used.
ToolDataStoreToolModalityConfigRewriterConfigModelSettings, ToolDataStoreToolModalityConfigRewriterConfigModelSettingsArgs
- Model string
- The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
- Temperature double
- 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
- The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
- Temperature float64
- 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
- The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
- temperature Double
- 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
- The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
- temperature number
- 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
- The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
- temperature float
- 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
- The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
- temperature Number
- 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.
ToolDataStoreToolModalityConfigSummarizationConfig, ToolDataStoreToolModalityConfigSummarizationConfigArgs
- Disabled bool
- Whether summarization is disabled.
- Model
Settings ToolData Store Tool Modality Config Summarization Config Model Settings - Model settings contains various configurations for the LLM model. Structure is documented below.
- Prompt string
- The prompt definition. If not set, default prompt will be used.
- Disabled bool
- Whether summarization is disabled.
- Model
Settings ToolData Store Tool Modality Config Summarization Config Model Settings - Model settings contains various configurations for the LLM model. Structure is documented below.
- Prompt string
- The prompt definition. If not set, default prompt will be used.
- disabled Boolean
- Whether summarization is disabled.
- model
Settings ToolData Store Tool Modality Config Summarization Config Model Settings - Model settings contains various configurations for the LLM model. Structure is documented below.
- prompt String
- The prompt definition. If not set, default prompt will be used.
- disabled boolean
- Whether summarization is disabled.
- model
Settings ToolData Store Tool Modality Config Summarization Config Model Settings - Model settings contains various configurations for the LLM model. Structure is documented below.
- prompt string
- The prompt definition. If not set, default prompt will be used.
- disabled bool
- Whether summarization is disabled.
- model_
settings ToolData Store Tool Modality Config Summarization Config Model Settings - Model settings contains various configurations for the LLM model. Structure is documented below.
- prompt str
- The prompt definition. If not set, default prompt will be used.
- disabled Boolean
- Whether summarization is disabled.
- model
Settings Property Map - Model settings contains various configurations for the LLM model. Structure is documented below.
- prompt String
- The prompt definition. If not set, default prompt will be used.
ToolDataStoreToolModalityConfigSummarizationConfigModelSettings, ToolDataStoreToolModalityConfigSummarizationConfigModelSettingsArgs
- Model string
- The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
- Temperature double
- 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
- The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
- Temperature float64
- 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
- The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
- temperature Double
- 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
- The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
- temperature number
- 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
- The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
- temperature float
- 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
- The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
- temperature Number
- 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.
ToolGoogleSearchTool, ToolGoogleSearchToolArgs
- Name string
- The name of the tool.
- Description string
- Description of the tool's purpose.
- Exclude
Domains List<string> - List of domains to be excluded from the search results. Example: "example.com". A maximum of 2000 domains can be excluded.
- Name string
- The name of the tool.
- Description string
- Description of the tool's purpose.
- Exclude
Domains []string - List of domains to be excluded from the search results. Example: "example.com". A maximum of 2000 domains can be excluded.
- name String
- The name of the tool.
- description String
- Description of the tool's purpose.
- exclude
Domains List<String> - List of domains to be excluded from the search results. Example: "example.com". A maximum of 2000 domains can be excluded.
- name string
- The name of the tool.
- description string
- Description of the tool's purpose.
- exclude
Domains string[] - List of domains to be excluded from the search results. Example: "example.com". A maximum of 2000 domains can be excluded.
- name str
- The name of the tool.
- description str
- Description of the tool's purpose.
- exclude_
domains Sequence[str] - List of domains to be excluded from the search results. Example: "example.com". A maximum of 2000 domains can be excluded.
- name String
- The name of the tool.
- description String
- Description of the tool's purpose.
- exclude
Domains List<String> - List of domains to be excluded from the search results. Example: "example.com". A maximum of 2000 domains can be excluded.
ToolOpenApiTool, ToolOpenApiToolArgs
- Api
Authentications List<ToolOpen Api Tool Api Authentication> - (Output) Authentication information required for API calls. Structure is documented below.
- Description string
- (Output) The description of the system tool.
- Ignore
Unknown boolFields - (Output) If true, the agent will ignore unknown fields in the API response.
- Name string
- (Output) The name of the system tool.
- Open
Api stringSchema - (Output) The OpenAPI schema in JSON or YAML format.
- Service
Directory List<ToolConfigs Open Api Tool Service Directory Config> - (Output) Configuration for tools using Service Directory. Structure is documented below.
- Tls
Configs List<ToolOpen 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 tools 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 []ToolOpen Api Tool Api Authentication - (Output) Authentication information required for API calls. Structure is documented below.
- Description string
- (Output) The description of the system tool.
- Ignore
Unknown boolFields - (Output) If true, the agent will ignore unknown fields in the API response.
- Name string
- (Output) The name of the system tool.
- Open
Api stringSchema - (Output) The OpenAPI schema in JSON or YAML format.
- Service
Directory []ToolConfigs Open Api Tool Service Directory Config - (Output) Configuration for tools using Service Directory. Structure is documented below.
- Tls
Configs []ToolOpen 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 tools 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<ToolOpen Api Tool Api Authentication> - (Output) Authentication information required for API calls. Structure is documented below.
- description String
- (Output) The description of the system tool.
- ignore
Unknown BooleanFields - (Output) If true, the agent will ignore unknown fields in the API response.
- name String
- (Output) The name of the system tool.
- open
Api StringSchema - (Output) The OpenAPI schema in JSON or YAML format.
- service
Directory List<ToolConfigs Open Api Tool Service Directory Config> - (Output) Configuration for tools using Service Directory. Structure is documented below.
- tls
Configs List<ToolOpen 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 tools 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 ToolOpen Api Tool Api Authentication[] - (Output) Authentication information required for API calls. Structure is documented below.
- description string
- (Output) The description of the system tool.
- ignore
Unknown booleanFields - (Output) If true, the agent will ignore unknown fields in the API response.
- name string
- (Output) The name of the system tool.
- open
Api stringSchema - (Output) The OpenAPI schema in JSON or YAML format.
- service
Directory ToolConfigs Open Api Tool Service Directory Config[] - (Output) Configuration for tools using Service Directory. Structure is documented below.
- tls
Configs ToolOpen 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 tools 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[ToolOpen Api Tool Api Authentication] - (Output) Authentication information required for API calls. Structure is documented below.
- description str
- (Output) The description of the system tool.
- ignore_
unknown_ boolfields - (Output) If true, the agent will ignore unknown fields in the API response.
- name str
- (Output) The name of the system tool.
- open_
api_ strschema - (Output) The OpenAPI schema in JSON or YAML format.
- service_
directory_ Sequence[Toolconfigs Open Api Tool Service Directory Config] - (Output) Configuration for tools using Service Directory. Structure is documented below.
- tls_
configs Sequence[ToolOpen 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 tools 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
- (Output) The description of the system tool.
- ignore
Unknown BooleanFields - (Output) If true, the agent will ignore unknown fields in the API response.
- name String
- (Output) The name of the system tool.
- open
Api StringSchema - (Output) The OpenAPI schema in JSON or YAML format.
- 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 tools 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.
ToolOpenApiToolApiAuthentication, ToolOpenApiToolApiAuthenticationArgs
- Api
Key List<ToolConfigs Open Api Tool Api Authentication Api Key Config> - (Output) Configurations for authentication with API key. Structure is documented below.
- Oauth
Configs List<ToolOpen Api Tool Api Authentication Oauth Config> - (Output) Configurations for authentication with OAuth. Structure is documented below.
- Service
Account List<ToolAuth Configs 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<ToolId Token Auth Configs Open Api Tool Api Authentication Service Agent Id Token Auth Config> - (Output) Configurations for authentication with ID token generated from service agent.
- Api
Key []ToolConfigs Open Api Tool Api Authentication Api Key Config - (Output) Configurations for authentication with API key. Structure is documented below.
- Oauth
Configs []ToolOpen Api Tool Api Authentication Oauth Config - (Output) Configurations for authentication with OAuth. Structure is documented below.
- Service
Account []ToolAuth Configs Open Api Tool Api Authentication Service Account Auth Config - (Output) Configurations for authentication using a custom service account. Structure is documented below.
- Service
Agent []ToolId Token Auth Configs 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<ToolConfigs Open Api Tool Api Authentication Api Key Config> - (Output) Configurations for authentication with API key. Structure is documented below.
- oauth
Configs List<ToolOpen Api Tool Api Authentication Oauth Config> - (Output) Configurations for authentication with OAuth. Structure is documented below.
- service
Account List<ToolAuth Configs 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<ToolId Token Auth Configs Open Api Tool Api Authentication Service Agent Id Token Auth Config> - (Output) Configurations for authentication with ID token generated from service agent.
- api
Key ToolConfigs Open Api Tool Api Authentication Api Key Config[] - (Output) Configurations for authentication with API key. Structure is documented below.
- oauth
Configs ToolOpen Api Tool Api Authentication Oauth Config[] - (Output) Configurations for authentication with OAuth. Structure is documented below.
- service
Account ToolAuth Configs Open Api Tool Api Authentication Service Account Auth Config[] - (Output) Configurations for authentication using a custom service account. Structure is documented below.
- service
Agent ToolId Token Auth Configs 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[Toolconfigs Open Api Tool Api Authentication Api Key Config] - (Output) Configurations for authentication with API key. Structure is documented below.
- oauth_
configs Sequence[ToolOpen Api Tool Api Authentication Oauth Config] - (Output) Configurations for authentication with OAuth. Structure is documented below.
- service_
account_ Sequence[Toolauth_ configs 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[Toolid_ token_ auth_ configs 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.
ToolOpenApiToolApiAuthenticationApiKeyConfig, ToolOpenApiToolApiAuthenticationApiKeyConfigArgs
- 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-<PROJECT-NUMBER>@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-<PROJECT-NUMBER>@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-<PROJECT-NUMBER>@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-<PROJECT-NUMBER>@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-<PROJECT-NUMBER>@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-<PROJECT-NUMBER>@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
ToolOpenApiToolApiAuthenticationOauthConfig, ToolOpenApiToolApiAuthenticationOauthConfigArgs
- 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-<PROJECT-NUMBER>@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-<PROJECT-NUMBER>@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-<PROJECT-NUMBER>@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-<PROJECT-NUMBER>@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-<PROJECT-NUMBER>@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-<PROJECT-NUMBER>@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.
ToolOpenApiToolApiAuthenticationServiceAccountAuthConfig, ToolOpenApiToolApiAuthenticationServiceAccountAuthConfigArgs
- 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-<PROJECT-NUMBER>@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-<PROJECT-NUMBER>@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-<PROJECT-NUMBER>@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-<PROJECT-NUMBER>@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-<PROJECT-NUMBER>@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-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
ToolOpenApiToolServiceDirectoryConfig, ToolOpenApiToolServiceDirectoryConfigArgs
- 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.
ToolOpenApiToolTlsConfig, ToolOpenApiToolTlsConfigArgs
- Ca
Certs List<ToolOpen Api Tool Tls Config Ca Cert> - Specifies a list of allowed custom CA certificates for HTTPS verification. Structure is documented below.
- Ca
Certs []ToolOpen Api Tool Tls Config Ca Cert - Specifies a list of allowed custom CA certificates for HTTPS verification. Structure is documented below.
- ca
Certs List<ToolOpen Api Tool Tls Config Ca Cert> - Specifies a list of allowed custom CA certificates for HTTPS verification. Structure is documented below.
- ca
Certs ToolOpen Api Tool Tls Config Ca Cert[] - Specifies a list of allowed custom CA certificates for HTTPS verification. Structure is documented below.
- ca_
certs Sequence[ToolOpen Api Tool Tls Config Ca Cert] - Specifies a list of allowed custom CA certificates for HTTPS verification. Structure is documented below.
- ca
Certs List<Property Map> - Specifies a list of allowed custom CA certificates for HTTPS verification. Structure is documented below.
ToolOpenApiToolTlsConfigCaCert, ToolOpenApiToolTlsConfigCaCertArgs
- 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'") A base64-encoded string. - Display
Name string - (Output) The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
- 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'") A base64-encoded string. - Display
Name string - (Output) The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
- 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'") A base64-encoded string. - display
Name String - (Output) The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
- 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'") A base64-encoded string. - display
Name string - (Output) The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
- 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'") A base64-encoded string. - display_
name str - (Output) The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
- 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'") A base64-encoded string. - display
Name String - (Output) The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
ToolPythonFunction, ToolPythonFunctionArgs
- Description string
- (Output) The description of the Python function, parsed from the python code's docstring.
- Name string
- The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used.
- Python
Code string - The Python code to execute for the tool.
- Description string
- (Output) The description of the Python function, parsed from the python code's docstring.
- Name string
- The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used.
- Python
Code string - The Python code to execute for the tool.
- description String
- (Output) The description of the Python function, parsed from the python code's docstring.
- name String
- The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used.
- python
Code String - The Python code to execute for the tool.
- description string
- (Output) The description of the Python function, parsed from the python code's docstring.
- name string
- The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used.
- python
Code string - The Python code to execute for the tool.
- description str
- (Output) The description of the Python function, parsed from the python code's docstring.
- name str
- The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used.
- python_
code str - The Python code to execute for the tool.
- description String
- (Output) The description of the Python function, parsed from the python code's docstring.
- name String
- The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used.
- python
Code String - The Python code to execute for the tool.
ToolSystemTool, ToolSystemToolArgs
- Description string
- (Output) The description of the system tool.
- Name string
- (Output) The name of the system tool.
- Description string
- (Output) The description of the system tool.
- Name string
- (Output) The name of the system tool.
- description String
- (Output) The description of the system tool.
- name String
- (Output) The name of the system tool.
- description string
- (Output) The description of the system tool.
- name string
- (Output) The name of the system tool.
- description str
- (Output) The description of the system tool.
- name str
- (Output) The name of the system tool.
- description String
- (Output) The description of the system tool.
- name String
- (Output) The name of the system tool.
Import
Tool can be imported using any of these accepted formats:
projects/{{project}}/locations/{{location}}/apps/{{app}}/tools/{{name}}{{project}}/{{location}}/{{app}}/{{name}}{{location}}/{{app}}/{{name}}
When using the pulumi import command, Tool can be imported using one of the formats above. For example:
$ pulumi import gcp:ces/tool:Tool default projects/{{project}}/locations/{{location}}/apps/{{app}}/tools/{{name}}
$ pulumi import gcp:ces/tool:Tool default {{project}}/{{location}}/{{app}}/{{name}}
$ pulumi import gcp:ces/tool:Tool 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.
