knowledge_bases

Creates, updates, deletes, gets or lists a knowledge_bases resource.

Overview

Name	knowledge_bases
Type	Resource
Id	azure.ai_discovery.knowledge_bases

Fields

The following fields are returned by SELECT queries:

list

Name	Datatype	Description
id	string	The ID for the resource.
name	string	The knowledgeBase name. Required.
bookshelfName	string	The name of the associated Bookshelf tracked resource. Required.
copilotInstruction	string	The copilot instruction. Required.
createdAt	string (date-time)	The timestamp when the resource was created.
createdBy	string	The ID of the user who created this resource.
createdByType	string	The type of user who created this resource. Known values are: "User", "Application", and "System". (User, Application, System)
description	string	The description. Required.
knowledgeBaseUrl	string	URL to access the knowledge base.
lastModifiedAt	string (date-time)	The timestamp when the resource was last updated.
lastModifiedBy	string	The ID of the user who updated this resource.
lastModifiedByType	string	The type of user who updated this resource. Known values are: "User", "Application", and "System". (User, Application, System)
provisioningState	string	Provisioning state. Known values are: "Succeeded", "Failed", "Canceled", "Accepted", "Provisioning", "Updating", and "Deleting". (Succeeded, Failed, Canceled, Accepted, Provisioning, Updating, Deleting)
status	string	The status. Known values are: "NotStarted", "Running", "Succeeded", "Canceled", and "Failed". (NotStarted, Running, Succeeded, Canceled, Failed)
storageAssetReferences	array	Storage asset references to index.
tags	array	The tags.
version	string	Version. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	endpoint		List KnowledgeBase resources.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
endpoint	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: )

SELECT examples

list

List KnowledgeBase resources.

SELECT
id,
name,
bookshelfName,
copilotInstruction,
createdAt,
createdBy,
createdByType,
description,
knowledgeBaseUrl,
lastModifiedAt,
lastModifiedBy,
lastModifiedByType,
provisioningState,
status,
storageAssetReferences,
tags,
version
FROM azure.ai_discovery.knowledge_bases
WHERE endpoint = '{{ endpoint }}' -- required
;