pdstools.infinity.resources.knowledge_buddy
===========================================

.. py:module:: pdstools.infinity.resources.knowledge_buddy


Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/pdstools/infinity/resources/knowledge_buddy/knowledge_buddy/index


Classes
-------

.. autoapisummary::

   pdstools.infinity.resources.knowledge_buddy.KnowledgeBuddy


Package Contents
----------------

.. py:class:: KnowledgeBuddy(client)

   Bases: :py:obj:`pdstools.infinity.internal._resource.SyncAPIResource`


   Helper class that provides a standard way to create an ABC using
   inheritance.


   .. py:attribute:: custom_exception_hook


   .. py:method:: question(question: str, buddy: str, include_search_results: bool = False, question_source: Optional[str] = None, question_tag: Optional[str] = None, additional_text_inputs: Optional[List[TextInput]] = None, filter_attributes: Optional[List[FilterAttributes]] = None, user_name: Optional[str] = None, user_email: Optional[str] = None) -> BuddyResponse

      Send a question to the Knowledge Buddy.

      :param question: Input the question.
      :type question: str: (Required)
      :param buddy: Input the buddy name.
                    If you do not have the required role to access the buddy,
                    an access error will be displayed.
      :type buddy: str (Required)
      :param include_search_results: If set to true, this property returns chunks of data related to each
                                     SEARCHRESULTS information variable that is defined for the Knowledge Buddy,
                                     which is the same information that is returned during a semantic search.
      :type include_search_results: bool (Default: False)
      :param question_source: Input a source for the question based on the use case.
                              This information can be used for reporting purposes.
      :type question_source: str (Optional)
      :param question_tag: Input a tag for the question based on the use case.
                           This information can be used for reporting purposes.
      :type question_tag: str (Optional)
      :param additional_text_inputs: Input the search variable values, where key is the search variable name
                                     and value is the data that replaces the variable.
                                     Search variables are defined in the Information section of the Knowledge Buddy.
      :type additional_text_inputs: List[TextInput]: (Optional)
      :param filter_attributes: Input the filter attributes to get the filtered chunks from the vector database.
                                User-defined attributes ingested with content can be used as filters.
                                Filters are recommended to improve the semantic search performance.
                                Database indexes can be used further to enhance the search.
      :type filter_attributes: List[FilterAttributes]: (Optional)



   .. py:method:: feedback(question_id: str, helpful: Literal['Yes', 'No', 'Unsure'] = 'Unsure', comments: Optional[str] = None)

      Capture feedback for a question asked to the Knowledge Buddy.

      :param question_id: The Knowledge Buddy case Id that is required to capture the feedback.
      :type question_id: str: (Required)
      :param helpful: Was this comment helpful? Valid values are Yes, No and Unsure.
                      Empty value defaults to Unsure.
      :type helpful: str (Optional)
      :param comments: Text of the comment.
      :type comments: str (Optional)