QNA store APIs

Submodules

vianops_client.api.qnastore.jargon_lexicon module

class JargonLexiconV1Api(config: Config | None = None)

Bases: ConfiguredBaseApiClass

create(data: V1JargonRequestList, output_type: str = 'object') → V1JargonModelResponseList

Create jargon lexicon

Parameters:: data (V1JargonRequestList) – Instance containing the data to create jargon lexicon.
Returns:: Instance containing a list of the created jargon lexicon.
Return type:: V1JargonModelResponseList

async create_async(data: V1JargonRequestList, output_type: str = 'object') → V1JargonModelResponseList

Create jargon lexicon

Parameters:: data (V1JargonRequestList) – Instance containing the data to create jargon lexicon.
Returns:: Instance containing a list of the created jargon lexicon.
Return type:: V1JargonModelResponseList

async delete(data: V1JargonFilters, deletetype: str = 'archive', output_type: str = 'object') → V1JargonModelResponseList

Mark deleted jargon lexicon

Parameters:: data (V1JargonFilters) – Instance containing the required data to select, and mark deleted the jargon lexicon.
Returns:: Instance containing response from jargon lexicon deletion.
Return type:: V1JargonModelResponseList

delete_url = '/v1/service/qnastore/v1/qna/jargon-lexicon/{deletetype}'

search(data: V1JargonSearch, output_type: str = 'object') → V1JargonModelPage

Search for jargon lexicon

Parameters:: data (V1JargonSearch) – Instance containing data to be use to perform a paginated jargon lexicon search.
Returns:: Instance containing a list of jargon lexicon collected from search along with pagination details.
Return type:: V1JargonModelPage

async search_async(data: V1JargonSearch, output_type: str = 'object') → V1JargonModelPage

Search for jargon lexicon

Parameters:: data (V1JargonSearch) – Instance containing data to be use to perform a paginated jargon lexicon search.
Returns:: Instance containing a list of jargon lexicon collected from search along with pagination details.
Return type:: V1JargonModelPage

search_url = '/v1/service/qnastore/v1/qna/jargon-lexicon/search'

update(data: V1JargonUpdate, output_type: str = 'object') → V1JargonModelResponseList

Update existing jargon lexicon

Parameters:: data (V1JargonUpdate) – An instance of V1JargonUpdate containing the data for updating the jargon lexicon.
Returns:: Instance containing information about the updated jargon lexicon.
Return type:: V1JargonModelResponseList

async update_async(data: V1JargonUpdate, output_type: str = 'object') → V1JargonModelResponseList

Update existing jargon lexicon

Parameters:: data (V1JargonUpdate) – An instance of V1JargonUpdate containing the data for updating the jargon lexicon.
Returns:: Instance containing information about the updated jargon lexicon.
Return type:: V1JargonModelResponseList

url_suffix = '/v1/service/qnastore/v1/qna/jargon-lexicon'

vianops_client.api.qnastore.qna_conversation module

class QNAConversationV1Api(config: Config | None = None)

Bases: ConfiguredBaseApiClass

create(data: V1QNAConversationList, output_type: str = 'object') → V1QNAConversationResponseList

Create QNAConversation

Parameters:: data (V1QNAConversationList) – Instance containing the data to create QNAConversation.
Returns:: Instance containing a list of the created QNAConversation.
Return type:: V1QNAConversationResponseList

async create_async(data: V1QNAConversationList, output_type: str = 'object') → V1QNAConversationResponseList

Create QNAConversation

Parameters:: data (V1QNAConversationList) – Instance containing the data to create QNAConversation.
Returns:: Instance containing a list of the created QNAConversation.
Return type:: V1QNAConversationResponseList

delete(data: V1QNAConversationFilters, deletetype: str = 'archive', output_type: str = 'object') → V1QNAConversationResponseList

Mark deleted QNAConversation

Parameters:: data (V1QNAConversationFilters) – Instance containing the required data to select, and mark deleted the QNAConversation.
Returns:: Instance containing response from QNAConversation deletion.
Return type:: V1QNAConversationResponseList

async delete_async(data: V1QNAConversationFilters, deletetype: str = 'archive', output_type: str = 'object') → V1QNAConversationResponseList

Mark deleted QNAConversation

Parameters:: data (V1QNAConversationFilters) – Instance containing the required data to select, and mark deleted the QNAConversation.
Returns:: Instance containing response from QNAConversation deletion.
Return type:: V1QNAConversationResponseList

delete_url = '/v1/service/qnastore/v1/qna/qna-conversation/{deletetype}'

search(data: V1QNAConversationSearch, output_type: str = 'object') → V1QNAConversationPage

Search for QNAConversation

Parameters:: data (V1QNAConversationSearch) – Instance containing data to be use to perform a paginated QNAConversation search.
Returns:: Instance containing a list of QNAConversation collected from search along with pagination details.
Return type:: V1QNAConversationPage

async search_async(data: V1QNAConversationSearch, output_type: str = 'object') → V1QNAConversationPage

Search for QNAConversation

Parameters:: data (V1QNAConversationSearch) – Instance containing data to be use to perform a paginated QNAConversation search.
Returns:: Instance containing a list of QNAConversation collected from search along with pagination details.
Return type:: V1QNAConversationPage

search_url = '/v1/service/qnastore/v1/qna/qna-conversation/search'

update(data: V1QNAConversationUpdates, output_type: str = 'object') → V1QNAConversationResponseList

Update existing QNAConversation

Parameters:: data (V1QNAConversationUpdates) – An instance of V1QNAConversationUpdates containing the data for updating the QNAConversation.
Returns:: Instance containing information about the updated QNAConversation.
Return type:: V1QNAConversationResponseList

async update_async(data: V1QNAConversationUpdates, output_type: str = 'object') → V1QNAConversationResponseList

Update existing QNAConversation

Parameters:: data (V1QNAConversationUpdates) – An instance of V1QNAConversationUpdates containing the data for updating the QNAConversation.
Returns:: Instance containing information about the updated QNAConversation.
Return type:: V1QNAConversationResponseList

upsert(name: str, description: str, status: str, feedback_value: bool, feedback_comment: str, is_pinned: str, is_favorite: str, is_report: str, overwrite: bool = True, output_type: str = 'object') → V1BaseQNAConversation | V1QNAConversationList

Create or update an existence QNAConversation

Parameters:

name (str) – The name of the QNAConversation.
description (str, optional) – The description of the QNAConversation.
status (str, optional) – The status of the QNAConversation.
feedback_value (bool, optional) – existing feedback_value.
feedback_comment (str, optional) – existing feedback_comment.
overwrite (bool, optional) – If True, existing QNAConversation gets updated; otherwise, existing QNAConversation is returned as is. (Default is True)

Returns:

Instance containing information about the QNAConversation created or updated

Return type:

Union[V1BaseQNAConversation, V1QNAConversationList]

async upsert_async(name: str, description: str, status: str, feedback_value: bool, feedback_comment: str, is_pinned: str, is_favorite: str, is_report: str, overwrite: bool = True, output_type: str = 'object') → V1BaseQNAConversation | V1QNAConversationList

Create or update an existence QNAConversation

Parameters:

name (str) – The name of the QNAConversation.
description (str, optional) – The description of the QNAConversation.
status (str, optional) – The status of the QNAConversation.
feedback_value (bool, optional) – existing feedback_value.
feedback_comment (str, optional) – existing feedback_comment.
overwrite (bool, optional) – If True, existing QNAConversation gets updated; otherwise, existing QNAConversation is returned as is. (Default is True)

Returns:

Instance containing information about the QNAConversation created or updated

Return type:

Union[V1BaseQNAConversation, V1QNAConversationList]

url_suffix = '/v1/service/qnastore/v1/qna/qna-conversation'

vianops_client.api.qnastore.qna_io module

class QNAIoV1Api(config: Config | None = None)

Bases: ConfiguredBaseApiClass

create(data: V1QnaIoList, output_type: str = 'object') → V1QnaIoResponseList

Create QNA IO

Parameters:: data (V1QnaIoList) – Instance containing the data to create metadata.
Returns:: Instance containing a list of the created metadata.
Return type:: V1QnaIoResponseList

async create_async(data: V1QnaIoList, output_type: str = 'object') → V1QnaIoResponseList

Create QNA IO

Parameters:: data (V1QnaIoList) – Instance containing the data to create metadata.
Returns:: Instance containing a list of the created metadata.
Return type:: V1QnaIoResponseList

delete(data: V1QnaIoFilters, deletetype: str = 'archive', output_type: str = 'object') → V1QnaIoResponseList

Mark deleted IO

Parameters:: data (V1QnaIoFilters) – Instance containing the required data to select, and mark deleted the IO.
Returns:: Instance containing response from IO deletion.
Return type:: V1QnaIoResponseList

