Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. GenerativeAi
  5. getAgentKnowledgeBases
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-oci

oci.GenerativeAi.getAgentKnowledgeBases

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-oci

    This data source provides the list of Knowledge Bases in Oracle Cloud Infrastructure Generative Ai Agent service.

    ListKnowledgeBases

    Gets a list of knowledge bases.

    Example Usage

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

const testKnowledgeBases = oci.GenerativeAi.getAgentKnowledgeBases({
    compartmentId: compartmentId,
    displayName: knowledgeBaseDisplayName,
    state: knowledgeBaseState,
});

    import pulumi
import pulumi_oci as oci

test_knowledge_bases = oci.GenerativeAi.get_agent_knowledge_bases(compartment_id=compartment_id,
    display_name=knowledge_base_display_name,
    state=knowledge_base_state)

    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.GetAgentKnowledgeBases(ctx, &generativeai.GetAgentKnowledgeBasesArgs{
			CompartmentId: pulumi.StringRef(compartmentId),
			DisplayName:   pulumi.StringRef(knowledgeBaseDisplayName),
			State:         pulumi.StringRef(knowledgeBaseState),
		}, nil)
		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 testKnowledgeBases = Oci.GenerativeAi.GetAgentKnowledgeBases.Invoke(new()
    {
        CompartmentId = compartmentId,
        DisplayName = knowledgeBaseDisplayName,
        State = knowledgeBaseState,
    });

});

    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.GetAgentKnowledgeBasesArgs;
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 testKnowledgeBases = GenerativeAiFunctions.getAgentKnowledgeBases(GetAgentKnowledgeBasesArgs.builder()
            .compartmentId(compartmentId)
            .displayName(knowledgeBaseDisplayName)
            .state(knowledgeBaseState)
            .build());

    }
}

    variables:
  testKnowledgeBases:
    fn::invoke:
      function: oci:GenerativeAi:getAgentKnowledgeBases
      arguments:
        compartmentId: ${compartmentId}
        displayName: ${knowledgeBaseDisplayName}
        state: ${knowledgeBaseState}

    Using getAgentKnowledgeBases

    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 getAgentKnowledgeBases(args: GetAgentKnowledgeBasesArgs, opts?: InvokeOptions): Promise<GetAgentKnowledgeBasesResult>
function getAgentKnowledgeBasesOutput(args: GetAgentKnowledgeBasesOutputArgs, opts?: InvokeOptions): Output<GetAgentKnowledgeBasesResult>
    def get_agent_knowledge_bases(compartment_id: Optional[str] = None,
                              display_name: Optional[str] = None,
                              filters: Optional[Sequence[GetAgentKnowledgeBasesFilter]] = None,
                              state: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetAgentKnowledgeBasesResult
def get_agent_knowledge_bases_output(compartment_id: Optional[pulumi.Input[str]] = None,
                              display_name: Optional[pulumi.Input[str]] = None,
                              filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetAgentKnowledgeBasesFilterArgs]]]] = None,
                              state: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetAgentKnowledgeBasesResult]
    func GetAgentKnowledgeBases(ctx *Context, args *GetAgentKnowledgeBasesArgs, opts ...InvokeOption) (*GetAgentKnowledgeBasesResult, error)
