Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. GenerativeAi
  5. AgentDataSource
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-oci

oci.GenerativeAi.AgentDataSource

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-oci

    This resource provides the Data Source resource in Oracle Cloud Infrastructure Generative Ai Agent service.

    CreateDataSource

    Creates a data source.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testDataSource = new oci.generativeai.AgentDataSource("test_data_source", {
    compartmentId: compartmentId,
    dataSourceConfig: {
        dataSourceConfigType: dataSourceDataSourceConfigDataSourceConfigType,
        objectStoragePrefixes: [{
            bucket: dataSourceDataSourceConfigObjectStoragePrefixesBucket,
            namespace: dataSourceDataSourceConfigObjectStoragePrefixesNamespace,
            prefix: dataSourceDataSourceConfigObjectStoragePrefixesPrefix,
        }],
    },
    knowledgeBaseId: testKnowledgeBase.id,
    definedTags: {
        "Operations.CostCenter": "42",
    },
    description: dataSourceDescription,
    displayName: dataSourceDisplayName,
    freeformTags: {
        Department: "Finance",
    },
});

    import pulumi
import pulumi_oci as oci

test_data_source = oci.generative_ai.AgentDataSource("test_data_source",
    compartment_id=compartment_id,
    data_source_config={
        "data_source_config_type": data_source_data_source_config_data_source_config_type,
        "object_storage_prefixes": [{
            "bucket": data_source_data_source_config_object_storage_prefixes_bucket,
            "namespace": data_source_data_source_config_object_storage_prefixes_namespace,
            "prefix": data_source_data_source_config_object_storage_prefixes_prefix,
        }],
    },
    knowledge_base_id=test_knowledge_base["id"],
    defined_tags={
        "Operations.CostCenter": "42",
    },
    description=data_source_description,
    display_name=data_source_display_name,
    freeform_tags={
        "Department": "Finance",
    })

    package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/GenerativeAi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := GenerativeAi.NewAgentDataSource(ctx, "test_data_source", &GenerativeAi.AgentDataSourceArgs{
			CompartmentId: pulumi.Any(compartmentId),
			DataSourceConfig: &generativeai.AgentDataSourceDataSourceConfigArgs{
				DataSourceConfigType: pulumi.Any(dataSourceDataSourceConfigDataSourceConfigType),
				ObjectStoragePrefixes: generativeai.AgentDataSourceDataSourceConfigObjectStoragePrefixArray{
					&generativeai.AgentDataSourceDataSourceConfigObjectStoragePrefixArgs{
						Bucket:    pulumi.Any(dataSourceDataSourceConfigObjectStoragePrefixesBucket),
						Namespace: pulumi.Any(dataSourceDataSourceConfigObjectStoragePrefixesNamespace),
						Prefix:    pulumi.Any(dataSourceDataSourceConfigObjectStoragePrefixesPrefix),
					},
				},
			},
			KnowledgeBaseId: pulumi.Any(testKnowledgeBase.Id),
			DefinedTags: pulumi.StringMap{
				"Operations.CostCenter": pulumi.String("42"),
			},
			Description: pulumi.Any(dataSourceDescription),
			DisplayName: pulumi.Any(dataSourceDisplayName),
			FreeformTags: pulumi.StringMap{
				"Department": pulumi.String("Finance"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testDataSource = new Oci.GenerativeAi.AgentDataSource("test_data_source", new()
    {
        CompartmentId = compartmentId,
        DataSourceConfig = new Oci.GenerativeAi.Inputs.AgentDataSourceDataSourceConfigArgs
        {
            DataSourceConfigType = dataSourceDataSourceConfigDataSourceConfigType,
            ObjectStoragePrefixes = new[]
            {
                new Oci.GenerativeAi.Inputs.AgentDataSourceDataSourceConfigObjectStoragePrefixArgs
                {
                    Bucket = dataSourceDataSourceConfigObjectStoragePrefixesBucket,
                    Namespace = dataSourceDataSourceConfigObjectStoragePrefixesNamespace,
                    Prefix = dataSourceDataSourceConfigObjectStoragePrefixesPrefix,
                },
            },
        },
        KnowledgeBaseId = testKnowledgeBase.Id,
        DefinedTags = 
        {
            { "Operations.CostCenter", "42" },
        },
        Description = dataSourceDescription,
        DisplayName = dataSourceDisplayName,
        FreeformTags = 
        {
            { "Department", "Finance" },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.GenerativeAi.AgentDataSource;
import com.pulumi.oci.GenerativeAi.AgentDataSourceArgs;
import com.pulumi.oci.GenerativeAi.inputs.AgentDataSourceDataSourceConfigArgs;
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 testDataSource = new AgentDataSource("testDataSource", AgentDataSourceArgs.builder()
            .compartmentId(compartmentId)
            .dataSourceConfig(AgentDataSourceDataSourceConfigArgs.builder()
                .dataSourceConfigType(dataSourceDataSourceConfigDataSourceConfigType)
                .objectStoragePrefixes(AgentDataSourceDataSourceConfigObjectStoragePrefixArgs.builder()
                    .bucket(dataSourceDataSourceConfigObjectStoragePrefixesBucket)
                    .namespace(dataSourceDataSourceConfigObjectStoragePrefixesNamespace)
                    .prefix(dataSourceDataSourceConfigObjectStoragePrefixesPrefix)
                    .build())
                .build())
            .knowledgeBaseId(testKnowledgeBase.id())
            .definedTags(Map.of("Operations.CostCenter", "42"))
            .description(dataSourceDescription)
            .displayName(dataSourceDisplayName)
            .freeformTags(Map.of("Department", "Finance"))
            .build());

    }
}

    resources:
  testDataSource:
    type: oci:GenerativeAi:AgentDataSource
    name: test_data_source
    properties:
      compartmentId: ${compartmentId}
      dataSourceConfig:
        dataSourceConfigType: ${dataSourceDataSourceConfigDataSourceConfigType}
        objectStoragePrefixes:
          - bucket: ${dataSourceDataSourceConfigObjectStoragePrefixesBucket}
            namespace: ${dataSourceDataSourceConfigObjectStoragePrefixesNamespace}
            prefix: ${dataSourceDataSourceConfigObjectStoragePrefixesPrefix}
      knowledgeBaseId: ${testKnowledgeBase.id}
      definedTags:
        Operations.CostCenter: '42'
      description: ${dataSourceDescription}
      displayName: ${dataSourceDisplayName}
      freeformTags:
        Department: Finance

    Create AgentDataSource Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new AgentDataSource(name: string, args: AgentDataSourceArgs, opts?: CustomResourceOptions);
    @overload
def AgentDataSource(resource_name: str,
                    args: AgentDataSourceArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def AgentDataSource(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    compartment_id: Optional[str] = None,
                    data_source_config: Optional[_generativeai.AgentDataSourceDataSourceConfigArgs] = None,
                    knowledge_base_id: Optional[str] = None,
                    defined_tags: Optional[Mapping[str, str]] = None,
                    description: Optional[str] = None,
                    display_name: Optional[str] = None,
                    freeform_tags: Optional[Mapping[str, str]] = None)
    func NewAgentDataSource(ctx *Context, name string, args AgentDataSourceArgs, opts ...ResourceOption) (*AgentDataSource, error)
    public AgentDataSource(string name, AgentDataSourceArgs args, CustomResourceOptions? opts = null)
    public AgentDataSource(String name, AgentDataSourceArgs args)
public AgentDataSource(String name, AgentDataSourceArgs args, CustomResourceOptions options)

    type: oci:GenerativeAi:AgentDataSource
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 AgentDataSourceArgs
    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 AgentDataSourceArgs
    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 AgentDataSourceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AgentDataSourceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AgentDataSourceArgs
    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 agentDataSourceResource = new Oci.GenerativeAi.AgentDataSource("agentDataSourceResource", new()
{
    CompartmentId = "string",
    DataSourceConfig = new Oci.GenerativeAi.Inputs.AgentDataSourceDataSourceConfigArgs
    {
        DataSourceConfigType = "string",
        ObjectStoragePrefixes = new[]
        {
            new Oci.GenerativeAi.Inputs.AgentDataSourceDataSourceConfigObjectStoragePrefixArgs
            {
                Bucket = "string",
                Namespace = "string",
                Prefix = "string",
            },
        },
    },
    KnowledgeBaseId = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    Description = "string",
    DisplayName = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
});

    example, err := GenerativeAi.NewAgentDataSource(ctx, "agentDataSourceResource", &GenerativeAi.AgentDataSourceArgs{
	CompartmentId: pulumi.String("string"),
	DataSourceConfig: &generativeai.AgentDataSourceDataSourceConfigArgs{
		DataSourceConfigType: pulumi.String("string"),
		ObjectStoragePrefixes: generativeai.AgentDataSourceDataSourceConfigObjectStoragePrefixArray{
			&generativeai.AgentDataSourceDataSourceConfigObjectStoragePrefixArgs{
				Bucket:    pulumi.String("string"),
				Namespace: pulumi.String("string"),
				Prefix:    pulumi.String("string"),
			},
		},
	},
	KnowledgeBaseId: pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	DisplayName: pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var agentDataSourceResource = new AgentDataSource("agentDataSourceResource", AgentDataSourceArgs.builder()
    .compartmentId("string")
    .dataSourceConfig(AgentDataSourceDataSourceConfigArgs.builder()
        .dataSourceConfigType("string")
        .objectStoragePrefixes(AgentDataSourceDataSourceConfigObjectStoragePrefixArgs.builder()
            .bucket("string")
            .namespace("string")
            .prefix("string")
            .build())
        .build())
    .knowledgeBaseId("string")
    .definedTags(Map.of("string", "string"))
    .description("string")
    .displayName("string")
    .freeformTags(Map.of("string", "string"))
    .build());

    agent_data_source_resource = oci.generative_ai.AgentDataSource("agentDataSourceResource",
    compartment_id="string",
    data_source_config={
        "data_source_config_type": "string",
        "object_storage_prefixes": [{
            "bucket": "string",
            "namespace": "string",
            "prefix": "string",
        }],
    },
    knowledge_base_id="string",
    defined_tags={
        "string": "string",
    },
    description="string",
    display_name="string",
    freeform_tags={
        "string": "string",
    })

    const agentDataSourceResource = new oci.generativeai.AgentDataSource("agentDataSourceResource", {
    compartmentId: "string",
    dataSourceConfig: {
        dataSourceConfigType: "string",
        objectStoragePrefixes: [{
            bucket: "string",
            namespace: "string",
            prefix: "string",
        }],
    },
    knowledgeBaseId: "string",
    definedTags: {
        string: "string",
    },
    description: "string",
    displayName: "string",
    freeformTags: {
        string: "string",
    },
});

    type: oci:GenerativeAi:AgentDataSource
properties:
    compartmentId: string
    dataSourceConfig:
        dataSourceConfigType: string
        objectStoragePrefixes:
            - bucket: string
              namespace: string
              prefix: string
    definedTags:
        string: string
    description: string
    displayName: string
    freeformTags:
        string: string
    knowledgeBaseId: string

    AgentDataSource 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 AgentDataSource resource accepts the following input properties:

    CompartmentId string
    The OCID of the compartment to create the data source in.
    DataSourceConfig AgentDataSourceDataSourceConfig

    (Updatable) DataSourceConfig

    The details of data source.

    KnowledgeBaseId string

    The OCID of the parent KnowledgeBase.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    (Updatable) A description of the data source.
    DisplayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    FreeformTags Dictionary<string, string>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    CompartmentId string
    The OCID of the compartment to create the data source in.
    DataSourceConfig AgentDataSourceDataSourceConfigArgs

    (Updatable) DataSourceConfig

    The details of data source.

    KnowledgeBaseId string

    The OCID of the parent KnowledgeBase.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    (Updatable) A description of the data source.
    DisplayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    FreeformTags map[string]string
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    compartmentId String
    The OCID of the compartment to create the data source in.
    dataSourceConfig AgentDataSourceDataSourceConfig

    (Updatable) DataSourceConfig

    The details of data source.

    knowledgeBaseId String

    The OCID of the parent KnowledgeBase.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    (Updatable) A description of the data source.
    displayName String
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags Map<String,String>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    compartmentId string
    The OCID of the compartment to create the data source in.
    dataSourceConfig AgentDataSourceDataSourceConfig

    (Updatable) DataSourceConfig

    The details of data source.

    knowledgeBaseId string

    The OCID of the parent KnowledgeBase.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description string
    (Updatable) A description of the data source.
    displayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags {[key: string]: string}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    compartment_id str
    The OCID of the compartment to create the data source in.
    data_source_config generativeai.AgentDataSourceDataSourceConfigArgs

    (Updatable) DataSourceConfig

    The details of data source.

    knowledge_base_id str

    The OCID of the parent KnowledgeBase.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description str
    (Updatable) A description of the data source.
    display_name str
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeform_tags Mapping[str, str]
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    compartmentId String
    The OCID of the compartment to create the data source in.
    dataSourceConfig Property Map

    (Updatable) DataSourceConfig

    The details of data source.

    knowledgeBaseId String

    The OCID of the parent KnowledgeBase.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    (Updatable) A description of the data source.
    displayName String
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags Map<String>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

    Outputs

    All input properties are implicitly available as output properties. Additionally, the AgentDataSource resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleDetails string
    A message that describes the current state of the data source in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
    State string
    The current state of the data source.
    SystemTags Dictionary<string, string>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time the data source was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    TimeUpdated string
    The date and time the data source was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleDetails string
    A message that describes the current state of the data source in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
    State string
    The current state of the data source.
    SystemTags map[string]string
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time the data source was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    TimeUpdated string
    The date and time the data source was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails String
    A message that describes the current state of the data source in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
    state String
    The current state of the data source.
    systemTags Map<String,String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time the data source was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated String
    The date and time the data source was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    id string
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails string
    A message that describes the current state of the data source in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
    state string
    The current state of the data source.
    systemTags {[key: string]: string}
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The date and time the data source was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated string
    The date and time the data source was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    id str
    The provider-assigned unique ID for this managed resource.
    lifecycle_details str
    A message that describes the current state of the data source in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
    state str
    The current state of the data source.
    system_tags Mapping[str, str]
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The date and time the data source was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    time_updated str
    The date and time the data source was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails String
    A message that describes the current state of the data source in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
    state String
    The current state of the data source.
    systemTags Map<String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time the data source was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated String
    The date and time the data source was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

    Look up Existing AgentDataSource Resource

    Get an existing AgentDataSource 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?: AgentDataSourceState, opts?: CustomResourceOptions): AgentDataSource
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compartment_id: Optional[str] = None,
        data_source_config: Optional[_generativeai.AgentDataSourceDataSourceConfigArgs] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        knowledge_base_id: Optional[str] = None,
        lifecycle_details: Optional[str] = None,
        state: Optional[str] = None,
        system_tags: Optional[Mapping[str, str]] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None) -> AgentDataSource
    func GetAgentDataSource(ctx *Context, name string, id IDInput, state *AgentDataSourceState, opts ...ResourceOption) (*AgentDataSource, error)
    public static AgentDataSource Get(string name, Input<string> id, AgentDataSourceState? state, CustomResourceOptions? opts = null)
    public static AgentDataSource get(String name, Output<String> id, AgentDataSourceState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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.
    The following state arguments are supported:
    CompartmentId string
    The OCID of the compartment to create the data source in.
    DataSourceConfig AgentDataSourceDataSourceConfig

    (Updatable) DataSourceConfig

    The details of data source.

    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    (Updatable) A description of the data source.
    DisplayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    FreeformTags Dictionary<string, string>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    KnowledgeBaseId string

    The OCID of the parent KnowledgeBase.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    LifecycleDetails string
    A message that describes the current state of the data source in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
    State string
    The current state of the data source.
    SystemTags Dictionary<string, string>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time the data source was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    TimeUpdated string
    The date and time the data source was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    CompartmentId string
    The OCID of the compartment to create the data source in.
    DataSourceConfig AgentDataSourceDataSourceConfigArgs

    (Updatable) DataSourceConfig

    The details of data source.

    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    (Updatable) A description of the data source.
    DisplayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    FreeformTags map[string]string
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    KnowledgeBaseId string

    The OCID of the parent KnowledgeBase.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    LifecycleDetails string
    A message that describes the current state of the data source in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
    State string
    The current state of the data source.
    SystemTags map[string]string
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time the data source was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    TimeUpdated string
    The date and time the data source was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    compartmentId String
    The OCID of the compartment to create the data source in.
    dataSourceConfig AgentDataSourceDataSourceConfig

    (Updatable) DataSourceConfig

    The details of data source.

    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    (Updatable) A description of the data source.
    displayName String
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags Map<String,String>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    knowledgeBaseId String

    The OCID of the parent KnowledgeBase.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    lifecycleDetails String
    A message that describes the current state of the data source in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
    state String
    The current state of the data source.
    systemTags Map<String,String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time the data source was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated String
    The date and time the data source was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    compartmentId string
    The OCID of the compartment to create the data source in.
    dataSourceConfig AgentDataSourceDataSourceConfig

    (Updatable) DataSourceConfig

    The details of data source.

    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description string
    (Updatable) A description of the data source.
    displayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags {[key: string]: string}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    knowledgeBaseId string

    The OCID of the parent KnowledgeBase.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    lifecycleDetails string
    A message that describes the current state of the data source in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
    state string
    The current state of the data source.
    systemTags {[key: string]: string}
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The date and time the data source was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated string
    The date and time the data source was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    compartment_id str
    The OCID of the compartment to create the data source in.
    data_source_config generativeai.AgentDataSourceDataSourceConfigArgs

    (Updatable) DataSourceConfig

    The details of data source.

    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description str
    (Updatable) A description of the data source.
    display_name str
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeform_tags Mapping[str, str]
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    knowledge_base_id str

    The OCID of the parent KnowledgeBase.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    lifecycle_details str
    A message that describes the current state of the data source in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
    state str
    The current state of the data source.
    system_tags Mapping[str, str]
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The date and time the data source was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    time_updated str
    The date and time the data source was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    compartmentId String
    The OCID of the compartment to create the data source in.
    dataSourceConfig Property Map

    (Updatable) DataSourceConfig

    The details of data source.

    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    (Updatable) A description of the data source.
    displayName String
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags Map<String>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    knowledgeBaseId String

    The OCID of the parent KnowledgeBase.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    lifecycleDetails String
    A message that describes the current state of the data source in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
    state String
    The current state of the data source.
    systemTags Map<String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time the data source was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated String
    The date and time the data source was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

    Supporting Types

    AgentDataSourceDataSourceConfig, AgentDataSourceDataSourceConfigArgs

    DataSourceConfigType string
    (Updatable) The type of the tool. The allowed values are:

    • OCI_OBJECT_STORAGE: The data source is Oracle Cloud Infrastructure Object Storage.
    ObjectStoragePrefixes List<AgentDataSourceDataSourceConfigObjectStoragePrefix>
    (Updatable) The locations of data items in Object Storage, can either be an object (File) or a prefix (folder).
    DataSourceConfigType string
    (Updatable) The type of the tool. The allowed values are:

    • OCI_OBJECT_STORAGE: The data source is Oracle Cloud Infrastructure Object Storage.
    ObjectStoragePrefixes []AgentDataSourceDataSourceConfigObjectStoragePrefix
    (Updatable) The locations of data items in Object Storage, can either be an object (File) or a prefix (folder).
    dataSourceConfigType String
    (Updatable) The type of the tool. The allowed values are:

    • OCI_OBJECT_STORAGE: The data source is Oracle Cloud Infrastructure Object Storage.
    objectStoragePrefixes List<AgentDataSourceDataSourceConfigObjectStoragePrefix>
    (Updatable) The locations of data items in Object Storage, can either be an object (File) or a prefix (folder).
    dataSourceConfigType string
    (Updatable) The type of the tool. The allowed values are:

    • OCI_OBJECT_STORAGE: The data source is Oracle Cloud Infrastructure Object Storage.
    objectStoragePrefixes AgentDataSourceDataSourceConfigObjectStoragePrefix[]
    (Updatable) The locations of data items in Object Storage, can either be an object (File) or a prefix (folder).
    data_source_config_type str
    (Updatable) The type of the tool. The allowed values are:

    • OCI_OBJECT_STORAGE: The data source is Oracle Cloud Infrastructure Object Storage.
    object_storage_prefixes Sequence[generativeai.AgentDataSourceDataSourceConfigObjectStoragePrefix]
    (Updatable) The locations of data items in Object Storage, can either be an object (File) or a prefix (folder).
    dataSourceConfigType String
    (Updatable) The type of the tool. The allowed values are:

    • OCI_OBJECT_STORAGE: The data source is Oracle Cloud Infrastructure Object Storage.
    objectStoragePrefixes List<Property Map>
    (Updatable) The locations of data items in Object Storage, can either be an object (File) or a prefix (folder).

    AgentDataSourceDataSourceConfigObjectStoragePrefix, AgentDataSourceDataSourceConfigObjectStoragePrefixArgs

    Bucket string
    (Updatable) The bucket name of an object.
    Namespace string
    (Updatable) The namespace name of an object.
    Prefix string
    (Updatable) The name of the object (file) or prefix (folder).
    Bucket string
    (Updatable) The bucket name of an object.
    Namespace string
    (Updatable) The namespace name of an object.
    Prefix string
    (Updatable) The name of the object (file) or prefix (folder).
    bucket String
    (Updatable) The bucket name of an object.
    namespace String
    (Updatable) The namespace name of an object.
    prefix String
    (Updatable) The name of the object (file) or prefix (folder).
    bucket string
    (Updatable) The bucket name of an object.
    namespace string
    (Updatable) The namespace name of an object.
    prefix string
    (Updatable) The name of the object (file) or prefix (folder).
    bucket str
    (Updatable) The bucket name of an object.
    namespace str
    (Updatable) The namespace name of an object.
    prefix str
    (Updatable) The name of the object (file) or prefix (folder).
    bucket String
    (Updatable) The bucket name of an object.
    namespace String
    (Updatable) The namespace name of an object.
    prefix String
    (Updatable) The name of the object (file) or prefix (folder).

    Import

    DataSources can be imported using the id, e.g.

    $ pulumi import oci:GenerativeAi/agentDataSource:AgentDataSource test_data_source "id"

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
    pulumi/pulumi-oci