KnowledgeBase interface

Package:

@azure/ai-discovery

A knowledgeBase.

Properties

bookshelfName	The name of the associated Bookshelf tracked resource.
copilotInstruction	The copilot instruction
createdAt	The timestamp when the resource was created
createdBy	The ID of the user who created this resource.
createdByApiVersion	The API version used to create this knowledge base.
createdByType	The type of user who created this resource.
description	The description
error	Error details if provisioning failed.
id	The ID for the resource.
knowledgeBaseUrl	URL to access the knowledge base.
lastIndexingRun	The details of the most recent indexing run.
lastModifiedAt	The timestamp when the resource was last updated
lastModifiedBy	The ID of the user who updated this resource.
lastModifiedByType	The type of user who updated this resource.
name	The knowledgeBase name.
provisioningState	Provisioning state.
status	The status
storageAssetReferences	Storage asset references to index.
tags	The tags

Property Details

bookshelfName

The name of the associated Bookshelf tracked resource.

bookshelfName: string

Property Value

string

copilotInstruction

The copilot instruction

copilotInstruction: string

Property Value

string

createdAt

The timestamp when the resource was created

createdAt?: Date

Property Value

Date

createdBy

The ID of the user who created this resource.

createdBy?: string

Property Value

string

createdByApiVersion

The API version used to create this knowledge base.

createdByApiVersion?: string

Property Value

string

createdByType

The type of user who created this resource.

createdByType?: string

Property Value

string

description

The description

description: string

Property Value

string

error

Error details if provisioning failed.

error?: ErrorModel

Property Value

ErrorModel

id

The ID for the resource.

id?: string

Property Value

string

knowledgeBaseUrl

URL to access the knowledge base.

knowledgeBaseUrl?: string

Property Value

string

lastIndexingRun

The details of the most recent indexing run.

lastIndexingRun?: LastIndexingRun

Property Value

LastIndexingRun

lastModifiedAt

The timestamp when the resource was last updated

lastModifiedAt?: Date

Property Value

Date

lastModifiedBy

The ID of the user who updated this resource.

lastModifiedBy?: string

Property Value

string

lastModifiedByType

The type of user who updated this resource.

lastModifiedByType?: string

Property Value

string

name

The knowledgeBase name.

name: string

Property Value

string

provisioningState

Provisioning state.

provisioningState?: string

Property Value

string

status

The status

status?: string

Property Value

string

storageAssetReferences

Storage asset references to index.

storageAssetReferences?: StorageAssetReference[]

Property Value

StorageAssetReference[]

tags

The tags

tags?: Tag[]

Property Value

Tag[]