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

oci.GenerativeAi.AgentKnowledgeBase

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 Knowledge Base resource in Oracle Cloud Infrastructure Generative Ai Agent service.

    CreateKnowledgeBase

    Creates a knowledge base.

    Example Usage

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

const testKnowledgeBase = new oci.generativeai.AgentKnowledgeBase("test_knowledge_base", {
    compartmentId: compartmentId,
    indexConfig: {
        indexConfigType: knowledgeBaseIndexConfigIndexConfigType,
        clusterId: testCluster.id,
        databaseConnection: {
            connectionId: testConnection.id,
            connectionType: knowledgeBaseIndexConfigDatabaseConnectionConnectionType,
        },
        databaseFunctions: [{
            name: knowledgeBaseIndexConfigDatabaseFunctionsName,
        }],
        indexes: [{
            name: knowledgeBaseIndexConfigIndexesName,
            schema: {
                bodyKey: knowledgeBaseIndexConfigIndexesSchemaBodyKey,
                embeddingBodyKey: knowledgeBaseIndexConfigIndexesSchemaEmbeddingBodyKey,
                titleKey: knowledgeBaseIndexConfigIndexesSchemaTitleKey,
                urlKey: knowledgeBaseIndexConfigIndexesSchemaUrlKey,
            },
        }],
        secretDetail: {
            type: knowledgeBaseIndexConfigSecretDetailType,
            vaultSecretId: testSecret.id,
            clientId: testClient.id,
            idcsUrl: knowledgeBaseIndexConfigSecretDetailIdcsUrl,
            scopeUrl: knowledgeBaseIndexConfigSecretDetailScopeUrl,
        },
        shouldEnableHybridSearch: knowledgeBaseIndexConfigShouldEnableHybridSearch,
    },
    definedTags: {
        "Operations.CostCenter": "42",
    },
    description: knowledgeBaseDescription,
    displayName: knowledgeBaseDisplayName,
    freeformTags: {
        Department: "Finance",
    },
});

    import pulumi
import pulumi_oci as oci

test_knowledge_base = oci.generative_ai.AgentKnowledgeBase("test_knowledge_base",
    compartment_id=compartment_id,
    index_config={
        "index_config_type": knowledge_base_index_config_index_config_type,
        "cluster_id": test_cluster["id"],
        "database_connection": {
            "connection_id": test_connection["id"],
            "connection_type": knowledge_base_index_config_database_connection_connection_type,
        },
        "database_functions": [{
            "name": knowledge_base_index_config_database_functions_name,
        }],
        "indexes": [{
            "name": knowledge_base_index_config_indexes_name,
            "schema": {
                "body_key": knowledge_base_index_config_indexes_schema_body_key,
                "embedding_body_key": knowledge_base_index_config_indexes_schema_embedding_body_key,
                "title_key": knowledge_base_index_config_indexes_schema_title_key,
                "url_key": knowledge_base_index_config_indexes_schema_url_key,
            },
        }],
        "secret_detail": {
            "type": knowledge_base_index_config_secret_detail_type,
            "vault_secret_id": test_secret["id"],
            "client_id": test_client["id"],
            "idcs_url": knowledge_base_index_config_secret_detail_idcs_url,
            "scope_url": knowledge_base_index_config_secret_detail_scope_url,
        },
        "should_enable_hybrid_search": knowledge_base_index_config_should_enable_hybrid_search,
    },
    defined_tags={
        "Operations.CostCenter": "42",
    },
    description=knowledge_base_description,
    display_name=knowledge_base_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.NewAgentKnowledgeBase(ctx, "test_knowledge_base", &GenerativeAi.AgentKnowledgeBaseArgs{
			CompartmentId: pulumi.Any(compartmentId),
			IndexConfig: &generativeai.AgentKnowledgeBaseIndexConfigArgs{
				IndexConfigType: pulumi.Any(knowledgeBaseIndexConfigIndexConfigType),
				ClusterId:       pulumi.Any(testCluster.Id),
				DatabaseConnection: &generativeai.AgentKnowledgeBaseIndexConfigDatabaseConnectionArgs{
					ConnectionId:   pulumi.Any(testConnection.Id),
					ConnectionType: pulumi.Any(knowledgeBaseIndexConfigDatabaseConnectionConnectionType),
				},
				DatabaseFunctions: generativeai.AgentKnowledgeBaseIndexConfigDatabaseFunctionArray{
					&generativeai.AgentKnowledgeBaseIndexConfigDatabaseFunctionArgs{
						Name: pulumi.Any(knowledgeBaseIndexConfigDatabaseFunctionsName),
					},
				},
				Indexes: generativeai.AgentKnowledgeBaseIndexConfigIndexArray{
					&generativeai.AgentKnowledgeBaseIndexConfigIndexArgs{
						Name: pulumi.Any(knowledgeBaseIndexConfigIndexesName),
						Schema: &generativeai.AgentKnowledgeBaseIndexConfigIndexSchemaArgs{
							BodyKey:          pulumi.Any(knowledgeBaseIndexConfigIndexesSchemaBodyKey),
							EmbeddingBodyKey: pulumi.Any(knowledgeBaseIndexConfigIndexesSchemaEmbeddingBodyKey),
							TitleKey:         pulumi.Any(knowledgeBaseIndexConfigIndexesSchemaTitleKey),
							UrlKey:           pulumi.Any(knowledgeBaseIndexConfigIndexesSchemaUrlKey),
						},
					},
				},
				SecretDetail: &generativeai.AgentKnowledgeBaseIndexConfigSecretDetailArgs{
					Type:          pulumi.Any(knowledgeBaseIndexConfigSecretDetailType),
					VaultSecretId: pulumi.Any(testSecret.Id),
					ClientId:      pulumi.Any(testClient.Id),
					IdcsUrl:       pulumi.Any(knowledgeBaseIndexConfigSecretDetailIdcsUrl),
					ScopeUrl:      pulumi.Any(knowledgeBaseIndexConfigSecretDetailScopeUrl),
				},
				ShouldEnableHybridSearch: pulumi.Any(knowledgeBaseIndexConfigShouldEnableHybridSearch),
			},
			DefinedTags: pulumi.StringMap{
				"Operations.CostCenter": pulumi.String("42"),
			},
			Description: pulumi.Any(knowledgeBaseDescription),
			DisplayName: pulumi.Any(knowledgeBaseDisplayName),
			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 testKnowledgeBase = new Oci.GenerativeAi.AgentKnowledgeBase("test_knowledge_base", new()
    {
        CompartmentId = compartmentId,
        IndexConfig = new Oci.GenerativeAi.Inputs.AgentKnowledgeBaseIndexConfigArgs
        {
            IndexConfigType = knowledgeBaseIndexConfigIndexConfigType,
            ClusterId = testCluster.Id,
            DatabaseConnection = new Oci.GenerativeAi.Inputs.AgentKnowledgeBaseIndexConfigDatabaseConnectionArgs
            {
                ConnectionId = testConnection.Id,
                ConnectionType = knowledgeBaseIndexConfigDatabaseConnectionConnectionType,
            },
            DatabaseFunctions = new[]
            {
                new Oci.GenerativeAi.Inputs.AgentKnowledgeBaseIndexConfigDatabaseFunctionArgs
                {
                    Name = knowledgeBaseIndexConfigDatabaseFunctionsName,
                },
            },
            Indexes = new[]
            {
                new Oci.GenerativeAi.Inputs.AgentKnowledgeBaseIndexConfigIndexArgs
                {
                    Name = knowledgeBaseIndexConfigIndexesName,
                    Schema = new Oci.GenerativeAi.Inputs.AgentKnowledgeBaseIndexConfigIndexSchemaArgs
                    {
                        BodyKey = knowledgeBaseIndexConfigIndexesSchemaBodyKey,
                        EmbeddingBodyKey = knowledgeBaseIndexConfigIndexesSchemaEmbeddingBodyKey,
                        TitleKey = knowledgeBaseIndexConfigIndexesSchemaTitleKey,
                        UrlKey = knowledgeBaseIndexConfigIndexesSchemaUrlKey,
                    },
                },
            },
            SecretDetail = new Oci.GenerativeAi.Inputs.AgentKnowledgeBaseIndexConfigSecretDetailArgs
            {
                Type = knowledgeBaseIndexConfigSecretDetailType,
                VaultSecretId = testSecret.Id,
                ClientId = testClient.Id,
                IdcsUrl = knowledgeBaseIndexConfigSecretDetailIdcsUrl,
                ScopeUrl = knowledgeBaseIndexConfigSecretDetailScopeUrl,
            },
            ShouldEnableHybridSearch = knowledgeBaseIndexConfigShouldEnableHybridSearch,
        },
        DefinedTags = 
        {
            { "Operations.CostCenter", "42" },
        },
        Description = knowledgeBaseDescription,
        DisplayName = knowledgeBaseDisplayName,
        FreeformTags = 
        {
            { "Department", "Finance" },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.GenerativeAi.AgentKnowledgeBase;
import com.pulumi.oci.GenerativeAi.AgentKnowledgeBaseArgs;
import com.pulumi.oci.GenerativeAi.inputs.AgentKnowledgeBaseIndexConfigArgs;
import com.pulumi.oci.GenerativeAi.inputs.AgentKnowledgeBaseIndexConfigDatabaseConnectionArgs;
import com.pulumi.oci.GenerativeAi.inputs.AgentKnowledgeBaseIndexConfigSecretDetailArgs;
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 testKnowledgeBase = new AgentKnowledgeBase("testKnowledgeBase", AgentKnowledgeBaseArgs.builder()
            .compartmentId(compartmentId)
            .indexConfig(AgentKnowledgeBaseIndexConfigArgs.builder()
                .indexConfigType(knowledgeBaseIndexConfigIndexConfigType)
                .clusterId(testCluster.id())
                .databaseConnection(AgentKnowledgeBaseIndexConfigDatabaseConnectionArgs.builder()
                    .connectionId(testConnection.id())
                    .connectionType(knowledgeBaseIndexConfigDatabaseConnectionConnectionType)
                    .build())
                .databaseFunctions(AgentKnowledgeBaseIndexConfigDatabaseFunctionArgs.builder()
                    .name(knowledgeBaseIndexConfigDatabaseFunctionsName)
                    .build())
                .indexes(AgentKnowledgeBaseIndexConfigIndexArgs.builder()
                    .name(knowledgeBaseIndexConfigIndexesName)
                    .schema(AgentKnowledgeBaseIndexConfigIndexSchemaArgs.builder()
                        .bodyKey(knowledgeBaseIndexConfigIndexesSchemaBodyKey)
                        .embeddingBodyKey(knowledgeBaseIndexConfigIndexesSchemaEmbeddingBodyKey)
                        .titleKey(knowledgeBaseIndexConfigIndexesSchemaTitleKey)
                        .urlKey(knowledgeBaseIndexConfigIndexesSchemaUrlKey)
                        .build())
                    .build())
                .secretDetail(AgentKnowledgeBaseIndexConfigSecretDetailArgs.builder()
                    .type(knowledgeBaseIndexConfigSecretDetailType)
                    .vaultSecretId(testSecret.id())
                    .clientId(testClient.id())
                    .idcsUrl(knowledgeBaseIndexConfigSecretDetailIdcsUrl)
                    .scopeUrl(knowledgeBaseIndexConfigSecretDetailScopeUrl)
                    .build())
                .shouldEnableHybridSearch(knowledgeBaseIndexConfigShouldEnableHybridSearch)
                .build())
            .definedTags(Map.of("Operations.CostCenter", "42"))
            .description(knowledgeBaseDescription)
            .displayName(knowledgeBaseDisplayName)
            .freeformTags(Map.of("Department", "Finance"))
            .build());

    }
}

    resources:
  testKnowledgeBase:
    type: oci:GenerativeAi:AgentKnowledgeBase
    name: test_knowledge_base
    properties:
      compartmentId: ${compartmentId}
      indexConfig:
        indexConfigType: ${knowledgeBaseIndexConfigIndexConfigType}
        clusterId: ${testCluster.id}
        databaseConnection:
          connectionId: ${testConnection.id}
          connectionType: ${knowledgeBaseIndexConfigDatabaseConnectionConnectionType}
        databaseFunctions:
          - name: ${knowledgeBaseIndexConfigDatabaseFunctionsName}
        indexes:
          - name: ${knowledgeBaseIndexConfigIndexesName}
            schema:
              bodyKey: ${knowledgeBaseIndexConfigIndexesSchemaBodyKey}
              embeddingBodyKey: ${knowledgeBaseIndexConfigIndexesSchemaEmbeddingBodyKey}
              titleKey: ${knowledgeBaseIndexConfigIndexesSchemaTitleKey}
              urlKey: ${knowledgeBaseIndexConfigIndexesSchemaUrlKey}
        secretDetail:
          type: ${knowledgeBaseIndexConfigSecretDetailType}
          vaultSecretId: ${testSecret.id}
          clientId: ${testClient.id}
          idcsUrl: ${knowledgeBaseIndexConfigSecretDetailIdcsUrl}
          scopeUrl: ${knowledgeBaseIndexConfigSecretDetailScopeUrl}
        shouldEnableHybridSearch: ${knowledgeBaseIndexConfigShouldEnableHybridSearch}
      definedTags:
        Operations.CostCenter: '42'
      description: ${knowledgeBaseDescription}
      displayName: ${knowledgeBaseDisplayName}
      freeformTags:
        Department: Finance

    Create AgentKnowledgeBase Resource

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

    Constructor syntax

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

@overload
def AgentKnowledgeBase(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       compartment_id: Optional[str] = None,
                       index_config: Optional[_generativeai.AgentKnowledgeBaseIndexConfigArgs] = 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 NewAgentKnowledgeBase(ctx *Context, name string, args AgentKnowledgeBaseArgs, opts ...ResourceOption) (*AgentKnowledgeBase, error)
    public AgentKnowledgeBase(string name, AgentKnowledgeBaseArgs args, CustomResourceOptions? opts = null)
    public AgentKnowledgeBase(String name, AgentKnowledgeBaseArgs args)
public AgentKnowledgeBase(String name, AgentKnowledgeBaseArgs args, CustomResourceOptions options)

    type: oci:GenerativeAi:AgentKnowledgeBase
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 AgentKnowledgeBaseArgs
    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 AgentKnowledgeBaseArgs
    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 AgentKnowledgeBaseArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AgentKnowledgeBaseArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AgentKnowledgeBaseArgs
    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 agentKnowledgeBaseResource = new Oci.GenerativeAi.AgentKnowledgeBase("agentKnowledgeBaseResource", new()
{
    CompartmentId = "string",
    IndexConfig = new Oci.GenerativeAi.Inputs.AgentKnowledgeBaseIndexConfigArgs
    {
        IndexConfigType = "string",
        ClusterId = "string",
        DatabaseConnection = new Oci.GenerativeAi.Inputs.AgentKnowledgeBaseIndexConfigDatabaseConnectionArgs
        {
            ConnectionId = "string",
            ConnectionType = "string",
        },
        DatabaseFunctions = new[]
        {
            new Oci.GenerativeAi.Inputs.AgentKnowledgeBaseIndexConfigDatabaseFunctionArgs
            {
                Name = "string",
            },
        },
        Indexes = new[]
        {
            new Oci.GenerativeAi.Inputs.AgentKnowledgeBaseIndexConfigIndexArgs
            {
                Name = "string",
                Schema = new Oci.GenerativeAi.Inputs.AgentKnowledgeBaseIndexConfigIndexSchemaArgs
                {
                    BodyKey = "string",
                    EmbeddingBodyKey = "string",
                    TitleKey = "string",
                    UrlKey = "string",
                },
            },
        },
        SecretDetail = new Oci.GenerativeAi.Inputs.AgentKnowledgeBaseIndexConfigSecretDetailArgs
        {
            Type = "string",
            VaultSecretId = "string",
            ClientId = "string",
            IdcsUrl = "string",
            ScopeUrl = "string",
        },
        ShouldEnableHybridSearch = false,
    },
    DefinedTags = 
    {
        { "string", "string" },
    },
    Description = "string",
    DisplayName = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
});

    example, err := GenerativeAi.NewAgentKnowledgeBase(ctx, "agentKnowledgeBaseResource", &GenerativeAi.AgentKnowledgeBaseArgs{
	CompartmentId: pulumi.String("string"),
	IndexConfig: &generativeai.AgentKnowledgeBaseIndexConfigArgs{
		IndexConfigType: pulumi.String("string"),
		ClusterId:       pulumi.String("string"),
		DatabaseConnection: &generativeai.AgentKnowledgeBaseIndexConfigDatabaseConnectionArgs{
			ConnectionId:   pulumi.String("string"),
			ConnectionType: pulumi.String("string"),
		},
		DatabaseFunctions: generativeai.AgentKnowledgeBaseIndexConfigDatabaseFunctionArray{
			&generativeai.AgentKnowledgeBaseIndexConfigDatabaseFunctionArgs{
				Name: pulumi.String("string"),
			},
		},
		Indexes: generativeai.AgentKnowledgeBaseIndexConfigIndexArray{
			&generativeai.AgentKnowledgeBaseIndexConfigIndexArgs{
				Name: pulumi.String("string"),
				Schema: &generativeai.AgentKnowledgeBaseIndexConfigIndexSchemaArgs{
					BodyKey:          pulumi.String("string"),
					EmbeddingBodyKey: pulumi.String("string"),
					TitleKey:         pulumi.String("string"),
					UrlKey:           pulumi.String("string"),
				},
			},
		},
		SecretDetail: &generativeai.AgentKnowledgeBaseIndexConfigSecretDetailArgs{
			Type:          pulumi.String("string"),
			VaultSecretId: pulumi.String("string"),
			ClientId:      pulumi.String("string"),
			IdcsUrl:       pulumi.String("string"),
			ScopeUrl:      pulumi.String("string"),
		},
		ShouldEnableHybridSearch: pulumi.Bool(false),
	},
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	DisplayName: pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var agentKnowledgeBaseResource = new AgentKnowledgeBase("agentKnowledgeBaseResource", AgentKnowledgeBaseArgs.builder()
    .compartmentId("string")
    .indexConfig(AgentKnowledgeBaseIndexConfigArgs.builder()
        .indexConfigType("string")
        .clusterId("string")
        .databaseConnection(AgentKnowledgeBaseIndexConfigDatabaseConnectionArgs.builder()
            .connectionId("string")
            .connectionType("string")
            .build())
        .databaseFunctions(AgentKnowledgeBaseIndexConfigDatabaseFunctionArgs.builder()
            .name("string")
            .build())
        .indexes(AgentKnowledgeBaseIndexConfigIndexArgs.builder()
            .name("string")
            .schema(AgentKnowledgeBaseIndexConfigIndexSchemaArgs.builder()
                .bodyKey("string")
                .embeddingBodyKey("string")
                .titleKey("string")
                .urlKey("string")
                .build())
            .build())
        .secretDetail(AgentKnowledgeBaseIndexConfigSecretDetailArgs.builder()
            .type("string")
            .vaultSecretId("string")
            .clientId("string")
            .idcsUrl("string")
            .scopeUrl("string")
            .build())
        .shouldEnableHybridSearch(false)
        .build())
    .definedTags(Map.of("string", "string"))
    .description("string")
    .displayName("string")
    .freeformTags(Map.of("string", "string"))
    .build());

    agent_knowledge_base_resource = oci.generative_ai.AgentKnowledgeBase("agentKnowledgeBaseResource",
    compartment_id="string",
    index_config={
        "index_config_type": "string",
        "cluster_id": "string",
        "database_connection": {
            "connection_id": "string",
            "connection_type": "string",
        },
        "database_functions": [{
            "name": "string",
        }],
        "indexes": [{
            "name": "string",
            "schema": {
                "body_key": "string",
                "embedding_body_key": "string",
                "title_key": "string",
                "url_key": "string",
            },
        }],
        "secret_detail": {
            "type": "string",
            "vault_secret_id": "string",
            "client_id": "string",
            "idcs_url": "string",
            "scope_url": "string",
        },
        "should_enable_hybrid_search": False,
    },
    defined_tags={
        "string": "string",
    },
    description="string",
    display_name="string",
    freeform_tags={
        "string": "string",
    })

    const agentKnowledgeBaseResource = new oci.generativeai.AgentKnowledgeBase("agentKnowledgeBaseResource", {
    compartmentId: "string",
    indexConfig: {
        indexConfigType: "string",
        clusterId: "string",
        databaseConnection: {
            connectionId: "string",
            connectionType: "string",
        },
        databaseFunctions: [{
            name: "string",
        }],
        indexes: [{
            name: "string",
            schema: {
                bodyKey: "string",
                embeddingBodyKey: "string",
                titleKey: "string",
                urlKey: "string",
            },
        }],
        secretDetail: {
            type: "string",
            vaultSecretId: "string",
            clientId: "string",
            idcsUrl: "string",
            scopeUrl: "string",
        },
        shouldEnableHybridSearch: false,
    },
    definedTags: {
        string: "string",
    },
    description: "string",
    displayName: "string",
    freeformTags: {
        string: "string",
    },
});

    type: oci:GenerativeAi:AgentKnowledgeBase
properties:
    compartmentId: string
    definedTags:
        string: string
    description: string
    displayName: string
    freeformTags:
        string: string
    indexConfig:
        clusterId: string
        databaseConnection:
            connectionId: string
            connectionType: string
        databaseFunctions:
            - name: string
        indexConfigType: string
        indexes:
            - name: string
              schema:
                bodyKey: string
                embeddingBodyKey: string
                titleKey: string
                urlKey: string
        secretDetail:
            clientId: string
            idcsUrl: string
            scopeUrl: string
            type: string
            vaultSecretId: string
        shouldEnableHybridSearch: false

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

    CompartmentId string
    (Updatable) The OCID of the compartment to create the knowledge base in.
    IndexConfig AgentKnowledgeBaseIndexConfig

    (Updatable) IndexConfig

    The index configuration of Knowledge bases.

    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 user-friendly description of the knowledge base.
    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
    (Updatable) The OCID of the compartment to create the knowledge base in.
    IndexConfig AgentKnowledgeBaseIndexConfigArgs

    (Updatable) IndexConfig

    The index configuration of Knowledge bases.

    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 user-friendly description of the knowledge base.
    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
    (Updatable) The OCID of the compartment to create the knowledge base in.
    indexConfig AgentKnowledgeBaseIndexConfig

    (Updatable) IndexConfig

    The index configuration of Knowledge bases.

    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 user-friendly description of the knowledge base.
    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
    (Updatable) The OCID of the compartment to create the knowledge base in.
    indexConfig AgentKnowledgeBaseIndexConfig

    (Updatable) IndexConfig

    The index configuration of Knowledge bases.

    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 user-friendly description of the knowledge base.
    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
    (Updatable) The OCID of the compartment to create the knowledge base in.
    index_config generativeai.AgentKnowledgeBaseIndexConfigArgs

    (Updatable) IndexConfig

    The index configuration of Knowledge bases.

    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 user-friendly description of the knowledge base.
    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
    (Updatable) The OCID of the compartment to create the knowledge base in.
    indexConfig Property Map

    (Updatable) IndexConfig

    The index configuration of Knowledge bases.

    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 user-friendly description of the knowledge base.
    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 AgentKnowledgeBase 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 knowledge base 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 knowledge base.
    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
    Id string
    The provider-assigned unique ID for this managed resource.
    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
    The current state of the knowledge base.
    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
    id String
    The provider-assigned unique ID for this managed resource.
    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
    The current state of the knowledge base.
    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
    id string
    The provider-assigned unique ID for this managed resource.
    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
    The current state of the knowledge base.
    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
    id str
    The provider-assigned unique ID for this managed resource.
    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
    The current state of the knowledge base.
    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
    id String
    The provider-assigned unique ID for this managed resource.
    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
    The current state of the knowledge base.
    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

    Look up Existing AgentKnowledgeBase Resource

    Get an existing AgentKnowledgeBase 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?: AgentKnowledgeBaseState, opts?: CustomResourceOptions): AgentKnowledgeBase
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compartment_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,
        index_config: Optional[_generativeai.AgentKnowledgeBaseIndexConfigArgs] = 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) -> AgentKnowledgeBase
    func GetAgentKnowledgeBase(ctx *Context, name string, id IDInput, state *AgentKnowledgeBaseState, opts ...ResourceOption) (*AgentKnowledgeBase, error)
    public static AgentKnowledgeBase Get(string name, Input<string> id, AgentKnowledgeBaseState? state, CustomResourceOptions? opts = null)
    public static AgentKnowledgeBase get(String name, Output<String> id, AgentKnowledgeBaseState 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
    (Updatable) The OCID of the compartment to create the knowledge base in.
    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 user-friendly description of the knowledge base.
    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"}
    IndexConfig AgentKnowledgeBaseIndexConfig

    (Updatable) IndexConfig

    The index configuration of Knowledge bases.

    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
    The current state of the knowledge base.
    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
    (Updatable) The OCID of the compartment to create the knowledge base in.
    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 user-friendly description of the knowledge base.
    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"}
    IndexConfig AgentKnowledgeBaseIndexConfigArgs

    (Updatable) IndexConfig

    The index configuration of Knowledge bases.

    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
    The current state of the knowledge base.
    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
    (Updatable) The OCID of the compartment to create the knowledge base in.
    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 user-friendly description of the knowledge base.
    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"}
    indexConfig AgentKnowledgeBaseIndexConfig

    (Updatable) IndexConfig

    The index configuration of Knowledge bases.

    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
    The current state of the knowledge base.
    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
    (Updatable) The OCID of the compartment to create the knowledge base in.
    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 user-friendly description of the knowledge base.
    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"}
    indexConfig AgentKnowledgeBaseIndexConfig

    (Updatable) IndexConfig

    The index configuration of Knowledge bases.

    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
    The current state of the knowledge base.
    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
    (Updatable) The OCID of the compartment to create the knowledge base in.
    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 user-friendly description of the knowledge base.
    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"}
    index_config generativeai.AgentKnowledgeBaseIndexConfigArgs

    (Updatable) IndexConfig

    The index configuration of Knowledge bases.

    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
    The current state of the knowledge base.
    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
    (Updatable) The OCID of the compartment to create the knowledge base in.
    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 user-friendly description of the knowledge base.
    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"}
    indexConfig Property Map

    (Updatable) IndexConfig

    The index configuration of Knowledge bases.

    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
    The current state of the knowledge base.
    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

    Supporting Types

    AgentKnowledgeBaseIndexConfig, AgentKnowledgeBaseIndexConfigArgs

    IndexConfigType string
    (Updatable) 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.
    ClusterId string
    (Updatable) The OCID of the OpenSearch Cluster.
    DatabaseConnection AgentKnowledgeBaseIndexConfigDatabaseConnection

    (Updatable) DatabaseConnection

    The connection type for Databases.

    DatabaseFunctions List<AgentKnowledgeBaseIndexConfigDatabaseFunction>
    (Updatable) Array of Database functions to be used.
    Indexes List<AgentKnowledgeBaseIndexConfigIndex>
    (Updatable) Index configuration for open search.
    SecretDetail AgentKnowledgeBaseIndexConfigSecretDetail

    (Updatable) SecretDetail

    The details of configured security configuration on OpenSearch.

    ShouldEnableHybridSearch bool

    (Updatable) Whether to enable Hybrid search in service managed OpenSearch.

    ** 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

    IndexConfigType string
    (Updatable) 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.
    ClusterId string
    (Updatable) The OCID of the OpenSearch Cluster.
    DatabaseConnection AgentKnowledgeBaseIndexConfigDatabaseConnection

    (Updatable) DatabaseConnection

    The connection type for Databases.

    DatabaseFunctions []AgentKnowledgeBaseIndexConfigDatabaseFunction
    (Updatable) Array of Database functions to be used.
    Indexes []AgentKnowledgeBaseIndexConfigIndex
    (Updatable) Index configuration for open search.
    SecretDetail AgentKnowledgeBaseIndexConfigSecretDetail

    (Updatable) SecretDetail

    The details of configured security configuration on OpenSearch.

    ShouldEnableHybridSearch bool

    (Updatable) Whether to enable Hybrid search in service managed OpenSearch.

    ** 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

    indexConfigType String
    (Updatable) 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.
    clusterId String
    (Updatable) The OCID of the OpenSearch Cluster.
    databaseConnection AgentKnowledgeBaseIndexConfigDatabaseConnection

    (Updatable) DatabaseConnection

    The connection type for Databases.

    databaseFunctions List<AgentKnowledgeBaseIndexConfigDatabaseFunction>
    (Updatable) Array of Database functions to be used.
    indexes List<AgentKnowledgeBaseIndexConfigIndex>
    (Updatable) Index configuration for open search.
    secretDetail AgentKnowledgeBaseIndexConfigSecretDetail

    (Updatable) SecretDetail

    The details of configured security configuration on OpenSearch.

    shouldEnableHybridSearch Boolean

    (Updatable) Whether to enable Hybrid search in service managed OpenSearch.

    ** 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

    indexConfigType string
    (Updatable) 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.
    clusterId string
    (Updatable) The OCID of the OpenSearch Cluster.
    databaseConnection AgentKnowledgeBaseIndexConfigDatabaseConnection

    (Updatable) DatabaseConnection

    The connection type for Databases.

    databaseFunctions AgentKnowledgeBaseIndexConfigDatabaseFunction[]
    (Updatable) Array of Database functions to be used.
    indexes AgentKnowledgeBaseIndexConfigIndex[]
    (Updatable) Index configuration for open search.
    secretDetail AgentKnowledgeBaseIndexConfigSecretDetail

    (Updatable) SecretDetail

    The details of configured security configuration on OpenSearch.

    shouldEnableHybridSearch boolean

    (Updatable) Whether to enable Hybrid search in service managed OpenSearch.

    ** 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

    index_config_type str
    (Updatable) 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.
    cluster_id str
    (Updatable) The OCID of the OpenSearch Cluster.
    database_connection generativeai.AgentKnowledgeBaseIndexConfigDatabaseConnection

    (Updatable) DatabaseConnection

    The connection type for Databases.

    database_functions Sequence[generativeai.AgentKnowledgeBaseIndexConfigDatabaseFunction]
    (Updatable) Array of Database functions to be used.
    indexes Sequence[generativeai.AgentKnowledgeBaseIndexConfigIndex]
    (Updatable) Index configuration for open search.
    secret_detail generativeai.AgentKnowledgeBaseIndexConfigSecretDetail

    (Updatable) SecretDetail

    The details of configured security configuration on OpenSearch.

    should_enable_hybrid_search bool

    (Updatable) Whether to enable Hybrid search in service managed OpenSearch.

    ** 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

    indexConfigType String
    (Updatable) 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.
    clusterId String
    (Updatable) The OCID of the OpenSearch Cluster.
    databaseConnection Property Map

    (Updatable) DatabaseConnection

    The connection type for Databases.

    databaseFunctions List<Property Map>
    (Updatable) Array of Database functions to be used.
    indexes List<Property Map>
    (Updatable) Index configuration for open search.
    secretDetail Property Map

    (Updatable) SecretDetail

    The details of configured security configuration on OpenSearch.

    shouldEnableHybridSearch Boolean

    (Updatable) Whether to enable Hybrid search in service managed OpenSearch.

    ** 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

    AgentKnowledgeBaseIndexConfigDatabaseConnection, AgentKnowledgeBaseIndexConfigDatabaseConnectionArgs

    ConnectionId string
    (Updatable) The OCID of the Database Tools Connection.
    ConnectionType string
    (Updatable) 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
    (Updatable) The OCID of the Database Tools Connection.
    ConnectionType string
    (Updatable) 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
    (Updatable) The OCID of the Database Tools Connection.
    connectionType String
    (Updatable) 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
    (Updatable) The OCID of the Database Tools Connection.
    connectionType string
    (Updatable) 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
    (Updatable) The OCID of the Database Tools Connection.
    connection_type str
    (Updatable) 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
    (Updatable) The OCID of the Database Tools Connection.
    connectionType String
    (Updatable) 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.

    AgentKnowledgeBaseIndexConfigDatabaseFunction, AgentKnowledgeBaseIndexConfigDatabaseFunctionArgs

    Name string
    (Updatable) The name of the Database function.
    Name string
    (Updatable) The name of the Database function.
    name String
    (Updatable) The name of the Database function.
    name string
    (Updatable) The name of the Database function.
    name str
    (Updatable) The name of the Database function.
    name String
    (Updatable) The name of the Database function.

    AgentKnowledgeBaseIndexConfigIndex, AgentKnowledgeBaseIndexConfigIndexArgs

    Name string
    (Updatable) The index name in opensearch.
    Schema AgentKnowledgeBaseIndexConfigIndexSchema

    (Updatable) IndexSchema

    The index schema details.

    Name string
    (Updatable) The index name in opensearch.
    Schema AgentKnowledgeBaseIndexConfigIndexSchema

    (Updatable) IndexSchema

    The index schema details.

    name String
    (Updatable) The index name in opensearch.
    schema AgentKnowledgeBaseIndexConfigIndexSchema

    (Updatable) IndexSchema

    The index schema details.

    name string
    (Updatable) The index name in opensearch.
    schema AgentKnowledgeBaseIndexConfigIndexSchema

    (Updatable) IndexSchema

    The index schema details.

    name str
    (Updatable) The index name in opensearch.
    schema generativeai.AgentKnowledgeBaseIndexConfigIndexSchema

    (Updatable) IndexSchema

    The index schema details.

    name String
    (Updatable) The index name in opensearch.
    schema Property Map

    (Updatable) IndexSchema

    The index schema details.

    AgentKnowledgeBaseIndexConfigIndexSchema, AgentKnowledgeBaseIndexConfigIndexSchemaArgs

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

    AgentKnowledgeBaseIndexConfigSecretDetail, AgentKnowledgeBaseIndexConfigSecretDetailArgs

    Type string
    (Updatable) 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
    (Updatable) The OCID of the secret for basic authentication.
    ClientId string
    (Updatable) The IDCS Connect clientId.
    IdcsUrl string
    (Updatable) The URL represent authentication url of the IDCS.
    ScopeUrl string
    (Updatable) Fully qualified scope url
    Type string
    (Updatable) 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
    (Updatable) The OCID of the secret for basic authentication.
    ClientId string
    (Updatable) The IDCS Connect clientId.
    IdcsUrl string
    (Updatable) The URL represent authentication url of the IDCS.
    ScopeUrl string
    (Updatable) Fully qualified scope url
    type String
    (Updatable) 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
    (Updatable) The OCID of the secret for basic authentication.
    clientId String
    (Updatable) The IDCS Connect clientId.
    idcsUrl String
    (Updatable) The URL represent authentication url of the IDCS.
    scopeUrl String
    (Updatable) Fully qualified scope url
    type string
    (Updatable) 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
    (Updatable) The OCID of the secret for basic authentication.
    clientId string
    (Updatable) The IDCS Connect clientId.
    idcsUrl string
    (Updatable) The URL represent authentication url of the IDCS.
    scopeUrl string
    (Updatable) Fully qualified scope url
    type str
    (Updatable) 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
    (Updatable) The OCID of the secret for basic authentication.
    client_id str
    (Updatable) The IDCS Connect clientId.
    idcs_url str
    (Updatable) The URL represent authentication url of the IDCS.
    scope_url str
    (Updatable) Fully qualified scope url
    type String
    (Updatable) 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
    (Updatable) The OCID of the secret for basic authentication.
    clientId String
    (Updatable) The IDCS Connect clientId.
    idcsUrl String
    (Updatable) The URL represent authentication url of the IDCS.
    scopeUrl String
    (Updatable) Fully qualified scope url

    Import

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

    $ pulumi import oci:GenerativeAi/agentKnowledgeBase:AgentKnowledgeBase test_knowledge_base "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