1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. GenerativeAi
  5. getAgentDataSource
Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi

oci.GenerativeAi.getAgentDataSource

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi

This data source provides details about a specific Data Source resource in Oracle Cloud Infrastructure Generative Ai Agent service.

GetDataSource

Gets information about a data source.

Example Usage

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

const testDataSource = oci.GenerativeAi.getAgentDataSource({
    dataSourceId: testDataSourceOciGenerativeAiAgentDataSource.id,
});
Copy
import pulumi
import pulumi_oci as oci

test_data_source = oci.GenerativeAi.get_agent_data_source(data_source_id=test_data_source_oci_generative_ai_agent_data_source["id"])
Copy
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.GetAgentDataSource(ctx, &generativeai.GetAgentDataSourceArgs{
			DataSourceId: testDataSourceOciGenerativeAiAgentDataSource.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testDataSource = Oci.GenerativeAi.GetAgentDataSource.Invoke(new()
    {
        DataSourceId = testDataSourceOciGenerativeAiAgentDataSource.Id,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.GenerativeAi.GenerativeAiFunctions;
import com.pulumi.oci.GenerativeAi.inputs.GetAgentDataSourceArgs;
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) {
        final var testDataSource = GenerativeAiFunctions.getAgentDataSource(GetAgentDataSourceArgs.builder()
            .dataSourceId(testDataSourceOciGenerativeAiAgentDataSource.id())
            .build());

    }
}
Copy
variables:
  testDataSource:
    fn::invoke:
      function: oci:GenerativeAi:getAgentDataSource
      arguments:
        dataSourceId: ${testDataSourceOciGenerativeAiAgentDataSource.id}
Copy

Using getAgentDataSource

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getAgentDataSource(args: GetAgentDataSourceArgs, opts?: InvokeOptions): Promise<GetAgentDataSourceResult>
function getAgentDataSourceOutput(args: GetAgentDataSourceOutputArgs, opts?: InvokeOptions): Output<GetAgentDataSourceResult>
Copy
def get_agent_data_source(data_source_id: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetAgentDataSourceResult
def get_agent_data_source_output(data_source_id: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetAgentDataSourceResult]
Copy
func GetAgentDataSource(ctx *Context, args *GetAgentDataSourceArgs, opts ...InvokeOption) (*GetAgentDataSourceResult, error)
func GetAgentDataSourceOutput(ctx *Context, args *GetAgentDataSourceOutputArgs, opts ...InvokeOption) GetAgentDataSourceResultOutput
Copy

> Note: This function is named GetAgentDataSource in the Go SDK.

public static class GetAgentDataSource 
{
    public static Task<GetAgentDataSourceResult> InvokeAsync(GetAgentDataSourceArgs args, InvokeOptions? opts = null)
    public static Output<GetAgentDataSourceResult> Invoke(GetAgentDataSourceInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetAgentDataSourceResult> getAgentDataSource(GetAgentDataSourceArgs args, InvokeOptions options)
public static Output<GetAgentDataSourceResult> getAgentDataSource(GetAgentDataSourceArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: oci:GenerativeAi/getAgentDataSource:getAgentDataSource
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

DataSourceId This property is required. string
The OCID of the data source.
DataSourceId This property is required. string
The OCID of the data source.
dataSourceId This property is required. String
The OCID of the data source.
dataSourceId This property is required. string
The OCID of the data source.
data_source_id This property is required. str
The OCID of the data source.
dataSourceId This property is required. String
The OCID of the data source.

getAgentDataSource Result

The following output properties are available:

CompartmentId string
The OCID of the compartment.
DataSourceConfigs List<GetAgentDataSourceDataSourceConfig>
DataSourceConfig
DataSourceId string
DefinedTags Dictionary<string, string>
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
A description of the data source.
DisplayName string
A user-friendly name. Does not have to be unique, and it's changeable.
FreeformTags Dictionary<string, string>
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"}
Id string
The OCID of the data source.
KnowledgeBaseId string
The OCID of the parent KnowledgeBase.
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.
DataSourceConfigs []GetAgentDataSourceDataSourceConfig
DataSourceConfig
DataSourceId string
DefinedTags map[string]string
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
A description of the data source.
DisplayName string
A user-friendly name. Does not have to be unique, and it's changeable.
FreeformTags map[string]string
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"}
Id string
The OCID of the data source.
KnowledgeBaseId string
The OCID of the parent KnowledgeBase.
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.
dataSourceConfigs List<GetAgentDataSourceDataSourceConfig>
DataSourceConfig
dataSourceId String
definedTags Map<String,String>
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
A description of the data source.
displayName String
A user-friendly name. Does not have to be unique, and it's changeable.
freeformTags Map<String,String>
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"}
id String
The OCID of the data source.
knowledgeBaseId String
The OCID of the parent KnowledgeBase.
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.
dataSourceConfigs GetAgentDataSourceDataSourceConfig[]
DataSourceConfig
dataSourceId string
definedTags {[key: string]: string}
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
A description of the data source.
displayName string
A user-friendly name. Does not have to be unique, and it's changeable.
freeformTags {[key: string]: string}
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"}
id string
The OCID of the data source.
knowledgeBaseId string
The OCID of the parent KnowledgeBase.
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.
data_source_configs Sequence[generativeai.GetAgentDataSourceDataSourceConfig]
DataSourceConfig
data_source_id str
defined_tags Mapping[str, str]
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
A description of the data source.
display_name str
A user-friendly name. Does not have to be unique, and it's changeable.
freeform_tags Mapping[str, str]
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"}
id str
The OCID of the data source.
knowledge_base_id str
The OCID of the parent KnowledgeBase.
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.
dataSourceConfigs List<Property Map>
DataSourceConfig
dataSourceId String
definedTags Map<String>
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
A description of the data source.
displayName String
A user-friendly name. Does not have to be unique, and it's changeable.
freeformTags Map<String>
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"}
id String
The OCID of the data source.
knowledgeBaseId String
The OCID of the parent KnowledgeBase.
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

GetAgentDataSourceDataSourceConfig

DataSourceConfigType This property is required. string
The type of the tool. The allowed values are:

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

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

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

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

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

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

GetAgentDataSourceDataSourceConfigObjectStoragePrefix

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

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes
This Pulumi package is based on the oci Terraform Provider.
Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi