import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * This resource provides the Knowledge Base resource in Oracle Cloud Infrastructure Generative Ai Agent service. * Api doc link for the resource: https://docs.oracle.com/iaas/api/#/en/generative-ai-agents/latest/KnowledgeBase * * Example terraform configs related to the resource : https://github.com/oracle/terraform-provider-oci/tree/master/examples/generative_ai_agent * * Creates a knowledge base. * * ## Example Usage * * ```typescript * 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 === "true", * }, * definedTags: { * "Operations.CostCenter": "42", * }, * description: knowledgeBaseDescription, * displayName: knowledgeBaseDisplayName, * freeformTags: { * Department: "Finance", * }, * }); * ``` * * ## Import * * KnowledgeBases can be imported using the `id`, e.g. * * ```sh * $ pulumi import oci:GenerativeAi/agentKnowledgeBase:AgentKnowledgeBase test_knowledge_base "id" * ``` */ export declare class AgentKnowledgeBase extends pulumi.CustomResource { /** * Get an existing AgentKnowledgeBase resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: AgentKnowledgeBaseState, opts?: pulumi.CustomResourceOptions): AgentKnowledgeBase; /** * Returns true if the given object is an instance of AgentKnowledgeBase. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is AgentKnowledgeBase; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to create the knowledge base in. */ readonly compartmentId: pulumi.Output; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ readonly definedTags: pulumi.Output<{ [key: string]: string; }>; /** * (Updatable) A user-friendly description of the knowledge base. */ readonly description: pulumi.Output; /** * (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ readonly displayName: pulumi.Output; /** * (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](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ readonly freeformTags: pulumi.Output<{ [key: string]: string; }>; /** * (Updatable) The index configuration of Knowledge bases. */ readonly indexConfig: pulumi.Output; /** * Statistics for Default Knowledge Base. */ readonly knowledgeBaseStatistics: pulumi.Output; /** * 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. */ readonly lifecycleDetails: pulumi.Output; /** * The current state of the knowledge base. */ readonly state: pulumi.Output; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ readonly systemTags: pulumi.Output<{ [key: string]: string; }>; /** * The date and time the knowledge base was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ readonly timeCreated: pulumi.Output; /** * The date and time the knowledge base was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ readonly timeUpdated: pulumi.Output; /** * Create a AgentKnowledgeBase resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: AgentKnowledgeBaseArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering AgentKnowledgeBase resources. */ export interface AgentKnowledgeBaseState { /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to create the knowledge base in. */ compartmentId?: pulumi.Input; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ definedTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) A user-friendly description of the knowledge base. */ description?: pulumi.Input; /** * (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName?: pulumi.Input; /** * (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](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ freeformTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) The index configuration of Knowledge bases. */ indexConfig?: pulumi.Input; /** * Statistics for Default Knowledge Base. */ knowledgeBaseStatistics?: pulumi.Input[] | undefined>; /** * 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. */ lifecycleDetails?: pulumi.Input; /** * The current state of the knowledge base. */ state?: pulumi.Input; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * The date and time the knowledge base was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated?: pulumi.Input; /** * The date and time the knowledge base was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeUpdated?: pulumi.Input; } /** * The set of arguments for constructing a AgentKnowledgeBase resource. */ export interface AgentKnowledgeBaseArgs { /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to create the knowledge base in. */ compartmentId: pulumi.Input; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ definedTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) A user-friendly description of the knowledge base. */ description?: pulumi.Input; /** * (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName?: pulumi.Input; /** * (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](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ freeformTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) The index configuration of Knowledge bases. */ indexConfig: pulumi.Input; } //# sourceMappingURL=agentKnowledgeBase.d.ts.map