func GetAgentKnowledgeBasesOutput(ctx *Context, args *GetAgentKnowledgeBasesOutputArgs, opts ...InvokeOption) GetAgentKnowledgeBasesResultOutput

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

    public static class GetAgentKnowledgeBases 
{
    public static Task<GetAgentKnowledgeBasesResult> InvokeAsync(GetAgentKnowledgeBasesArgs args, InvokeOptions? opts = null)
    public static Output<GetAgentKnowledgeBasesResult> Invoke(GetAgentKnowledgeBasesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetAgentKnowledgeBasesResult> getAgentKnowledgeBases(GetAgentKnowledgeBasesArgs args, InvokeOptions options)
public static Output<GetAgentKnowledgeBasesResult> getAgentKnowledgeBases(GetAgentKnowledgeBasesArgs args, InvokeOptions options)

    fn::invoke:
  function: oci:GenerativeAi/getAgentKnowledgeBases:getAgentKnowledgeBases
  arguments:
    # arguments dictionary

    The following arguments are supported:

    CompartmentId string
    The OCID of the compartment in which to list resources.
    DisplayName string
    A filter to return only resources that match the given display name exactly.
    Filters List<GetAgentKnowledgeBasesFilter>
    State string
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    CompartmentId string
    The OCID of the compartment in which to list resources.
    DisplayName string
    A filter to return only resources that match the given display name exactly.
    Filters []GetAgentKnowledgeBasesFilter
    State string
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    compartmentId String
    The OCID of the compartment in which to list resources.
    displayName String
    A filter to return only resources that match the given display name exactly.
    filters List<GetAgentKnowledgeBasesFilter>
    state String
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    compartmentId string
    The OCID of the compartment in which to list resources.
    displayName string
    A filter to return only resources that match the given display name exactly.
    filters GetAgentKnowledgeBasesFilter[]
    state string
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    compartment_id str
    The OCID of the compartment in which to list resources.
    display_name str
    A filter to return only resources that match the given display name exactly.
    filters Sequence[GetAgentKnowledgeBasesFilter]
    state str
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    compartmentId String
    The OCID of the compartment in which to list resources.
    displayName String
    A filter to return only resources that match the given display name exactly.
    filters List<Property Map>
    state String
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.

    getAgentKnowledgeBases Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    KnowledgeBaseCollections List<GetAgentKnowledgeBasesKnowledgeBaseCollection>
    The list of knowledge_base_collection.
    CompartmentId string
    The OCID of the compartment.
    DisplayName string
    A user-friendly name. Does not have to be unique, and it's changeable.
    Filters List<GetAgentKnowledgeBasesFilter>
    State string
    The current state of the knowledge base.
    Id string
    The provider-assigned unique ID for this managed resource.
    KnowledgeBaseCollections []GetAgentKnowledgeBasesKnowledgeBaseCollection
    The list of knowledge_base_collection.
    CompartmentId string
    The OCID of the compartment.
    DisplayName string
    A user-friendly name. Does not have to be unique, and it's changeable.
    Filters []GetAgentKnowledgeBasesFilter
    State string
    The current state of the knowledge base.
    id String
    The provider-assigned unique ID for this managed resource.
    knowledgeBaseCollections List<GetAgentKnowledgeBasesKnowledgeBaseCollection>
    The list of knowledge_base_collection.
    compartmentId String
    The OCID of the compartment.
    displayName String
    A user-friendly name. Does not have to be unique, and it's changeable.
    filters List<GetAgentKnowledgeBasesFilter>
    state String
    The current state of the knowledge base.
    id string
    The provider-assigned unique ID for this managed resource.
    knowledgeBaseCollections GetAgentKnowledgeBasesKnowledgeBaseCollection[]
    The list of knowledge_base_collection.
    compartmentId string
    The OCID of the compartment.
    displayName string
    A user-friendly name. Does not have to be unique, and it's changeable.
    filters GetAgentKnowledgeBasesFilter[]
    state string
    The current state of the knowledge base.
    id str
    The provider-assigned unique ID for this managed resource.
    knowledge_base_collections Sequence[GetAgentKnowledgeBasesKnowledgeBaseCollection]
    The list of knowledge_base_collection.
    compartment_id str
    The OCID of the compartment.
    display_name str
    A user-friendly name. Does not have to be unique, and it's changeable.
    filters Sequence[GetAgentKnowledgeBasesFilter]
    state str
    The current state of the knowledge base.
    id String
    The provider-assigned unique ID for this managed resource.
    knowledgeBaseCollections List<Property Map>
    The list of knowledge_base_collection.
    compartmentId String
    The OCID of the compartment.
    displayName String
    A user-friendly name. Does not have to be unique, and it's changeable.
    filters List<Property Map>
    state String
    The current state of the knowledge base.

    Supporting Types

    GetAgentKnowledgeBasesFilter

    Name string
    The index name in opensearch.
    Values List<string>
    Regex bool
    Name string
    The index name in opensearch.
    Values []string
    Regex bool
    name String
    The index name in opensearch.
    values List<String>
    regex Boolean
    name string
    The index name in opensearch.
    values string[]
    regex boolean
    name str
    The index name in opensearch.
    values Sequence[str]
    regex bool
    name String
    The index name in opensearch.
    values List<String>
    regex Boolean

    GetAgentKnowledgeBasesKnowledgeBaseCollection

    GetAgentKnowledgeBasesKnowledgeBaseCollectionItem

    CompartmentId string
    The OCID of the compartment in which to list resources.
    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 knowledge base.
    DisplayName string
    A filter to return only resources that match the given display name exactly.
    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 knowledge base.
    IndexConfigs List<GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfig>
    IndexConfig
    LifecycleDetails string
    A message that describes the current state of the knowledge base in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
    State string
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    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 knowledge base was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    TimeUpdated string
    The date and time the knowledge base was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    CompartmentId string
    The OCID of the compartment in which to list resources.
    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 knowledge base.
    DisplayName string
    A filter to return only resources that match the given display name exactly.
    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 knowledge base.
    IndexConfigs []GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfig
    IndexConfig
    LifecycleDetails string
    A message that describes the current state of the knowledge base in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
    State string
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    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 knowledge base was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    TimeUpdated string
    The date and time the knowledge base was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    compartmentId String
    The OCID of the compartment in which to list resources.
    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 knowledge base.
    displayName String
    A filter to return only resources that match the given display name exactly.
    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 knowledge base.
    indexConfigs List<GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfig>
    IndexConfig
    lifecycleDetails String
    A message that describes the current state of the knowledge base in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
    state String
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    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 knowledge base was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated String
    The date and time the knowledge base was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    compartmentId string
    The OCID of the compartment in which to list resources.
    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 knowledge base.
    displayName string
    A filter to return only resources that match the given display name exactly.
    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 knowledge base.
    indexConfigs GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfig[]
    IndexConfig
    lifecycleDetails string
    A message that describes the current state of the knowledge base in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
    state string
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    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 knowledge base was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated string
    The date and time the knowledge base was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    compartment_id str
    The OCID of the compartment in which to list resources.
    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 knowledge base.
    display_name str
    A filter to return only resources that match the given display name exactly.
    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 knowledge base.
    index_configs Sequence[GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfig]
    IndexConfig
    lifecycle_details str
    A message that describes the current state of the knowledge base in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
    state str
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    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 knowledge base was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    time_updated str
    The date and time the knowledge base was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    compartmentId String
    The OCID of the compartment in which to list resources.
    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 knowledge base.
    displayName String
    A filter to return only resources that match the given display name exactly.
    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 knowledge base.
    indexConfigs List<Property Map>
    IndexConfig
    lifecycleDetails String
    A message that describes the current state of the knowledge base in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
    state String
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    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 knowledge base was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated String
    The date and time the knowledge base was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

    GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfig

    ClusterId string
    The OCID of the OpenSearch Cluster.
    DatabaseConnections List<GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigDatabaseConnection>
    DatabaseConnection
    DatabaseFunctions List<GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigDatabaseFunction>
    Array of Database functions to be used.
    IndexConfigType string
    The type of index. The allowed values are:

    • DEFAULT_INDEX_CONFIG: DefaultIndexConfig allows the service to create and manage vector store on behalf of the customer.
    • OCI_OPEN_SEARCH_INDEX_CONFIG: OciOpenSearchIndexConfig allows customer to configure their OpenSearch cluster.
    • OCI_DATABASE_CONFIG: OciDatabaseConfig allows customer to configure their Database.
    Indexes List<GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigIndex>
    Index configuration for open search.
    SecretDetails List<GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigSecretDetail>
    SecretDetail
    ShouldEnableHybridSearch bool
    Whether to enable Hybrid search in service managed OpenSearch.
    ClusterId string
    The OCID of the OpenSearch Cluster.
    DatabaseConnections []GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigDatabaseConnection
    DatabaseConnection
    DatabaseFunctions []GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigDatabaseFunction
    Array of Database functions to be used.
    IndexConfigType string
    The type of index. The allowed values are:

    • DEFAULT_INDEX_CONFIG: DefaultIndexConfig allows the service to create and manage vector store on behalf of the customer.
    • OCI_OPEN_SEARCH_INDEX_CONFIG: OciOpenSearchIndexConfig allows customer to configure their OpenSearch cluster.
    • OCI_DATABASE_CONFIG: OciDatabaseConfig allows customer to configure their Database.
    Indexes []GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigIndex
    Index configuration for open search.
    SecretDetails []GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigSecretDetail
    SecretDetail
    ShouldEnableHybridSearch bool
    Whether to enable Hybrid search in service managed OpenSearch.
    clusterId String
    The OCID of the OpenSearch Cluster.
    databaseConnections List<GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigDatabaseConnection>
    DatabaseConnection
    databaseFunctions List<GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigDatabaseFunction>
    Array of Database functions to be used.
    indexConfigType String
    The type of index. The allowed values are:

    • DEFAULT_INDEX_CONFIG: DefaultIndexConfig allows the service to create and manage vector store on behalf of the customer.
    • OCI_OPEN_SEARCH_INDEX_CONFIG: OciOpenSearchIndexConfig allows customer to configure their OpenSearch cluster.
    • OCI_DATABASE_CONFIG: OciDatabaseConfig allows customer to configure their Database.
    indexes List<GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigIndex>
    Index configuration for open search.
    secretDetails List<GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigSecretDetail>
    SecretDetail
    shouldEnableHybridSearch Boolean
    Whether to enable Hybrid search in service managed OpenSearch.
    clusterId string
    The OCID of the OpenSearch Cluster.
    databaseConnections GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigDatabaseConnection[]
    DatabaseConnection
    databaseFunctions GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigDatabaseFunction[]
    Array of Database functions to be used.
    indexConfigType string
    The type of index. The allowed values are:

    • DEFAULT_INDEX_CONFIG: DefaultIndexConfig allows the service to create and manage vector store on behalf of the customer.
    • OCI_OPEN_SEARCH_INDEX_CONFIG: OciOpenSearchIndexConfig allows customer to configure their OpenSearch cluster.
    • OCI_DATABASE_CONFIG: OciDatabaseConfig allows customer to configure their Database.
    indexes GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigIndex[]
    Index configuration for open search.
    secretDetails GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigSecretDetail[]
    SecretDetail
    shouldEnableHybridSearch boolean
    Whether to enable Hybrid search in service managed OpenSearch.
    cluster_id str
    The OCID of the OpenSearch Cluster.
    database_connections Sequence[GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigDatabaseConnection]
    DatabaseConnection
    database_functions Sequence[GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigDatabaseFunction]
    Array of Database functions to be used.
    index_config_type str
    The type of index. The allowed values are:

    • DEFAULT_INDEX_CONFIG: DefaultIndexConfig allows the service to create and manage vector store on behalf of the customer.
    • OCI_OPEN_SEARCH_INDEX_CONFIG: OciOpenSearchIndexConfig allows customer to configure their OpenSearch cluster.
    • OCI_DATABASE_CONFIG: OciDatabaseConfig allows customer to configure their Database.
    indexes Sequence[GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigIndex]
    Index configuration for open search.
    secret_details Sequence[GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigSecretDetail]
    SecretDetail
    should_enable_hybrid_search bool
    Whether to enable Hybrid search in service managed OpenSearch.
    clusterId String
    The OCID of the OpenSearch Cluster.
    databaseConnections List<Property Map>
    DatabaseConnection
    databaseFunctions List<Property Map>
    Array of Database functions to be used.
    indexConfigType String
    The type of index. The allowed values are:

    • DEFAULT_INDEX_CONFIG: DefaultIndexConfig allows the service to create and manage vector store on behalf of the customer.
    • OCI_OPEN_SEARCH_INDEX_CONFIG: OciOpenSearchIndexConfig allows customer to configure their OpenSearch cluster.
    • OCI_DATABASE_CONFIG: OciDatabaseConfig allows customer to configure their Database.
    indexes List<Property Map>
    Index configuration for open search.
    secretDetails List<Property Map>
    SecretDetail
    shouldEnableHybridSearch Boolean
    Whether to enable Hybrid search in service managed OpenSearch.

    GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigDatabaseConnection

    ConnectionId string
    The OCID of the Database Tools Connection.
    ConnectionType string
    The type of Database connection. The allowed values are:

    • DATABASE_TOOL_CONNECTION: This allows the service to connect to a vector store via a Database Tools Connection.
    ConnectionId string
    The OCID of the Database Tools Connection.
    ConnectionType string
    The type of Database connection. The allowed values are:

    • DATABASE_TOOL_CONNECTION: This allows the service to connect to a vector store via a Database Tools Connection.
    connectionId String
    The OCID of the Database Tools Connection.
    connectionType String
    The type of Database connection. The allowed values are:

    • DATABASE_TOOL_CONNECTION: This allows the service to connect to a vector store via a Database Tools Connection.
    connectionId string
    The OCID of the Database Tools Connection.
    connectionType string
    The type of Database connection. The allowed values are:

    • DATABASE_TOOL_CONNECTION: This allows the service to connect to a vector store via a Database Tools Connection.
    connection_id str
    The OCID of the Database Tools Connection.
    connection_type str
    The type of Database connection. The allowed values are:

    • DATABASE_TOOL_CONNECTION: This allows the service to connect to a vector store via a Database Tools Connection.
    connectionId String
    The OCID of the Database Tools Connection.
    connectionType String
    The type of Database connection. The allowed values are:

    • DATABASE_TOOL_CONNECTION: This allows the service to connect to a vector store via a Database Tools Connection.

    GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigDatabaseFunction

    Name string
    The index name in opensearch.
    Name string
    The index name in opensearch.
    name String
    The index name in opensearch.
    name string
    The index name in opensearch.
    name str
    The index name in opensearch.
    name String
    The index name in opensearch.

    GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigIndex

    name String
    The index name in opensearch.
    schemas List<Property Map>
    IndexSchema

    GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigIndexSchema

    BodyKey string
    Body key name.
    EmbeddingBodyKey string
    Field within customer managed Oracle Cloud Infrastructure OpenSearch document containing the vector embedding for queries.
    TitleKey string
    Title key that stores the Title of a document, if available.
    UrlKey string
    URL key that stores the URL of a document, if available.
    BodyKey string
    Body key name.
    EmbeddingBodyKey string
    Field within customer managed Oracle Cloud Infrastructure OpenSearch document containing the vector embedding for queries.
    TitleKey string
    Title key that stores the Title of a document, if available.
    UrlKey string
    URL key that stores the URL of a document, if available.
    bodyKey String
    Body key name.
    embeddingBodyKey String
    Field within customer managed Oracle Cloud Infrastructure OpenSearch document containing the vector embedding for queries.
    titleKey String
    Title key that stores the Title of a document, if available.
    urlKey String
    URL key that stores the URL of a document, if available.
    bodyKey string
    Body key name.
    embeddingBodyKey string
    Field within customer managed Oracle Cloud Infrastructure OpenSearch document containing the vector embedding for queries.
    titleKey string
    Title key that stores the Title of a document, if available.
    urlKey string
    URL key that stores the URL of a document, if available.
    body_key str
    Body key name.
    embedding_body_key str
    Field within customer managed Oracle Cloud Infrastructure OpenSearch document containing the vector embedding for queries.
    title_key str
    Title key that stores the Title of a document, if available.
    url_key str
    URL key that stores the URL of a document, if available.
    bodyKey String
    Body key name.
    embeddingBodyKey String
    Field within customer managed Oracle Cloud Infrastructure OpenSearch document containing the vector embedding for queries.
    titleKey String
    Title key that stores the Title of a document, if available.
    urlKey String
    URL key that stores the URL of a document, if available.

    GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigSecretDetail

    ClientId string
    The IDCS Connect clientId.
    IdcsUrl string
    The URL represent authentication url of the IDCS.
    ScopeUrl string
    Fully qualified scope url
    Type string
    The type of OpenID. The allowed values are:

    • IDCS_SECRET: The OpenID configuration used is OpenSearch is IDCS.
    • BASIC_AUTH_SECRET: Basic authentication use for OpenSearch
    VaultSecretId string
    The OCID of the secret for basic authentication.
    ClientId string
    The IDCS Connect clientId.
    IdcsUrl string
    The URL represent authentication url of the IDCS.
    ScopeUrl string
    Fully qualified scope url
    Type string
    The type of OpenID. The allowed values are:

    • IDCS_SECRET: The OpenID configuration used is OpenSearch is IDCS.
    • BASIC_AUTH_SECRET: Basic authentication use for OpenSearch
    VaultSecretId string
    The OCID of the secret for basic authentication.
    clientId String
    The IDCS Connect clientId.
    idcsUrl String
    The URL represent authentication url of the IDCS.
    scopeUrl String
    Fully qualified scope url
    type String
    The type of OpenID. The allowed values are:

    • IDCS_SECRET: The OpenID configuration used is OpenSearch is IDCS.
    • BASIC_AUTH_SECRET: Basic authentication use for OpenSearch
    vaultSecretId String
    The OCID of the secret for basic authentication.
    clientId string
    The IDCS Connect clientId.
    idcsUrl string
    The URL represent authentication url of the IDCS.
    scopeUrl string
    Fully qualified scope url
    type string
    The type of OpenID. The allowed values are:

    • IDCS_SECRET: The OpenID configuration used is OpenSearch is IDCS.
    • BASIC_AUTH_SECRET: Basic authentication use for OpenSearch
    vaultSecretId string
    The OCID of the secret for basic authentication.
    client_id str
    The IDCS Connect clientId.
    idcs_url str
    The URL represent authentication url of the IDCS.
    scope_url str
    Fully qualified scope url
    type str
    The type of OpenID. The allowed values are:

    • IDCS_SECRET: The OpenID configuration used is OpenSearch is IDCS.
    • BASIC_AUTH_SECRET: Basic authentication use for OpenSearch
    vault_secret_id str
    The OCID of the secret for basic authentication.
    clientId String
    The IDCS Connect clientId.
    idcsUrl String
    The URL represent authentication url of the IDCS.
    scopeUrl String
    Fully qualified scope url
    type String
    The type of OpenID. The allowed values are:

    • IDCS_SECRET: The OpenID configuration used is OpenSearch is IDCS.
    • BASIC_AUTH_SECRET: Basic authentication use for OpenSearch
    vaultSecretId String
    The OCID of the secret for basic authentication.

    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.33.0 published on Thursday, May 1, 2025 by Pulumi
    pulumi/pulumi-oci