knowledge_base_versions

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

Overview

Name	knowledge_base_versions
Type	Resource
Id	azure.ai_discovery.knowledge_base_versions

Fields

The following fields are returned by SELECT queries:

get_operation_status

Name	Datatype	Description
id	string	The unique ID of the operation. Required.
error	object	Error object that describes the error when status is 'Failed'.
result	object	A version.
status	string	The status of the operation. Required. Known values are: "NotStarted", "Running", "Succeeded", "Failed", and "Canceled". (NotStarted, Running, Succeeded, Failed, Canceled)

get

Name	Datatype	Description
id	string	The ID for the resource.
name	string	The version 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.

list

Name	Datatype	Description
id	string	The ID for the resource.
name	string	The version 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
get_operation_status	select	knowledge_base_name, version_name, operation_id, endpoint		Get the status of a long-running operation.
get	select	knowledge_base_name, version_name, endpoint		Fetch a KnowledgeBaseVersion by name.
list	select	knowledge_base_name, endpoint	createdSince	List KnowledgeBaseVersion resources.
create_or_update	insert	knowledge_base_name, version_name, endpoint, description, copilotInstruction		Creates or updates a KnowledgeBaseVersion.
create_or_update	replace	knowledge_base_name, version_name, endpoint, description, copilotInstruction		Creates or updates a KnowledgeBaseVersion.
delete	delete	knowledge_base_name, version_name, endpoint		Delete a KnowledgeBaseVersion.
get_latest_version	exec	knowledge_base_name, endpoint		Get the most recent version of KnowledgeBase.
delete_latest_version	exec	knowledge_base_name, endpoint		Delete the most recent version of KnowledgeBase.
start_indexing	exec	knowledge_base_name, version_name, endpoint		Start indexing.
cancel_indexing	exec	knowledge_base_name, version_name, endpoint		Cancel indexing.

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: )
knowledge_base_name	string	The knowledgeBase name. Required.
operation_id	string	The unique ID of the operation. Required.
version_name	string	The version name. Required.
createdSince	string (date-time)	The oldest creation timestamp to keep. Default value is None.

SELECT examples

get_operation_status

Get the status of a long-running operation.

SELECT
id,
error,
result,
status
FROM azure.ai_discovery.knowledge_base_versions
WHERE knowledge_base_name = '{{ knowledge_base_name }}' -- required
AND version_name = '{{ version_name }}' -- required
AND operation_id = '{{ operation_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

get

Fetch a KnowledgeBaseVersion by name.

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

list

List KnowledgeBaseVersion resources.

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

INSERT examples

create_or_update

Creates or updates a KnowledgeBaseVersion.

INSERT INTO azure.ai_discovery.knowledge_base_versions (
storageAssetReferences,
tags,
description,
copilotInstruction,
knowledge_base_name,
version_name,
endpoint
)
SELECT 
'{{ storageAssetReferences }}',
'{{ tags }}',
'{{ description }}' /* required */,
'{{ copilotInstruction }}' /* required */,
'{{ knowledge_base_name }}',
'{{ version_name }}',
'{{ endpoint }}'
RETURNING
id,
name,
bookshelfName,
copilotInstruction,
createdAt,
createdBy,
createdByType,
description,
knowledgeBaseUrl,
lastModifiedAt,
lastModifiedBy,
lastModifiedByType,
provisioningState,
status,
storageAssetReferences,
tags,
version
;

Manifest

# Description fields are for documentation purposes
- name: knowledge_base_versions
props:
  - name: knowledge_base_name
    value: "{{ knowledge_base_name }}"
    description: Required parameter for the knowledge_base_versions resource.
  - name: version_name
    value: "{{ version_name }}"
    description: Required parameter for the knowledge_base_versions resource.
  - name: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the knowledge_base_versions resource.
  - name: storageAssetReferences
    description: |
      Storage asset references to index.
    value:
      - id: "{{ id }}"
        userAssignedIdentity: "{{ userAssignedIdentity }}"
  - name: tags
    description: |
      The tags.
    value:
      - key: "{{ key }}"
        value: "{{ value }}"
  - name: description
    value: "{{ description }}"
    description: |
      The description. Required.
  - name: copilotInstruction
    value: "{{ copilotInstruction }}"
    description: |
      The copilot instruction. Required.

REPLACE examples

create_or_update

Creates or updates a KnowledgeBaseVersion.

REPLACE azure.ai_discovery.knowledge_base_versions
SET 
storageAssetReferences = '{{ storageAssetReferences }}',
tags = '{{ tags }}',
description = '{{ description }}',
copilotInstruction = '{{ copilotInstruction }}'
WHERE 
knowledge_base_name = '{{ knowledge_base_name }}' --required
AND version_name = '{{ version_name }}' --required
AND endpoint = '{{ endpoint }}' --required
AND description = '{{ description }}' --required
AND copilotInstruction = '{{ copilotInstruction }}' --required
RETURNING
id,
name,
bookshelfName,
copilotInstruction,
createdAt,
createdBy,
createdByType,
description,
knowledgeBaseUrl,
lastModifiedAt,
lastModifiedBy,
lastModifiedByType,
provisioningState,
status,
storageAssetReferences,
tags,
version;

DELETE examples

delete

Delete a KnowledgeBaseVersion.

DELETE FROM azure.ai_discovery.knowledge_base_versions
WHERE knowledge_base_name = '{{ knowledge_base_name }}' --required
AND version_name = '{{ version_name }}' --required
AND endpoint = '{{ endpoint }}' --required
;

Lifecycle Methods

get_latest_version

Get the most recent version of KnowledgeBase.

EXEC azure.ai_discovery.knowledge_base_versions.get_latest_version 
@knowledge_base_name='{{ knowledge_base_name }}' --required, 
@endpoint='{{ endpoint }}' --required
;

delete_latest_version

Delete the most recent version of KnowledgeBase.

EXEC azure.ai_discovery.knowledge_base_versions.delete_latest_version 
@knowledge_base_name='{{ knowledge_base_name }}' --required, 
@endpoint='{{ endpoint }}' --required
;

start_indexing

Start indexing.

EXEC azure.ai_discovery.knowledge_base_versions.start_indexing 
@knowledge_base_name='{{ knowledge_base_name }}' --required, 
@version_name='{{ version_name }}' --required, 
@endpoint='{{ endpoint }}' --required
;

cancel_indexing

Cancel indexing.

EXEC azure.ai_discovery.knowledge_base_versions.cancel_indexing 
@knowledge_base_name='{{ knowledge_base_name }}' --required, 
@version_name='{{ version_name }}' --required, 
@endpoint='{{ endpoint }}' --required
;