Data Source: oci_generative_ai_agent_knowledge_base

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

GetKnowledgeBase

Gets information about a knowledge base.

Example Usage

data "oci_generative_ai_agent_knowledge_base" "test_knowledge_base" {
	#Required
	knowledge_base_id = oci_generative_ai_agent_knowledge_base.test_knowledge_base.id
}

Argument Reference

The following arguments are supported:

• knowledge_base_id - (Required) The OCID of the knowledge base.

Attributes Reference

The following attributes are exported:

• compartment_id - The OCID of the compartment.

• defined_tags - 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 - A description of the knowledge base.

• display_name - A user-friendly name. Does not have to be unique, and it’s changeable.

• freeform_tags - 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 - The OCID of the knowledge base.

• index_config - IndexConfig

  The index configuration of Knowledge bases.

  • cluster_id - The OCID of the OpenSearch Cluster.

  • database_connection - DatabaseConnection

    The connection type for Databases.

    • connection_id - The OCID of the Database Tools Connection.
    • connection_type - 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.

  • database_functions - Array of Database functions to be used.

    • name - The name of the Database function.

  • index_config_type - 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 - Index configuration for open search.

    • name - The index name in opensearch.

    • schema - IndexSchema

      The index schema details.

      • body_key - Body key name.
      • embedding_body_key - Field within customer managed Oracle Cloud Infrastructure OpenSearch document containing the vector embedding for queries.
      • title_key - Title key that stores the Title of a document, if available.
      • url_key - URL key that stores the URL of a document, if available.

  • secret_detail - SecretDetail

    The details of configured security configuration on OpenSearch.

    • client_id - The IDCS Connect clientId.
    • idcs_url - The URL represent authentication url of the IDCS.
    • scope_url - Fully qualified scope url
    • type - 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 - The OCID of the secret for basic authentication.

  • should_enable_hybrid_search - Whether to enable Hybrid search in service managed OpenSearch.

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

• system_tags - System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}

• time_created - 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 - The date and time the knowledge base was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z