async delete_async(data: V1QnaIoFilters, deletetype: str = 'archive', output_type: str = 'object') → V1QnaIoResponseList

Mark deleted IO

Parameters:: data (V1QnaIoFilters) – Instance containing the required data to select, and mark deleted the IO.
Returns:: Instance containing response from IO deletion.
Return type:: V1QnaIoResponseList

delete_url = '/v1/service/qnastore/v1/qna/io/{deletetype}'

search(data: V1QnaIoSearch, output_type: str = 'object') → V1QnaIoModelPage

Search for IO

Parameters:: data (V1QnaIoSearch) – Instance containing data to be use to perform a paginated IO search.
Returns:: Instance containing a list of IO collected from search along with pagination details.
Return type:: V1QnaIoModelPage

async search_async(data: V1QnaIoSearch, output_type: str = 'object') → V1QnaIoModelPage

Search for IO

Parameters:: data (V1QnaIoSearch) – Instance containing data to be use to perform a paginated IO search.
Returns:: Instance containing a list of IO collected from search along with pagination details.
Return type:: V1QnaIoModelPage

search_url = '/v1/service/qnastore/v1/qna/io/search'

update(data: V1QnaIoUpdates, output_type: str = 'object') → V1QnaIoResponseList

Update existing IO

Parameters:: data (V1QnaIoUpdates) – An instance of V1QnaIoUpdates containing the data for updating the IO.
Returns:: Instance containing information about the updated IO.
Return type:: V1QnaIoResponseList

async update_async(data: V1QnaIoUpdates, output_type: str = 'object') → V1QnaIoResponseList

Update existing IO

Parameters:: data (V1QnaIoUpdates) – An instance of V1QnaIoUpdates containing the data for updating the IO.
Returns:: Instance containing information about the updated IO.
Return type:: V1QnaIoResponseList

url_suffix = '/v1/service/qnastore/v1/qna/io'

vianops_client.api.qnastore.qna_jargon_identification module

class QNAJargonIdentificationV1Api(config: Config | None = None)

Bases: ConfiguredBaseApiClass

jargon_identification_url = '/v1/service/qnastore/v1/qna/jargon-identification'

url_suffix = '/v1/service/qnastore/v1'

validate_query(data: V1JargonIdentificationRequest, output_type: str = 'object') → V1JargonIdentificationResponse

async validate_query_async(data: V1JargonIdentificationRequest, output_type: str = 'object') → V1JargonIdentificationResponse

vianops_client.api.qnastore.qna_metadata module

class QNAMetedataV1Api(config: Config | None = None)

Bases: ConfiguredBaseApiClass

clone(data: V1QNAMetadataCloneRequest, output_type: str = 'object') → V1QNAMetadataCloneResponse

Clone metadata

Parameters:: data (V1QNAMetadataCloneRequest) – An instance of V1QNAMetadataCloneRequest containing the data to clone the metadata.
Returns:: Instance containing information about the cloned metadata.
Return type:: V1QNAMetadataCloneResponse

async clone_async(data: V1QNAMetadataCloneRequest, output_type: str = 'object') → V1QNAMetadataCloneResponse

Clone metadata

Parameters:: data (V1QNAMetadataCloneRequest) – An instance of V1QNAMetadataCloneRequest containing the data to clone the metadata.
Returns:: Instance containing information about the cloned metadata.
Return type:: V1QNAMetadataCloneResponse

clone_url = '/v1/service/qnastore/v1/qna/metadata/clone'

create(data: V1QNAMetadataModelList, output_type: str = 'object') → V1QNAMetadataModelList

Create QNA Metadata

Parameters:: data (V1QNAMetadataModelList) – Instance containing the data to create metadata.
Returns:: Instance containing a list of the created metadata.
Return type:: V1QNAMetadataModelList

async create_async(data: V1QNAMetadataModelList, output_type: str = 'object') → V1QNAMetadataModelList

Create QNA Metadata

Parameters:: data (V1QNAMetadataModelList) – Instance containing the data to create metadata.
Returns:: Instance containing a list of the created metadata.
Return type:: V1QNAMetadataModelList

create_db(data: V1QNACreateDBRequest, output_type: str = 'object') → V1QNACreateDBResponse

Create database

Parameters:: data (V1QNACreateDBRequest) – An instance of V1QNACreateDBRequest containing the data to create the database.
Returns:: Instance containing information about the successful creation of the database.
Return type:: V1QNACreateDBResponse

async create_db_async(data: V1QNACreateDBRequest, output_type: str = 'object') → V1QNACreateDBResponse

Create database

Parameters:: data (V1QNACreateDBRequest) – An instance of V1QNACreateDBRequest containing the data to create the database.
Returns:: Instance containing information about the successful creation of the database.
Return type:: V1QNACreateDBResponse

create_db_url = '/v1/service/qnastore/v1/qna/create_db'

create_url = '/v1/service/qnastore/v1/qna/metadata'

delete(data: V1QNAMetadataFilters, deletetype: str = 'archive', output_type: str = 'object') → V1QNAMetadataModelList

Mark deleted metadata

Parameters:: data (V1QNAMetadataFilters) – Instance containing the required data to select, and mark deleted the metadata.
Returns:: Instance containing response from metadata deletion.
Return type:: V1QNAMetadataModelList

async delete_async(data: V1QNAMetadataFilters, deletetype: str = 'archive', output_type: str = 'object') → V1QNAMetadataModelList

Mark deleted metadata

Parameters:: data (V1QNAMetadataFilters) – Instance containing the required data to select, and mark deleted the metadata.
Returns:: Instance containing response from metadata deletion.
Return type:: V1QNAMetadataModelList

delete_url = '/v1/service/qnastore/v1/qna/metadata/{deletetype}'

generate(data: V1QNAMetadataGenerateRequest, output_type: str = 'object') → V1QNAMetadataGenerateResponse

Generate metadata

Parameters:: data (V1QNAMetadataGenerateRequest) – An instance of V1QNAMetadataGenerateRequest containing the data to generate the metadata.
Returns:: Instance containing information about the generated metadata.
Return type:: V1QNAMetadataGenerateResponse

async generate_async(data: V1QNAMetadataGenerateRequest, output_type: str = 'object') → V1QNAMetadataGenerateResponse

Generate metadata

Parameters:: data (V1QNAMetadataGenerateRequest) – An instance of V1QNAMetadataGenerateRequest containing the data to generate the metadata.
Returns:: Instance containing information about the generated metadata.
Return type:: V1QNAMetadataGenerateResponse

generate_url = '/v1/service/qnastore/v1/qna/metadata/generate'

search(data: V1QNAMetadataSearch, output_type: str = 'object') → V1QNAMetadataPage

Search for metadata

Parameters:: data (V1QNAMetadataSearch) – Instance containing data to be use to perform a paginated metadata search.
Returns:: Instance containing a list of metadata collected from search along with pagination details.
Return type:: V1QNAMetadataPage

async search_async(data: V1QNAMetadataSearch, output_type: str = 'object') → V1QNAMetadataPage

Search for metadata

Parameters:: data (V1QNAMetadataSearch) – Instance containing data to be use to perform a paginated metadata search.
Returns:: Instance containing a list of metadata collected from search along with pagination details.
Return type:: V1QNAMetadataPage

search_url = '/v1/service/qnastore/v1/qna/metadata/search'

update(data: V1QNAMetadataUpdates, trigger_autogen_job: bool = True, output_type: str = 'object') → V1QNAMetadataModelList

Update existing metadata

Parameters:: data (V1QNAMetadataUpdates) – An instance of V1QNAMetadataUpdates containing the data for updating the metadata.
Returns:: Instance containing information about the updated metadata.
Return type:: V1QNAMetadataModelList

async update_async(data: V1QNAMetadataUpdates, trigger_autogen_job: bool = True, output_type: str = 'object') → V1QNAMetadataModelList

Update existing metadata

Parameters:: data (V1QNAMetadataUpdates) – An instance of V1QNAMetadataUpdates containing the data for updating the metadata.
Returns:: Instance containing information about the updated metadata.
Return type:: V1QNAMetadataModelList

update_url = '/v1/service/qnastore/v1/qna/metadata?trigger_autogen_job={trigger_autogen_job}'

url_suffix = '/v1/service/qnastore/v1/qna'

vianops_client.api.qnastore.qna_prompt_generation module

class QNAPromptGenerationV1Api(config: Config | None = None)

Bases: ConfiguredBaseApiClass

create(data: V1PromptGenerationModel, output_type: str = 'object') → V1PromptGenerationResponse

async create_async(data: V1PromptGenerationModel, output_type: str = 'object') → V1PromptGenerationResponse

