abacusai.api_class.dataset_application_connector
================================================

.. py:module:: abacusai.api_class.dataset_application_connector


Classes
-------

.. autoapisummary::

   abacusai.api_class.dataset_application_connector.ApplicationConnectorDatasetConfig
   abacusai.api_class.dataset_application_connector.ConfluenceDatasetConfig
   abacusai.api_class.dataset_application_connector.BoxDatasetConfig
   abacusai.api_class.dataset_application_connector.GoogleAnalyticsDatasetConfig
   abacusai.api_class.dataset_application_connector.GoogleDriveDatasetConfig
   abacusai.api_class.dataset_application_connector.JiraDatasetConfig
   abacusai.api_class.dataset_application_connector.OneDriveDatasetConfig
   abacusai.api_class.dataset_application_connector.SharepointDatasetConfig
   abacusai.api_class.dataset_application_connector.ZendeskDatasetConfig
   abacusai.api_class.dataset_application_connector.AbacusUsageMetricsDatasetConfig
   abacusai.api_class.dataset_application_connector.TeamsScraperDatasetConfig
   abacusai.api_class.dataset_application_connector.FreshserviceDatasetConfig
   abacusai.api_class.dataset_application_connector.SftpDatasetConfig
   abacusai.api_class.dataset_application_connector._ApplicationConnectorDatasetConfigFactory


Module Contents
---------------

.. py:class:: ApplicationConnectorDatasetConfig

   Bases: :py:obj:`abacusai.api_class.dataset.DatasetConfig`


   An abstract class for dataset configs specific to application connectors.

   :param application_connector_type: The type of application connector
   :type application_connector_type: enums.ApplicationConnectorType
   :param application_connector_id: The ID of the application connector
   :type application_connector_id: str
   :param document_processing_config: The document processing configuration. Only valid if is_documentset is True for the dataset.
   :type document_processing_config: DatasetDocumentProcessingConfig


   .. py:attribute:: application_connector_type
      :type:  abacusai.api_class.enums.ApplicationConnectorType
      :value: None



   .. py:attribute:: application_connector_id
      :type:  str
      :value: None



   .. py:attribute:: document_processing_config
      :type:  abacusai.api_class.dataset.DatasetDocumentProcessingConfig
      :value: None



   .. py:method:: _get_builder()
      :classmethod:



.. py:class:: ConfluenceDatasetConfig

   Bases: :py:obj:`ApplicationConnectorDatasetConfig`


   Dataset config for Confluence Application Connector
   :param location: The location of the pages to fetch
   :type location: str
   :param space_key: The space key of the space from which we fetch pages
   :type space_key: str
   :param pull_attachments: Whether to pull attachments for each page
   :type pull_attachments: bool
   :param extract_bounding_boxes: Whether to extract bounding boxes from the documents
   :type extract_bounding_boxes: bool
   :param location_type: The type of location to be fetched. Maps values in `location` to content type, example: 'spaceKey/folderTitle/*' -> 'folder'
   :type location_type: str


   .. py:attribute:: location
      :type:  str
      :value: None



   .. py:attribute:: space_key
      :type:  str
      :value: None



   .. py:attribute:: pull_attachments
      :type:  bool
      :value: False



   .. py:attribute:: extract_bounding_boxes
      :type:  bool
      :value: False



   .. py:attribute:: location_type
      :type:  str
      :value: None



   .. py:method:: __post_init__()


.. py:class:: BoxDatasetConfig

   Bases: :py:obj:`ApplicationConnectorDatasetConfig`


   Dataset config for Box Application Connector
   :param location: The regex location of the files to fetch
   :type location: str
   :param csv_delimiter: If the file format is CSV, use a specific csv delimiter
   :type csv_delimiter: str
   :param merge_file_schemas: Signifies if the merge file schema policy is enabled. Not applicable if is_documentset is True
   :type merge_file_schemas: bool


   .. py:attribute:: location
      :type:  str
      :value: None



   .. py:attribute:: csv_delimiter
      :type:  str
      :value: None



   .. py:attribute:: merge_file_schemas
      :type:  bool
      :value: False



   .. py:method:: __post_init__()


.. py:class:: GoogleAnalyticsDatasetConfig

   Bases: :py:obj:`ApplicationConnectorDatasetConfig`


   Dataset config for Google Analytics Application Connector

   :param location: The view id of the report in the connector to fetch
   :type location: str
   :param start_timestamp: Unix timestamp of the start of the period that will be queried
   :type start_timestamp: int
   :param end_timestamp: Unix timestamp of the end of the period that will be queried
   :type end_timestamp: int


   .. py:attribute:: location
      :type:  str
      :value: None



   .. py:attribute:: start_timestamp
      :type:  int
      :value: None



   .. py:attribute:: end_timestamp
      :type:  int
      :value: None



   .. py:method:: __post_init__()


.. py:class:: GoogleDriveDatasetConfig

   Bases: :py:obj:`ApplicationConnectorDatasetConfig`


   Dataset config for Google Drive Application Connector

   :param location: The regex location of the files to fetch
   :type location: str
   :param csv_delimiter: If the file format is CSV, use a specific csv delimiter
   :type csv_delimiter: str
   :param extract_bounding_boxes: Signifies whether to extract bounding boxes out of the documents. Only valid if is_documentset if True
   :type extract_bounding_boxes: bool
   :param merge_file_schemas: Signifies if the merge file schema policy is enabled. Not applicable if is_documentset is True
   :type merge_file_schemas: bool


   .. py:attribute:: location
      :type:  str
      :value: None



   .. py:attribute:: csv_delimiter
      :type:  str
      :value: None



   .. py:attribute:: extract_bounding_boxes
      :type:  bool
      :value: False



   .. py:attribute:: merge_file_schemas
      :type:  bool
      :value: False



   .. py:method:: __post_init__()


.. py:class:: JiraDatasetConfig

   Bases: :py:obj:`ApplicationConnectorDatasetConfig`


   Dataset config for Jira Application Connector

   :param jql: The JQL query for fetching issues
   :type jql: str
   :param custom_fields: A list of custom fields to include in the dataset
   :type custom_fields: list
   :param include_comments: Fetch comments for each issue
   :type include_comments: bool
   :param include_watchers: Fetch watchers for each issue
   :type include_watchers: bool


   .. py:attribute:: jql
      :type:  str
      :value: None



   .. py:attribute:: custom_fields
      :type:  list
      :value: None



   .. py:attribute:: include_comments
      :type:  bool
      :value: False



   .. py:attribute:: include_watchers
      :type:  bool
      :value: False



   .. py:method:: __post_init__()


.. py:class:: OneDriveDatasetConfig

   Bases: :py:obj:`ApplicationConnectorDatasetConfig`


   Dataset config for OneDrive Application Connector

   :param location: The regex location of the files to fetch
   :type location: str
   :param csv_delimiter: If the file format is CSV, use a specific csv delimiter
   :type csv_delimiter: str
   :param extract_bounding_boxes: Signifies whether to extract bounding boxes out of the documents. Only valid if is_documentset if True
   :type extract_bounding_boxes: bool
   :param merge_file_schemas: Signifies if the merge file schema policy is enabled. Not applicable if is_documentset is True
   :type merge_file_schemas: bool


   .. py:attribute:: location
      :type:  str
      :value: None



   .. py:attribute:: csv_delimiter
      :type:  str
      :value: None



   .. py:attribute:: extract_bounding_boxes
      :type:  bool
      :value: False



   .. py:attribute:: merge_file_schemas
      :type:  bool
      :value: False



   .. py:method:: __post_init__()


.. py:class:: SharepointDatasetConfig

   Bases: :py:obj:`ApplicationConnectorDatasetConfig`


   Dataset config for Sharepoint Application Connector

   :param location: The regex location of the files to fetch
   :type location: str
   :param csv_delimiter: If the file format is CSV, use a specific csv delimiter
   :type csv_delimiter: str
   :param extract_bounding_boxes: Signifies whether to extract bounding boxes out of the documents. Only valid if is_documentset if True
   :type extract_bounding_boxes: bool
   :param merge_file_schemas: Signifies if the merge file schema policy is enabled. Not applicable if is_documentset is True
   :type merge_file_schemas: bool


   .. py:attribute:: location
      :type:  str
      :value: None



   .. py:attribute:: csv_delimiter
      :type:  str
      :value: None



   .. py:attribute:: extract_bounding_boxes
      :type:  bool
      :value: False



   .. py:attribute:: merge_file_schemas
      :type:  bool
      :value: False



   .. py:method:: __post_init__()


.. py:class:: ZendeskDatasetConfig

   Bases: :py:obj:`ApplicationConnectorDatasetConfig`


   Dataset config for Zendesk Application Connector

   :param location: The regex location of the files to fetch
   :type location: str


   .. py:attribute:: location
      :type:  str
      :value: None



   .. py:method:: __post_init__()


.. py:class:: AbacusUsageMetricsDatasetConfig

   Bases: :py:obj:`ApplicationConnectorDatasetConfig`


   Dataset config for Abacus Usage Metrics Application Connector

   :param include_entire_conversation_history: Whether to show the entire history for this deployment conversation
   :type include_entire_conversation_history: bool
   :param include_all_feedback: Whether to include all feedback for this deployment conversation
   :type include_all_feedback: bool
   :param resolve_matching_documents: Whether to get matching document references for response instead of prompt.
                                      Needs to recalculate them if highlights are unavailable in summary_info
   :type resolve_matching_documents: bool


   .. py:attribute:: include_entire_conversation_history
      :type:  bool
      :value: False



   .. py:attribute:: include_all_feedback
      :type:  bool
      :value: False



   .. py:attribute:: resolve_matching_documents
      :type:  bool
      :value: False



   .. py:method:: __post_init__()


.. py:class:: TeamsScraperDatasetConfig

   Bases: :py:obj:`ApplicationConnectorDatasetConfig`


   Dataset config for Teams Scraper Application Connector

   :param pull_chat_messages: Whether to pull teams chat messages
   :type pull_chat_messages: bool
   :param pull_channel_posts: Whether to pull posts for each channel
   :type pull_channel_posts: bool
   :param pull_transcripts: Whether to pull transcripts for calendar meetings
   :type pull_transcripts: bool


   .. py:attribute:: pull_chat_messages
      :type:  bool
      :value: False



   .. py:attribute:: pull_channel_posts
      :type:  bool
      :value: False



   .. py:attribute:: pull_transcripts
      :type:  bool
      :value: False



   .. py:method:: __post_init__()


.. py:class:: FreshserviceDatasetConfig

   Bases: :py:obj:`ApplicationConnectorDatasetConfig`


   Dataset config for Freshservice Application Connector


   .. py:method:: __post_init__()


.. py:class:: SftpDatasetConfig

   Bases: :py:obj:`ApplicationConnectorDatasetConfig`


   Dataset config for SFTP Application Connector

   :param location: The regex location of the files to fetch
   :type location: str
   :param csv_delimiter: If the file format is CSV, use a specific csv delimiter
   :type csv_delimiter: str
   :param extract_bounding_boxes: Signifies whether to extract bounding boxes out of the documents. Only valid if is_documentset if True
   :type extract_bounding_boxes: bool
   :param merge_file_schemas: Signifies if the merge file schema policy is enabled. Not applicable if is_documentset is True
   :type merge_file_schemas: bool


   .. py:attribute:: location
      :type:  str
      :value: None



   .. py:attribute:: csv_delimiter
      :type:  str
      :value: None



   .. py:attribute:: extract_bounding_boxes
      :type:  bool
      :value: False



   .. py:attribute:: merge_file_schemas
      :type:  bool
      :value: False



   .. py:method:: __post_init__()


.. py:class:: _ApplicationConnectorDatasetConfigFactory

   Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory`


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


   .. py:attribute:: config_abstract_class


   .. py:attribute:: config_class_key
      :value: 'application_connector_type'



   .. py:attribute:: config_class_map


