Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace DataSource

A data source points to the source of your data. After you add a data source to a knowledge base, you must ingest the data source's data, so that agents using the knowledge base can refer to the data.

To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see [Getting Started with Policies](https://docs.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm).

Properties

compartmentId

compartmentId: string

The OCID of the compartment.

dataSourceConfig

definedTags

definedTags: object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}

Type declaration

  • [key: string]: object
    • [key: string]: any

Optional description

description: undefined | string

A description of the data source.

displayName

displayName: string

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

freeformTags

freeformTags: object

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: {@code {\"Department\": \"Finance\"}}

Type declaration

  • [key: string]: string

id

id: string

The OCID of the data source.

knowledgeBaseId

knowledgeBaseId: string

The OCID of the parent KnowledgeBase.

Optional lifecycleDetails

lifecycleDetails: undefined | string

A message that describes the current state of the data source in more detail. For example, can be used to provide actionable information for a resource in the Failed state.

lifecycleState

lifecycleState: LifecycleState

The current state of the data source.

Optional metadata

metadata: undefined | object

Key-value pairs to allow additional configurations.

Optional systemTags

systemTags: undefined | object

System tags for this resource. Each key is predefined and scoped to a namespace.

Example: {@code {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}}

timeCreated

timeCreated: Date

The date and time the data source was created, in the format defined by RFC 3339.

Example: {@code 2016-08-25T21:10:29.600Z}

Optional timeUpdated

timeUpdated: Date

The date and time the data source was updated, in the format defined by RFC 3339.

Example: {@code 2016-08-25T21:10:29.600Z}

Functions

getDeserializedJsonObj

getJsonObj