prompt_generation_url = '/v1/service/qnastore/v1/prompt_generation/generate_prompt'

url_suffix = '/v1/service/qnastore/v1'

vianops_client.api.qnastore.qna_report module

class QNAReportV1Api(config: Config | None = None)

Bases: ConfiguredBaseApiClass

create(data: V1QNAReportList, output_type: str = 'object') → V1QNAReportResponseList

Create QNAReport

Parameters:: data (V1QNAReportList) – Instance containing the data to create QNAReport.
Returns:: Instance containing a list of the created QNAReport.
Return type:: V1QNAReportResponseList

async create_async(data: V1QNAReportList, output_type: str = 'object') → V1QNAReportResponseList

Create QNAReport

Parameters:: data (V1QNAReportList) – Instance containing the data to create QNAReport.
Returns:: Instance containing a list of the created QNAReport.
Return type:: V1QNAReportResponseList

async delete(data: V1QNAReportFilters, deletetype: str = 'archive', output_type: str = 'object') → V1QNAReportResponseList

Mark deleted QNAConversation

Parameters:: data (V1QNAConversationFilters) – Instance containing the required data to select, and mark deleted the QNAConversation.
Returns:: Instance containing response from QNAConversation deletion.
Return type:: V1QNAConversationResponseList

delete_url = '/v1/service/qnastore/v1/qna/qna-report/{deletetype}'

search(data: V1QNAReportSearch, output_type: str = 'object') → V1QNAReportPage

Search for QNAReport

Parameters:: data (V1QNAReportSearch) – Instance containing data to be use to perform a paginated QNAReport search.
Returns:: Instance containing a list of QNAReport collected from search along with pagination details.
Return type:: V1QNAReportPage

async search_async(data: V1QNAReportSearch, output_type: str = 'object') → V1QNAReportPage

Search for QNAReport

Parameters:: data (V1QNAReportSearch) – Instance containing data to be use to perform a paginated QNAReport search.
Returns:: Instance containing a list of QNAReport collected from search along with pagination details.
Return type:: V1QNAReportPage

search_url = '/v1/service/qnastore/v1/qna/qna-report/search'

update(data: V1QNAReportUpdates, output_type: str = 'object') → V1QNAReportResponseList

Update existing QNAReport

Parameters:: data (V1QNAReportUpdates) – An instance of V1QNAReportUpdates containing the data for updating the QNAReport.
Returns:: Instance containing information about the updated QNAReport.
Return type:: V1QNAReportResponseList

async update_async(data: V1QNAReportUpdates, output_type: str = 'object') → V1QNAReportResponseList

Update existing QNAReport

Parameters:: data (V1QNAReportUpdates) – An instance of V1QNAReportUpdates containing the data for updating the QNAReport.
Returns:: Instance containing information about the updated QNAReport.
Return type:: V1QNAReportResponseList

upsert(name: str, description: str, original_conversation_uuid: str, report_conversation_uuid: str, layout: dict, job_id: str, pdf_key: str, is_pinned: str, is_favorite: str, status: str, overwrite: bool = True, output_type: str = 'object') → V1BaseQNAReport | V1QNAReportList

Create or update an existence QNAReport

Parameters:

name (str) – The name of the QNAReport.
description (str, optional) – The description of the QNAReport.
original_conversation_uuid (str) – The UUID of the Original Conversation.
report_conversation_uuid (str) – The UUID of the Report Conversation.
layout (dict, optional) – The layout information of the QNAReport.
job_id (str, optional) – Job ID of QnaReport Job.
pdf_key – PDF Key of QnaReport.
status (str, optional) – The status of the QNAReport.
overwrite (bool, optional) – If True, existing QNAReport gets updated; otherwise, existing QNAReport is returned as is. (Default is True)

Returns:

Instance containing information about the QNAReport created or updated

Return type:

Union[V1BaseQNAReport, V1QNAReportList]

async upsert_async(name: str, description: str, original_conversation_uuid: str, report_conversation_uuid: str, layout: dict, job_id: str, pdf_key: str, is_pinned: str, is_favorite: str, status: str, overwrite: bool = True, output_type: str = 'object') → V1BaseQNAReport | V1QNAReportList

Create or update an existence QNAReport

Parameters:

