knowledge_bases

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

Overview

Name	knowledge_bases
Type	Resource
Id	azure.search_documents.knowledge_bases

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
create_knowledge_base	insert	search_service_name		Creates a new knowledge base.
list_knowledge_bases	exec	search_service_name		Lists all knowledge bases available for a search service.
get_knowledge_base	exec	knowledge_base_name, search_service_name		Retrieves a knowledge base definition.

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
knowledge_base_name	string	The name of the knowledge base. Required.
search_service_name	string	Search service name. (default: )

INSERT examples

create_knowledge_base

Creates a new knowledge base.

INSERT INTO azure.search_documents.knowledge_bases (
search_service_name
)
SELECT 
'{{ search_service_name }}'
;

Manifest

# Description fields are for documentation purposes
- name: knowledge_bases
props:
  - name: search_service_name
    value: "{{ search_service_name }}"
    description: Required parameter for the knowledge_bases resource.

Lifecycle Methods

list_knowledge_bases

Lists all knowledge bases available for a search service.

EXEC azure.search_documents.knowledge_bases.list_knowledge_bases 
@search_service_name='{{ search_service_name }}' --required
;

get_knowledge_base

Retrieves a knowledge base definition.

EXEC azure.search_documents.knowledge_bases.get_knowledge_base 
@knowledge_base_name='{{ knowledge_base_name }}' --required, 
@search_service_name='{{ search_service_name }}' --required
;