name (str) – The name of the QNAReport.
description (str, optional) – The description of the QNAReport.
original_conversation_uuid (str) – The UUID of the Original Conversation.
report_conversation_uuid (str) – The UUID of the Report Conversation.
layout (dict, optional) – The layout information of the QNAReport.
job_id (str, optional) – Job ID of QnaReport Job.
pdf_key – PDF Key of QnaReport.
status (str, optional) – The status of the QNAReport.
overwrite (bool, optional) – If True, existing QNAReport gets updated; otherwise, existing QNAReport is returned as is. (Default is True)

Returns:

Instance containing information about the QNAReport created or updated

Return type:

Union[V1BaseQNAReport, V1QNAReportList]

url_suffix = '/v1/service/qnastore/v1/qna/qna-report'

vianops_client.api.qnastore.qna_sqlgpt module

class QNASqlGptV1Api(config: Config | None = None)

Bases: ConfiguredBaseApiClass

async create(data: V1PromptGenerationModel, output_type: str = 'object') → V1SQLGPTResponse

prompt_generation_url = '/v1/service/qnastore/v1/sql_gpt/run_sql'

url_suffix = '/v1/service/qnastore/v1'

vianops_client.api.qnastore.qna_text2sql module

class QNAText2sqlV1Api(config: Config | None = None)

Bases: ConfiguredBaseApiClass

create(data: V1Text2sqlList, output_type: str = 'object') → V1Text2sqlResponseList

Create QNA Text2sql

Parameters:: data (V1Text2sqlList) – Instance containing the data to create Text2sql.
Returns:: Instance containing a list of the created Text2sql.
Return type:: V1Text2sqlResponseList

delete(data: V1Text2sqlFilters, deletetype: str = 'archive', output_type: str = 'object') → V1Text2sqlResponseList

Mark deleted Text2sql

Parameters:: data (V1Text2sqlFilters) – Instance containing the required data to select, and mark deleted the Text2sql.
Returns:: Instance containing response from Text2sql deletion.
Return type:: V1Text2sqlResponseList

delete_url = '/v1/service/qnastore/v1/qna/text2sql/{deletetype}'

search(data: V1Text2sqlSearch, output_type: str = 'object') → V1Text2sqlPage

Search for Text2sql

Parameters:: data (V1Text2sqlSearch) – Instance containing data to be use to perform a paginated Text2sql search.
Returns:: Instance containing a list of Text2sql collected from search along with pagination details.
Return type:: V1Text2sqlPage

search_url = '/v1/service/qnastore/v1/qna/text2sql/search'

update(data: V1Text2sqlUpdates, output_type: str = 'object') → V1Text2sqlResponseList

Update existing Text2sql

Parameters:: data (V1Text2sqlUpdates) – An instance of V1Text2sqlUpdates containing the data for updating the Text2sql.
Returns:: Instance containing information about the updated Text2sql.
Return type:: V1Text2sqlResponseList

url_suffix = '/v1/service/qnastore/v1/qna/text2sql'

vianops_client.api.qnastore.qna_thread module

class QNAThreadV1Api(config: Config | None = None)

Bases: ConfiguredBaseApiClass

create(data: V1QNAThreadList, output_type: str = 'object') → V1QNAThreadResponseList

Create QNAThread

Parameters:: data (V1QNAThreadList) – Instance containing the data to create QNAThread.
Return type:: V1QNAThreadResponseList
Returns:: Instance containing a list of the created QNAThread.

async create_async(data: V1QNAThreadList, output_type: str = 'object') → V1QNAThreadResponseList

Create QNAThread

Parameters:: data (V1QNAThreadList) – Instance containing the data to create QNAThread.
Returns:: Instance containing a list of the created QNAThread.
Return type:: V1QNAThreadResponseList

delete(data: V1QNAThreadFilters, deletetype: str = 'archive', output_type: str = 'object') → V1QNAThreadResponseList

Mark deleted QNAThread

Parameters:: data (V1QNAThreadFilters) – Instance containing the required data to select, and mark deleted the QNAThread.
Returns:: Instance containing response from QNAThread deletion.
Return type:: V1QNAThreadResponseList

async delete_async(data: V1QNAThreadFilters, deletetype: str = 'archive', output_type: str = 'object') → V1QNAThreadResponseList

Mark deleted QNAThread

Parameters:: data (V1QNAThreadFilters) – Instance containing the required data to select, and mark deleted the QNAThread.
Returns:: Instance containing response from QNAThread deletion.
Return type:: V1QNAThreadResponseList

delete_url = '/v1/service/qnastore/v1/qna/qna-thread/{deletetype}'

search(data: V1QNAThreadSearch, output_type: str = 'object') → V1QNAThreadPage

Search for QNAThread

Parameters:: data (V1QNAThreadSearch) – Instance containing data to be use to perform a paginated QNAThread search.
Returns:: Instance containing a list of QNAThread collected from search along with pagination details.
Return type:: V1QNAThreadPage

async search_async(data: V1QNAThreadSearch, output_type: str = 'object') → V1QNAThreadPage

Search for QNAThread

Parameters:: data (V1QNAThreadSearch) – Instance containing data to be use to perform a paginated QNAThread search.
Returns:: Instance containing a list of QNAThread collected from search along with pagination details.
Return type:: V1QNAThreadPage

search_url = '/v1/service/qnastore/v1/qna/qna-thread/search'

update(data: V1QNAThreadUpdates, output_type: str = 'object') → V1QNAThreadResponseList

Update existing QNAThread

Parameters:: data (V1QNAThreadUpdates) – An instance of V1QNAThreadUpdates containing the data for updating the QNAThread.
Returns:: Instance containing information about the updated QNAThread.
Return type:: V1QNAThreadResponseList

async update_async(data: V1QNAThreadUpdates, output_type: str = 'object') → V1QNAThreadResponseList

Update existing QNAThread

Parameters:: data (V1QNAThreadUpdates) – An instance of V1QNAThreadUpdates containing the data for updating the QNAThread.
Returns:: Instance containing information about the updated QNAThread.
Return type:: V1QNAThreadResponseList

upsert(name: str, description: str, status: str, sources: List[str], qna_conversation_uuid: str, feedback_value: bool, feedback_comment: str, is_pinned: str, is_favorite: str, overwrite: bool = True, output_type: str = 'object') → V1BaseQNAThread | V1QNAThreadList

Create or update an existence QNAThread

Parameters:

name (str, optional) – The name of the QNAThread.
description (str, optional) – The description of the QNAThread.
status (str, optional) – The status of the QNAThread.
sources (list[str], optional) – List of model:UUID, qna_metadata:UUID or RAG:name
qna_conversation_uuid – qna_conversation:UUID.

:type qna_conversation_uuid:UUID str, required

Parameters:

feedback_value (bool, optional) – existing feedback_value.
feedback_comment (str, optional) – existing feedback_comment.
overwrite (bool, optional) – If True, existing QNAThread gets updated; otherwise, existing QNAThread is returned as is. (Default is True)

Returns:

Instance containing information about the QNAThread created or updated

Return type:

Union[V1BaseQNAThread, V1QNAThreadList]

async upsert_async(name: str, description: str, status: str, sources: List[str], qna_conversation_uuid: str, feedback_value: bool, feedback_comment: str, is_pinned: str, is_favorite: str, overwrite: bool = True, output_type: str = 'object') → V1BaseQNAThread | V1QNAThreadList

Create or update an existence QNAThread

Parameters:

name (str, optional) – The name of the QNAThread.
description (str, optional) – The description of the QNAThread.
status (str, optional) – The status of the QNAThread.
sources (list[str], optional) – List of model:UUID, qna_metadata:UUID or RAG:name
qna_conversation_uuid – qna_conversation:UUID.

:type qna_conversation_uuid:UUID str, required

Parameters:

feedback_value (bool, optional) – existing feedback_value.
feedback_comment (str, optional) – existing feedback_comment.
overwrite (bool, optional) – If True, existing QNAThread gets updated; otherwise, existing QNAThread is returned as is. (Default is True)

Returns:

Instance containing information about the QNAThread created or updated

Return type:

Union[V1BaseQNAThread, V1QNAThreadList]

url_suffix = '/v1/service/qnastore/v1/qna/qna-thread'

QNA store APIs

Submodules

vianops_client.api.qnastore.jargon_lexicon module

vianops_client.api.qnastore.qna_conversation module

vianops_client.api.qnastore.qna_io module

vianops_client.api.qnastore.qna_jargon_identification module

vianops_client.api.qnastore.qna_metadata module

vianops_client.api.qnastore.qna_prompt_generation module

vianops_client.api.qnastore.qna_report module

vianops_client.api.qnastore.qna_sqlgpt module

vianops_client.api.qnastore.qna_text2sql module

vianops_client.api.qnastore.qna_thread module

Module contents