diff --git a/deepsearch/cps/apis/public_v2/__init__.py b/deepsearch/cps/apis/public_v2/__init__.py index bfd9a910..0347f6a8 100644 --- a/deepsearch/cps/apis/public_v2/__init__.py +++ b/deepsearch/cps/apis/public_v2/__init__.py @@ -50,9 +50,13 @@ from deepsearch.cps.apis.public_v2.models.ccs_project import CCSProject from deepsearch.cps.apis.public_v2.models.cps_package import CPSPackage from deepsearch.cps.apis.public_v2.models.cps_summary import CPSSummary +from deepsearch.cps.apis.public_v2.models.ccs_task import CcsTask from deepsearch.cps.apis.public_v2.models.collection_metadata_settings import CollectionMetadataSettings from deepsearch.cps.apis.public_v2.models.config import Config +from deepsearch.cps.apis.public_v2.models.convert_document_request import ConvertDocumentRequest from deepsearch.cps.apis.public_v2.models.convert_documents_request_body import ConvertDocumentsRequestBody +from deepsearch.cps.apis.public_v2.models.convert_documents_sources import ConvertDocumentsSources +from deepsearch.cps.apis.public_v2.models.convert_upload_documents_request_body import ConvertUploadDocumentsRequestBody from deepsearch.cps.apis.public_v2.models.cps_task import CpsTask from deepsearch.cps.apis.public_v2.models.data import Data from deepsearch.cps.apis.public_v2.models.data_flow import DataFlow @@ -70,6 +74,7 @@ from deepsearch.cps.apis.public_v2.models.elastic_index_source import ElasticIndexSource from deepsearch.cps.apis.public_v2.models.elastic_instance_data_index import ElasticInstanceDataIndex from deepsearch.cps.apis.public_v2.models.elastic_metadata import ElasticMetadata +from deepsearch.cps.apis.public_v2.models.file_source import FileSource from deepsearch.cps.apis.public_v2.models.flavour import Flavour from deepsearch.cps.apis.public_v2.models.flavours_default_quota import FlavoursDefaultQuota from deepsearch.cps.apis.public_v2.models.flavours_quota import FlavoursQuota @@ -85,6 +90,7 @@ from deepsearch.cps.apis.public_v2.models.gen_ai_watsonx_config import GenAIWatsonxConfig from deepsearch.cps.apis.public_v2.models.grouped_project_documents import GroupedProjectDocuments from deepsearch.cps.apis.public_v2.models.http_validation_error import HTTPValidationError +from deepsearch.cps.apis.public_v2.models.http_source import HttpSource from deepsearch.cps.apis.public_v2.models.internal_url import InternalUrl from deepsearch.cps.apis.public_v2.models.json_upload_request_body import JsonUploadRequestBody from deepsearch.cps.apis.public_v2.models.list_project_flavours import ListProjectFlavours @@ -128,6 +134,7 @@ from deepsearch.cps.apis.public_v2.models.source1 import Source1 from deepsearch.cps.apis.public_v2.models.storage_summary_task import StorageSummaryTask from deepsearch.cps.apis.public_v2.models.system_info import SystemInfo +from deepsearch.cps.apis.public_v2.models.target_conversion_parameters import TargetConversionParameters from deepsearch.cps.apis.public_v2.models.task_context import TaskContext from deepsearch.cps.apis.public_v2.models.task_result import TaskResult from deepsearch.cps.apis.public_v2.models.temporary_upload_file_result import TemporaryUploadFileResult @@ -135,6 +142,7 @@ from deepsearch.cps.apis.public_v2.models.temporary_url_fields import TemporaryUrlFields from deepsearch.cps.apis.public_v2.models.token_response import TokenResponse from deepsearch.cps.apis.public_v2.models.upload_date import UploadDate +from deepsearch.cps.apis.public_v2.models.upload_elastic_request_body import UploadElasticRequestBody from deepsearch.cps.apis.public_v2.models.upload_job import UploadJob from deepsearch.cps.apis.public_v2.models.urls import Urls from deepsearch.cps.apis.public_v2.models.validation_error import ValidationError diff --git a/deepsearch/cps/apis/public_v2/api/data_indices_upload_api.py b/deepsearch/cps/apis/public_v2/api/data_indices_upload_api.py index 1f9157dc..8b372161 100644 --- a/deepsearch/cps/apis/public_v2/api/data_indices_upload_api.py +++ b/deepsearch/cps/apis/public_v2/api/data_indices_upload_api.py @@ -20,9 +20,12 @@ from deepsearch.cps.apis.public_v2.models.attachment_upload_data import AttachmentUploadData from deepsearch.cps.apis.public_v2.models.attachment_upload_request_body import AttachmentUploadRequestBody from deepsearch.cps.apis.public_v2.models.convert_documents_request_body import ConvertDocumentsRequestBody +from deepsearch.cps.apis.public_v2.models.convert_documents_sources import ConvertDocumentsSources +from deepsearch.cps.apis.public_v2.models.convert_upload_documents_request_body import ConvertUploadDocumentsRequestBody from deepsearch.cps.apis.public_v2.models.cps_task import CpsTask from deepsearch.cps.apis.public_v2.models.data_index_upload_file_source import DataIndexUploadFileSource from deepsearch.cps.apis.public_v2.models.json_upload_request_body import JsonUploadRequestBody +from deepsearch.cps.apis.public_v2.models.upload_elastic_request_body import UploadElasticRequestBody from deepsearch.cps.apis.public_v2.api_client import ApiClient, RequestSerialized from deepsearch.cps.apis.public_v2.api_response import ApiResponse @@ -43,7 +46,7 @@ def __init__(self, api_client=None) -> None: @validate_call - def ccs_convert_upload_file_project_data_index( + def ccs_convert_file_project_data_index( self, index_key: StrictStr, proj_key: StrictStr, @@ -61,9 +64,9 @@ def ccs_convert_upload_file_project_data_index( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> CpsTask: - """Ccs Convert Upload File Project Data Index + """Ccs Convert File Project Data Index - Convert files via CCS and upload to a project data index (only for indices with 'deepsearch-doc' schema). + Convert files via CCS previously registered and in a project data index. :param index_key: (required) :type index_key: str @@ -93,7 +96,7 @@ def ccs_convert_upload_file_project_data_index( :return: Returns the result object. """ # noqa: E501 - _param = self._ccs_convert_upload_file_project_data_index_serialize( + _param = self._ccs_convert_file_project_data_index_serialize( index_key=index_key, proj_key=proj_key, convert_documents_request_body=convert_documents_request_body, @@ -119,7 +122,7 @@ def ccs_convert_upload_file_project_data_index( @validate_call - def ccs_convert_upload_file_project_data_index_with_http_info( + def ccs_convert_file_project_data_index_with_http_info( self, index_key: StrictStr, proj_key: StrictStr, @@ -137,9 +140,9 @@ def ccs_convert_upload_file_project_data_index_with_http_info( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> ApiResponse[CpsTask]: - """Ccs Convert Upload File Project Data Index + """Ccs Convert File Project Data Index - Convert files via CCS and upload to a project data index (only for indices with 'deepsearch-doc' schema). + Convert files via CCS previously registered and in a project data index. :param index_key: (required) :type index_key: str @@ -169,7 +172,7 @@ def ccs_convert_upload_file_project_data_index_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._ccs_convert_upload_file_project_data_index_serialize( + _param = self._ccs_convert_file_project_data_index_serialize( index_key=index_key, proj_key=proj_key, convert_documents_request_body=convert_documents_request_body, @@ -195,7 +198,7 @@ def ccs_convert_upload_file_project_data_index_with_http_info( @validate_call - def ccs_convert_upload_file_project_data_index_without_preload_content( + def ccs_convert_file_project_data_index_without_preload_content( self, index_key: StrictStr, proj_key: StrictStr, @@ -213,9 +216,9 @@ def ccs_convert_upload_file_project_data_index_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Ccs Convert Upload File Project Data Index + """Ccs Convert File Project Data Index - Convert files via CCS and upload to a project data index (only for indices with 'deepsearch-doc' schema). + Convert files via CCS previously registered and in a project data index. :param index_key: (required) :type index_key: str @@ -245,7 +248,7 @@ def ccs_convert_upload_file_project_data_index_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._ccs_convert_upload_file_project_data_index_serialize( + _param = self._ccs_convert_file_project_data_index_serialize( index_key=index_key, proj_key=proj_key, convert_documents_request_body=convert_documents_request_body, @@ -266,7 +269,7 @@ def ccs_convert_upload_file_project_data_index_without_preload_content( return response_data.response - def _ccs_convert_upload_file_project_data_index_serialize( + def _ccs_convert_file_project_data_index_serialize( self, index_key, proj_key, @@ -330,7 +333,7 @@ def _ccs_convert_upload_file_project_data_index_serialize( return self.api_client.param_serialize( method='POST', - resource_path='/project/{proj_key}/data_indices/{index_key}/actions/ccs_convert_upload', + resource_path='/project/{proj_key}/data_indices/{index_key}/actions/ccs_convert', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -347,12 +350,11 @@ def _ccs_convert_upload_file_project_data_index_serialize( @validate_call - def get_attachment_upload_data( + def ccs_convert_upload_file_project_data_index( self, index_key: StrictStr, - index_item_id: StrictStr, - filename: StrictStr, proj_key: StrictStr, + convert_upload_documents_request_body: ConvertUploadDocumentsRequestBody, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -365,19 +367,931 @@ def get_attachment_upload_data( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> AttachmentUploadData: - """Get Attachment Upload Data + ) -> CpsTask: + """Ccs Convert Upload File Project Data Index - Get url and path to upload an attachment to a project data index. + Convert files via CCS and upload to a project data index (only for indices with 'deepsearch-doc' schema). + + :param index_key: (required) + :type index_key: str + :param proj_key: (required) + :type proj_key: str + :param convert_upload_documents_request_body: (required) + :type convert_upload_documents_request_body: ConvertUploadDocumentsRequestBody + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ccs_convert_upload_file_project_data_index_serialize( + index_key=index_key, + proj_key=proj_key, + convert_upload_documents_request_body=convert_upload_documents_request_body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "CpsTask", + '422': "HTTPValidationError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ccs_convert_upload_file_project_data_index_with_http_info( + self, + index_key: StrictStr, + proj_key: StrictStr, + convert_upload_documents_request_body: ConvertUploadDocumentsRequestBody, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[CpsTask]: + """Ccs Convert Upload File Project Data Index + + Convert files via CCS and upload to a project data index (only for indices with 'deepsearch-doc' schema). + + :param index_key: (required) + :type index_key: str + :param proj_key: (required) + :type proj_key: str + :param convert_upload_documents_request_body: (required) + :type convert_upload_documents_request_body: ConvertUploadDocumentsRequestBody + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ccs_convert_upload_file_project_data_index_serialize( + index_key=index_key, + proj_key=proj_key, + convert_upload_documents_request_body=convert_upload_documents_request_body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "CpsTask", + '422': "HTTPValidationError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ccs_convert_upload_file_project_data_index_without_preload_content( + self, + index_key: StrictStr, + proj_key: StrictStr, + convert_upload_documents_request_body: ConvertUploadDocumentsRequestBody, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Ccs Convert Upload File Project Data Index + + Convert files via CCS and upload to a project data index (only for indices with 'deepsearch-doc' schema). + + :param index_key: (required) + :type index_key: str + :param proj_key: (required) + :type proj_key: str + :param convert_upload_documents_request_body: (required) + :type convert_upload_documents_request_body: ConvertUploadDocumentsRequestBody + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ccs_convert_upload_file_project_data_index_serialize( + index_key=index_key, + proj_key=proj_key, + convert_upload_documents_request_body=convert_upload_documents_request_body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "CpsTask", + '422': "HTTPValidationError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ccs_convert_upload_file_project_data_index_serialize( + self, + index_key, + proj_key, + convert_upload_documents_request_body, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if index_key is not None: + _path_params['index_key'] = index_key + if proj_key is not None: + _path_params['proj_key'] = proj_key + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if convert_upload_documents_request_body is not None: + _body_params = convert_upload_documents_request_body + + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'Bearer' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/project/{proj_key}/data_indices/{index_key}/actions/ccs_convert_upload', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_attachment_upload_data( + self, + index_key: StrictStr, + index_item_id: StrictStr, + filename: StrictStr, + proj_key: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AttachmentUploadData: + """Get Attachment Upload Data + + Get url and path to upload an attachment to a project data index. + + :param index_key: (required) + :type index_key: str + :param index_item_id: (required) + :type index_item_id: str + :param filename: (required) + :type filename: str + :param proj_key: (required) + :type proj_key: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_attachment_upload_data_serialize( + index_key=index_key, + index_item_id=index_item_id, + filename=filename, + proj_key=proj_key, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AttachmentUploadData", + '422': "HTTPValidationError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_attachment_upload_data_with_http_info( + self, + index_key: StrictStr, + index_item_id: StrictStr, + filename: StrictStr, + proj_key: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AttachmentUploadData]: + """Get Attachment Upload Data + + Get url and path to upload an attachment to a project data index. + + :param index_key: (required) + :type index_key: str + :param index_item_id: (required) + :type index_item_id: str + :param filename: (required) + :type filename: str + :param proj_key: (required) + :type proj_key: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_attachment_upload_data_serialize( + index_key=index_key, + index_item_id=index_item_id, + filename=filename, + proj_key=proj_key, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AttachmentUploadData", + '422': "HTTPValidationError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_attachment_upload_data_without_preload_content( + self, + index_key: StrictStr, + index_item_id: StrictStr, + filename: StrictStr, + proj_key: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Attachment Upload Data + + Get url and path to upload an attachment to a project data index. + + :param index_key: (required) + :type index_key: str + :param index_item_id: (required) + :type index_item_id: str + :param filename: (required) + :type filename: str + :param proj_key: (required) + :type proj_key: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_attachment_upload_data_serialize( + index_key=index_key, + index_item_id=index_item_id, + filename=filename, + proj_key=proj_key, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AttachmentUploadData", + '422': "HTTPValidationError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_attachment_upload_data_serialize( + self, + index_key, + index_item_id, + filename, + proj_key, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if index_key is not None: + _path_params['index_key'] = index_key + if index_item_id is not None: + _path_params['index_item_id'] = index_item_id + if filename is not None: + _path_params['filename'] = filename + if proj_key is not None: + _path_params['proj_key'] = proj_key + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'Bearer' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/project/{proj_key}/data_indices/{index_key}/documents/{index_item_id}/attachment_url/{filename}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def html_print_convert_upload( + self, + index_key: StrictStr, + proj_key: StrictStr, + data_index_upload_file_source: DataIndexUploadFileSource, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> CpsTask: + """Html Print Convert Upload + + Convert a list of HTML pages to PDF, convert them via CCS and upload to a project data index (only for indices with 'deepsearch-doc' schema). + + :param index_key: (required) + :type index_key: str + :param proj_key: (required) + :type proj_key: str + :param data_index_upload_file_source: (required) + :type data_index_upload_file_source: DataIndexUploadFileSource + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._html_print_convert_upload_serialize( + index_key=index_key, + proj_key=proj_key, + data_index_upload_file_source=data_index_upload_file_source, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "CpsTask", + '422': "HTTPValidationError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def html_print_convert_upload_with_http_info( + self, + index_key: StrictStr, + proj_key: StrictStr, + data_index_upload_file_source: DataIndexUploadFileSource, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[CpsTask]: + """Html Print Convert Upload + + Convert a list of HTML pages to PDF, convert them via CCS and upload to a project data index (only for indices with 'deepsearch-doc' schema). + + :param index_key: (required) + :type index_key: str + :param proj_key: (required) + :type proj_key: str + :param data_index_upload_file_source: (required) + :type data_index_upload_file_source: DataIndexUploadFileSource + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._html_print_convert_upload_serialize( + index_key=index_key, + proj_key=proj_key, + data_index_upload_file_source=data_index_upload_file_source, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "CpsTask", + '422': "HTTPValidationError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def html_print_convert_upload_without_preload_content( + self, + index_key: StrictStr, + proj_key: StrictStr, + data_index_upload_file_source: DataIndexUploadFileSource, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Html Print Convert Upload + + Convert a list of HTML pages to PDF, convert them via CCS and upload to a project data index (only for indices with 'deepsearch-doc' schema). + + :param index_key: (required) + :type index_key: str + :param proj_key: (required) + :type proj_key: str + :param data_index_upload_file_source: (required) + :type data_index_upload_file_source: DataIndexUploadFileSource + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._html_print_convert_upload_serialize( + index_key=index_key, + proj_key=proj_key, + data_index_upload_file_source=data_index_upload_file_source, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "CpsTask", + '422': "HTTPValidationError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _html_print_convert_upload_serialize( + self, + index_key, + proj_key, + data_index_upload_file_source, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if index_key is not None: + _path_params['index_key'] = index_key + if proj_key is not None: + _path_params['proj_key'] = proj_key + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if data_index_upload_file_source is not None: + _body_params = data_index_upload_file_source + + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'Bearer' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/project/{proj_key}/data_indices/{index_key}/actions/html_print_convert_upload', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def load_project_data_index_files_elastic( + self, + index_key: StrictStr, + proj_key: StrictStr, + upload_elastic_request_body: UploadElasticRequestBody, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> CpsTask: + """Load Project Data Index Files Elastic + + Load file(s) in a project data index to elastic. :param index_key: (required) :type index_key: str - :param index_item_id: (required) - :type index_item_id: str - :param filename: (required) - :type filename: str :param proj_key: (required) :type proj_key: str + :param upload_elastic_request_body: (required) + :type upload_elastic_request_body: UploadElasticRequestBody :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -400,11 +1314,10 @@ def get_attachment_upload_data( :return: Returns the result object. """ # noqa: E501 - _param = self._get_attachment_upload_data_serialize( + _param = self._load_project_data_index_files_elastic_serialize( index_key=index_key, - index_item_id=index_item_id, - filename=filename, proj_key=proj_key, + upload_elastic_request_body=upload_elastic_request_body, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -412,7 +1325,7 @@ def get_attachment_upload_data( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "AttachmentUploadData", + '200': "CpsTask", '422': "HTTPValidationError", } response_data = self.api_client.call_api( @@ -427,12 +1340,11 @@ def get_attachment_upload_data( @validate_call - def get_attachment_upload_data_with_http_info( + def load_project_data_index_files_elastic_with_http_info( self, index_key: StrictStr, - index_item_id: StrictStr, - filename: StrictStr, proj_key: StrictStr, + upload_elastic_request_body: UploadElasticRequestBody, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -445,19 +1357,17 @@ def get_attachment_upload_data_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[AttachmentUploadData]: - """Get Attachment Upload Data + ) -> ApiResponse[CpsTask]: + """Load Project Data Index Files Elastic - Get url and path to upload an attachment to a project data index. + Load file(s) in a project data index to elastic. :param index_key: (required) :type index_key: str - :param index_item_id: (required) - :type index_item_id: str - :param filename: (required) - :type filename: str :param proj_key: (required) :type proj_key: str + :param upload_elastic_request_body: (required) + :type upload_elastic_request_body: UploadElasticRequestBody :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -480,11 +1390,10 @@ def get_attachment_upload_data_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._get_attachment_upload_data_serialize( + _param = self._load_project_data_index_files_elastic_serialize( index_key=index_key, - index_item_id=index_item_id, - filename=filename, proj_key=proj_key, + upload_elastic_request_body=upload_elastic_request_body, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -492,7 +1401,7 @@ def get_attachment_upload_data_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "AttachmentUploadData", + '200': "CpsTask", '422': "HTTPValidationError", } response_data = self.api_client.call_api( @@ -507,12 +1416,11 @@ def get_attachment_upload_data_with_http_info( @validate_call - def get_attachment_upload_data_without_preload_content( + def load_project_data_index_files_elastic_without_preload_content( self, index_key: StrictStr, - index_item_id: StrictStr, - filename: StrictStr, proj_key: StrictStr, + upload_elastic_request_body: UploadElasticRequestBody, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -526,18 +1434,16 @@ def get_attachment_upload_data_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Get Attachment Upload Data + """Load Project Data Index Files Elastic - Get url and path to upload an attachment to a project data index. + Load file(s) in a project data index to elastic. :param index_key: (required) :type index_key: str - :param index_item_id: (required) - :type index_item_id: str - :param filename: (required) - :type filename: str :param proj_key: (required) :type proj_key: str + :param upload_elastic_request_body: (required) + :type upload_elastic_request_body: UploadElasticRequestBody :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -560,11 +1466,10 @@ def get_attachment_upload_data_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._get_attachment_upload_data_serialize( + _param = self._load_project_data_index_files_elastic_serialize( index_key=index_key, - index_item_id=index_item_id, - filename=filename, proj_key=proj_key, + upload_elastic_request_body=upload_elastic_request_body, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -572,7 +1477,7 @@ def get_attachment_upload_data_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "AttachmentUploadData", + '200': "CpsTask", '422': "HTTPValidationError", } response_data = self.api_client.call_api( @@ -582,12 +1487,11 @@ def get_attachment_upload_data_without_preload_content( return response_data.response - def _get_attachment_upload_data_serialize( + def _load_project_data_index_files_elastic_serialize( self, index_key, - index_item_id, - filename, proj_key, + upload_elastic_request_body, _request_auth, _content_type, _headers, @@ -609,16 +1513,14 @@ def _get_attachment_upload_data_serialize( # process the path parameters if index_key is not None: _path_params['index_key'] = index_key - if index_item_id is not None: - _path_params['index_item_id'] = index_item_id - if filename is not None: - _path_params['filename'] = filename if proj_key is not None: _path_params['proj_key'] = proj_key # process the query parameters # process the header parameters # process the form parameters # process the body parameter + if upload_elastic_request_body is not None: + _body_params = upload_elastic_request_body # set the HTTP header `Accept` @@ -628,6 +1530,19 @@ def _get_attachment_upload_data_serialize( ] ) + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting _auth_settings: List[str] = [ @@ -635,8 +1550,8 @@ def _get_attachment_upload_data_serialize( ] return self.api_client.param_serialize( - method='GET', - resource_path='/project/{proj_key}/data_indices/{index_key}/documents/{index_item_id}/attachment_url/{filename}', + method='POST', + resource_path='/project/{proj_key}/data_indices/{index_key}/actions/load_elastic', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -653,11 +1568,12 @@ def _get_attachment_upload_data_serialize( @validate_call - def html_print_convert_upload( + def register_attachment( self, index_key: StrictStr, + index_item_id: StrictStr, proj_key: StrictStr, - data_index_upload_file_source: DataIndexUploadFileSource, + attachment_upload_request_body: AttachmentUploadRequestBody, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -670,17 +1586,19 @@ def html_print_convert_upload( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> CpsTask: - """Html Print Convert Upload + ) -> None: + """Register Attachment - Convert a list of HTML pages to PDF, convert them via CCS and upload to a project data index (only for indices with 'deepsearch-doc' schema). + Notify upload completion of an attachment to a project data index. :param index_key: (required) :type index_key: str + :param index_item_id: (required) + :type index_item_id: str :param proj_key: (required) :type proj_key: str - :param data_index_upload_file_source: (required) - :type data_index_upload_file_source: DataIndexUploadFileSource + :param attachment_upload_request_body: (required) + :type attachment_upload_request_body: AttachmentUploadRequestBody :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -703,10 +1621,11 @@ def html_print_convert_upload( :return: Returns the result object. """ # noqa: E501 - _param = self._html_print_convert_upload_serialize( + _param = self._register_attachment_serialize( index_key=index_key, + index_item_id=index_item_id, proj_key=proj_key, - data_index_upload_file_source=data_index_upload_file_source, + attachment_upload_request_body=attachment_upload_request_body, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -714,7 +1633,7 @@ def html_print_convert_upload( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "CpsTask", + '204': None, '422': "HTTPValidationError", } response_data = self.api_client.call_api( @@ -729,11 +1648,12 @@ def html_print_convert_upload( @validate_call - def html_print_convert_upload_with_http_info( + def register_attachment_with_http_info( self, index_key: StrictStr, + index_item_id: StrictStr, proj_key: StrictStr, - data_index_upload_file_source: DataIndexUploadFileSource, + attachment_upload_request_body: AttachmentUploadRequestBody, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -746,17 +1666,19 @@ def html_print_convert_upload_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[CpsTask]: - """Html Print Convert Upload + ) -> ApiResponse[None]: + """Register Attachment - Convert a list of HTML pages to PDF, convert them via CCS and upload to a project data index (only for indices with 'deepsearch-doc' schema). + Notify upload completion of an attachment to a project data index. :param index_key: (required) :type index_key: str + :param index_item_id: (required) + :type index_item_id: str :param proj_key: (required) :type proj_key: str - :param data_index_upload_file_source: (required) - :type data_index_upload_file_source: DataIndexUploadFileSource + :param attachment_upload_request_body: (required) + :type attachment_upload_request_body: AttachmentUploadRequestBody :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -779,10 +1701,11 @@ def html_print_convert_upload_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._html_print_convert_upload_serialize( + _param = self._register_attachment_serialize( index_key=index_key, + index_item_id=index_item_id, proj_key=proj_key, - data_index_upload_file_source=data_index_upload_file_source, + attachment_upload_request_body=attachment_upload_request_body, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -790,7 +1713,7 @@ def html_print_convert_upload_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "CpsTask", + '204': None, '422': "HTTPValidationError", } response_data = self.api_client.call_api( @@ -805,11 +1728,12 @@ def html_print_convert_upload_with_http_info( @validate_call - def html_print_convert_upload_without_preload_content( + def register_attachment_without_preload_content( self, index_key: StrictStr, + index_item_id: StrictStr, proj_key: StrictStr, - data_index_upload_file_source: DataIndexUploadFileSource, + attachment_upload_request_body: AttachmentUploadRequestBody, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -823,16 +1747,18 @@ def html_print_convert_upload_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Html Print Convert Upload + """Register Attachment - Convert a list of HTML pages to PDF, convert them via CCS and upload to a project data index (only for indices with 'deepsearch-doc' schema). + Notify upload completion of an attachment to a project data index. :param index_key: (required) :type index_key: str + :param index_item_id: (required) + :type index_item_id: str :param proj_key: (required) :type proj_key: str - :param data_index_upload_file_source: (required) - :type data_index_upload_file_source: DataIndexUploadFileSource + :param attachment_upload_request_body: (required) + :type attachment_upload_request_body: AttachmentUploadRequestBody :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -855,10 +1781,11 @@ def html_print_convert_upload_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._html_print_convert_upload_serialize( + _param = self._register_attachment_serialize( index_key=index_key, + index_item_id=index_item_id, proj_key=proj_key, - data_index_upload_file_source=data_index_upload_file_source, + attachment_upload_request_body=attachment_upload_request_body, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -866,7 +1793,7 @@ def html_print_convert_upload_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "CpsTask", + '204': None, '422': "HTTPValidationError", } response_data = self.api_client.call_api( @@ -876,11 +1803,12 @@ def html_print_convert_upload_without_preload_content( return response_data.response - def _html_print_convert_upload_serialize( + def _register_attachment_serialize( self, index_key, + index_item_id, proj_key, - data_index_upload_file_source, + attachment_upload_request_body, _request_auth, _content_type, _headers, @@ -902,14 +1830,16 @@ def _html_print_convert_upload_serialize( # process the path parameters if index_key is not None: _path_params['index_key'] = index_key + if index_item_id is not None: + _path_params['index_item_id'] = index_item_id if proj_key is not None: _path_params['proj_key'] = proj_key # process the query parameters # process the header parameters # process the form parameters # process the body parameter - if data_index_upload_file_source is not None: - _body_params = data_index_upload_file_source + if attachment_upload_request_body is not None: + _body_params = attachment_upload_request_body # set the HTTP header `Accept` @@ -940,7 +1870,7 @@ def _html_print_convert_upload_serialize( return self.api_client.param_serialize( method='POST', - resource_path='/project/{proj_key}/data_indices/{index_key}/actions/html_print_convert_upload', + resource_path='/project/{proj_key}/data_indices/{index_key}/documents/{index_item_id}/attachment', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -957,12 +1887,11 @@ def _html_print_convert_upload_serialize( @validate_call - def register_attachment( + def upload_project_data_index_file( self, index_key: StrictStr, - index_item_id: StrictStr, proj_key: StrictStr, - attachment_upload_request_body: AttachmentUploadRequestBody, + json_upload_request_body: JsonUploadRequestBody, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -975,19 +1904,17 @@ def register_attachment( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> None: - """Register Attachment + ) -> CpsTask: + """Upload Project Data Index File - Notify upload completion of an attachment to a project data index. + Upload a file to a project data index. :param index_key: (required) :type index_key: str - :param index_item_id: (required) - :type index_item_id: str :param proj_key: (required) :type proj_key: str - :param attachment_upload_request_body: (required) - :type attachment_upload_request_body: AttachmentUploadRequestBody + :param json_upload_request_body: (required) + :type json_upload_request_body: JsonUploadRequestBody :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1010,11 +1937,10 @@ def register_attachment( :return: Returns the result object. """ # noqa: E501 - _param = self._register_attachment_serialize( + _param = self._upload_project_data_index_file_serialize( index_key=index_key, - index_item_id=index_item_id, proj_key=proj_key, - attachment_upload_request_body=attachment_upload_request_body, + json_upload_request_body=json_upload_request_body, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1022,7 +1948,7 @@ def register_attachment( ) _response_types_map: Dict[str, Optional[str]] = { - '204': None, + '200': "CpsTask", '422': "HTTPValidationError", } response_data = self.api_client.call_api( @@ -1037,12 +1963,11 @@ def register_attachment( @validate_call - def register_attachment_with_http_info( + def upload_project_data_index_file_with_http_info( self, index_key: StrictStr, - index_item_id: StrictStr, proj_key: StrictStr, - attachment_upload_request_body: AttachmentUploadRequestBody, + json_upload_request_body: JsonUploadRequestBody, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1055,19 +1980,17 @@ def register_attachment_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[None]: - """Register Attachment + ) -> ApiResponse[CpsTask]: + """Upload Project Data Index File - Notify upload completion of an attachment to a project data index. + Upload a file to a project data index. :param index_key: (required) :type index_key: str - :param index_item_id: (required) - :type index_item_id: str :param proj_key: (required) :type proj_key: str - :param attachment_upload_request_body: (required) - :type attachment_upload_request_body: AttachmentUploadRequestBody + :param json_upload_request_body: (required) + :type json_upload_request_body: JsonUploadRequestBody :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1090,11 +2013,10 @@ def register_attachment_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._register_attachment_serialize( + _param = self._upload_project_data_index_file_serialize( index_key=index_key, - index_item_id=index_item_id, proj_key=proj_key, - attachment_upload_request_body=attachment_upload_request_body, + json_upload_request_body=json_upload_request_body, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1102,7 +2024,7 @@ def register_attachment_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '204': None, + '200': "CpsTask", '422': "HTTPValidationError", } response_data = self.api_client.call_api( @@ -1117,12 +2039,11 @@ def register_attachment_with_http_info( @validate_call - def register_attachment_without_preload_content( + def upload_project_data_index_file_without_preload_content( self, index_key: StrictStr, - index_item_id: StrictStr, proj_key: StrictStr, - attachment_upload_request_body: AttachmentUploadRequestBody, + json_upload_request_body: JsonUploadRequestBody, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1136,18 +2057,16 @@ def register_attachment_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Register Attachment + """Upload Project Data Index File - Notify upload completion of an attachment to a project data index. + Upload a file to a project data index. :param index_key: (required) :type index_key: str - :param index_item_id: (required) - :type index_item_id: str :param proj_key: (required) :type proj_key: str - :param attachment_upload_request_body: (required) - :type attachment_upload_request_body: AttachmentUploadRequestBody + :param json_upload_request_body: (required) + :type json_upload_request_body: JsonUploadRequestBody :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1170,11 +2089,10 @@ def register_attachment_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._register_attachment_serialize( + _param = self._upload_project_data_index_file_serialize( index_key=index_key, - index_item_id=index_item_id, proj_key=proj_key, - attachment_upload_request_body=attachment_upload_request_body, + json_upload_request_body=json_upload_request_body, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1182,7 +2100,7 @@ def register_attachment_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '204': None, + '200': "CpsTask", '422': "HTTPValidationError", } response_data = self.api_client.call_api( @@ -1192,12 +2110,11 @@ def register_attachment_without_preload_content( return response_data.response - def _register_attachment_serialize( + def _upload_project_data_index_file_serialize( self, index_key, - index_item_id, proj_key, - attachment_upload_request_body, + json_upload_request_body, _request_auth, _content_type, _headers, @@ -1219,16 +2136,14 @@ def _register_attachment_serialize( # process the path parameters if index_key is not None: _path_params['index_key'] = index_key - if index_item_id is not None: - _path_params['index_item_id'] = index_item_id if proj_key is not None: _path_params['proj_key'] = proj_key # process the query parameters # process the header parameters # process the form parameters # process the body parameter - if attachment_upload_request_body is not None: - _body_params = attachment_upload_request_body + if json_upload_request_body is not None: + _body_params = json_upload_request_body # set the HTTP header `Accept` @@ -1259,7 +2174,7 @@ def _register_attachment_serialize( return self.api_client.param_serialize( method='POST', - resource_path='/project/{proj_key}/data_indices/{index_key}/documents/{index_item_id}/attachment', + resource_path='/project/{proj_key}/data_indices/{index_key}/actions/upload', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -1276,11 +2191,11 @@ def _register_attachment_serialize( @validate_call - def upload_project_data_index_file( + def upload_register_project_documents( self, index_key: StrictStr, proj_key: StrictStr, - json_upload_request_body: JsonUploadRequestBody, + convert_documents_sources: ConvertDocumentsSources, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1294,16 +2209,16 @@ def upload_project_data_index_file( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> CpsTask: - """Upload Project Data Index File + """Upload Register Project Documents - Upload a file to a project data index. + Upload and register documents to be converted later. :param index_key: (required) :type index_key: str :param proj_key: (required) :type proj_key: str - :param json_upload_request_body: (required) - :type json_upload_request_body: JsonUploadRequestBody + :param convert_documents_sources: (required) + :type convert_documents_sources: ConvertDocumentsSources :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1326,10 +2241,10 @@ def upload_project_data_index_file( :return: Returns the result object. """ # noqa: E501 - _param = self._upload_project_data_index_file_serialize( + _param = self._upload_register_project_documents_serialize( index_key=index_key, proj_key=proj_key, - json_upload_request_body=json_upload_request_body, + convert_documents_sources=convert_documents_sources, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1352,11 +2267,11 @@ def upload_project_data_index_file( @validate_call - def upload_project_data_index_file_with_http_info( + def upload_register_project_documents_with_http_info( self, index_key: StrictStr, proj_key: StrictStr, - json_upload_request_body: JsonUploadRequestBody, + convert_documents_sources: ConvertDocumentsSources, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1370,16 +2285,16 @@ def upload_project_data_index_file_with_http_info( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> ApiResponse[CpsTask]: - """Upload Project Data Index File + """Upload Register Project Documents - Upload a file to a project data index. + Upload and register documents to be converted later. :param index_key: (required) :type index_key: str :param proj_key: (required) :type proj_key: str - :param json_upload_request_body: (required) - :type json_upload_request_body: JsonUploadRequestBody + :param convert_documents_sources: (required) + :type convert_documents_sources: ConvertDocumentsSources :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1402,10 +2317,10 @@ def upload_project_data_index_file_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._upload_project_data_index_file_serialize( + _param = self._upload_register_project_documents_serialize( index_key=index_key, proj_key=proj_key, - json_upload_request_body=json_upload_request_body, + convert_documents_sources=convert_documents_sources, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1428,11 +2343,11 @@ def upload_project_data_index_file_with_http_info( @validate_call - def upload_project_data_index_file_without_preload_content( + def upload_register_project_documents_without_preload_content( self, index_key: StrictStr, proj_key: StrictStr, - json_upload_request_body: JsonUploadRequestBody, + convert_documents_sources: ConvertDocumentsSources, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1446,16 +2361,16 @@ def upload_project_data_index_file_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Upload Project Data Index File + """Upload Register Project Documents - Upload a file to a project data index. + Upload and register documents to be converted later. :param index_key: (required) :type index_key: str :param proj_key: (required) :type proj_key: str - :param json_upload_request_body: (required) - :type json_upload_request_body: JsonUploadRequestBody + :param convert_documents_sources: (required) + :type convert_documents_sources: ConvertDocumentsSources :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1478,10 +2393,10 @@ def upload_project_data_index_file_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._upload_project_data_index_file_serialize( + _param = self._upload_register_project_documents_serialize( index_key=index_key, proj_key=proj_key, - json_upload_request_body=json_upload_request_body, + convert_documents_sources=convert_documents_sources, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1499,11 +2414,11 @@ def upload_project_data_index_file_without_preload_content( return response_data.response - def _upload_project_data_index_file_serialize( + def _upload_register_project_documents_serialize( self, index_key, proj_key, - json_upload_request_body, + convert_documents_sources, _request_auth, _content_type, _headers, @@ -1531,8 +2446,8 @@ def _upload_project_data_index_file_serialize( # process the header parameters # process the form parameters # process the body parameter - if json_upload_request_body is not None: - _body_params = json_upload_request_body + if convert_documents_sources is not None: + _body_params = convert_documents_sources # set the HTTP header `Accept` @@ -1563,7 +2478,7 @@ def _upload_project_data_index_file_serialize( return self.api_client.param_serialize( method='POST', - resource_path='/project/{proj_key}/data_indices/{index_key}/actions/upload', + resource_path='/project/{proj_key}/data_indices/{index_key}/actions/upload_register_documents', path_params=_path_params, query_params=_query_params, header_params=_header_params, diff --git a/deepsearch/cps/apis/public_v2/api/project_api.py b/deepsearch/cps/apis/public_v2/api/project_api.py index 587a1c30..90905223 100644 --- a/deepsearch/cps/apis/public_v2/api/project_api.py +++ b/deepsearch/cps/apis/public_v2/api/project_api.py @@ -16,13 +16,17 @@ from typing import Any, Dict, List, Optional, Tuple, Union from typing_extensions import Annotated -from pydantic import StrictBool, StrictStr -from typing import Optional +from pydantic import Field, StrictBool, StrictStr +from typing import Optional, Union +from typing_extensions import Annotated +from deepsearch.cps.apis.public_v2.models.ccs_task import CcsTask from deepsearch.cps.apis.public_v2.models.config import Config +from deepsearch.cps.apis.public_v2.models.convert_document_request import ConvertDocumentRequest from deepsearch.cps.apis.public_v2.models.default_values import DefaultValues from deepsearch.cps.apis.public_v2.models.project_package_instalation_manifest import ProjectPackageInstalationManifest from deepsearch.cps.apis.public_v2.models.response_get_project_integration_config_genai import ResponseGetProjectIntegrationConfigGenai from deepsearch.cps.apis.public_v2.models.task_context import TaskContext +from deepsearch.cps.apis.public_v2.models.task_result import TaskResult from deepsearch.cps.apis.public_v2.api_client import ApiClient, RequestSerialized from deepsearch.cps.apis.public_v2.api_response import ApiResponse @@ -42,6 +46,588 @@ def __init__(self, api_client=None) -> None: self.api_client = api_client + @validate_call + def check_wait_ccs_task_task( + self, + task_id: StrictStr, + proj_key: StrictStr, + wait: Annotated[Optional[Union[Annotated[float, Field(le=30.0, strict=True)], Annotated[int, Field(le=30, strict=True)]]], Field(description="Optionally block this method call for a few seconds to wait for the result instead of polling through multiple calls.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> TaskResult: + """Check Wait Ccs Task Task + + Check status of a CCS conversion task. + + :param task_id: (required) + :type task_id: str + :param proj_key: (required) + :type proj_key: str + :param wait: Optionally block this method call for a few seconds to wait for the result instead of polling through multiple calls. + :type wait: float + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._check_wait_ccs_task_task_serialize( + task_id=task_id, + proj_key=proj_key, + wait=wait, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "TaskResult", + '422': "HTTPValidationError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def check_wait_ccs_task_task_with_http_info( + self, + task_id: StrictStr, + proj_key: StrictStr, + wait: Annotated[Optional[Union[Annotated[float, Field(le=30.0, strict=True)], Annotated[int, Field(le=30, strict=True)]]], Field(description="Optionally block this method call for a few seconds to wait for the result instead of polling through multiple calls.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[TaskResult]: + """Check Wait Ccs Task Task + + Check status of a CCS conversion task. + + :param task_id: (required) + :type task_id: str + :param proj_key: (required) + :type proj_key: str + :param wait: Optionally block this method call for a few seconds to wait for the result instead of polling through multiple calls. + :type wait: float + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._check_wait_ccs_task_task_serialize( + task_id=task_id, + proj_key=proj_key, + wait=wait, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "TaskResult", + '422': "HTTPValidationError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def check_wait_ccs_task_task_without_preload_content( + self, + task_id: StrictStr, + proj_key: StrictStr, + wait: Annotated[Optional[Union[Annotated[float, Field(le=30.0, strict=True)], Annotated[int, Field(le=30, strict=True)]]], Field(description="Optionally block this method call for a few seconds to wait for the result instead of polling through multiple calls.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Check Wait Ccs Task Task + + Check status of a CCS conversion task. + + :param task_id: (required) + :type task_id: str + :param proj_key: (required) + :type proj_key: str + :param wait: Optionally block this method call for a few seconds to wait for the result instead of polling through multiple calls. + :type wait: float + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._check_wait_ccs_task_task_serialize( + task_id=task_id, + proj_key=proj_key, + wait=wait, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "TaskResult", + '422': "HTTPValidationError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _check_wait_ccs_task_task_serialize( + self, + task_id, + proj_key, + wait, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if task_id is not None: + _path_params['task_id'] = task_id + if proj_key is not None: + _path_params['proj_key'] = proj_key + # process the query parameters + if wait is not None: + + _query_params.append(('wait', wait)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'Bearer' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/project/{proj_key}/convert_tasks/{task_id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def convert_pdf_document( + self, + proj_key: StrictStr, + convert_document_request: ConvertDocumentRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> CcsTask: + """Convert Pdf Document + + Convert a PDF document directly to CCS. + + :param proj_key: (required) + :type proj_key: str + :param convert_document_request: (required) + :type convert_document_request: ConvertDocumentRequest + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._convert_pdf_document_serialize( + proj_key=proj_key, + convert_document_request=convert_document_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "CcsTask", + '422': "HTTPValidationError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def convert_pdf_document_with_http_info( + self, + proj_key: StrictStr, + convert_document_request: ConvertDocumentRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[CcsTask]: + """Convert Pdf Document + + Convert a PDF document directly to CCS. + + :param proj_key: (required) + :type proj_key: str + :param convert_document_request: (required) + :type convert_document_request: ConvertDocumentRequest + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._convert_pdf_document_serialize( + proj_key=proj_key, + convert_document_request=convert_document_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "CcsTask", + '422': "HTTPValidationError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def convert_pdf_document_without_preload_content( + self, + proj_key: StrictStr, + convert_document_request: ConvertDocumentRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Convert Pdf Document + + Convert a PDF document directly to CCS. + + :param proj_key: (required) + :type proj_key: str + :param convert_document_request: (required) + :type convert_document_request: ConvertDocumentRequest + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._convert_pdf_document_serialize( + proj_key=proj_key, + convert_document_request=convert_document_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "CcsTask", + '422': "HTTPValidationError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _convert_pdf_document_serialize( + self, + proj_key, + convert_document_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if proj_key is not None: + _path_params['proj_key'] = proj_key + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if convert_document_request is not None: + _body_params = convert_document_request + + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'Bearer' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/project/{proj_key}/convert', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def delete_project_integration_config_genai( self, diff --git a/deepsearch/cps/apis/public_v2/models/__init__.py b/deepsearch/cps/apis/public_v2/models/__init__.py index 13f55924..f8eb7591 100644 --- a/deepsearch/cps/apis/public_v2/models/__init__.py +++ b/deepsearch/cps/apis/public_v2/models/__init__.py @@ -22,9 +22,13 @@ from deepsearch.cps.apis.public_v2.models.ccs_project import CCSProject from deepsearch.cps.apis.public_v2.models.cps_package import CPSPackage from deepsearch.cps.apis.public_v2.models.cps_summary import CPSSummary +from deepsearch.cps.apis.public_v2.models.ccs_task import CcsTask from deepsearch.cps.apis.public_v2.models.collection_metadata_settings import CollectionMetadataSettings from deepsearch.cps.apis.public_v2.models.config import Config +from deepsearch.cps.apis.public_v2.models.convert_document_request import ConvertDocumentRequest from deepsearch.cps.apis.public_v2.models.convert_documents_request_body import ConvertDocumentsRequestBody +from deepsearch.cps.apis.public_v2.models.convert_documents_sources import ConvertDocumentsSources +from deepsearch.cps.apis.public_v2.models.convert_upload_documents_request_body import ConvertUploadDocumentsRequestBody from deepsearch.cps.apis.public_v2.models.cps_task import CpsTask from deepsearch.cps.apis.public_v2.models.data import Data from deepsearch.cps.apis.public_v2.models.data_flow import DataFlow @@ -42,6 +46,7 @@ from deepsearch.cps.apis.public_v2.models.elastic_index_source import ElasticIndexSource from deepsearch.cps.apis.public_v2.models.elastic_instance_data_index import ElasticInstanceDataIndex from deepsearch.cps.apis.public_v2.models.elastic_metadata import ElasticMetadata +from deepsearch.cps.apis.public_v2.models.file_source import FileSource from deepsearch.cps.apis.public_v2.models.flavour import Flavour from deepsearch.cps.apis.public_v2.models.flavours_default_quota import FlavoursDefaultQuota from deepsearch.cps.apis.public_v2.models.flavours_quota import FlavoursQuota @@ -57,6 +62,7 @@ from deepsearch.cps.apis.public_v2.models.gen_ai_watsonx_config import GenAIWatsonxConfig from deepsearch.cps.apis.public_v2.models.grouped_project_documents import GroupedProjectDocuments from deepsearch.cps.apis.public_v2.models.http_validation_error import HTTPValidationError +from deepsearch.cps.apis.public_v2.models.http_source import HttpSource from deepsearch.cps.apis.public_v2.models.internal_url import InternalUrl from deepsearch.cps.apis.public_v2.models.json_upload_request_body import JsonUploadRequestBody from deepsearch.cps.apis.public_v2.models.list_project_flavours import ListProjectFlavours @@ -100,6 +106,7 @@ from deepsearch.cps.apis.public_v2.models.source1 import Source1 from deepsearch.cps.apis.public_v2.models.storage_summary_task import StorageSummaryTask from deepsearch.cps.apis.public_v2.models.system_info import SystemInfo +from deepsearch.cps.apis.public_v2.models.target_conversion_parameters import TargetConversionParameters from deepsearch.cps.apis.public_v2.models.task_context import TaskContext from deepsearch.cps.apis.public_v2.models.task_result import TaskResult from deepsearch.cps.apis.public_v2.models.temporary_upload_file_result import TemporaryUploadFileResult @@ -107,6 +114,7 @@ from deepsearch.cps.apis.public_v2.models.temporary_url_fields import TemporaryUrlFields from deepsearch.cps.apis.public_v2.models.token_response import TokenResponse from deepsearch.cps.apis.public_v2.models.upload_date import UploadDate +from deepsearch.cps.apis.public_v2.models.upload_elastic_request_body import UploadElasticRequestBody from deepsearch.cps.apis.public_v2.models.upload_job import UploadJob from deepsearch.cps.apis.public_v2.models.urls import Urls from deepsearch.cps.apis.public_v2.models.validation_error import ValidationError diff --git a/deepsearch/cps/apis/public_v2/models/ccs_task.py b/deepsearch/cps/apis/public_v2/models/ccs_task.py new file mode 100644 index 00000000..0753215b --- /dev/null +++ b/deepsearch/cps/apis/public_v2/models/ccs_task.py @@ -0,0 +1,91 @@ +# coding: utf-8 + +""" + Deep Search (DS) API + + API for Deep Search. **WARNING**: This API is subject to change without warning! + + The version of the OpenAPI document: 3.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class CcsTask(BaseModel): + """ + CcsTask + """ # noqa: E501 + task_id: StrictStr + ccs_project_key: StrictStr + ccs_collection_name: StrictStr + __properties: ClassVar[List[str]] = ["task_id", "ccs_project_key", "ccs_collection_name"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of CcsTask from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of CcsTask from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "task_id": obj.get("task_id"), + "ccs_project_key": obj.get("ccs_project_key"), + "ccs_collection_name": obj.get("ccs_collection_name") + }) + return _obj + + diff --git a/deepsearch/cps/apis/public_v2/models/convert_document_request.py b/deepsearch/cps/apis/public_v2/models/convert_document_request.py new file mode 100644 index 00000000..e1e86c03 --- /dev/null +++ b/deepsearch/cps/apis/public_v2/models/convert_document_request.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + Deep Search (DS) API + + API for Deep Search. **WARNING**: This API is subject to change without warning! + + The version of the OpenAPI document: 3.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from deepsearch.cps.apis.public_v2.models.file_source import FileSource +from deepsearch.cps.apis.public_v2.models.http_source import HttpSource +from typing import Optional, Set +from typing_extensions import Self + +class ConvertDocumentRequest(BaseModel): + """ + ConvertDocumentRequest + """ # noqa: E501 + http_source: Optional[HttpSource] = None + file_source: Optional[FileSource] = None + __properties: ClassVar[List[str]] = ["http_source", "file_source"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ConvertDocumentRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of http_source + if self.http_source: + _dict['http_source'] = self.http_source.to_dict() + # override the default output from pydantic by calling `to_dict()` of file_source + if self.file_source: + _dict['file_source'] = self.file_source.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ConvertDocumentRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "http_source": HttpSource.from_dict(obj["http_source"]) if obj.get("http_source") is not None else None, + "file_source": FileSource.from_dict(obj["file_source"]) if obj.get("file_source") is not None else None + }) + return _obj + + diff --git a/deepsearch/cps/apis/public_v2/models/convert_documents_request_body.py b/deepsearch/cps/apis/public_v2/models/convert_documents_request_body.py index 0a52951d..204cb0f5 100644 --- a/deepsearch/cps/apis/public_v2/models/convert_documents_request_body.py +++ b/deepsearch/cps/apis/public_v2/models/convert_documents_request_body.py @@ -17,11 +17,10 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional -from deepsearch.cps.apis.public_v2.models.internal_url import InternalUrl from deepsearch.cps.apis.public_v2.models.partial_direct_conversion_parameters import PartialDirectConversionParameters -from deepsearch.cps.apis.public_v2.models.s3_document_source import S3DocumentSource +from deepsearch.cps.apis.public_v2.models.target_conversion_parameters import TargetConversionParameters from typing import Optional, Set from typing_extensions import Self @@ -29,12 +28,23 @@ class ConvertDocumentsRequestBody(BaseModel): """ ConvertDocumentsRequestBody """ # noqa: E501 - file_url: Optional[List[StrictStr]] = Field(default=None, description="List of File's URL to be converted and uploaded to the data index.") - internal_file_url: Optional[List[InternalUrl]] = Field(default=None, description="List of Internal File's URLs to be converted and uploaded to the data index.") - s3_source: Optional[S3DocumentSource] = Field(default=None, description="Coordinates to object store to get files to convert. Can specify which files with object keys.") - upload_to_elastic: Optional[StrictBool] = None conversion_settings: Optional[PartialDirectConversionParameters] = Field(default=None, description="Specify the conversion settings to use.") - __properties: ClassVar[List[str]] = ["file_url", "internal_file_url", "s3_source", "upload_to_elastic", "conversion_settings"] + target_settings: Optional[TargetConversionParameters] = Field(default=None, description="Specify the target settings to use.") + document_hashes: Optional[List[StrictStr]] = Field(default=None, description="List of document hashes to be used as filter.") + without_operations: Optional[List[StrictStr]] = Field(default=None, description="List of Operation Status documents don't have to be used as filter.") + upload_to_elastic: Optional[StrictBool] = None + __properties: ClassVar[List[str]] = ["conversion_settings", "target_settings", "document_hashes", "without_operations", "upload_to_elastic"] + + @field_validator('without_operations') + def without_operations_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + for i in value: + if i not in set(['PENDING', 'FAILURE', 'SUCCESS']): + raise ValueError("each list item must be one of ('PENDING', 'FAILURE', 'SUCCESS')") + return value model_config = ConfigDict( populate_by_name=True, @@ -75,19 +85,12 @@ def to_dict(self) -> Dict[str, Any]: exclude=excluded_fields, exclude_none=True, ) - # override the default output from pydantic by calling `to_dict()` of each item in internal_file_url (list) - _items = [] - if self.internal_file_url: - for _item in self.internal_file_url: - if _item: - _items.append(_item.to_dict()) - _dict['internal_file_url'] = _items - # override the default output from pydantic by calling `to_dict()` of s3_source - if self.s3_source: - _dict['s3_source'] = self.s3_source.to_dict() # override the default output from pydantic by calling `to_dict()` of conversion_settings if self.conversion_settings: _dict['conversion_settings'] = self.conversion_settings.to_dict() + # override the default output from pydantic by calling `to_dict()` of target_settings + if self.target_settings: + _dict['target_settings'] = self.target_settings.to_dict() return _dict @classmethod @@ -100,11 +103,11 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: return cls.model_validate(obj) _obj = cls.model_validate({ - "file_url": obj.get("file_url"), - "internal_file_url": [InternalUrl.from_dict(_item) for _item in obj["internal_file_url"]] if obj.get("internal_file_url") is not None else None, - "s3_source": S3DocumentSource.from_dict(obj["s3_source"]) if obj.get("s3_source") is not None else None, - "upload_to_elastic": obj.get("upload_to_elastic"), - "conversion_settings": PartialDirectConversionParameters.from_dict(obj["conversion_settings"]) if obj.get("conversion_settings") is not None else None + "conversion_settings": PartialDirectConversionParameters.from_dict(obj["conversion_settings"]) if obj.get("conversion_settings") is not None else None, + "target_settings": TargetConversionParameters.from_dict(obj["target_settings"]) if obj.get("target_settings") is not None else None, + "document_hashes": obj.get("document_hashes"), + "without_operations": obj.get("without_operations"), + "upload_to_elastic": obj.get("upload_to_elastic") }) return _obj diff --git a/deepsearch/cps/apis/public_v2/models/convert_documents_sources.py b/deepsearch/cps/apis/public_v2/models/convert_documents_sources.py new file mode 100644 index 00000000..72596258 --- /dev/null +++ b/deepsearch/cps/apis/public_v2/models/convert_documents_sources.py @@ -0,0 +1,103 @@ +# coding: utf-8 + +""" + Deep Search (DS) API + + API for Deep Search. **WARNING**: This API is subject to change without warning! + + The version of the OpenAPI document: 3.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from deepsearch.cps.apis.public_v2.models.internal_url import InternalUrl +from deepsearch.cps.apis.public_v2.models.s3_document_source import S3DocumentSource +from typing import Optional, Set +from typing_extensions import Self + +class ConvertDocumentsSources(BaseModel): + """ + ConvertDocumentsSources + """ # noqa: E501 + file_url: Optional[List[StrictStr]] = Field(default=None, description="List of File's URL to be converted and uploaded to the data index.") + internal_file_url: Optional[List[InternalUrl]] = Field(default=None, description="List of Internal File's URLs to be converted and uploaded to the data index.") + s3_source: Optional[S3DocumentSource] = Field(default=None, description="Coordinates to object store to get files to convert. Can specify which files with object keys.") + __properties: ClassVar[List[str]] = ["file_url", "internal_file_url", "s3_source"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ConvertDocumentsSources from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in internal_file_url (list) + _items = [] + if self.internal_file_url: + for _item in self.internal_file_url: + if _item: + _items.append(_item.to_dict()) + _dict['internal_file_url'] = _items + # override the default output from pydantic by calling `to_dict()` of s3_source + if self.s3_source: + _dict['s3_source'] = self.s3_source.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ConvertDocumentsSources from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "file_url": obj.get("file_url"), + "internal_file_url": [InternalUrl.from_dict(_item) for _item in obj["internal_file_url"]] if obj.get("internal_file_url") is not None else None, + "s3_source": S3DocumentSource.from_dict(obj["s3_source"]) if obj.get("s3_source") is not None else None + }) + return _obj + + diff --git a/deepsearch/cps/apis/public_v2/models/convert_upload_documents_request_body.py b/deepsearch/cps/apis/public_v2/models/convert_upload_documents_request_body.py new file mode 100644 index 00000000..b316700a --- /dev/null +++ b/deepsearch/cps/apis/public_v2/models/convert_upload_documents_request_body.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + Deep Search (DS) API + + API for Deep Search. **WARNING**: This API is subject to change without warning! + + The version of the OpenAPI document: 3.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from deepsearch.cps.apis.public_v2.models.internal_url import InternalUrl +from deepsearch.cps.apis.public_v2.models.partial_direct_conversion_parameters import PartialDirectConversionParameters +from deepsearch.cps.apis.public_v2.models.s3_document_source import S3DocumentSource +from deepsearch.cps.apis.public_v2.models.target_conversion_parameters import TargetConversionParameters +from typing import Optional, Set +from typing_extensions import Self + +class ConvertUploadDocumentsRequestBody(BaseModel): + """ + ConvertUploadDocumentsRequestBody + """ # noqa: E501 + file_url: Optional[List[StrictStr]] = Field(default=None, description="List of File's URL to be converted and uploaded to the data index.") + internal_file_url: Optional[List[InternalUrl]] = Field(default=None, description="List of Internal File's URLs to be converted and uploaded to the data index.") + s3_source: Optional[S3DocumentSource] = Field(default=None, description="Coordinates to object store to get files to convert. Can specify which files with object keys.") + upload_to_elastic: Optional[StrictBool] = None + conversion_settings: Optional[PartialDirectConversionParameters] = Field(default=None, description="Specify the conversion settings to use.") + target_settings: Optional[TargetConversionParameters] = Field(default=None, description="Specify the target settings to use.") + __properties: ClassVar[List[str]] = ["file_url", "internal_file_url", "s3_source", "upload_to_elastic", "conversion_settings", "target_settings"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ConvertUploadDocumentsRequestBody from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in internal_file_url (list) + _items = [] + if self.internal_file_url: + for _item in self.internal_file_url: + if _item: + _items.append(_item.to_dict()) + _dict['internal_file_url'] = _items + # override the default output from pydantic by calling `to_dict()` of s3_source + if self.s3_source: + _dict['s3_source'] = self.s3_source.to_dict() + # override the default output from pydantic by calling `to_dict()` of conversion_settings + if self.conversion_settings: + _dict['conversion_settings'] = self.conversion_settings.to_dict() + # override the default output from pydantic by calling `to_dict()` of target_settings + if self.target_settings: + _dict['target_settings'] = self.target_settings.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ConvertUploadDocumentsRequestBody from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "file_url": obj.get("file_url"), + "internal_file_url": [InternalUrl.from_dict(_item) for _item in obj["internal_file_url"]] if obj.get("internal_file_url") is not None else None, + "s3_source": S3DocumentSource.from_dict(obj["s3_source"]) if obj.get("s3_source") is not None else None, + "upload_to_elastic": obj.get("upload_to_elastic"), + "conversion_settings": PartialDirectConversionParameters.from_dict(obj["conversion_settings"]) if obj.get("conversion_settings") is not None else None, + "target_settings": TargetConversionParameters.from_dict(obj["target_settings"]) if obj.get("target_settings") is not None else None + }) + return _obj + + diff --git a/deepsearch/cps/apis/public_v2/models/file_source.py b/deepsearch/cps/apis/public_v2/models/file_source.py new file mode 100644 index 00000000..d11ee4e3 --- /dev/null +++ b/deepsearch/cps/apis/public_v2/models/file_source.py @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + Deep Search (DS) API + + API for Deep Search. **WARNING**: This API is subject to change without warning! + + The version of the OpenAPI document: 3.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class FileSource(BaseModel): + """ + FileSource + """ # noqa: E501 + base64_string: StrictStr + filename: StrictStr + __properties: ClassVar[List[str]] = ["base64_string", "filename"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of FileSource from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of FileSource from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "base64_string": obj.get("base64_string"), + "filename": obj.get("filename") + }) + return _obj + + diff --git a/deepsearch/cps/apis/public_v2/models/gen_ai_params.py b/deepsearch/cps/apis/public_v2/models/gen_ai_params.py index 80a2f1dd..f803bb54 100644 --- a/deepsearch/cps/apis/public_v2/models/gen_ai_params.py +++ b/deepsearch/cps/apis/public_v2/models/gen_ai_params.py @@ -17,8 +17,8 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, StrictStr -from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, ConfigDict, StrictFloat, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Union from typing import Optional, Set from typing_extensions import Self @@ -29,7 +29,8 @@ class GenAIParams(BaseModel): model_id: StrictStr prompt_template: StrictStr params: Dict[str, Any] - __properties: ClassVar[List[str]] = ["model_id", "prompt_template", "params"] + timeout: Union[StrictFloat, StrictInt] + __properties: ClassVar[List[str]] = ["model_id", "prompt_template", "params", "timeout"] model_config = ConfigDict( populate_by_name=True, @@ -84,7 +85,8 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate({ "model_id": obj.get("model_id"), "prompt_template": obj.get("prompt_template"), - "params": obj.get("params") + "params": obj.get("params"), + "timeout": obj.get("timeout") }) return _obj diff --git a/deepsearch/cps/apis/public_v2/models/gen_ai_partial_params.py b/deepsearch/cps/apis/public_v2/models/gen_ai_partial_params.py index ab54fbda..efec0e4c 100644 --- a/deepsearch/cps/apis/public_v2/models/gen_ai_partial_params.py +++ b/deepsearch/cps/apis/public_v2/models/gen_ai_partial_params.py @@ -17,8 +17,8 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, StrictStr -from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, ConfigDict, StrictFloat, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional, Union from typing import Optional, Set from typing_extensions import Self @@ -29,7 +29,8 @@ class GenAIPartialParams(BaseModel): model_id: Optional[StrictStr] = None prompt_template: Optional[StrictStr] = None params: Optional[Dict[str, Any]] = None - __properties: ClassVar[List[str]] = ["model_id", "prompt_template", "params"] + timeout: Optional[Union[StrictFloat, StrictInt]] = None + __properties: ClassVar[List[str]] = ["model_id", "prompt_template", "params", "timeout"] model_config = ConfigDict( populate_by_name=True, @@ -84,7 +85,8 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate({ "model_id": obj.get("model_id"), "prompt_template": obj.get("prompt_template"), - "params": obj.get("params") + "params": obj.get("params"), + "timeout": obj.get("timeout") }) return _obj diff --git a/deepsearch/cps/apis/public_v2/models/http_source.py b/deepsearch/cps/apis/public_v2/models/http_source.py new file mode 100644 index 00000000..3aa2f191 --- /dev/null +++ b/deepsearch/cps/apis/public_v2/models/http_source.py @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + Deep Search (DS) API + + API for Deep Search. **WARNING**: This API is subject to change without warning! + + The version of the OpenAPI document: 3.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class HttpSource(BaseModel): + """ + HttpSource + """ # noqa: E501 + url: StrictStr + headers: Dict[str, Any] + __properties: ClassVar[List[str]] = ["url", "headers"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of HttpSource from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of HttpSource from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "url": obj.get("url"), + "headers": obj.get("headers") + }) + return _obj + + diff --git a/deepsearch/cps/apis/public_v2/models/target_conversion_parameters.py b/deepsearch/cps/apis/public_v2/models/target_conversion_parameters.py new file mode 100644 index 00000000..8bc9339b --- /dev/null +++ b/deepsearch/cps/apis/public_v2/models/target_conversion_parameters.py @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + Deep Search (DS) API + + API for Deep Search. **WARNING**: This API is subject to change without warning! + + The version of the OpenAPI document: 3.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictBool +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class TargetConversionParameters(BaseModel): + """ + Specify target settings (add_raw_pages, add_annotations). Fields left null are set to platform defaults. + """ # noqa: E501 + add_raw_pages: Optional[StrictBool] = None + add_annotations: Optional[StrictBool] = None + __properties: ClassVar[List[str]] = ["add_raw_pages", "add_annotations"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of TargetConversionParameters from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of TargetConversionParameters from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "add_raw_pages": obj.get("add_raw_pages"), + "add_annotations": obj.get("add_annotations") + }) + return _obj + + diff --git a/deepsearch/cps/apis/public_v2/models/upload_elastic_request_body.py b/deepsearch/cps/apis/public_v2/models/upload_elastic_request_body.py new file mode 100644 index 00000000..48226e25 --- /dev/null +++ b/deepsearch/cps/apis/public_v2/models/upload_elastic_request_body.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + Deep Search (DS) API + + API for Deep Search. **WARNING**: This API is subject to change without warning! + + The version of the OpenAPI document: 3.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class UploadElasticRequestBody(BaseModel): + """ + UploadElasticRequestBody + """ # noqa: E501 + document_hashes: Optional[List[StrictStr]] = Field(default=None, description="List of document hashes to be used as filter.") + with_operations: Optional[List[StrictStr]] = Field(default=None, description="List of Operation Status documents don't have to be used as filter.") + __properties: ClassVar[List[str]] = ["document_hashes", "with_operations"] + + @field_validator('with_operations') + def with_operations_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + for i in value: + if i not in set(['PENDING', 'FAILURE', 'SUCCESS']): + raise ValueError("each list item must be one of ('PENDING', 'FAILURE', 'SUCCESS')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of UploadElasticRequestBody from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of UploadElasticRequestBody from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "document_hashes": obj.get("document_hashes"), + "with_operations": obj.get("with_operations") + }) + return _obj + + diff --git a/docs/apis/public/AnnotateApi.md b/docs/apis/public/AnnotateApi.md deleted file mode 100644 index 03683bd2..00000000 --- a/docs/apis/public/AnnotateApi.md +++ /dev/null @@ -1,328 +0,0 @@ -# deepsearch.cps.apis.public.AnnotateApi - -All URIs are relative to *http://localhost/api/cps/public/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**generate_project_object_annotations**](AnnotateApi.md#generate_project_object_annotations) | **POST** /project/{proj_key}/object_annotations | -[**generate_project_object_annotations_async**](AnnotateApi.md#generate_project_object_annotations_async) | **POST** /project/{proj_key}/object_annotations_async | -[**get_cached_annotator_metadata**](AnnotateApi.md#get_cached_annotator_metadata) | **POST** /project/{proj_key}/annotator/metadata | -[**get_project_annotator_supported_annotations**](AnnotateApi.md#get_project_annotator_supported_annotations) | **POST** /project/{proj_key}/annotate/supported_annotations | - - -# **generate_project_object_annotations** -> AnnotatedObject1 generate_project_object_annotations(proj_key, options) - - - -Run an annotator on an object, using resources from the project. *DEPRECATED*, please use generate_project_object_annotations_async instead. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.AnnotateApi(api_client) - proj_key = 'proj_key_example' # str | -options = deepsearch.cps.apis.public.AnnotateObjectOptions() # AnnotateObjectOptions | - - try: - api_response = api_instance.generate_project_object_annotations(proj_key, options) - pprint(api_response) - except ApiException as e: - print("Exception when calling AnnotateApi->generate_project_object_annotations: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **options** | [**AnnotateObjectOptions**](AnnotateObjectOptions.md)| | - -### Return type - -[**AnnotatedObject1**](AnnotatedObject1.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **generate_project_object_annotations_async** -> Task generate_project_object_annotations_async(proj_key, options) - - - -Run an annotator on an object, using resources from the project. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.AnnotateApi(api_client) - proj_key = 'proj_key_example' # str | -options = deepsearch.cps.apis.public.AnnotateObjectOptions1() # AnnotateObjectOptions1 | - - try: - api_response = api_instance.generate_project_object_annotations_async(proj_key, options) - pprint(api_response) - except ApiException as e: - print("Exception when calling AnnotateApi->generate_project_object_annotations_async: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **options** | [**AnnotateObjectOptions1**](AnnotateObjectOptions1.md)| | - -### Return type - -[**Task**](Task.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_cached_annotator_metadata** -> AnnotatorMetadata get_cached_annotator_metadata(proj_key, options) - - - -Get annotator's metadata - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.AnnotateApi(api_client) - proj_key = 'proj_key_example' # str | -options = None # object | - - try: - api_response = api_instance.get_cached_annotator_metadata(proj_key, options) - pprint(api_response) - except ApiException as e: - print("Exception when calling AnnotateApi->get_cached_annotator_metadata: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **options** | **object**| | - -### Return type - -[**AnnotatorMetadata**](AnnotatorMetadata.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json, text/html - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_project_annotator_supported_annotations** -> SupportedAnnotatorAnnotations get_project_annotator_supported_annotations(proj_key, options) - - - -Get supported annotations for an annotator - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.AnnotateApi(api_client) - proj_key = 'proj_key_example' # str | -options = None # object | - - try: - api_response = api_instance.get_project_annotator_supported_annotations(proj_key, options) - pprint(api_response) - except ApiException as e: - print("Exception when calling AnnotateApi->get_project_annotator_supported_annotations: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **options** | **object**| | - -### Return type - -[**SupportedAnnotatorAnnotations**](SupportedAnnotatorAnnotations.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json, text/html - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/apis/public/AnnotateDocumentRequest.md b/docs/apis/public/AnnotateDocumentRequest.md deleted file mode 100644 index 3b990288..00000000 --- a/docs/apis/public/AnnotateDocumentRequest.md +++ /dev/null @@ -1,14 +0,0 @@ -# AnnotateDocumentRequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**document** | [**object**](.md) | | -**image_annotators** | [**list[AnnotatorParametersOrRef]**](AnnotatorParametersOrRef.md) | | -**table_annotators** | [**list[AnnotatorParametersOrRef]**](AnnotatorParametersOrRef.md) | | -**text_annotators** | [**list[AnnotatorParametersOrRef]**](AnnotatorParametersOrRef.md) | | -**use_cache** | **bool** | | [optional] [default to True] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/AnnotateObjectOptions.md b/docs/apis/public/AnnotateObjectOptions.md deleted file mode 100644 index 96c1b2dc..00000000 --- a/docs/apis/public/AnnotateObjectOptions.md +++ /dev/null @@ -1,11 +0,0 @@ -# AnnotateObjectOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**input** | [**AnnotatorInput**](AnnotatorInput.md) | | -**parameters** | **dict(str, object)** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/AnnotateObjectOptions1.md b/docs/apis/public/AnnotateObjectOptions1.md deleted file mode 100644 index 452a7442..00000000 --- a/docs/apis/public/AnnotateObjectOptions1.md +++ /dev/null @@ -1,14 +0,0 @@ -# AnnotateObjectOptions1 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**input** | [**AnnotatorInput**](AnnotatorInput.md) | | -**model_config_key** | **str** | | [optional] -**parameters** | **dict(str, object)** | | -**proj_key** | **str** | | [optional] -**public** | **bool** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/AnnotatedDocumentReport.md b/docs/apis/public/AnnotatedDocumentReport.md deleted file mode 100644 index 9324ec65..00000000 --- a/docs/apis/public/AnnotatedDocumentReport.md +++ /dev/null @@ -1,13 +0,0 @@ -# AnnotatedDocumentReport - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**document** | [**ProjectProjKeyAnnotateDocumentReportDocument**](ProjectProjKeyAnnotateDocumentReportDocument.md) | | -**document_annotation_parameters** | [**object**](.md) | | [optional] -**document_conversion_parameters** | [**object**](.md) | | [optional] -**report** | [**ProjectProjKeyAnnotateDocumentReportReport**](ProjectProjKeyAnnotateDocumentReportReport.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/AnnotatedImage.md b/docs/apis/public/AnnotatedImage.md deleted file mode 100644 index 0fdaaeff..00000000 --- a/docs/apis/public/AnnotatedImage.md +++ /dev/null @@ -1,13 +0,0 @@ -# AnnotatedImage - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**entities** | **dict(str, list[EntityAnnotation])** | | -**properties** | [**object**](.md) | | -**relationships** | **dict(str, list[object])** | | -**text** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/AnnotatedObject.md b/docs/apis/public/AnnotatedObject.md deleted file mode 100644 index b5602f3b..00000000 --- a/docs/apis/public/AnnotatedObject.md +++ /dev/null @@ -1,12 +0,0 @@ -# AnnotatedObject - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**image** | [**AnnotatedImage**](AnnotatedImage.md) | | [optional] -**table** | [**AnnotatedTable**](AnnotatedTable.md) | | [optional] -**text** | [**AnnotatedTextLines**](AnnotatedTextLines.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/AnnotatedObject1.md b/docs/apis/public/AnnotatedObject1.md deleted file mode 100644 index 1678dd95..00000000 --- a/docs/apis/public/AnnotatedObject1.md +++ /dev/null @@ -1,12 +0,0 @@ -# AnnotatedObject1 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**image** | [**AnnotatedImage**](AnnotatedImage.md) | | [optional] -**table** | [**AnnotatedTable**](AnnotatedTable.md) | | [optional] -**text** | [**AnnotatedTextLines**](AnnotatedTextLines.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/AnnotatedTable.md b/docs/apis/public/AnnotatedTable.md deleted file mode 100644 index 8f6bde54..00000000 --- a/docs/apis/public/AnnotatedTable.md +++ /dev/null @@ -1,13 +0,0 @@ -# AnnotatedTable - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**entities** | **dict(str, list[EntityAnnotation])** | | -**properties** | [**object**](.md) | | -**relationships** | **dict(str, list[object])** | | -**text** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/AnnotatedText.md b/docs/apis/public/AnnotatedText.md deleted file mode 100644 index 62a5c0bd..00000000 --- a/docs/apis/public/AnnotatedText.md +++ /dev/null @@ -1,13 +0,0 @@ -# AnnotatedText - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**entities** | **dict(str, list[EntityAnnotation])** | | -**properties** | [**object**](.md) | | -**relationships** | **dict(str, list[object])** | | -**text** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/AnnotatedTextLines.md b/docs/apis/public/AnnotatedTextLines.md deleted file mode 100644 index cb2cb61d..00000000 --- a/docs/apis/public/AnnotatedTextLines.md +++ /dev/null @@ -1,13 +0,0 @@ -# AnnotatedTextLines - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**entities** | **list[dict(str, list[EntityAnnotation])]** | One item per line on the original text. | -**properties** | **list[object]** | One item per line on the original text. | -**relationships** | **list[dict(str, list[object])]** | One item per line on the original text. | -**text** | **str** | Input text after clean up. The annotation indexes will be based on this text and not the input text. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/AnnotatorImageInput.md b/docs/apis/public/AnnotatorImageInput.md deleted file mode 100644 index 8bd222b6..00000000 --- a/docs/apis/public/AnnotatorImageInput.md +++ /dev/null @@ -1,11 +0,0 @@ -# AnnotatorImageInput - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**metadata** | [**ImageMetadata**](ImageMetadata.md) | | [optional] -**source** | [**ImageSource**](ImageSource.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/AnnotatorInput.md b/docs/apis/public/AnnotatorInput.md deleted file mode 100644 index cfc21245..00000000 --- a/docs/apis/public/AnnotatorInput.md +++ /dev/null @@ -1,12 +0,0 @@ -# AnnotatorInput - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**image** | [**AnnotatorImageInput**](AnnotatorImageInput.md) | | [optional] -**table** | **list[list[object]]** | A table, specified as an array of arrays. Each outer array represents a row, and each item in the inner array represents the column. | [optional] -**text** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/AnnotatorMetadata.md b/docs/apis/public/AnnotatorMetadata.md deleted file mode 100644 index 000ff2be..00000000 --- a/docs/apis/public/AnnotatorMetadata.md +++ /dev/null @@ -1,14 +0,0 @@ -# AnnotatorMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**author** | **str** | | -**description** | **str** | | -**name** | **str** | | -**url** | **str** | | -**version** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/AnnotatorParametersOrRef.md b/docs/apis/public/AnnotatorParametersOrRef.md deleted file mode 100644 index 574899d9..00000000 --- a/docs/apis/public/AnnotatorParametersOrRef.md +++ /dev/null @@ -1,13 +0,0 @@ -# AnnotatorParametersOrRef - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**model_config_key** | **str** | | [optional] -**proj_key** | **str** | | [optional] -**public** | **bool** | | [optional] -**type** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/AnnotatorSupportedAnnotationsParameters.md b/docs/apis/public/AnnotatorSupportedAnnotationsParameters.md deleted file mode 100644 index 50c4b3cb..00000000 --- a/docs/apis/public/AnnotatorSupportedAnnotationsParameters.md +++ /dev/null @@ -1,11 +0,0 @@ -# AnnotatorSupportedAnnotationsParameters - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**annotator** | **str** | | -**annotator_settings** | [**object**](.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/AssembleDataFlowIntoKnowledgeGraphOptions.md b/docs/apis/public/AssembleDataFlowIntoKnowledgeGraphOptions.md deleted file mode 100644 index 8e70572b..00000000 --- a/docs/apis/public/AssembleDataFlowIntoKnowledgeGraphOptions.md +++ /dev/null @@ -1,12 +0,0 @@ -# AssembleDataFlowIntoKnowledgeGraphOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data_flow** | [**BackendProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlow**](BackendProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlow.md) | | -**render** | [**BackendProjectProjKeyBagsBagKeyTasksAssembleDataflowRender**](BackendProjectProjKeyBagsBagKeyTasksAssembleDataflowRender.md) | | -**snapshot** | [**TakeSnapshotSettingsBackendAware**](TakeSnapshotSettingsBackendAware.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/AssembleDataFlowIntoKnowledgeGraphOptions1.md b/docs/apis/public/AssembleDataFlowIntoKnowledgeGraphOptions1.md deleted file mode 100644 index efea0b23..00000000 --- a/docs/apis/public/AssembleDataFlowIntoKnowledgeGraphOptions1.md +++ /dev/null @@ -1,12 +0,0 @@ -# AssembleDataFlowIntoKnowledgeGraphOptions1 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data_flow** | [**BackendProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlow**](BackendProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlow.md) | | -**render** | [**BackendProjectProjKeyBagsBagKeyTasksAssembleDataflowRender**](BackendProjectProjKeyBagsBagKeyTasksAssembleDataflowRender.md) | | -**snapshot** | [**TakeSnapshotSettings**](TakeSnapshotSettings.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/AssembleSettings.md b/docs/apis/public/AssembleSettings.md deleted file mode 100644 index 35590f9f..00000000 --- a/docs/apis/public/AssembleSettings.md +++ /dev/null @@ -1,11 +0,0 @@ -# AssembleSettings - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**include_incomplete_documents** | **bool** | | -**mode** | [**AssembleSettingsMode**](AssembleSettingsMode.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/AssembleSettingsMode.md b/docs/apis/public/AssembleSettingsMode.md deleted file mode 100644 index dfb7ef91..00000000 --- a/docs/apis/public/AssembleSettingsMode.md +++ /dev/null @@ -1,11 +0,0 @@ -# AssembleSettingsMode - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**page_elements** | **list[str]** | | -**tables** | **list[str]** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/AttachmentUploadData.md b/docs/apis/public/AttachmentUploadData.md deleted file mode 100644 index d40fe5c9..00000000 --- a/docs/apis/public/AttachmentUploadData.md +++ /dev/null @@ -1,11 +0,0 @@ -# AttachmentUploadData - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**attachment_path** | **str** | Attachment path. | -**upload_data** | [**AttachmentUploadDataUploadData**](AttachmentUploadDataUploadData.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/AttachmentUploadDataUploadData.md b/docs/apis/public/AttachmentUploadDataUploadData.md deleted file mode 100644 index 6f26d557..00000000 --- a/docs/apis/public/AttachmentUploadDataUploadData.md +++ /dev/null @@ -1,12 +0,0 @@ -# AttachmentUploadDataUploadData - -Data to upload the temporary file. Example using requests 'requests(dot)post(url, data=fields, files=file)'. More information can be found on aws s3 documentation here https://docs.aws.amazon.com/AmazonS3/latest/userguide/PresignedUrlUploadObject.html -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**fields** | [**object**](.md) | fields to use in request body. | [optional] -**url** | **str** | url of the host. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/BackendFlavour.md b/docs/apis/public/BackendFlavour.md deleted file mode 100644 index 49134a69..00000000 --- a/docs/apis/public/BackendFlavour.md +++ /dev/null @@ -1,11 +0,0 @@ -# BackendFlavour - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**kg_amqp** | **str** | | [optional] -**kg_legacy_api** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/BackendProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlow.md b/docs/apis/public/BackendProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlow.md deleted file mode 100644 index 4b255851..00000000 --- a/docs/apis/public/BackendProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlow.md +++ /dev/null @@ -1,13 +0,0 @@ -# BackendProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlow - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**df_tpl_key** | **str** | If set, the data flow with this key will be used. | [optional] -**proj_key** | **str** | If set, allows for cross-project data flows to be used. | [optional] -**public** | **bool** | Must be set if the data flow template is public | [optional] -**raw_data_flow** | [**BackendProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlowRawDataFlow**](BackendProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlowRawDataFlow.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/BackendProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlowRawDataFlow.md b/docs/apis/public/BackendProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlowRawDataFlow.md deleted file mode 100644 index 8ff2ea30..00000000 --- a/docs/apis/public/BackendProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlowRawDataFlow.md +++ /dev/null @@ -1,12 +0,0 @@ -# BackendProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlowRawDataFlow - -If this is set, the raw data flow contents will be used. -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**template** | **str** | Must be valid JSON | -**variables** | [**object**](.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/BackendProjectProjKeyBagsBagKeyTasksAssembleDataflowRender.md b/docs/apis/public/BackendProjectProjKeyBagsBagKeyTasksAssembleDataflowRender.md deleted file mode 100644 index c0d8b40c..00000000 --- a/docs/apis/public/BackendProjectProjKeyBagsBagKeyTasksAssembleDataflowRender.md +++ /dev/null @@ -1,10 +0,0 @@ -# BackendProjectProjKeyBagsBagKeyTasksAssembleDataflowRender - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**variables** | **dict(str, object)** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/BackupKnowledgeGraphOptions.md b/docs/apis/public/BackupKnowledgeGraphOptions.md deleted file mode 100644 index a2ce5c01..00000000 --- a/docs/apis/public/BackupKnowledgeGraphOptions.md +++ /dev/null @@ -1,11 +0,0 @@ -# BackupKnowledgeGraphOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**backup_s3** | **bool** | | [optional] [default to True] -**coordinates** | [**S3CoordinatesWithBackupKey**](S3CoordinatesWithBackupKey.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/Bag.md b/docs/apis/public/Bag.md deleted file mode 100644 index 269aa15f..00000000 --- a/docs/apis/public/Bag.md +++ /dev/null @@ -1,20 +0,0 @@ -# Bag - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**svc_endpoint** | **str** | | -**bag_domain** | **str** | | -**bag_key** | **str** | | -**bag_url** | **str** | | -**flavour** | **str** | | -**name** | **str** | | -**proj_key** | **str** | | -**public** | **bool** | | -**slug** | **str** | | -**timestamp** | **float** | | -**token** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/BagAmqpBackend.md b/docs/apis/public/BagAmqpBackend.md deleted file mode 100644 index 76571a2f..00000000 --- a/docs/apis/public/BagAmqpBackend.md +++ /dev/null @@ -1,10 +0,0 @@ -# BagAmqpBackend - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**flavour** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/BagBackendAware.md b/docs/apis/public/BagBackendAware.md deleted file mode 100644 index 41434ae9..00000000 --- a/docs/apis/public/BagBackendAware.md +++ /dev/null @@ -1,18 +0,0 @@ -# BagBackendAware - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**backend** | [**BagBackends**](BagBackends.md) | | -**bag_key** | **str** | | -**description** | **str** | | -**last_coords_resolution** | **float** | | [optional] -**name** | **str** | | -**proj_key** | **str** | | -**public** | **bool** | | -**slug** | **str** | | -**timestamp** | **float** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/BagBackends.md b/docs/apis/public/BagBackends.md deleted file mode 100644 index 480052e2..00000000 --- a/docs/apis/public/BagBackends.md +++ /dev/null @@ -1,11 +0,0 @@ -# BagBackends - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**kg_amqp** | [**BagAmqpBackend**](BagAmqpBackend.md) | | [optional] -**kg_legacy_api** | [**BagKgLegacyApiBackend**](BagKgLegacyApiBackend.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/BagCallback.md b/docs/apis/public/BagCallback.md deleted file mode 100644 index ee0e953b..00000000 --- a/docs/apis/public/BagCallback.md +++ /dev/null @@ -1,10 +0,0 @@ -# BagCallback - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**callback_url** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/BagComponentStatus.md b/docs/apis/public/BagComponentStatus.md deleted file mode 100644 index 66998ddd..00000000 --- a/docs/apis/public/BagComponentStatus.md +++ /dev/null @@ -1,11 +0,0 @@ -# BagComponentStatus - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**start_time** | **float** | | -**status** | [**BagComponentStatusEnum**](BagComponentStatusEnum.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/BagComponentStatusEnum.md b/docs/apis/public/BagComponentStatusEnum.md deleted file mode 100644 index fe4e4320..00000000 --- a/docs/apis/public/BagComponentStatusEnum.md +++ /dev/null @@ -1,9 +0,0 @@ -# BagComponentStatusEnum - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/BagFlavour.md b/docs/apis/public/BagFlavour.md deleted file mode 100644 index eeec2e62..00000000 --- a/docs/apis/public/BagFlavour.md +++ /dev/null @@ -1,12 +0,0 @@ -# BagFlavour - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | **str** | | [optional] -**display_name** | **str** | | [optional] -**name** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/BagFlavourDefaultQuota.md b/docs/apis/public/BagFlavourDefaultQuota.md deleted file mode 100644 index 0698d090..00000000 --- a/docs/apis/public/BagFlavourDefaultQuota.md +++ /dev/null @@ -1,12 +0,0 @@ -# BagFlavourDefaultQuota - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**default_quota** | **float** | | [optional] -**display_name** | **str** | | -**name** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/BagFlavourFullData.md b/docs/apis/public/BagFlavourFullData.md deleted file mode 100644 index 8927f95a..00000000 --- a/docs/apis/public/BagFlavourFullData.md +++ /dev/null @@ -1,18 +0,0 @@ -# BagFlavourFullData - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**backend** | **str** | | -**config** | [**object**](.md) | | -**default_quota** | **int** | | [optional] -**description** | **str** | | -**display_name** | **str** | | -**is_from_deployment** | **bool** | | [optional] -**name** | **str** | | [optional] -**order** | **float** | | [optional] -**project_specific** | **bool** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/BagKgLegacyApiBackend.md b/docs/apis/public/BagKgLegacyApiBackend.md deleted file mode 100644 index eb596398..00000000 --- a/docs/apis/public/BagKgLegacyApiBackend.md +++ /dev/null @@ -1,14 +0,0 @@ -# BagKgLegacyApiBackend - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**svc_endpoint** | **str** | | [optional] -**bag_domain** | **str** | | [optional] -**bag_url** | **str** | | [optional] -**flavour** | **str** | | [optional] -**token** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/BagStatus.md b/docs/apis/public/BagStatus.md deleted file mode 100644 index 971f6b04..00000000 --- a/docs/apis/public/BagStatus.md +++ /dev/null @@ -1,11 +0,0 @@ -# BagStatus - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**components** | [**BagStatusComponents**](BagStatusComponents.md) | | -**status** | [**BagComponentStatusEnum**](BagComponentStatusEnum.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/BagStatusBackendAware.md b/docs/apis/public/BagStatusBackendAware.md deleted file mode 100644 index 9235b3b3..00000000 --- a/docs/apis/public/BagStatusBackendAware.md +++ /dev/null @@ -1,12 +0,0 @@ -# BagStatusBackendAware - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**kg_amqp** | [**BagStatusBackendAwareKgAmqp**](BagStatusBackendAwareKgAmqp.md) | | [optional] -**kg_legacy_api** | [**BagStatus**](BagStatus.md) | | [optional] -**overall_status** | [**BagComponentStatusEnum**](BagComponentStatusEnum.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/BagStatusBackendAwareKgAmqp.md b/docs/apis/public/BagStatusBackendAwareKgAmqp.md deleted file mode 100644 index 27f07380..00000000 --- a/docs/apis/public/BagStatusBackendAwareKgAmqp.md +++ /dev/null @@ -1,10 +0,0 @@ -# BagStatusBackendAwareKgAmqp - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**status** | [**BagComponentStatusEnum**](BagComponentStatusEnum.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/BagStatusComponents.md b/docs/apis/public/BagStatusComponents.md deleted file mode 100644 index 073d60a1..00000000 --- a/docs/apis/public/BagStatusComponents.md +++ /dev/null @@ -1,12 +0,0 @@ -# BagStatusComponents - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**erlenmeyer_api** | [**BagComponentStatus**](BagComponentStatus.md) | Status of the Erlenmeyer API for this Graph | -**erlenmeyer_ui** | [**BagComponentStatus**](BagComponentStatus.md) | Status of the Erlenmeyer UI for this Graph | -**kg** | [**BagComponentStatus**](BagComponentStatus.md) | Status of the Knowledge Graph and its API | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/CatalogReference.md b/docs/apis/public/CatalogReference.md deleted file mode 100644 index 6f5b2e8a..00000000 --- a/docs/apis/public/CatalogReference.md +++ /dev/null @@ -1,12 +0,0 @@ -# CatalogReference - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**collection_name** | **str** | | -**dc_key** | **str** | | -**proj_key** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/CcsCollectionReference.md b/docs/apis/public/CcsCollectionReference.md deleted file mode 100644 index 857cd5b6..00000000 --- a/docs/apis/public/CcsCollectionReference.md +++ /dev/null @@ -1,12 +0,0 @@ -# CcsCollectionReference - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**collection_name** | **str** | | -**language** | **str** | | [optional] -**proj_key** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/CcsTask.md b/docs/apis/public/CcsTask.md deleted file mode 100644 index a28b11b9..00000000 --- a/docs/apis/public/CcsTask.md +++ /dev/null @@ -1,12 +0,0 @@ -# CcsTask - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ccs_collection_name** | **str** | | -**ccs_project_key** | **str** | | -**task_id** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/CeleryTask.md b/docs/apis/public/CeleryTask.md deleted file mode 100644 index e7455ef4..00000000 --- a/docs/apis/public/CeleryTask.md +++ /dev/null @@ -1,12 +0,0 @@ -# CeleryTask - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**failures** | [**list[SystemCeleryTasksFailureFailures]**](SystemCeleryTasksFailureFailures.md) | | -**proj_key** | **str** | | -**task_id** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/CeleryTask1.md b/docs/apis/public/CeleryTask1.md deleted file mode 100644 index 7c1eee05..00000000 --- a/docs/apis/public/CeleryTask1.md +++ /dev/null @@ -1,21 +0,0 @@ -# CeleryTask1 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**completed_at** | **float** | | -**created_at** | **float** | | -**meta** | **dict(str, object)** | | -**metrics** | [**object**](.md) | | [optional] -**proj_key** | **str** | | -**project_task_id** | **str** | | -**project_task_type** | **str** | | [optional] -**started_at** | **float** | | -**task_id** | **str** | | -**task_status** | **str** | | -**task_type** | **str** | | -**worker_name** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/CeleryTaskPromise.md b/docs/apis/public/CeleryTaskPromise.md deleted file mode 100644 index 54bd123e..00000000 --- a/docs/apis/public/CeleryTaskPromise.md +++ /dev/null @@ -1,12 +0,0 @@ -# CeleryTaskPromise - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**result** | [**object**](.md) | | -**task_id** | **str** | | -**task_status** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/CloneDataCatalogOptions.md b/docs/apis/public/CloneDataCatalogOptions.md deleted file mode 100644 index 91511811..00000000 --- a/docs/apis/public/CloneDataCatalogOptions.md +++ /dev/null @@ -1,14 +0,0 @@ -# CloneDataCatalogOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**collections** | **list[str]** | | [optional] -**copy_s3** | **bool** | Should the catalog's S3 data also be copied? | [optional] [default to True] -**description** | **str** | | -**name** | **str** | | -**public** | **bool** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/CloneDataCatalogResult.md b/docs/apis/public/CloneDataCatalogResult.md deleted file mode 100644 index 55a264f6..00000000 --- a/docs/apis/public/CloneDataCatalogResult.md +++ /dev/null @@ -1,11 +0,0 @@ -# CloneDataCatalogResult - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**clone_task** | [**Task**](Task.md) | | -**data_catalogue** | [**DataCatalogue**](DataCatalogue.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/CloneDictionaryOptions.md b/docs/apis/public/CloneDictionaryOptions.md deleted file mode 100644 index d873fc21..00000000 --- a/docs/apis/public/CloneDictionaryOptions.md +++ /dev/null @@ -1,14 +0,0 @@ -# CloneDictionaryOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**collections** | **list[str]** | | [optional] -**copy_s3** | **bool** | Should the dictionary's S3 data also be copied? | [optional] [default to True] -**description** | **str** | | -**name** | **str** | | -**public** | **bool** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ClonePublicDataCatalogOptions.md b/docs/apis/public/ClonePublicDataCatalogOptions.md deleted file mode 100644 index 954ab2e0..00000000 --- a/docs/apis/public/ClonePublicDataCatalogOptions.md +++ /dev/null @@ -1,15 +0,0 @@ -# ClonePublicDataCatalogOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**collections** | **list[str]** | | [optional] -**copy_s3** | **bool** | Should the catalog's S3 data also be copied? | [optional] [default to True] -**description** | **str** | | -**name** | **str** | | -**proj_key** | **str** | The project key of the project to store the resulting data catalogue | -**public** | **bool** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ClonePublicDictionaryOptions.md b/docs/apis/public/ClonePublicDictionaryOptions.md deleted file mode 100644 index 22817550..00000000 --- a/docs/apis/public/ClonePublicDictionaryOptions.md +++ /dev/null @@ -1,15 +0,0 @@ -# ClonePublicDictionaryOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**collections** | **list[str]** | | [optional] -**copy_s3** | **bool** | Should the dictionary's S3 data also be copied? | [optional] [default to True] -**description** | **str** | | -**name** | **str** | | -**proj_key** | **str** | The project key of the project to store the resulting dictionary | -**public** | **bool** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/CollectionListCoordinates.md b/docs/apis/public/CollectionListCoordinates.md deleted file mode 100644 index f8e4e2a8..00000000 --- a/docs/apis/public/CollectionListCoordinates.md +++ /dev/null @@ -1,10 +0,0 @@ -# CollectionListCoordinates - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**collections** | **list[str]** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/CollectionMetadataSettings.md b/docs/apis/public/CollectionMetadataSettings.md deleted file mode 100644 index 04b294e6..00000000 --- a/docs/apis/public/CollectionMetadataSettings.md +++ /dev/null @@ -1,14 +0,0 @@ -# CollectionMetadataSettings - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | **str** | | [optional] -**display_name** | **str** | | [optional] -**licence** | **str** | | [optional] -**source** | **str** | | [optional] -**version** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/CpsModelReference.md b/docs/apis/public/CpsModelReference.md deleted file mode 100644 index 2f0011a3..00000000 --- a/docs/apis/public/CpsModelReference.md +++ /dev/null @@ -1,11 +0,0 @@ -# CpsModelReference - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**model_config_key** | **str** | | -**proj_key** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/CpsPackage.md b/docs/apis/public/CpsPackage.md deleted file mode 100644 index 4e4ac75d..00000000 --- a/docs/apis/public/CpsPackage.md +++ /dev/null @@ -1,14 +0,0 @@ -# CpsPackage - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**dependencies** | **list[str]** | | -**description** | **str** | | -**name** | **str** | | -**package_id** | **str** | | -**type** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/CpsTask.md b/docs/apis/public/CpsTask.md deleted file mode 100644 index d82be6c0..00000000 --- a/docs/apis/public/CpsTask.md +++ /dev/null @@ -1,12 +0,0 @@ -# CpsTask - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**task_id** | **str** | | -**task_status** | **str** | | -**task_type** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/CreateCollectionInDictionaryOptions.md b/docs/apis/public/CreateCollectionInDictionaryOptions.md deleted file mode 100644 index 8d3d8a19..00000000 --- a/docs/apis/public/CreateCollectionInDictionaryOptions.md +++ /dev/null @@ -1,10 +0,0 @@ -# CreateCollectionInDictionaryOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**collection_name** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/CreateDataCatalogCollectionOptions.md b/docs/apis/public/CreateDataCatalogCollectionOptions.md deleted file mode 100644 index 89511314..00000000 --- a/docs/apis/public/CreateDataCatalogCollectionOptions.md +++ /dev/null @@ -1,10 +0,0 @@ -# CreateDataCatalogCollectionOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**collection_name** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/CreateDataCatalogOptions.md b/docs/apis/public/CreateDataCatalogOptions.md deleted file mode 100644 index 3e30e068..00000000 --- a/docs/apis/public/CreateDataCatalogOptions.md +++ /dev/null @@ -1,15 +0,0 @@ -# CreateDataCatalogOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**category_schemas** | [**list[DataCatalogCategorySchema]**](DataCatalogCategorySchema.md) | | [optional] -**collections_data_flows** | [**list[DataCatalogDataFlow]**](DataCatalogDataFlow.md) | | [optional] -**description** | **str** | | -**name** | **str** | | -**public** | **bool** | | -**topologydata_flows** | [**list[DataCatalogTopology]**](DataCatalogTopology.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/CreateDataFlowTemplateOptions.md b/docs/apis/public/CreateDataFlowTemplateOptions.md deleted file mode 100644 index 82d4a5f9..00000000 --- a/docs/apis/public/CreateDataFlowTemplateOptions.md +++ /dev/null @@ -1,14 +0,0 @@ -# CreateDataFlowTemplateOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | **str** | | -**name** | **str** | | -**public** | **bool** | | -**template** | [**DataFlowTemplate**](DataFlowTemplate.md) | | -**variables** | [**dict(str, ProjectProjKeyKgcDataflowTemplatesVariables)**](ProjectProjKeyKgcDataflowTemplatesVariables.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/CreateDictionaryOptions.md b/docs/apis/public/CreateDictionaryOptions.md deleted file mode 100644 index 5959032a..00000000 --- a/docs/apis/public/CreateDictionaryOptions.md +++ /dev/null @@ -1,12 +0,0 @@ -# CreateDictionaryOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | **str** | | -**name** | **str** | | -**public** | **bool** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/CreateKnowledgeGraphOptions.md b/docs/apis/public/CreateKnowledgeGraphOptions.md deleted file mode 100644 index 1606eebf..00000000 --- a/docs/apis/public/CreateKnowledgeGraphOptions.md +++ /dev/null @@ -1,13 +0,0 @@ -# CreateKnowledgeGraphOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | **str** | Description of the BAG | [optional] -**flavours** | **list[str]** | Flavours names of the bag. Determines its available resources | -**name** | **str** | Name of the BAG | -**public** | **bool** | If true, the BAG will be publicly available | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/CreateKnowledgeGraphOptions1.md b/docs/apis/public/CreateKnowledgeGraphOptions1.md deleted file mode 100644 index 5a60e866..00000000 --- a/docs/apis/public/CreateKnowledgeGraphOptions1.md +++ /dev/null @@ -1,13 +0,0 @@ -# CreateKnowledgeGraphOptions1 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | **str** | Description of the BAG | [optional] -**flavour** | **str** | \"Flavour\" of the BAG, determines its available resources. | -**name** | **str** | Name of the BAG | -**public** | **bool** | If true, the BAG will be publicly available | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/CreateProjectModelConfigOptions.md b/docs/apis/public/CreateProjectModelConfigOptions.md deleted file mode 100644 index 2cb8a926..00000000 --- a/docs/apis/public/CreateProjectModelConfigOptions.md +++ /dev/null @@ -1,14 +0,0 @@ -# CreateProjectModelConfigOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**configurations** | [**ProjectProjKeyModelConfigsConfigurations**](ProjectProjKeyModelConfigsConfigurations.md) | | -**description** | **str** | | -**model_config_key** | **str** | | [optional] -**name** | **str** | | -**public** | **bool** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataCatalogCategorySchema.md b/docs/apis/public/DataCatalogCategorySchema.md deleted file mode 100644 index c33487f8..00000000 --- a/docs/apis/public/DataCatalogCategorySchema.md +++ /dev/null @@ -1,11 +0,0 @@ -# DataCatalogCategorySchema - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**key** | **str** | | -**schema** | **dict(str, object)** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataCatalogCollection.md b/docs/apis/public/DataCatalogCollection.md deleted file mode 100644 index 7023e52d..00000000 --- a/docs/apis/public/DataCatalogCollection.md +++ /dev/null @@ -1,11 +0,0 @@ -# DataCatalogCollection - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**item_count** | **int** | | -**name** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataCatalogDataFlow.md b/docs/apis/public/DataCatalogDataFlow.md deleted file mode 100644 index 6f32a327..00000000 --- a/docs/apis/public/DataCatalogDataFlow.md +++ /dev/null @@ -1,11 +0,0 @@ -# DataCatalogDataFlow - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data_flows** | **list[object]** | | -**key** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataCatalogImportOptions.md b/docs/apis/public/DataCatalogImportOptions.md deleted file mode 100644 index 4ebe9ae6..00000000 --- a/docs/apis/public/DataCatalogImportOptions.md +++ /dev/null @@ -1,11 +0,0 @@ -# DataCatalogImportOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**options** | [**ProjectProjKeyDataCataloguesFromMongoOptions**](ProjectProjKeyDataCataloguesFromMongoOptions.md) | | -**target** | [**ProjectProjKeyDataCataloguesFromMongoTarget**](ProjectProjKeyDataCataloguesFromMongoTarget.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataCatalogImportResult.md b/docs/apis/public/DataCatalogImportResult.md deleted file mode 100644 index 32553551..00000000 --- a/docs/apis/public/DataCatalogImportResult.md +++ /dev/null @@ -1,11 +0,0 @@ -# DataCatalogImportResult - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data_catalogue** | [**DataCatalogue**](DataCatalogue.md) | | -**import_task** | [**Task**](Task.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataCatalogProvenanceLog.md b/docs/apis/public/DataCatalogProvenanceLog.md deleted file mode 100644 index 76a12361..00000000 --- a/docs/apis/public/DataCatalogProvenanceLog.md +++ /dev/null @@ -1,13 +0,0 @@ -# DataCatalogProvenanceLog - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**collection_name** | **str** | | -**source** | [**DataCatalogProvenanceLogSource**](DataCatalogProvenanceLogSource.md) | | -**timestamp** | **float** | | -**user** | [**DataCatalogProvenanceLogUser**](DataCatalogProvenanceLogUser.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataCatalogProvenanceLogSource.md b/docs/apis/public/DataCatalogProvenanceLogSource.md deleted file mode 100644 index e4188498..00000000 --- a/docs/apis/public/DataCatalogProvenanceLogSource.md +++ /dev/null @@ -1,15 +0,0 @@ -# DataCatalogProvenanceLogSource - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ccs** | [**object**](.md) | | [optional] -**clone** | [**object**](.md) | | [optional] -**elastic** | [**object**](.md) | | [optional] -**file** | [**object**](.md) | | [optional] -**mongo_s3** | [**object**](.md) | | [optional] -**url** | [**object**](.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataCatalogProvenanceLogUser.md b/docs/apis/public/DataCatalogProvenanceLogUser.md deleted file mode 100644 index 999760ac..00000000 --- a/docs/apis/public/DataCatalogProvenanceLogUser.md +++ /dev/null @@ -1,12 +0,0 @@ -# DataCatalogProvenanceLogUser - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**email** | **str** | | -**name** | **str** | | -**user_key** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataCatalogSchema.md b/docs/apis/public/DataCatalogSchema.md deleted file mode 100644 index 82cc9b32..00000000 --- a/docs/apis/public/DataCatalogSchema.md +++ /dev/null @@ -1,11 +0,0 @@ -# DataCatalogSchema - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | | [optional] -**schema** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataCatalogTopology.md b/docs/apis/public/DataCatalogTopology.md deleted file mode 100644 index 6777fddb..00000000 --- a/docs/apis/public/DataCatalogTopology.md +++ /dev/null @@ -1,11 +0,0 @@ -# DataCatalogTopology - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**categories** | [**list[DataCatalogTopologyNode]**](DataCatalogTopologyNode.md) | | -**edges** | [**list[DataCatalogTopologyEdge]**](DataCatalogTopologyEdge.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataCatalogTopologyEdge.md b/docs/apis/public/DataCatalogTopologyEdge.md deleted file mode 100644 index 83babab9..00000000 --- a/docs/apis/public/DataCatalogTopologyEdge.md +++ /dev/null @@ -1,14 +0,0 @@ -# DataCatalogTopologyEdge - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | | -**source** | **list[str]** | | -**source_field** | **str** | | -**target** | **list[str]** | | -**target_field** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataCatalogTopologyNode.md b/docs/apis/public/DataCatalogTopologyNode.md deleted file mode 100644 index e1fef115..00000000 --- a/docs/apis/public/DataCatalogTopologyNode.md +++ /dev/null @@ -1,11 +0,0 @@ -# DataCatalogTopologyNode - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data_fields** | **list[str]** | | -**name** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataCatalogUrlImportOptions.md b/docs/apis/public/DataCatalogUrlImportOptions.md deleted file mode 100644 index 1899a327..00000000 --- a/docs/apis/public/DataCatalogUrlImportOptions.md +++ /dev/null @@ -1,11 +0,0 @@ -# DataCatalogUrlImportOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**options** | [**ProjectProjKeyDataCataloguesFromUrlOptions**](ProjectProjKeyDataCataloguesFromUrlOptions.md) | | -**target** | [**ProjectProjKeyDataCataloguesFromMongoTarget**](ProjectProjKeyDataCataloguesFromMongoTarget.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataCatalogsApi.md b/docs/apis/public/DataCatalogsApi.md deleted file mode 100644 index 89595474..00000000 --- a/docs/apis/public/DataCatalogsApi.md +++ /dev/null @@ -1,2273 +0,0 @@ -# deepsearch.cps.apis.public.DataCatalogsApi - -All URIs are relative to *http://localhost/api/cps/public/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**clone_project_data_catalog**](DataCatalogsApi.md#clone_project_data_catalog) | **POST** /project/{proj_key}/data_catalogues/{dc_key}/actions/clone | -[**clone_public_data_catalog**](DataCatalogsApi.md#clone_public_data_catalog) | **POST** /project/public/data_catalogues/{dc_key}/actions/clone | -[**create_project_data_catalog**](DataCatalogsApi.md#create_project_data_catalog) | **POST** /project/{proj_key}/data_catalogues | -[**create_project_data_catalog_collection**](DataCatalogsApi.md#create_project_data_catalog_collection) | **POST** /project/{proj_key}/data_catalogues/{dc_key}/collections | -[**create_project_data_catalog_delete_token**](DataCatalogsApi.md#create_project_data_catalog_delete_token) | **POST** /project/{proj_key}/data_catalogues/{dc_key}/delete_token | -[**delete_project_data_catalog**](DataCatalogsApi.md#delete_project_data_catalog) | **DELETE** /project/{proj_key}/data_catalogues/{dc_key} | -[**delete_project_data_catalog_collection**](DataCatalogsApi.md#delete_project_data_catalog_collection) | **DELETE** /project/{proj_key}/data_catalogues/{dc_key}/collections/{collection_name} | -[**export_dataset**](DataCatalogsApi.md#export_dataset) | **POST** /project/{proj_key}/bags/{bag_key}/tasks/export_dataset | -[**export_project_data_catalog_collection_data**](DataCatalogsApi.md#export_project_data_catalog_collection_data) | **POST** /project/{proj_key}/data_catalogues/{dc_key}/collections/{collection_name}/actions/export | -[**export_project_data_catalog_data**](DataCatalogsApi.md#export_project_data_catalog_data) | **POST** /project/{proj_key}/data_catalogues/{dc_key}/actions/export | -[**get_data_catalog_collection_data**](DataCatalogsApi.md#get_data_catalog_collection_data) | **GET** /project/{proj_key}/data_catalogues/{dc_key}/collections/{collection_name}/data | -[**get_project_data_catalog**](DataCatalogsApi.md#get_project_data_catalog) | **GET** /project/{proj_key}/data_catalogues/{dc_key} | -[**get_public_data_catalog**](DataCatalogsApi.md#get_public_data_catalog) | **GET** /project/public/data_catalogues/{dc_key} | -[**import_project_data_catalog_collection_data**](DataCatalogsApi.md#import_project_data_catalog_collection_data) | **POST** /project/{proj_key}/data_catalogues/{dc_key}/collections/{collection_name}/actions/import | -[**import_project_data_catalog_data**](DataCatalogsApi.md#import_project_data_catalog_data) | **POST** /project/{proj_key}/data_catalogues/{dc_key}/actions/import | -[**import_project_data_catalog_from_mongo**](DataCatalogsApi.md#import_project_data_catalog_from_mongo) | **POST** /project/{proj_key}/data_catalogues/from_mongo | -[**import_project_data_catalog_from_url**](DataCatalogsApi.md#import_project_data_catalog_from_url) | **POST** /project/{proj_key}/data_catalogues/from_url | -[**infer_project_data_catalog_category_schema**](DataCatalogsApi.md#infer_project_data_catalog_category_schema) | **POST** /project/{proj_key}/data_catalogues/{dc_key}/collections/{collection_name}/actions/infer_schema | -[**list_data_catalogs_and_collections_from_schema**](DataCatalogsApi.md#list_data_catalogs_and_collections_from_schema) | **POST** /project/data_catalogues/with_schema | -[**list_known_data_catalog_schemas**](DataCatalogsApi.md#list_known_data_catalog_schemas) | **GET** /project/data_cataloges/known_schemas | -[**list_project_data_catalog_collections**](DataCatalogsApi.md#list_project_data_catalog_collections) | **GET** /project/{proj_key}/data_catalogues/{dc_key}/collections | -[**list_project_data_catalogs**](DataCatalogsApi.md#list_project_data_catalogs) | **GET** /project/{proj_key}/data_catalogues | -[**list_public_data_catalog_collections**](DataCatalogsApi.md#list_public_data_catalog_collections) | **GET** /project/public/data_catalogues/{dc_key}/collections | -[**list_public_data_catalogs**](DataCatalogsApi.md#list_public_data_catalogs) | **GET** /project/public/data_catalogues | -[**patch_project_data_catalog**](DataCatalogsApi.md#patch_project_data_catalog) | **PATCH** /project/{proj_key}/data_catalogues/{dc_key} | -[**upload_project_data_catalog_collection_data**](DataCatalogsApi.md#upload_project_data_catalog_collection_data) | **POST** /project/{proj_key}/data_catalogues/{dc_key}/collections/{collection_name}/actions/upload | -[**upload_project_data_catalog_data**](DataCatalogsApi.md#upload_project_data_catalog_data) | **POST** /project/{proj_key}/data_catalogues/{dc_key}/actions/upload | - - -# **clone_project_data_catalog** -> CloneDataCatalogResult clone_project_data_catalog(proj_key, dc_key, options) - - - -Clone an existing data catalogue - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataCatalogsApi(api_client) - proj_key = 'proj_key_example' # str | -dc_key = 'dc_key_example' # str | -options = deepsearch.cps.apis.public.CloneDataCatalogOptions() # CloneDataCatalogOptions | - - try: - api_response = api_instance.clone_project_data_catalog(proj_key, dc_key, options) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataCatalogsApi->clone_project_data_catalog: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dc_key** | **str**| | - **options** | [**CloneDataCatalogOptions**](CloneDataCatalogOptions.md)| | - -### Return type - -[**CloneDataCatalogResult**](CloneDataCatalogResult.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Data catalogue cloned, and data is being copied. | - | -**404** | Data catalogue not found | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **clone_public_data_catalog** -> CloneDataCatalogResult clone_public_data_catalog(dc_key, options) - - - -Clone an existing public data catalogue - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataCatalogsApi(api_client) - dc_key = 'dc_key_example' # str | -options = deepsearch.cps.apis.public.ClonePublicDataCatalogOptions() # ClonePublicDataCatalogOptions | - - try: - api_response = api_instance.clone_public_data_catalog(dc_key, options) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataCatalogsApi->clone_public_data_catalog: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **dc_key** | **str**| | - **options** | [**ClonePublicDataCatalogOptions**](ClonePublicDataCatalogOptions.md)| | - -### Return type - -[**CloneDataCatalogResult**](CloneDataCatalogResult.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Data catalogue cloned, and data is being copied. | - | -**404** | Data catalogue not found | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_project_data_catalog** -> DataCatalogue create_project_data_catalog(proj_key, options) - - - -Create an empty data catalog - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataCatalogsApi(api_client) - proj_key = 'proj_key_example' # str | -options = deepsearch.cps.apis.public.CreateDataCatalogOptions() # CreateDataCatalogOptions | - - try: - api_response = api_instance.create_project_data_catalog(proj_key, options) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataCatalogsApi->create_project_data_catalog: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **options** | [**CreateDataCatalogOptions**](CreateDataCatalogOptions.md)| | - -### Return type - -[**DataCatalogue**](DataCatalogue.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Data catalog created. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_project_data_catalog_collection** -> create_project_data_catalog_collection(proj_key, dc_key, body) - - - -Create a collection in a data catalog - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataCatalogsApi(api_client) - proj_key = 'proj_key_example' # str | -dc_key = 'dc_key_example' # str | -body = deepsearch.cps.apis.public.CreateDataCatalogCollectionOptions() # CreateDataCatalogCollectionOptions | - - try: - api_instance.create_project_data_catalog_collection(proj_key, dc_key, body) - except ApiException as e: - print("Exception when calling DataCatalogsApi->create_project_data_catalog_collection: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dc_key** | **str**| | - **body** | [**CreateDataCatalogCollectionOptions**](CreateDataCatalogCollectionOptions.md)| | - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Collection created. | - | -**404** | Dictionary doesn't exist. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_project_data_catalog_delete_token** -> TokenResponse create_project_data_catalog_delete_token(proj_key, dc_key) - - - -Get a token used to confirm the deletion of a data catalog. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataCatalogsApi(api_client) - proj_key = 'proj_key_example' # str | -dc_key = 'dc_key_example' # str | - - try: - api_response = api_instance.create_project_data_catalog_delete_token(proj_key, dc_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataCatalogsApi->create_project_data_catalog_delete_token: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dc_key** | **str**| | - -### Return type - -[**TokenResponse**](TokenResponse.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Data catalog deletion token. | - | -**404** | Data flow template not found. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **delete_project_data_catalog** -> delete_project_data_catalog(proj_key, dc_key, confirmation_token) - - - -Delete a single data catalog - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataCatalogsApi(api_client) - proj_key = 'proj_key_example' # str | -dc_key = 'dc_key_example' # str | -confirmation_token = 'confirmation_token_example' # str | - - try: - api_instance.delete_project_data_catalog(proj_key, dc_key, confirmation_token) - except ApiException as e: - print("Exception when calling DataCatalogsApi->delete_project_data_catalog: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dc_key** | **str**| | - **confirmation_token** | **str**| | - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | Data catalog deleted. | - | -**404** | Data catalog doesn't exist. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **delete_project_data_catalog_collection** -> delete_project_data_catalog_collection(proj_key, dc_key, collection_name) - - - -Delete a single data catalog's collection - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataCatalogsApi(api_client) - proj_key = 'proj_key_example' # str | -dc_key = 'dc_key_example' # str | -collection_name = 'collection_name_example' # str | - - try: - api_instance.delete_project_data_catalog_collection(proj_key, dc_key, collection_name) - except ApiException as e: - print("Exception when calling DataCatalogsApi->delete_project_data_catalog_collection: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dc_key** | **str**| | - **collection_name** | **str**| | - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | Collection deleted. | - | -**404** | Collection doesn't exist. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **export_dataset** -> ProjectTask export_dataset(proj_key, bag_key, data) - - - -Export dataset from a Knowledge Graph - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Configure API key authorization: KGAuth -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'X-CPS-KG-Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['X-CPS-KG-Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataCatalogsApi(api_client) - proj_key = 'proj_key_example' # str | -bag_key = 'bag_key_example' # str | -data = deepsearch.cps.apis.public.InlineObject3() # InlineObject3 | - - try: - api_response = api_instance.export_dataset(proj_key, bag_key, data) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataCatalogsApi->export_dataset: %s\n" % e) -``` - -* Api Key Authentication (KGAuth): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Configure API key authorization: KGAuth -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'X-CPS-KG-Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['X-CPS-KG-Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataCatalogsApi(api_client) - proj_key = 'proj_key_example' # str | -bag_key = 'bag_key_example' # str | -data = deepsearch.cps.apis.public.InlineObject3() # InlineObject3 | - - try: - api_response = api_instance.export_dataset(proj_key, bag_key, data) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataCatalogsApi->export_dataset: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **bag_key** | **str**| | - **data** | [**InlineObject3**](InlineObject3.md)| | - -### Return type - -[**ProjectTask**](ProjectTask.md) - -### Authorization - -[Bearer](../README.md#Bearer), [KGAuth](../README.md#KGAuth) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Task | - | -**404** | Task not found. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **export_project_data_catalog_collection_data** -> file export_project_data_catalog_collection_data(proj_key, dc_key, collection_name) - - - -Export the contents of a data catalog's collection - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataCatalogsApi(api_client) - proj_key = 'proj_key_example' # str | -dc_key = 'dc_key_example' # str | -collection_name = 'collection_name_example' # str | - - try: - api_response = api_instance.export_project_data_catalog_collection_data(proj_key, dc_key, collection_name) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataCatalogsApi->export_project_data_catalog_collection_data: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dc_key** | **str**| | - **collection_name** | **str**| | - -### Return type - -**file** - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/zip, application/json, application/x-jsonlines - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Data catalog collection contents. | - | -**404** | Data catalogue not found | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **export_project_data_catalog_data** -> file export_project_data_catalog_data(proj_key, dc_key) - - - -Export the contents of a data catalog. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataCatalogsApi(api_client) - proj_key = 'proj_key_example' # str | -dc_key = 'dc_key_example' # str | - - try: - api_response = api_instance.export_project_data_catalog_data(proj_key, dc_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataCatalogsApi->export_project_data_catalog_data: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dc_key** | **str**| | - -### Return type - -**file** - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/zip - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Data catalog contents. | - | -**404** | Data catalogue not found | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_data_catalog_collection_data** -> get_data_catalog_collection_data(proj_key, dc_key, collection_name, after=after, limit=limit) - - - -Get Data Catalog Collection data. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataCatalogsApi(api_client) - proj_key = 'proj_key_example' # str | -dc_key = 'dc_key_example' # str | -collection_name = 'collection_name_example' # str | -after = 'after_example' # str | (optional) -limit = 50 # int | (optional) (default to 50) - - try: - api_instance.get_data_catalog_collection_data(proj_key, dc_key, collection_name, after=after, limit=limit) - except ApiException as e: - print("Exception when calling DataCatalogsApi->get_data_catalog_collection_data: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dc_key** | **str**| | - **collection_name** | **str**| | - **after** | **str**| | [optional] - **limit** | **int**| | [optional] [default to 50] - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Get Data Catalog Collection data. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_project_data_catalog** -> DataCatalogue get_project_data_catalog(proj_key, dc_key, include_collections=include_collections) - - - -Get a single data catalogue - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataCatalogsApi(api_client) - proj_key = 'proj_key_example' # str | -dc_key = 'dc_key_example' # str | -include_collections = False # bool | (optional) (default to False) - - try: - api_response = api_instance.get_project_data_catalog(proj_key, dc_key, include_collections=include_collections) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataCatalogsApi->get_project_data_catalog: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dc_key** | **str**| | - **include_collections** | **bool**| | [optional] [default to False] - -### Return type - -[**DataCatalogue**](DataCatalogue.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Data catalogue | - | -**404** | Data catalogue not found | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_public_data_catalog** -> DataCatalogue get_public_data_catalog(dc_key, include_collections=include_collections) - - - -Get a single data catalogue that was made public - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataCatalogsApi(api_client) - dc_key = 'dc_key_example' # str | -include_collections = False # bool | (optional) (default to False) - - try: - api_response = api_instance.get_public_data_catalog(dc_key, include_collections=include_collections) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataCatalogsApi->get_public_data_catalog: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **dc_key** | **str**| | - **include_collections** | **bool**| | [optional] [default to False] - -### Return type - -[**DataCatalogue**](DataCatalogue.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Data catalogue | - | -**404** | Data catalogue not found or is not public | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **import_project_data_catalog_collection_data** -> Task import_project_data_catalog_collection_data(proj_key, dc_key, collection_name, body) - - - -Import data to a data catalog collection. The collection will be created if it doesn't exist. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataCatalogsApi(api_client) - proj_key = 'proj_key_example' # str | -dc_key = 'dc_key_example' # str | -collection_name = 'collection_name_example' # str | -body = deepsearch.cps.apis.public.ImportToDataCatalogCollectionOptions() # ImportToDataCatalogCollectionOptions | - - try: - api_response = api_instance.import_project_data_catalog_collection_data(proj_key, dc_key, collection_name, body) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataCatalogsApi->import_project_data_catalog_collection_data: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dc_key** | **str**| | - **collection_name** | **str**| | - **body** | [**ImportToDataCatalogCollectionOptions**](ImportToDataCatalogCollectionOptions.md)| | - -### Return type - -[**Task**](Task.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Data is being processed. | - | -**404** | Data catalogue not found | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **import_project_data_catalog_data** -> Task import_project_data_catalog_data(proj_key, dc_key, body) - - - -Import data to a data catalog. The collections will be created if they don't exist. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataCatalogsApi(api_client) - proj_key = 'proj_key_example' # str | -dc_key = 'dc_key_example' # str | -body = deepsearch.cps.apis.public.ImportToDataCatalogOptions() # ImportToDataCatalogOptions | - - try: - api_response = api_instance.import_project_data_catalog_data(proj_key, dc_key, body) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataCatalogsApi->import_project_data_catalog_data: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dc_key** | **str**| | - **body** | [**ImportToDataCatalogOptions**](ImportToDataCatalogOptions.md)| | - -### Return type - -[**Task**](Task.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Data is being processed. | - | -**404** | Data catalogue not found | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **import_project_data_catalog_from_mongo** -> DataCatalogImportResult import_project_data_catalog_from_mongo(proj_key, body) - - - -Create a data catalogue from a mongo database - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataCatalogsApi(api_client) - proj_key = 'proj_key_example' # str | -body = deepsearch.cps.apis.public.DataCatalogImportOptions() # DataCatalogImportOptions | - - try: - api_response = api_instance.import_project_data_catalog_from_mongo(proj_key, body) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataCatalogsApi->import_project_data_catalog_from_mongo: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **body** | [**DataCatalogImportOptions**](DataCatalogImportOptions.md)| | - -### Return type - -[**DataCatalogImportResult**](DataCatalogImportResult.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Data catalogue created, and data is being imported. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **import_project_data_catalog_from_url** -> DataCatalogImportResult import_project_data_catalog_from_url(proj_key, body) - - - -Create a data catalogue from a URL to a file - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataCatalogsApi(api_client) - proj_key = 'proj_key_example' # str | -body = deepsearch.cps.apis.public.DataCatalogUrlImportOptions() # DataCatalogUrlImportOptions | - - try: - api_response = api_instance.import_project_data_catalog_from_url(proj_key, body) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataCatalogsApi->import_project_data_catalog_from_url: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **body** | [**DataCatalogUrlImportOptions**](DataCatalogUrlImportOptions.md)| | - -### Return type - -[**DataCatalogImportResult**](DataCatalogImportResult.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Data catalogue created, and data is being imported. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **infer_project_data_catalog_category_schema** -> Task infer_project_data_catalog_category_schema(proj_key, dc_key, collection_name, body) - - - -Infer the schema for a data catalog's collection. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataCatalogsApi(api_client) - proj_key = 'proj_key_example' # str | -dc_key = 'dc_key_example' # str | -collection_name = 'collection_name_example' # str | -body = deepsearch.cps.apis.public.InferProjectDataCatalogCategorySchema() # InferProjectDataCatalogCategorySchema | - - try: - api_response = api_instance.infer_project_data_catalog_category_schema(proj_key, dc_key, collection_name, body) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataCatalogsApi->infer_project_data_catalog_category_schema: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dc_key** | **str**| | - **collection_name** | **str**| | - **body** | [**InferProjectDataCatalogCategorySchema**](InferProjectDataCatalogCategorySchema.md)| | - -### Return type - -[**Task**](Task.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_data_catalogs_and_collections_from_schema** -> list[DataCatalogue] list_data_catalogs_and_collections_from_schema(schema, proj_key=proj_key) - - - -List data catalogues with specific schema - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataCatalogsApi(api_client) - schema = None # dict(str, object) | -proj_key = 'proj_key_example' # str | (optional) - - try: - api_response = api_instance.list_data_catalogs_and_collections_from_schema(schema, proj_key=proj_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataCatalogsApi->list_data_catalogs_and_collections_from_schema: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **schema** | [**dict(str, object)**](object.md)| | - **proj_key** | **str**| | [optional] - -### Return type - -[**list[DataCatalogue]**](DataCatalogue.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | List of data catalogues | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_known_data_catalog_schemas** -> list[DataCatalogSchema] list_known_data_catalog_schemas() - - - -List System Known Data Catalog Schemas. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataCatalogsApi(api_client) - - try: - api_response = api_instance.list_known_data_catalog_schemas() - pprint(api_response) - except ApiException as e: - print("Exception when calling DataCatalogsApi->list_known_data_catalog_schemas: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -[**list[DataCatalogSchema]**](DataCatalogSchema.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | List of Known Data Catalog Schemas. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_project_data_catalog_collections** -> list[DataCatalogCollection] list_project_data_catalog_collections(proj_key, dc_key) - - - -Get the collections of a data catalog. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataCatalogsApi(api_client) - proj_key = 'proj_key_example' # str | -dc_key = 'dc_key_example' # str | - - try: - api_response = api_instance.list_project_data_catalog_collections(proj_key, dc_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataCatalogsApi->list_project_data_catalog_collections: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dc_key** | **str**| | - -### Return type - -[**list[DataCatalogCollection]**](DataCatalogCollection.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Data catalog collections | - | -**404** | Data catalogue not found | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_project_data_catalogs** -> list[DataCatalogue] list_project_data_catalogs(proj_key, query=query) - - - -List data catalogues for a project - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataCatalogsApi(api_client) - proj_key = 'proj_key_example' # str | -query = 'query_example' # str | (optional) - - try: - api_response = api_instance.list_project_data_catalogs(proj_key, query=query) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataCatalogsApi->list_project_data_catalogs: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **query** | **str**| | [optional] - -### Return type - -[**list[DataCatalogue]**](DataCatalogue.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | List of data catalogues | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_public_data_catalog_collections** -> list[DataCatalogCollection] list_public_data_catalog_collections(dc_key) - - - -Get the collections of a data catalog. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataCatalogsApi(api_client) - dc_key = 'dc_key_example' # str | - - try: - api_response = api_instance.list_public_data_catalog_collections(dc_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataCatalogsApi->list_public_data_catalog_collections: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **dc_key** | **str**| | - -### Return type - -[**list[DataCatalogCollection]**](DataCatalogCollection.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Data catalog collections | - | -**404** | Data catalogue not found | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_public_data_catalogs** -> list[DataCatalogue] list_public_data_catalogs(query=query) - - - -List public data catalogues - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataCatalogsApi(api_client) - query = 'query_example' # str | (optional) - - try: - api_response = api_instance.list_public_data_catalogs(query=query) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataCatalogsApi->list_public_data_catalogs: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **query** | **str**| | [optional] - -### Return type - -[**list[DataCatalogue]**](DataCatalogue.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | List of public data catalogues | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **patch_project_data_catalog** -> DataCatalogue patch_project_data_catalog(proj_key, dc_key, options) - - - -Update the metadata of a data catalog. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataCatalogsApi(api_client) - proj_key = 'proj_key_example' # str | -dc_key = 'dc_key_example' # str | -options = deepsearch.cps.apis.public.PatchDataCatalogOptions() # PatchDataCatalogOptions | - - try: - api_response = api_instance.patch_project_data_catalog(proj_key, dc_key, options) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataCatalogsApi->patch_project_data_catalog: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dc_key** | **str**| | - **options** | [**PatchDataCatalogOptions**](PatchDataCatalogOptions.md)| | - -### Return type - -[**DataCatalogue**](DataCatalogue.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Data catalog updated. | - | -**404** | Data catalog not found. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **upload_project_data_catalog_collection_data** -> Task upload_project_data_catalog_collection_data(proj_key, dc_key, collection_name, file) - - - -Upload data to a data catalog collection. The collection will be created if it doesn't exist. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataCatalogsApi(api_client) - proj_key = 'proj_key_example' # str | -dc_key = 'dc_key_example' # str | -collection_name = 'collection_name_example' # str | -file = '/path/to/file' # file | - - try: - api_response = api_instance.upload_project_data_catalog_collection_data(proj_key, dc_key, collection_name, file) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataCatalogsApi->upload_project_data_catalog_collection_data: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dc_key** | **str**| | - **collection_name** | **str**| | - **file** | **file**| | - -### Return type - -[**Task**](Task.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: multipart/form-data - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Data is being processed. | - | -**404** | Data catalogue not found | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **upload_project_data_catalog_data** -> Task upload_project_data_catalog_data(proj_key, dc_key, file) - - - -Upload data to a data catalog. The collection name(s) will be inferred from the file name(s). - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataCatalogsApi(api_client) - proj_key = 'proj_key_example' # str | -dc_key = 'dc_key_example' # str | -file = '/path/to/file' # file | - - try: - api_response = api_instance.upload_project_data_catalog_data(proj_key, dc_key, file) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataCatalogsApi->upload_project_data_catalog_data: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dc_key** | **str**| | - **file** | **file**| | - -### Return type - -[**Task**](Task.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: multipart/form-data - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Data is being processed. | - | -**404** | Data catalogue not found | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/apis/public/DataCatalogue.md b/docs/apis/public/DataCatalogue.md deleted file mode 100644 index dba37559..00000000 --- a/docs/apis/public/DataCatalogue.md +++ /dev/null @@ -1,22 +0,0 @@ -# DataCatalogue - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**category_schemas** | [**list[DataCatalogCategorySchema]**](DataCatalogCategorySchema.md) | | -**collections** | [**list[DataCatalogCollection]**](DataCatalogCollection.md) | | [optional] -**collections_data_flows** | [**list[DataCatalogDataFlow]**](DataCatalogDataFlow.md) | | -**copy_of** | **str** | | -**created_at** | **float** | | -**created_by** | **str** | | -**dc_key** | **str** | | -**description** | **str** | | -**name** | **str** | | -**proj_key** | **str** | | -**provenance_logs** | [**list[DataCatalogProvenanceLog]**](DataCatalogProvenanceLog.md) | | -**public** | **bool** | | -**topology** | [**DataCatalogTopology**](DataCatalogTopology.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataCollection.md b/docs/apis/public/DataCollection.md deleted file mode 100644 index 2bb3dc9a..00000000 --- a/docs/apis/public/DataCollection.md +++ /dev/null @@ -1,15 +0,0 @@ -# DataCollection - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**documents** | **float** | | -**health** | **str** | | -**metadata** | [**DataCollectionMetadata**](DataCollectionMetadata.md) | | -**name** | **str** | | -**source** | [**DataCollectionSource**](DataCollectionSource.md) | | [optional] -**status** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataCollectionMetadata.md b/docs/apis/public/DataCollectionMetadata.md deleted file mode 100644 index e5cd4ceb..00000000 --- a/docs/apis/public/DataCollectionMetadata.md +++ /dev/null @@ -1,17 +0,0 @@ -# DataCollectionMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**aliases** | **list[str]** | | -**created** | **str** | | -**description** | **str** | | -**domain** | **list[str]** | | -**source** | **str** | | -**storage** | **str** | | [optional] -**type** | **str** | | -**version** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataCollectionSource.md b/docs/apis/public/DataCollectionSource.md deleted file mode 100644 index 454180f6..00000000 --- a/docs/apis/public/DataCollectionSource.md +++ /dev/null @@ -1,12 +0,0 @@ -# DataCollectionSource - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**elastic_id** | **str** | | [optional] -**index_key** | **str** | | -**proj_key** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataFlow.md b/docs/apis/public/DataFlow.md deleted file mode 100644 index 854dfc29..00000000 --- a/docs/apis/public/DataFlow.md +++ /dev/null @@ -1,18 +0,0 @@ -# DataFlow - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**created_at** | **float** | | [optional] -**description** | **str** | | [optional] -**df_tpl_key** | **str** | | [optional] -**name** | **str** | | [optional] -**proj_key** | **str** | | [optional] -**public** | **bool** | | [optional] -**template** | [**object**](.md) | | [optional] -**updated_at** | **float** | | [optional] -**variables** | **dict(str, object)** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataFlowAssembleIntoKnowledgeGraphTask.md b/docs/apis/public/DataFlowAssembleIntoKnowledgeGraphTask.md deleted file mode 100644 index 76db2866..00000000 --- a/docs/apis/public/DataFlowAssembleIntoKnowledgeGraphTask.md +++ /dev/null @@ -1,11 +0,0 @@ -# DataFlowAssembleIntoKnowledgeGraphTask - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data_flow** | [**ProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlow**](ProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlow.md) | | [optional] -**timestamp** | **float** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataFlowAssembleReport.md b/docs/apis/public/DataFlowAssembleReport.md deleted file mode 100644 index 76a06d18..00000000 --- a/docs/apis/public/DataFlowAssembleReport.md +++ /dev/null @@ -1,11 +0,0 @@ -# DataFlowAssembleReport - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**dataflow_tasks** | [**dict(str, DataFlowAssembleReportSingleTask)**](DataFlowAssembleReportSingleTask.md) | | [optional] -**task_id** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataFlowAssembleReportCause.md b/docs/apis/public/DataFlowAssembleReportCause.md deleted file mode 100644 index 3ae90245..00000000 --- a/docs/apis/public/DataFlowAssembleReportCause.md +++ /dev/null @@ -1,11 +0,0 @@ -# DataFlowAssembleReportCause - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **str** | | [optional] -**value** | [**object**](.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataFlowAssembleReportChunks.md b/docs/apis/public/DataFlowAssembleReportChunks.md deleted file mode 100644 index cfd50e28..00000000 --- a/docs/apis/public/DataFlowAssembleReportChunks.md +++ /dev/null @@ -1,14 +0,0 @@ -# DataFlowAssembleReportChunks - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**completed** | **int** | | [optional] -**failure** | **int** | | [optional] -**spawned** | **int** | | [optional] -**success** | **int** | | [optional] -**total** | **int** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataFlowAssembleReportErrors.md b/docs/apis/public/DataFlowAssembleReportErrors.md deleted file mode 100644 index dd885616..00000000 --- a/docs/apis/public/DataFlowAssembleReportErrors.md +++ /dev/null @@ -1,11 +0,0 @@ -# DataFlowAssembleReportErrors - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**cause** | [**DataFlowAssembleReportCause**](DataFlowAssembleReportCause.md) | | [optional] -**timestamp** | **float** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataFlowAssembleReportOptions.md b/docs/apis/public/DataFlowAssembleReportOptions.md deleted file mode 100644 index 075f4b5b..00000000 --- a/docs/apis/public/DataFlowAssembleReportOptions.md +++ /dev/null @@ -1,11 +0,0 @@ -# DataFlowAssembleReportOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**event_log_level** | **str** | | [optional] [default to 'error'] -**max_errors** | **int** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataFlowAssembleReportSingleTask.md b/docs/apis/public/DataFlowAssembleReportSingleTask.md deleted file mode 100644 index 06e66fa6..00000000 --- a/docs/apis/public/DataFlowAssembleReportSingleTask.md +++ /dev/null @@ -1,14 +0,0 @@ -# DataFlowAssembleReportSingleTask - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**chunks** | [**DataFlowAssembleReportChunks**](DataFlowAssembleReportChunks.md) | | [optional] -**errors** | [**list[DataFlowAssembleReportErrors]**](DataFlowAssembleReportErrors.md) | | [optional] -**progress** | **float** | | [optional] -**status** | **str** | | [optional] -**task_type** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataFlowLoadIntoKnowledgeGraphTask.md b/docs/apis/public/DataFlowLoadIntoKnowledgeGraphTask.md deleted file mode 100644 index 4ff3e855..00000000 --- a/docs/apis/public/DataFlowLoadIntoKnowledgeGraphTask.md +++ /dev/null @@ -1,12 +0,0 @@ -# DataFlowLoadIntoKnowledgeGraphTask - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data_flow** | [**ProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlow**](ProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlow.md) | | [optional] -**save** | [**object**](.md) | | [optional] -**timestamp** | **float** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataFlowTemplate.md b/docs/apis/public/DataFlowTemplate.md deleted file mode 100644 index 21f7ac51..00000000 --- a/docs/apis/public/DataFlowTemplate.md +++ /dev/null @@ -1,11 +0,0 @@ -# DataFlowTemplate - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**config** | [**object**](.md) | | -**data_flow** | **list[object]** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataFlowTemplateListItem.md b/docs/apis/public/DataFlowTemplateListItem.md deleted file mode 100644 index 2311da37..00000000 --- a/docs/apis/public/DataFlowTemplateListItem.md +++ /dev/null @@ -1,16 +0,0 @@ -# DataFlowTemplateListItem - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**created_at** | **float** | | [optional] -**description** | **str** | | [optional] -**df_tpl_key** | **str** | | [optional] -**name** | **str** | | [optional] -**proj_key** | **str** | | [optional] -**public** | **bool** | | [optional] -**updated_at** | **float** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataFlowTemplateVariable.md b/docs/apis/public/DataFlowTemplateVariable.md deleted file mode 100644 index bf7c3f25..00000000 --- a/docs/apis/public/DataFlowTemplateVariable.md +++ /dev/null @@ -1,9 +0,0 @@ -# DataFlowTemplateVariable - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataFlowTopologyOptions.md b/docs/apis/public/DataFlowTopologyOptions.md deleted file mode 100644 index 4957eec7..00000000 --- a/docs/apis/public/DataFlowTopologyOptions.md +++ /dev/null @@ -1,10 +0,0 @@ -# DataFlowTopologyOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**variables** | **dict(str, object)** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataFlowsApi.md b/docs/apis/public/DataFlowsApi.md deleted file mode 100644 index 34c145ef..00000000 --- a/docs/apis/public/DataFlowsApi.md +++ /dev/null @@ -1,1718 +0,0 @@ -# deepsearch.cps.apis.public.DataFlowsApi - -All URIs are relative to *http://localhost/api/cps/public/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**assemble_project_data_flow**](DataFlowsApi.md#assemble_project_data_flow) | **POST** /project/{proj_key}/kgc/dataflows/actions/run | -[**assemble_project_data_flow_template_into_knowledge_graph**](DataFlowsApi.md#assemble_project_data_flow_template_into_knowledge_graph) | **POST** /project/{proj_key}/kgc/dataflow_templates/{df_tpl_key}/actions/run | -[**assemble_project_raw_data_flow_template_into_knowledge_graph**](DataFlowsApi.md#assemble_project_raw_data_flow_template_into_knowledge_graph) | **POST** /project/{proj_key}/kgc/raw_dataflow_templates/actions/run | -[**create_project_data_flow_template**](DataFlowsApi.md#create_project_data_flow_template) | **POST** /project/{proj_key}/kgc/dataflow_templates | -[**create_project_data_flow_template_delete_token**](DataFlowsApi.md#create_project_data_flow_template_delete_token) | **POST** /project/{proj_key}/kgc/dataflow_templates/{df_tpl_key}/delete_token | -[**create_project_knowledge_graph_assemble_report**](DataFlowsApi.md#create_project_knowledge_graph_assemble_report) | **POST** /project/{proj_key}/dataset_assembles/{task_id}/report | -[**debug_project_data_flow_template**](DataFlowsApi.md#debug_project_data_flow_template) | **POST** /project/{proj_key}/kgc_dataflow_templates/debug/{df_tpl_key} | -[**delete_project_data_flow_template**](DataFlowsApi.md#delete_project_data_flow_template) | **DELETE** /project/{proj_key}/kgc/dataflow_templates/{df_tpl_key} | -[**export_project_data_flow_template**](DataFlowsApi.md#export_project_data_flow_template) | **POST** /project/{proj_key}/kgc/dataflow_templates/{df_tpl_key}/export.json | -[**export_public_data_flow_template**](DataFlowsApi.md#export_public_data_flow_template) | **POST** /project/public/kgc/dataflow_templates/{df_tpl_key}/export.json | -[**get_project_data_flow**](DataFlowsApi.md#get_project_data_flow) | **GET** /project/{proj_key}/kgc/dataflow_templates/{df_tpl_key} | -[**get_project_data_flow_template_topology**](DataFlowsApi.md#get_project_data_flow_template_topology) | **POST** /project/{proj_key}/kgc/dataflow_templates/{df_tpl_key}/topology | -[**get_public_data_flow_template**](DataFlowsApi.md#get_public_data_flow_template) | **GET** /project/public/kgc/dataflow_templates/{df_tpl_key} | -[**list_project_data_flow_templates**](DataFlowsApi.md#list_project_data_flow_templates) | **GET** /project/{proj_key}/kgc/dataflow_templates | -[**list_public_data_flow_templates**](DataFlowsApi.md#list_public_data_flow_templates) | **GET** /project/public/kgc/dataflow_templates | -[**load_project_data_flow**](DataFlowsApi.md#load_project_data_flow) | **POST** /project/{proj_key}/kgc/dataflows/actions/load | -[**load_project_data_flow_template_into_knowledge_graph**](DataFlowsApi.md#load_project_data_flow_template_into_knowledge_graph) | **POST** /project/{proj_key}/kgc/dataflow_templates/{df_tpl_key}/actions/load | -[**render_project_data_flow_template**](DataFlowsApi.md#render_project_data_flow_template) | **POST** /project/{proj_key}/kgc/dataflow_templates/{df_tpl_key}/actions/render | -[**update_project_data_flow_template**](DataFlowsApi.md#update_project_data_flow_template) | **PUT** /project/{proj_key}/kgc/dataflow_templates/{df_tpl_key} | -[**upload_project_data_flow_template**](DataFlowsApi.md#upload_project_data_flow_template) | **POST** /project/{proj_key}/kgc/dataflow_templates/from_json | -[**validate_project_data_flow**](DataFlowsApi.md#validate_project_data_flow) | **POST** /project/{proj_key}/kgc/dataflows/actions/validate | - - -# **assemble_project_data_flow** -> Task assemble_project_data_flow(proj_key, dataflow) - - - -Run a dataflow - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataFlowsApi(api_client) - proj_key = 'proj_key_example' # str | -dataflow = deepsearch.cps.apis.public.KgcDataInput() # KgcDataInput | - - try: - api_response = api_instance.assemble_project_data_flow(proj_key, dataflow) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataFlowsApi->assemble_project_data_flow: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dataflow** | [**KgcDataInput**](KgcDataInput.md)| | - -### Return type - -[**Task**](Task.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Task started. | - | -**400** | Invalid dataflow. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **assemble_project_data_flow_template_into_knowledge_graph** -> Task assemble_project_data_flow_template_into_knowledge_graph(proj_key, df_tpl_key, options) - - - -Render a single data flow template, replacing the variable placeholders by their actual values and run it. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataFlowsApi(api_client) - proj_key = 'proj_key_example' # str | -df_tpl_key = 'df_tpl_key_example' # str | -options = deepsearch.cps.apis.public.RunDataFlowTemplateOptions() # RunDataFlowTemplateOptions | - - try: - api_response = api_instance.assemble_project_data_flow_template_into_knowledge_graph(proj_key, df_tpl_key, options) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataFlowsApi->assemble_project_data_flow_template_into_knowledge_graph: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **df_tpl_key** | **str**| | - **options** | [**RunDataFlowTemplateOptions**](RunDataFlowTemplateOptions.md)| | - -### Return type - -[**Task**](Task.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Task started. | - | -**400** | Invalid dataflow. | - | -**404** | Data flow template doesn't exist. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **assemble_project_raw_data_flow_template_into_knowledge_graph** -> Task assemble_project_raw_data_flow_template_into_knowledge_graph(proj_key, options) - - - -Render a single data flow template, replacing the variable placeholders by their actual values and run it. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataFlowsApi(api_client) - proj_key = 'proj_key_example' # str | -options = deepsearch.cps.apis.public.RunDataFlowTemplateOptions1() # RunDataFlowTemplateOptions1 | - - try: - api_response = api_instance.assemble_project_raw_data_flow_template_into_knowledge_graph(proj_key, options) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataFlowsApi->assemble_project_raw_data_flow_template_into_knowledge_graph: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **options** | [**RunDataFlowTemplateOptions1**](RunDataFlowTemplateOptions1.md)| | - -### Return type - -[**Task**](Task.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Task started. | - | -**400** | Invalid dataflow. | - | -**404** | Data flow template doesn't exist. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_project_data_flow_template** -> DataFlow create_project_data_flow_template(proj_key, options) - - - -Create a data flow template - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataFlowsApi(api_client) - proj_key = 'proj_key_example' # str | -options = deepsearch.cps.apis.public.CreateDataFlowTemplateOptions() # CreateDataFlowTemplateOptions | - - try: - api_response = api_instance.create_project_data_flow_template(proj_key, options) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataFlowsApi->create_project_data_flow_template: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **options** | [**CreateDataFlowTemplateOptions**](CreateDataFlowTemplateOptions.md)| | - -### Return type - -[**DataFlow**](DataFlow.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Dataflow created. | - | -**400** | Invalid dataflow. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_project_data_flow_template_delete_token** -> TokenResponse create_project_data_flow_template_delete_token(proj_key, df_tpl_key) - - - -Get a token used to confirm the deletion of a data flow template. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataFlowsApi(api_client) - proj_key = 'proj_key_example' # str | -df_tpl_key = 'df_tpl_key_example' # str | - - try: - api_response = api_instance.create_project_data_flow_template_delete_token(proj_key, df_tpl_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataFlowsApi->create_project_data_flow_template_delete_token: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **df_tpl_key** | **str**| | - -### Return type - -[**TokenResponse**](TokenResponse.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Data flow deletion token. | - | -**404** | Data flow template not found. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_project_knowledge_graph_assemble_report** -> DataFlowAssembleReport create_project_knowledge_graph_assemble_report(proj_key, task_id, options) - - - -Create a report for a data flow task assemble. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataFlowsApi(api_client) - proj_key = 'proj_key_example' # str | -task_id = 'task_id_example' # str | -options = deepsearch.cps.apis.public.DataFlowAssembleReportOptions() # DataFlowAssembleReportOptions | - - try: - api_response = api_instance.create_project_knowledge_graph_assemble_report(proj_key, task_id, options) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataFlowsApi->create_project_knowledge_graph_assemble_report: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **task_id** | **str**| | - **options** | [**DataFlowAssembleReportOptions**](DataFlowAssembleReportOptions.md)| | - -### Return type - -[**DataFlowAssembleReport**](DataFlowAssembleReport.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Report. | - | -**404** | Task not found, or is not a data flow assemble. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **debug_project_data_flow_template** -> object debug_project_data_flow_template(proj_key, df_tpl_key, options) - - - -(Debug) get the fully rendered data flow, with all the coordinates set. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataFlowsApi(api_client) - proj_key = 'proj_key_example' # str | -df_tpl_key = 'df_tpl_key_example' # str | -options = deepsearch.cps.apis.public.FullyRenderedDataFlow() # FullyRenderedDataFlow | - - try: - api_response = api_instance.debug_project_data_flow_template(proj_key, df_tpl_key, options) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataFlowsApi->debug_project_data_flow_template: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **df_tpl_key** | **str**| | - **options** | [**FullyRenderedDataFlow**](FullyRenderedDataFlow.md)| | - -### Return type - -**object** - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Rendered data flow. | - | -**400** | Invalid dataflow. | - | -**404** | Data flow template doesn't exist. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **delete_project_data_flow_template** -> delete_project_data_flow_template(proj_key, df_tpl_key, confirmation_token) - - - -Delete a single data flow template - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataFlowsApi(api_client) - proj_key = 'proj_key_example' # str | -df_tpl_key = 'df_tpl_key_example' # str | -confirmation_token = 'confirmation_token_example' # str | - - try: - api_instance.delete_project_data_flow_template(proj_key, df_tpl_key, confirmation_token) - except ApiException as e: - print("Exception when calling DataFlowsApi->delete_project_data_flow_template: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **df_tpl_key** | **str**| | - **confirmation_token** | **str**| | - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | Data flow deleted. | - | -**404** | Data flow template doesn't exist. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **export_project_data_flow_template** -> file export_project_data_flow_template(proj_key, df_tpl_key) - - - -Export a single data flow template - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataFlowsApi(api_client) - proj_key = 'proj_key_example' # str | -df_tpl_key = 'df_tpl_key_example' # str | - - try: - api_response = api_instance.export_project_data_flow_template(proj_key, df_tpl_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataFlowsApi->export_project_data_flow_template: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **df_tpl_key** | **str**| | - -### Return type - -**file** - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/vnd.ibm.cps.df-template+json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Data flow template. | - | -**404** | Data flow template doesn't exist. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **export_public_data_flow_template** -> file export_public_data_flow_template(df_tpl_key) - - - -Export a single public data flow template - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataFlowsApi(api_client) - df_tpl_key = 'df_tpl_key_example' # str | - - try: - api_response = api_instance.export_public_data_flow_template(df_tpl_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataFlowsApi->export_public_data_flow_template: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **df_tpl_key** | **str**| | - -### Return type - -**file** - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/vnd.ibm.cps.df-template+json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Data flow template. | - | -**404** | Data flow template doesn't exist. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_project_data_flow** -> DataFlow get_project_data_flow(proj_key, df_tpl_key) - - - -Get a single data flow template - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataFlowsApi(api_client) - proj_key = 'proj_key_example' # str | -df_tpl_key = 'df_tpl_key_example' # str | - - try: - api_response = api_instance.get_project_data_flow(proj_key, df_tpl_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataFlowsApi->get_project_data_flow: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **df_tpl_key** | **str**| | - -### Return type - -[**DataFlow**](DataFlow.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Data flow template. | - | -**404** | Data flow template doesn't exist. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_project_data_flow_template_topology** -> Topology get_project_data_flow_template_topology(proj_key, df_tpl_key, options) - - - -Render a single data flow template, replacing the variable placeholders by their actual values and get the resulting Knowledge Graph topology from it. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataFlowsApi(api_client) - proj_key = 'proj_key_example' # str | -df_tpl_key = 'df_tpl_key_example' # str | -options = deepsearch.cps.apis.public.DataFlowTopologyOptions() # DataFlowTopologyOptions | - - try: - api_response = api_instance.get_project_data_flow_template_topology(proj_key, df_tpl_key, options) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataFlowsApi->get_project_data_flow_template_topology: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **df_tpl_key** | **str**| | - **options** | [**DataFlowTopologyOptions**](DataFlowTopologyOptions.md)| | - -### Return type - -[**Topology**](Topology.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Data flow topology. | - | -**400** | Invalid dataflow. | - | -**404** | Data flow template doesn't exist. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_public_data_flow_template** -> DataFlow get_public_data_flow_template(df_tpl_key) - - - -Get a single data flow template - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataFlowsApi(api_client) - df_tpl_key = 'df_tpl_key_example' # str | - - try: - api_response = api_instance.get_public_data_flow_template(df_tpl_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataFlowsApi->get_public_data_flow_template: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **df_tpl_key** | **str**| | - -### Return type - -[**DataFlow**](DataFlow.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Data flow. | - | -**404** | Data flow template doesn't exist. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_project_data_flow_templates** -> list[DataFlowTemplateListItem] list_project_data_flow_templates(proj_key, query=query) - - - -List a data flow templates - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataFlowsApi(api_client) - proj_key = 'proj_key_example' # str | -query = 'query_example' # str | (optional) - - try: - api_response = api_instance.list_project_data_flow_templates(proj_key, query=query) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataFlowsApi->list_project_data_flow_templates: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **query** | **str**| | [optional] - -### Return type - -[**list[DataFlowTemplateListItem]**](DataFlowTemplateListItem.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | List of data flow templates. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_public_data_flow_templates** -> list[DataFlowTemplateListItem] list_public_data_flow_templates(query=query) - - - -List public data flow templates - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataFlowsApi(api_client) - query = 'query_example' # str | (optional) - - try: - api_response = api_instance.list_public_data_flow_templates(query=query) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataFlowsApi->list_public_data_flow_templates: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **query** | **str**| | [optional] - -### Return type - -[**list[DataFlowTemplateListItem]**](DataFlowTemplateListItem.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | List of data flow templates. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **load_project_data_flow** -> Task load_project_data_flow(proj_key, options) - - - -Load a dataflow into a KG - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataFlowsApi(api_client) - proj_key = 'proj_key_example' # str | -options = deepsearch.cps.apis.public.LoadKgcDataInput() # LoadKgcDataInput | - - try: - api_response = api_instance.load_project_data_flow(proj_key, options) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataFlowsApi->load_project_data_flow: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **options** | [**LoadKgcDataInput**](LoadKgcDataInput.md)| | - -### Return type - -[**Task**](Task.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Task started. | - | -**400** | Invalid dataflow. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **load_project_data_flow_template_into_knowledge_graph** -> Task load_project_data_flow_template_into_knowledge_graph(proj_key, df_tpl_key, options) - - - -Render a single data flow template, replacing the variable placeholders by their actual values and load it into a Knowledge Graph. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataFlowsApi(api_client) - proj_key = 'proj_key_example' # str | -df_tpl_key = 'df_tpl_key_example' # str | -options = deepsearch.cps.apis.public.LoadDataFlowIntoKnowledgeGraphOptions1() # LoadDataFlowIntoKnowledgeGraphOptions1 | - - try: - api_response = api_instance.load_project_data_flow_template_into_knowledge_graph(proj_key, df_tpl_key, options) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataFlowsApi->load_project_data_flow_template_into_knowledge_graph: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **df_tpl_key** | **str**| | - **options** | [**LoadDataFlowIntoKnowledgeGraphOptions1**](LoadDataFlowIntoKnowledgeGraphOptions1.md)| | - -### Return type - -[**Task**](Task.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Task started. | - | -**400** | Invalid dataflow. | - | -**404** | Data flow template doesn't exist. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **render_project_data_flow_template** -> object render_project_data_flow_template(proj_key, df_tpl_key, options) - - - -Render a single data flow template, replacing the variable placeholders by their actual values. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataFlowsApi(api_client) - proj_key = 'proj_key_example' # str | -df_tpl_key = 'df_tpl_key_example' # str | -options = deepsearch.cps.apis.public.RenderDataFlowTemplateOptions() # RenderDataFlowTemplateOptions | - - try: - api_response = api_instance.render_project_data_flow_template(proj_key, df_tpl_key, options) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataFlowsApi->render_project_data_flow_template: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **df_tpl_key** | **str**| | - **options** | [**RenderDataFlowTemplateOptions**](RenderDataFlowTemplateOptions.md)| | - -### Return type - -**object** - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Rendered data flow | - | -**400** | Invalid dataflow. | - | -**404** | Data flow template doesn't exist. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_project_data_flow_template** -> DataFlow update_project_data_flow_template(proj_key, df_tpl_key, options) - - - -Update a data flow template - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataFlowsApi(api_client) - proj_key = 'proj_key_example' # str | -df_tpl_key = 'df_tpl_key_example' # str | -options = deepsearch.cps.apis.public.UpdateDataFlowOptions() # UpdateDataFlowOptions | - - try: - api_response = api_instance.update_project_data_flow_template(proj_key, df_tpl_key, options) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataFlowsApi->update_project_data_flow_template: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **df_tpl_key** | **str**| | - **options** | [**UpdateDataFlowOptions**](UpdateDataFlowOptions.md)| | - -### Return type - -[**DataFlow**](DataFlow.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Dataflow updated. | - | -**400** | Invalid dataflow. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **upload_project_data_flow_template** -> DataFlow upload_project_data_flow_template(proj_key, contents, name=name, description=description, public=public) - - - -Create a data flow template from a JSON file. **DEPRECATED**: use `create_project_data_flow_template` - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataFlowsApi(api_client) - proj_key = 'proj_key_example' # str | -contents = '/path/to/file' # file | -name = 'name_example' # str | (optional) -description = 'description_example' # str | (optional) -public = True # bool | (optional) - - try: - api_response = api_instance.upload_project_data_flow_template(proj_key, contents, name=name, description=description, public=public) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataFlowsApi->upload_project_data_flow_template: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **contents** | **file**| | - **name** | **str**| | [optional] - **description** | **str**| | [optional] - **public** | **bool**| | [optional] - -### Return type - -[**DataFlow**](DataFlow.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: multipart/form-data - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Dataflow created. | - | -**400** | Invalid dataflow. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **validate_project_data_flow** -> validate_project_data_flow(proj_key, dataflow) - - - -Validate a dataflow - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataFlowsApi(api_client) - proj_key = 'proj_key_example' # str | -dataflow = deepsearch.cps.apis.public.KgcDataInput() # KgcDataInput | - - try: - api_instance.validate_project_data_flow(proj_key, dataflow) - except ApiException as e: - print("Exception when calling DataFlowsApi->validate_project_data_flow: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dataflow** | [**KgcDataInput**](KgcDataInput.md)| | - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Validation successful. | - | -**400** | Invalid dataflow. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/apis/public/DataIndexUploadFileSource.md b/docs/apis/public/DataIndexUploadFileSource.md deleted file mode 100644 index 88defe08..00000000 --- a/docs/apis/public/DataIndexUploadFileSource.md +++ /dev/null @@ -1,13 +0,0 @@ -# DataIndexUploadFileSource - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**conversion_settings** | [**ProjectDataIndexConversionSettings**](ProjectDataIndexConversionSettings.md) | | [optional] -**file_url** | **list[str]** | List of File's URL to be converted and uploaded to the data index | [optional] -**s3_source** | [**ProjectProjKeyDataIndicesIndexKeyActionsCcsConvertUploadS3Source**](ProjectProjKeyDataIndicesIndexKeyActionsCcsConvertUploadS3Source.md) | | [optional] -**scratch_files_id** | **list[str]** | List of CCS's scratch files id to be converted and uploaded to the data index | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataIndexUploadFileSource1.md b/docs/apis/public/DataIndexUploadFileSource1.md deleted file mode 100644 index 78c7dc00..00000000 --- a/docs/apis/public/DataIndexUploadFileSource1.md +++ /dev/null @@ -1,11 +0,0 @@ -# DataIndexUploadFileSource1 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**conversion_settings** | [**ProjectDataIndexConversionSettings**](ProjectDataIndexConversionSettings.md) | | [optional] -**urls** | **list[object]** | List of URLs to be printed to PDF, converted and uploaded to the data index | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DataIndicesApi.md b/docs/apis/public/DataIndicesApi.md deleted file mode 100644 index fe3849f6..00000000 --- a/docs/apis/public/DataIndicesApi.md +++ /dev/null @@ -1,915 +0,0 @@ -# deepsearch.cps.apis.public.DataIndicesApi - -All URIs are relative to *http://localhost/api/cps/public/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**ccs_convert_upload_file_project_data_index**](DataIndicesApi.md#ccs_convert_upload_file_project_data_index) | **POST** /project/{proj_key}/data_indices/{index_key}/actions/ccs_convert_upload | -[**create_project_data_index**](DataIndicesApi.md#create_project_data_index) | **POST** /project/{proj_key}/data_indices | -[**create_project_data_index_delete_token**](DataIndicesApi.md#create_project_data_index_delete_token) | **POST** /project/{proj_key}/data_indices/{index_key}/delete_token | -[**delete_project_data_index**](DataIndicesApi.md#delete_project_data_index) | **DELETE** /project/{proj_key}/data_indices/{index_key} | -[**get_attachment_upload_data**](DataIndicesApi.md#get_attachment_upload_data) | **GET** /project/{proj_key}/data_indices/{index_key}/documents/{index_item_id}/attachment_url/{filename} | -[**get_project_data_index**](DataIndicesApi.md#get_project_data_index) | **GET** /project/{proj_key}/data_indices/{index_key} | -[**get_project_data_indices**](DataIndicesApi.md#get_project_data_indices) | **GET** /project/{proj_key}/data_indices | -[**html_print_convert_upload**](DataIndicesApi.md#html_print_convert_upload) | **POST** /project/{proj_key}/data_indices/{index_key}/actions/html_print_convert_upload | -[**register_attachment**](DataIndicesApi.md#register_attachment) | **POST** /project/{proj_key}/data_indices/{index_key}/documents/{index_item_id}/attachment | -[**update_project_data_index**](DataIndicesApi.md#update_project_data_index) | **PATCH** /project/{proj_key}/data_indices/{index_key} | -[**upload_project_data_index_file**](DataIndicesApi.md#upload_project_data_index_file) | **POST** /project/{proj_key}/data_indices/{index_key}/actions/upload | - - -# **ccs_convert_upload_file_project_data_index** -> CpsTask ccs_convert_upload_file_project_data_index(proj_key, index_key, body) - - - -Convert files via CCS and upload to a project data index (only for indices with 'deepsearch-doc' schema) - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataIndicesApi(api_client) - proj_key = 'proj_key_example' # str | -index_key = 'index_key_example' # str | -body = deepsearch.cps.apis.public.DataIndexUploadFileSource() # DataIndexUploadFileSource | - - try: - api_response = api_instance.ccs_convert_upload_file_project_data_index(proj_key, index_key, body) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataIndicesApi->ccs_convert_upload_file_project_data_index: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **index_key** | **str**| | - **body** | [**DataIndexUploadFileSource**](DataIndexUploadFileSource.md)| | - -### Return type - -[**CpsTask**](CpsTask.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | CPS task info | - | -**404** | Project data index not found. | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_project_data_index** -> ProjectDataIndexWithStatus create_project_data_index(proj_key, data) - - - -Create a project data index - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataIndicesApi(api_client) - proj_key = 'proj_key_example' # str | -data = None # object | - - try: - api_response = api_instance.create_project_data_index(proj_key, data) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataIndicesApi->create_project_data_index: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **data** | **object**| | - -### Return type - -[**ProjectDataIndexWithStatus**](ProjectDataIndexWithStatus.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Project data index. | - | -**404** | Project data index not found. | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_project_data_index_delete_token** -> TokenResponse create_project_data_index_delete_token(proj_key, index_key) - - - -Get a token used to confirm the deletion of a project data index. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataIndicesApi(api_client) - proj_key = 'proj_key_example' # str | -index_key = 'index_key_example' # str | - - try: - api_response = api_instance.create_project_data_index_delete_token(proj_key, index_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataIndicesApi->create_project_data_index_delete_token: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **index_key** | **str**| | - -### Return type - -[**TokenResponse**](TokenResponse.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Project data index deletion token. | - | -**404** | Data flow template not found. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **delete_project_data_index** -> delete_project_data_index(proj_key, index_key, confirmation_token) - - - -Delete a project index data - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataIndicesApi(api_client) - proj_key = 'proj_key_example' # str | -index_key = 'index_key_example' # str | -confirmation_token = 'confirmation_token_example' # str | The delete confirmation token - - try: - api_instance.delete_project_data_index(proj_key, index_key, confirmation_token) - except ApiException as e: - print("Exception when calling DataIndicesApi->delete_project_data_index: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **index_key** | **str**| | - **confirmation_token** | **str**| The delete confirmation token | - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Project data index deleted successfully. | - | -**404** | Project data index not found. | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_attachment_upload_data** -> AttachmentUploadData get_attachment_upload_data(proj_key, index_key, index_item_id, filename) - - - -Get url and path to upload an attachment to a project data index - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataIndicesApi(api_client) - proj_key = 'proj_key_example' # str | -index_key = 'index_key_example' # str | -index_item_id = 'index_item_id_example' # str | -filename = 'filename_example' # str | - - try: - api_response = api_instance.get_attachment_upload_data(proj_key, index_key, index_item_id, filename) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataIndicesApi->get_attachment_upload_data: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **index_key** | **str**| | - **index_item_id** | **str**| | - **filename** | **str**| | - -### Return type - -[**AttachmentUploadData**](AttachmentUploadData.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Attachment upload url and path | - | -**404** | Project data index or document ID not found. | - | -**500** | Error occured on the server | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_project_data_index** -> ProjectDataIndexWithStatus get_project_data_index(proj_key, index_key) - - - -Get project data index - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataIndicesApi(api_client) - proj_key = 'proj_key_example' # str | -index_key = 'index_key_example' # str | - - try: - api_response = api_instance.get_project_data_index(proj_key, index_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataIndicesApi->get_project_data_index: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **index_key** | **str**| | - -### Return type - -[**ProjectDataIndexWithStatus**](ProjectDataIndexWithStatus.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Project data index. | - | -**404** | Project data index not found. | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_project_data_indices** -> list[ProjectDataIndexWithStatus] get_project_data_indices(proj_key) - - - -Get project data indices - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataIndicesApi(api_client) - proj_key = 'proj_key_example' # str | - - try: - api_response = api_instance.get_project_data_indices(proj_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataIndicesApi->get_project_data_indices: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - -### Return type - -[**list[ProjectDataIndexWithStatus]**](ProjectDataIndexWithStatus.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Project data indices. | - | -**404** | Project data index not found. | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **html_print_convert_upload** -> CpsTask html_print_convert_upload(proj_key, index_key, body) - - - -Convert a list of HTML pages to PDF, convert them via CCS and upload to a project data index (only for indices with 'deepsearch-doc' schema) - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataIndicesApi(api_client) - proj_key = 'proj_key_example' # str | -index_key = 'index_key_example' # str | -body = deepsearch.cps.apis.public.DataIndexUploadFileSource1() # DataIndexUploadFileSource1 | - - try: - api_response = api_instance.html_print_convert_upload(proj_key, index_key, body) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataIndicesApi->html_print_convert_upload: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **index_key** | **str**| | - **body** | [**DataIndexUploadFileSource1**](DataIndexUploadFileSource1.md)| | - -### Return type - -[**CpsTask**](CpsTask.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | CPS task info | - | -**404** | Project data index not found. | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **register_attachment** -> register_attachment(proj_key, index_key, index_item_id, params) - - - -Notify upload completion of an attachment to a project data index - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataIndicesApi(api_client) - proj_key = 'proj_key_example' # str | -index_key = 'index_key_example' # str | -index_item_id = 'index_item_id_example' # str | -params = deepsearch.cps.apis.public.InlineObject5() # InlineObject5 | - - try: - api_instance.register_attachment(proj_key, index_key, index_item_id, params) - except ApiException as e: - print("Exception when calling DataIndicesApi->register_attachment: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **index_key** | **str**| | - **index_item_id** | **str**| | - **params** | [**InlineObject5**](InlineObject5.md)| | - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | Attachment notify successfull | - | -**404** | Project data index or document ID not found. | - | -**500** | Error occured on the server | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_project_data_index** -> ProjectDataIndexWithStatus update_project_data_index(proj_key, index_key, data) - - - -Update a project data index - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataIndicesApi(api_client) - proj_key = 'proj_key_example' # str | -index_key = 'index_key_example' # str | -data = None # object | - - try: - api_response = api_instance.update_project_data_index(proj_key, index_key, data) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataIndicesApi->update_project_data_index: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **index_key** | **str**| | - **data** | **object**| | - -### Return type - -[**ProjectDataIndexWithStatus**](ProjectDataIndexWithStatus.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Updated project data index. | - | -**404** | Project data index not found. | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **upload_project_data_index_file** -> CpsTask upload_project_data_index_file(proj_key, index_key, params) - - - -Upload a file to a project data index - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DataIndicesApi(api_client) - proj_key = 'proj_key_example' # str | -index_key = 'index_key_example' # str | -params = deepsearch.cps.apis.public.InlineObject4() # InlineObject4 | - - try: - api_response = api_instance.upload_project_data_index_file(proj_key, index_key, params) - pprint(api_response) - except ApiException as e: - print("Exception when calling DataIndicesApi->upload_project_data_index_file: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **index_key** | **str**| | - **params** | [**InlineObject4**](InlineObject4.md)| | - -### Return type - -[**CpsTask**](CpsTask.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | CPS task info | - | -**404** | Project data index not found. | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/apis/public/DictionariesApi.md b/docs/apis/public/DictionariesApi.md deleted file mode 100644 index e8dfdc0d..00000000 --- a/docs/apis/public/DictionariesApi.md +++ /dev/null @@ -1,1730 +0,0 @@ -# deepsearch.cps.apis.public.DictionariesApi - -All URIs are relative to *http://localhost/api/cps/public/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**clone_project_dictionary**](DictionariesApi.md#clone_project_dictionary) | **POST** /project/{proj_key}/dictionaries/{dict_key}/actions/clone | -[**clone_public_dictionary**](DictionariesApi.md#clone_public_dictionary) | **POST** /project/public/dictionaries/{dict_key}/actions/clone | -[**create_project_dictionary**](DictionariesApi.md#create_project_dictionary) | **POST** /project/{proj_key}/dictionaries | -[**create_project_dictionary_collection**](DictionariesApi.md#create_project_dictionary_collection) | **POST** /project/{proj_key}/dictionaries/{dict_key}/collections | -[**create_project_dictionary_delete_token**](DictionariesApi.md#create_project_dictionary_delete_token) | **POST** /project/{proj_key}/dictionaries/{dict_key}/delete_token | -[**delete_project_dictionary**](DictionariesApi.md#delete_project_dictionary) | **DELETE** /project/{proj_key}/dictionaries/{dict_key} | -[**delete_project_dictionary_collection**](DictionariesApi.md#delete_project_dictionary_collection) | **DELETE** /project/{proj_key}/dictionaries/{dict_key}/collections/{collection_name} | -[**export_project_dictionary_collection_data**](DictionariesApi.md#export_project_dictionary_collection_data) | **POST** /project/{proj_key}/dictionaries/{dict_key}/collections/{collection_name}/actions/export | -[**export_project_dictionary_data**](DictionariesApi.md#export_project_dictionary_data) | **POST** /project/{proj_key}/dictionaries/{dict_key}/actions/export | -[**get_project_dictionary**](DictionariesApi.md#get_project_dictionary) | **GET** /project/{proj_key}/dictionaries/{dict_key} | -[**get_project_dictionary_collection_data**](DictionariesApi.md#get_project_dictionary_collection_data) | **GET** /project/{proj_key}/dictionaries/{dict_key}/collections/{collection_name}/data | -[**get_public_dictionary**](DictionariesApi.md#get_public_dictionary) | **GET** /project/public/dictionaries/{dict_key} | -[**import_project_dictionary_from_mongo**](DictionariesApi.md#import_project_dictionary_from_mongo) | **POST** /project/{proj_key}/dictionaries/from_mongo | -[**list_project_dictionaries**](DictionariesApi.md#list_project_dictionaries) | **GET** /project/{proj_key}/dictionaries | -[**list_project_dictionary_collections**](DictionariesApi.md#list_project_dictionary_collections) | **GET** /project/{proj_key}/dictionaries/{dict_key}/collections | -[**list_public_dictionaries**](DictionariesApi.md#list_public_dictionaries) | **GET** /project/public/dictionaries | -[**list_public_dictionary_collections**](DictionariesApi.md#list_public_dictionary_collections) | **GET** /project/public/dictionaries/{dict_key}/collections | -[**update_project_dictionary**](DictionariesApi.md#update_project_dictionary) | **PATCH** /project/{proj_key}/dictionaries/{dict_key} | -[**update_project_dictionary_collection_data**](DictionariesApi.md#update_project_dictionary_collection_data) | **PATCH** /project/{proj_key}/dictionaries/{dict_key}/collections/{collection_name}/data | -[**upload_project_dictionary_collection_data**](DictionariesApi.md#upload_project_dictionary_collection_data) | **POST** /project/{proj_key}/dictionaries/{dict_key}/collections/{collection_name}/actions/upload | -[**upload_project_dictionary_data**](DictionariesApi.md#upload_project_dictionary_data) | **POST** /project/{proj_key}/dictionaries/{dict_key}/actions/upload | - - -# **clone_project_dictionary** -> DictionaryCloneResult clone_project_dictionary(proj_key, dict_key, body) - - - -Clone an existing dictionary - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DictionariesApi(api_client) - proj_key = 'proj_key_example' # str | -dict_key = 'dict_key_example' # str | -body = deepsearch.cps.apis.public.CloneDictionaryOptions() # CloneDictionaryOptions | - - try: - api_response = api_instance.clone_project_dictionary(proj_key, dict_key, body) - pprint(api_response) - except ApiException as e: - print("Exception when calling DictionariesApi->clone_project_dictionary: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dict_key** | **str**| | - **body** | [**CloneDictionaryOptions**](CloneDictionaryOptions.md)| | - -### Return type - -[**DictionaryCloneResult**](DictionaryCloneResult.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Dictionary cloned, and data is being copied. | - | -**404** | Dictionary not found | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **clone_public_dictionary** -> DictionaryCloneResult clone_public_dictionary(dict_key, body) - - - -Clone an existing public dictionary - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DictionariesApi(api_client) - dict_key = 'dict_key_example' # str | -body = deepsearch.cps.apis.public.ClonePublicDictionaryOptions() # ClonePublicDictionaryOptions | - - try: - api_response = api_instance.clone_public_dictionary(dict_key, body) - pprint(api_response) - except ApiException as e: - print("Exception when calling DictionariesApi->clone_public_dictionary: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **dict_key** | **str**| | - **body** | [**ClonePublicDictionaryOptions**](ClonePublicDictionaryOptions.md)| | - -### Return type - -[**DictionaryCloneResult**](DictionaryCloneResult.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Dictionary cloned, and data is being copied. | - | -**404** | Dictionary not found | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_project_dictionary** -> Dictionary create_project_dictionary(proj_key, body) - - - -Create an empty dictionary - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DictionariesApi(api_client) - proj_key = 'proj_key_example' # str | -body = deepsearch.cps.apis.public.CreateDictionaryOptions() # CreateDictionaryOptions | - - try: - api_response = api_instance.create_project_dictionary(proj_key, body) - pprint(api_response) - except ApiException as e: - print("Exception when calling DictionariesApi->create_project_dictionary: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **body** | [**CreateDictionaryOptions**](CreateDictionaryOptions.md)| | - -### Return type - -[**Dictionary**](Dictionary.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Dictionary created. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_project_dictionary_collection** -> create_project_dictionary_collection(proj_key, dict_key, body) - - - -Create a collection in a dictionary - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DictionariesApi(api_client) - proj_key = 'proj_key_example' # str | -dict_key = 'dict_key_example' # str | -body = deepsearch.cps.apis.public.CreateCollectionInDictionaryOptions() # CreateCollectionInDictionaryOptions | - - try: - api_instance.create_project_dictionary_collection(proj_key, dict_key, body) - except ApiException as e: - print("Exception when calling DictionariesApi->create_project_dictionary_collection: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dict_key** | **str**| | - **body** | [**CreateCollectionInDictionaryOptions**](CreateCollectionInDictionaryOptions.md)| | - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Collection created. | - | -**404** | Dictionary doesn't exist. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_project_dictionary_delete_token** -> TokenResponse create_project_dictionary_delete_token(proj_key, dict_key) - - - -Get a token used to confirm the deletion of a dictionary. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DictionariesApi(api_client) - proj_key = 'proj_key_example' # str | -dict_key = 'dict_key_example' # str | - - try: - api_response = api_instance.create_project_dictionary_delete_token(proj_key, dict_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling DictionariesApi->create_project_dictionary_delete_token: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dict_key** | **str**| | - -### Return type - -[**TokenResponse**](TokenResponse.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Dictionary deletion token. | - | -**404** | Data flow template not found. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **delete_project_dictionary** -> delete_project_dictionary(proj_key, dict_key, confirmation_token) - - - -Delete a single dictionary - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DictionariesApi(api_client) - proj_key = 'proj_key_example' # str | -dict_key = 'dict_key_example' # str | -confirmation_token = 'confirmation_token_example' # str | - - try: - api_instance.delete_project_dictionary(proj_key, dict_key, confirmation_token) - except ApiException as e: - print("Exception when calling DictionariesApi->delete_project_dictionary: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dict_key** | **str**| | - **confirmation_token** | **str**| | - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | Dictionary deleted. | - | -**404** | Dictionary doesn't exist. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **delete_project_dictionary_collection** -> delete_project_dictionary_collection(proj_key, dict_key, collection_name) - - - -Delete a single dictionary's collection - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DictionariesApi(api_client) - proj_key = 'proj_key_example' # str | -dict_key = 'dict_key_example' # str | -collection_name = 'collection_name_example' # str | - - try: - api_instance.delete_project_dictionary_collection(proj_key, dict_key, collection_name) - except ApiException as e: - print("Exception when calling DictionariesApi->delete_project_dictionary_collection: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dict_key** | **str**| | - **collection_name** | **str**| | - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | Collection deleted. | - | -**404** | Collection doesn't exist. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **export_project_dictionary_collection_data** -> file export_project_dictionary_collection_data(proj_key, dict_key, collection_name, file_format=file_format) - - - -Export the contents of a dictionary's collection - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DictionariesApi(api_client) - proj_key = 'proj_key_example' # str | -dict_key = 'dict_key_example' # str | -collection_name = 'collection_name_example' # str | -file_format = 'file_format_example' # str | (optional) - - try: - api_response = api_instance.export_project_dictionary_collection_data(proj_key, dict_key, collection_name, file_format=file_format) - pprint(api_response) - except ApiException as e: - print("Exception when calling DictionariesApi->export_project_dictionary_collection_data: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dict_key** | **str**| | - **collection_name** | **str**| | - **file_format** | **str**| | [optional] - -### Return type - -**file** - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/zip, application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Dictionary collection contents. | - | -**404** | Dictionary not found | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **export_project_dictionary_data** -> file export_project_dictionary_data(proj_key, dict_key) - - - -Export the contents of a dictionary. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DictionariesApi(api_client) - proj_key = 'proj_key_example' # str | -dict_key = 'dict_key_example' # str | - - try: - api_response = api_instance.export_project_dictionary_data(proj_key, dict_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling DictionariesApi->export_project_dictionary_data: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dict_key** | **str**| | - -### Return type - -**file** - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/zip - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Dictionary contents. | - | -**404** | Dictionary not found | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_project_dictionary** -> Dictionary get_project_dictionary(proj_key, dict_key, include_collections=include_collections) - - - -Get a single dictionary - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DictionariesApi(api_client) - proj_key = 'proj_key_example' # str | -dict_key = 'dict_key_example' # str | -include_collections = False # bool | (optional) (default to False) - - try: - api_response = api_instance.get_project_dictionary(proj_key, dict_key, include_collections=include_collections) - pprint(api_response) - except ApiException as e: - print("Exception when calling DictionariesApi->get_project_dictionary: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dict_key** | **str**| | - **include_collections** | **bool**| | [optional] [default to False] - -### Return type - -[**Dictionary**](Dictionary.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Dictionary | - | -**404** | Dictionary not found | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_project_dictionary_collection_data** -> object get_project_dictionary_collection_data(proj_key, dict_key, collection_name, after=after, limit=limit, response_format=response_format) - - - -Get a preview of the data in a dictionary - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DictionariesApi(api_client) - proj_key = 'proj_key_example' # str | -dict_key = 'dict_key_example' # str | -collection_name = 'collection_name_example' # str | -after = 'after_example' # str | (optional) -limit = 1000 # int | (optional) (default to 1000) -response_format = 'object' # str | (optional) (default to 'object') - - try: - api_response = api_instance.get_project_dictionary_collection_data(proj_key, dict_key, collection_name, after=after, limit=limit, response_format=response_format) - pprint(api_response) - except ApiException as e: - print("Exception when calling DictionariesApi->get_project_dictionary_collection_data: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dict_key** | **str**| | - **collection_name** | **str**| | - **after** | **str**| | [optional] - **limit** | **int**| | [optional] [default to 1000] - **response_format** | **str**| | [optional] [default to 'object'] - -### Return type - -**object** - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Dictionary collection contents. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_public_dictionary** -> Dictionary get_public_dictionary(dict_key, include_collections=include_collections) - - - -Get a single dictionary that was made public - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DictionariesApi(api_client) - dict_key = 'dict_key_example' # str | -include_collections = False # bool | (optional) (default to False) - - try: - api_response = api_instance.get_public_dictionary(dict_key, include_collections=include_collections) - pprint(api_response) - except ApiException as e: - print("Exception when calling DictionariesApi->get_public_dictionary: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **dict_key** | **str**| | - **include_collections** | **bool**| | [optional] [default to False] - -### Return type - -[**Dictionary**](Dictionary.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Dictionary | - | -**404** | Dictionary not found or is not public | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **import_project_dictionary_from_mongo** -> DictionaryImportResult import_project_dictionary_from_mongo(proj_key, body) - - - -Create a dictionary from a mongo database - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DictionariesApi(api_client) - proj_key = 'proj_key_example' # str | -body = deepsearch.cps.apis.public.DictionaryImportOptions() # DictionaryImportOptions | - - try: - api_response = api_instance.import_project_dictionary_from_mongo(proj_key, body) - pprint(api_response) - except ApiException as e: - print("Exception when calling DictionariesApi->import_project_dictionary_from_mongo: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **body** | [**DictionaryImportOptions**](DictionaryImportOptions.md)| | - -### Return type - -[**DictionaryImportResult**](DictionaryImportResult.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Dictionary created, and data is being imported. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_project_dictionaries** -> list[Dictionary] list_project_dictionaries(proj_key, query=query) - - - -List dictionaries for a project - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DictionariesApi(api_client) - proj_key = 'proj_key_example' # str | -query = 'query_example' # str | (optional) - - try: - api_response = api_instance.list_project_dictionaries(proj_key, query=query) - pprint(api_response) - except ApiException as e: - print("Exception when calling DictionariesApi->list_project_dictionaries: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **query** | **str**| | [optional] - -### Return type - -[**list[Dictionary]**](Dictionary.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | List of dictionaries | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_project_dictionary_collections** -> list[DictionaryCollection] list_project_dictionary_collections(proj_key, dict_key) - - - -Get the collections of a dictionary. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DictionariesApi(api_client) - proj_key = 'proj_key_example' # str | -dict_key = 'dict_key_example' # str | - - try: - api_response = api_instance.list_project_dictionary_collections(proj_key, dict_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling DictionariesApi->list_project_dictionary_collections: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dict_key** | **str**| | - -### Return type - -[**list[DictionaryCollection]**](DictionaryCollection.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Dictionary collections | - | -**404** | Dictionary not found | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_public_dictionaries** -> list[Dictionary] list_public_dictionaries(query=query) - - - -List public dictionaries - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DictionariesApi(api_client) - query = 'query_example' # str | (optional) - - try: - api_response = api_instance.list_public_dictionaries(query=query) - pprint(api_response) - except ApiException as e: - print("Exception when calling DictionariesApi->list_public_dictionaries: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **query** | **str**| | [optional] - -### Return type - -[**list[Dictionary]**](Dictionary.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | List of public dictionaries | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_public_dictionary_collections** -> list[DictionaryCollection] list_public_dictionary_collections(dict_key) - - - -Get the collections of a dictionary. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DictionariesApi(api_client) - dict_key = 'dict_key_example' # str | - - try: - api_response = api_instance.list_public_dictionary_collections(dict_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling DictionariesApi->list_public_dictionary_collections: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **dict_key** | **str**| | - -### Return type - -[**list[DictionaryCollection]**](DictionaryCollection.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Dictionary collections | - | -**404** | Dictionary not found | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_project_dictionary** -> Dictionary update_project_dictionary(proj_key, dict_key, options) - - - -Update the metadata of a dictionary - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DictionariesApi(api_client) - proj_key = 'proj_key_example' # str | -dict_key = 'dict_key_example' # str | -options = deepsearch.cps.apis.public.PatchDictionaryOptions() # PatchDictionaryOptions | - - try: - api_response = api_instance.update_project_dictionary(proj_key, dict_key, options) - pprint(api_response) - except ApiException as e: - print("Exception when calling DictionariesApi->update_project_dictionary: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dict_key** | **str**| | - **options** | [**PatchDictionaryOptions**](PatchDictionaryOptions.md)| | - -### Return type - -[**Dictionary**](Dictionary.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Dictionary updated. | - | -**404** | Dictionary not found | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_project_dictionary_collection_data** -> update_project_dictionary_collection_data(proj_key, dict_key, collection_name, body) - - - -Update the data in a dictionary's collection - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DictionariesApi(api_client) - proj_key = 'proj_key_example' # str | -dict_key = 'dict_key_example' # str | -collection_name = 'collection_name_example' # str | -body = [deepsearch.cps.apis.public.DictionaryCollectionPatch()] # list[DictionaryCollectionPatch] | A subset of JSON Patch operation list. Only `add`, `replace`, and `remove` is supported. See http://jsonpatch.com/ for more details. - - try: - api_instance.update_project_dictionary_collection_data(proj_key, dict_key, collection_name, body) - except ApiException as e: - print("Exception when calling DictionariesApi->update_project_dictionary_collection_data: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dict_key** | **str**| | - **collection_name** | **str**| | - **body** | [**list[DictionaryCollectionPatch]**](DictionaryCollectionPatch.md)| A subset of JSON Patch operation list. Only `add`, `replace`, and `remove` is supported. See http://jsonpatch.com/ for more details. | - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | Data updated. | - | -**404** | Dictionary not found | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **upload_project_dictionary_collection_data** -> Task upload_project_dictionary_collection_data(proj_key, dict_key, collection_name, file) - - - -Upload data to a dictionary collection. The collection will be created if it doesn't exist. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DictionariesApi(api_client) - proj_key = 'proj_key_example' # str | -dict_key = 'dict_key_example' # str | -collection_name = 'collection_name_example' # str | -file = '/path/to/file' # file | - - try: - api_response = api_instance.upload_project_dictionary_collection_data(proj_key, dict_key, collection_name, file) - pprint(api_response) - except ApiException as e: - print("Exception when calling DictionariesApi->upload_project_dictionary_collection_data: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dict_key** | **str**| | - **collection_name** | **str**| | - **file** | **file**| | - -### Return type - -[**Task**](Task.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: multipart/form-data - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Data is being processed. | - | -**404** | Dictionary not found | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **upload_project_dictionary_data** -> Task upload_project_dictionary_data(proj_key, dict_key, file) - - - -Upload data to a dictionary. The collection name(s) will be inferred from the file name(s). - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DictionariesApi(api_client) - proj_key = 'proj_key_example' # str | -dict_key = 'dict_key_example' # str | -file = '/path/to/file' # file | - - try: - api_response = api_instance.upload_project_dictionary_data(proj_key, dict_key, file) - pprint(api_response) - except ApiException as e: - print("Exception when calling DictionariesApi->upload_project_dictionary_data: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **dict_key** | **str**| | - **file** | **file**| | - -### Return type - -[**Task**](Task.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: multipart/form-data - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Data is being processed. | - | -**404** | Dictionary not found | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/apis/public/Dictionary.md b/docs/apis/public/Dictionary.md deleted file mode 100644 index a362521c..00000000 --- a/docs/apis/public/Dictionary.md +++ /dev/null @@ -1,18 +0,0 @@ -# Dictionary - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**collections** | [**list[DictionaryCollection]**](DictionaryCollection.md) | | [optional] -**copy_of** | **str** | | -**created_at** | **float** | | -**created_by** | **str** | | -**description** | **str** | | -**dict_key** | **str** | | -**name** | **str** | | -**proj_key** | **str** | | -**public** | **bool** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DictionaryCloneResult.md b/docs/apis/public/DictionaryCloneResult.md deleted file mode 100644 index ff328186..00000000 --- a/docs/apis/public/DictionaryCloneResult.md +++ /dev/null @@ -1,11 +0,0 @@ -# DictionaryCloneResult - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**clone_task** | [**Task**](Task.md) | | [optional] -**dictionary** | [**Dictionary**](Dictionary.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DictionaryCollection.md b/docs/apis/public/DictionaryCollection.md deleted file mode 100644 index 89a9e51d..00000000 --- a/docs/apis/public/DictionaryCollection.md +++ /dev/null @@ -1,11 +0,0 @@ -# DictionaryCollection - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**item_count** | **int** | | -**name** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DictionaryCollectionCsvData.md b/docs/apis/public/DictionaryCollectionCsvData.md deleted file mode 100644 index 680620ec..00000000 --- a/docs/apis/public/DictionaryCollectionCsvData.md +++ /dev/null @@ -1,11 +0,0 @@ -# DictionaryCollectionCsvData - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**body** | **str** | | -**header** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DictionaryCollectionPatch.md b/docs/apis/public/DictionaryCollectionPatch.md deleted file mode 100644 index 335109fd..00000000 --- a/docs/apis/public/DictionaryCollectionPatch.md +++ /dev/null @@ -1,12 +0,0 @@ -# DictionaryCollectionPatch - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**op** | **str** | | -**path** | **str** | A path (see JSON patch specification) in the format `/{objectid}` for existing objects, or `/-` for new objects (`add` operations). | -**value** | [**DictionaryEntry**](DictionaryEntry.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DictionaryEntry.md b/docs/apis/public/DictionaryEntry.md deleted file mode 100644 index 00ef66be..00000000 --- a/docs/apis/public/DictionaryEntry.md +++ /dev/null @@ -1,11 +0,0 @@ -# DictionaryEntry - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | | -**synonyms** | **list[str]** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DictionaryImportOptions.md b/docs/apis/public/DictionaryImportOptions.md deleted file mode 100644 index 0b939cab..00000000 --- a/docs/apis/public/DictionaryImportOptions.md +++ /dev/null @@ -1,11 +0,0 @@ -# DictionaryImportOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**options** | [**ProjectProjKeyDataCataloguesFromMongoOptions**](ProjectProjKeyDataCataloguesFromMongoOptions.md) | | -**target** | [**ProjectProjKeyDictionariesFromMongoTarget**](ProjectProjKeyDictionariesFromMongoTarget.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DictionaryImportResult.md b/docs/apis/public/DictionaryImportResult.md deleted file mode 100644 index 1a6581eb..00000000 --- a/docs/apis/public/DictionaryImportResult.md +++ /dev/null @@ -1,11 +0,0 @@ -# DictionaryImportResult - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**dictionary** | [**Dictionary**](Dictionary.md) | | [optional] -**import_task** | [**Task**](Task.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/DocumentInspectionApi.md b/docs/apis/public/DocumentInspectionApi.md deleted file mode 100644 index a3de2385..00000000 --- a/docs/apis/public/DocumentInspectionApi.md +++ /dev/null @@ -1,497 +0,0 @@ -# deepsearch.cps.apis.public.DocumentInspectionApi - -All URIs are relative to *http://localhost/api/cps/public/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**annotate_document**](DocumentInspectionApi.md#annotate_document) | **POST** /project/{proj_key}/annotate/document | -[**delete_document_annotation_result**](DocumentInspectionApi.md#delete_document_annotation_result) | **DELETE** /project/{proj_key}/annotate/document/results/{document_hash} | -[**get_annotate_document_result**](DocumentInspectionApi.md#get_annotate_document_result) | **GET** /project/{proj_key}/annotate/document/tasks/{task_id} | -[**ingest_documentqa**](DocumentInspectionApi.md#ingest_documentqa) | **POST** /project/{proj_key}/ingest/documentqa | -[**list_project_inspection_report**](DocumentInspectionApi.md#list_project_inspection_report) | **GET** /project/{proj_key}/annotate/inspection_report | -[**report_inspected_document**](DocumentInspectionApi.md#report_inspected_document) | **POST** /project/{proj_key}/annotate/document/report | - - -# **annotate_document** -> Task annotate_document(proj_key, body) - - - -Run an annotator on a document - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DocumentInspectionApi(api_client) - proj_key = 'proj_key_example' # str | -body = deepsearch.cps.apis.public.AnnotateDocumentRequest() # AnnotateDocumentRequest | - - try: - api_response = api_instance.annotate_document(proj_key, body) - pprint(api_response) - except ApiException as e: - print("Exception when calling DocumentInspectionApi->annotate_document: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **body** | [**AnnotateDocumentRequest**](AnnotateDocumentRequest.md)| | - -### Return type - -[**Task**](Task.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **delete_document_annotation_result** -> delete_document_annotation_result(proj_key, document_hash) - - - -Delete annotation results for a document - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DocumentInspectionApi(api_client) - proj_key = 'proj_key_example' # str | -document_hash = 'document_hash_example' # str | - - try: - api_instance.delete_document_annotation_result(proj_key, document_hash) - except ApiException as e: - print("Exception when calling DocumentInspectionApi->delete_document_annotation_result: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **document_hash** | **str**| | - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_annotate_document_result** -> InlineResponse2002 get_annotate_document_result(proj_key, task_id, wait=wait) - - - -Get the result of a previous document annotation - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DocumentInspectionApi(api_client) - proj_key = 'proj_key_example' # str | -task_id = 'task_id_example' # str | -wait = 3.4 # float | Allow the response to be delayed for a few seconds to wait for the result, instead of doing client-side polling. (optional) - - try: - api_response = api_instance.get_annotate_document_result(proj_key, task_id, wait=wait) - pprint(api_response) - except ApiException as e: - print("Exception when calling DocumentInspectionApi->get_annotate_document_result: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **task_id** | **str**| | - **wait** | **float**| Allow the response to be delayed for a few seconds to wait for the result, instead of doing client-side polling. | [optional] - -### Return type - -[**InlineResponse2002**](InlineResponse2002.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **ingest_documentqa** -> Task ingest_documentqa(proj_key, body) - - - -Ingest a document for QA - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DocumentInspectionApi(api_client) - proj_key = 'proj_key_example' # str | -body = deepsearch.cps.apis.public.IngestDocumentQARequest() # IngestDocumentQARequest | - - try: - api_response = api_instance.ingest_documentqa(proj_key, body) - pprint(api_response) - except ApiException as e: - print("Exception when calling DocumentInspectionApi->ingest_documentqa: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **body** | [**IngestDocumentQARequest**](IngestDocumentQARequest.md)| | - -### Return type - -[**Task**](Task.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_project_inspection_report** -> list[InspectionReport] list_project_inspection_report(proj_key, page=page, items_per_page=items_per_page, search_string=search_string, begin_date=begin_date, end_date=end_date) - - - -Get paginated list of inspection reports for a project - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DocumentInspectionApi(api_client) - proj_key = 'proj_key_example' # str | -page = 56 # int | page of the result list (optional) -items_per_page = 20 # int | items on one page of the result list (optional) (default to 20) -search_string = 'search_string_example' # str | search keyword (optional) -begin_date = 56 # int | begin date of the search date interval (optional) -end_date = 56 # int | end date of the search date interval (optional) - - try: - api_response = api_instance.list_project_inspection_report(proj_key, page=page, items_per_page=items_per_page, search_string=search_string, begin_date=begin_date, end_date=end_date) - pprint(api_response) - except ApiException as e: - print("Exception when calling DocumentInspectionApi->list_project_inspection_report: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **page** | **int**| page of the result list | [optional] - **items_per_page** | **int**| items on one page of the result list | [optional] [default to 20] - **search_string** | **str**| search keyword | [optional] - **begin_date** | **int**| begin date of the search date interval | [optional] - **end_date** | **int**| end date of the search date interval | [optional] - -### Return type - -[**list[InspectionReport]**](InspectionReport.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Reports | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **report_inspected_document** -> Task report_inspected_document(proj_key, body) - - - -Submit a report on an inspected document - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DocumentInspectionApi(api_client) - proj_key = 'proj_key_example' # str | -body = deepsearch.cps.apis.public.AnnotatedDocumentReport() # AnnotatedDocumentReport | - - try: - api_response = api_instance.report_inspected_document(proj_key, body) - pprint(api_response) - except ApiException as e: - print("Exception when calling DocumentInspectionApi->report_inspected_document: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **body** | [**AnnotatedDocumentReport**](AnnotatedDocumentReport.md)| | - -### Return type - -[**Task**](Task.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/apis/public/ElasticApi.md b/docs/apis/public/ElasticApi.md deleted file mode 100644 index 39b9d592..00000000 --- a/docs/apis/public/ElasticApi.md +++ /dev/null @@ -1,401 +0,0 @@ -# deepsearch.cps.apis.public.ElasticApi - -All URIs are relative to *http://localhost/api/cps/public/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**get_elastic_domains**](ElasticApi.md#get_elastic_domains) | **GET** /elastic/domains | -[**get_elastic_query_max_size**](ElasticApi.md#get_elastic_query_max_size) | **GET** /elastic/query_max_size | -[**get_index_properties**](ElasticApi.md#get_index_properties) | **GET** /elastic/{elastic_instance}/{elastic_index}/properties | -[**get_kibana_saved_queries**](ElasticApi.md#get_kibana_saved_queries) | **GET** /elastic/{elastic_instance}/{elastic_index}/saved_queries | -[**list_indices_from_elastic_instance**](ElasticApi.md#list_indices_from_elastic_instance) | **GET** /elastic/indices/{index_type}/{index_domain} | - - -# **get_elastic_domains** -> list[str] get_elastic_domains() - - - -List system elastic domains. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.ElasticApi(api_client) - - try: - api_response = api_instance.get_elastic_domains() - pprint(api_response) - except ApiException as e: - print("Exception when calling ElasticApi->get_elastic_domains: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -**list[str]** - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | List of Elastic Domains. | - | -**404** | Domains not found. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_elastic_query_max_size** -> InlineResponse200 get_elastic_query_max_size() - - - -Get the system maximum workable elastic query size. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.ElasticApi(api_client) - - try: - api_response = api_instance.get_elastic_query_max_size() - pprint(api_response) - except ApiException as e: - print("Exception when calling ElasticApi->get_elastic_query_max_size: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -[**InlineResponse200**](InlineResponse200.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Maximum elastic query size. | - | -**404** | No maximum workable elastic query size found. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_index_properties** -> object get_index_properties(elastic_instance, elastic_index) - - - -Get the property schema of the given index. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.ElasticApi(api_client) - elastic_instance = 'elastic_instance_example' # str | -elastic_index = 'elastic_index_example' # str | - - try: - api_response = api_instance.get_index_properties(elastic_instance, elastic_index) - pprint(api_response) - except ApiException as e: - print("Exception when calling ElasticApi->get_index_properties: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **elastic_instance** | **str**| | - **elastic_index** | **str**| | - -### Return type - -**object** - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Property schema | - | -**404** | Instance index not found. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_kibana_saved_queries** -> list[KibanaSavedQueriesResult] get_kibana_saved_queries(elastic_instance, elastic_index) - - - -List Kibana saved queries. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.ElasticApi(api_client) - elastic_instance = 'elastic_instance_example' # str | -elastic_index = 'elastic_index_example' # str | - - try: - api_response = api_instance.get_kibana_saved_queries(elastic_instance, elastic_index) - pprint(api_response) - except ApiException as e: - print("Exception when calling ElasticApi->get_kibana_saved_queries: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **elastic_instance** | **str**| | - **elastic_index** | **str**| | - -### Return type - -[**list[KibanaSavedQueriesResult]**](KibanaSavedQueriesResult.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | List of Kibana saved queries | - | -**404** | Instance indices not found. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_indices_from_elastic_instance** -> list[DataCollection] list_indices_from_elastic_instance(index_type, index_domain) - - - -List of indices for elastic instance. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.ElasticApi(api_client) - index_type = 'all' # str | (default to 'all') -index_domain = 'all' # str | (default to 'all') - - try: - api_response = api_instance.list_indices_from_elastic_instance(index_type, index_domain) - pprint(api_response) - except ApiException as e: - print("Exception when calling ElasticApi->list_indices_from_elastic_instance: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **index_type** | **str**| | [default to 'all'] - **index_domain** | **str**| | [default to 'all'] - -### Return type - -[**list[DataCollection]**](DataCollection.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | List of Elastic Instance Indices | - | -**404** | Instance indices not found. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/apis/public/ElasticCoordinates.md b/docs/apis/public/ElasticCoordinates.md deleted file mode 100644 index b82a22bf..00000000 --- a/docs/apis/public/ElasticCoordinates.md +++ /dev/null @@ -1,12 +0,0 @@ -# ElasticCoordinates - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ca_certificate_base64** | **str** | | [optional] -**dangerously_disable_ssl_validation** | **bool** | | [optional] -**hosts** | **list[str]** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ElasticIndexSearchQueryOptions.md b/docs/apis/public/ElasticIndexSearchQueryOptions.md deleted file mode 100644 index afecc59b..00000000 --- a/docs/apis/public/ElasticIndexSearchQueryOptions.md +++ /dev/null @@ -1,15 +0,0 @@ -# ElasticIndexSearchQueryOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**source** | **list[str]** | | [optional] -**aggs** | [**object**](.md) | | [optional] -**_from** | **float** | | [optional] -**query** | **dict(str, object)** | | [optional] -**size** | **float** | | [optional] -**sort** | **list[object]** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/EntityAnnotation.md b/docs/apis/public/EntityAnnotation.md deleted file mode 100644 index 342d1cb3..00000000 --- a/docs/apis/public/EntityAnnotation.md +++ /dev/null @@ -1,13 +0,0 @@ -# EntityAnnotation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**match** | **str** | | -**range** | **list[int]** | 2-Tuple representing the low and high indexes of the matching substring | -**subtype** | **str** | | [optional] -**type** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/EntityAnnotationDescriptor.md b/docs/apis/public/EntityAnnotationDescriptor.md deleted file mode 100644 index ebfd5117..00000000 --- a/docs/apis/public/EntityAnnotationDescriptor.md +++ /dev/null @@ -1,12 +0,0 @@ -# EntityAnnotationDescriptor - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data_fields** | **list[str]** | | [optional] -**description** | **str** | | -**key** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ErrorResponse.md b/docs/apis/public/ErrorResponse.md deleted file mode 100644 index b7236e04..00000000 --- a/docs/apis/public/ErrorResponse.md +++ /dev/null @@ -1,11 +0,0 @@ -# ErrorResponse - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**error_code** | **str** | | [optional] -**error_message** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/FlavoursQuota.md b/docs/apis/public/FlavoursQuota.md deleted file mode 100644 index ebd7dc1a..00000000 --- a/docs/apis/public/FlavoursQuota.md +++ /dev/null @@ -1,12 +0,0 @@ -# FlavoursQuota - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**display_name** | **str** | | -**name** | **str** | | -**quota** | **int** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/FullyRenderedDataFlow.md b/docs/apis/public/FullyRenderedDataFlow.md deleted file mode 100644 index ebdf17e8..00000000 --- a/docs/apis/public/FullyRenderedDataFlow.md +++ /dev/null @@ -1,11 +0,0 @@ -# FullyRenderedDataFlow - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**target_bag** | [**ProjectProjKeyKgcDataflowTemplatesDebugDfTplKeyTargetBag**](ProjectProjKeyKgcDataflowTemplatesDebugDfTplKeyTargetBag.md) | | [optional] -**variables** | **dict(str, object)** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ImageCells.md b/docs/apis/public/ImageCells.md deleted file mode 100644 index dad3b265..00000000 --- a/docs/apis/public/ImageCells.md +++ /dev/null @@ -1,10 +0,0 @@ -# ImageCells - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | **list[object]** | A 6-tuple consisting of x1, y1, x2, y2, font, coordinates | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ImageInfo.md b/docs/apis/public/ImageInfo.md deleted file mode 100644 index 46812a42..00000000 --- a/docs/apis/public/ImageInfo.md +++ /dev/null @@ -1,11 +0,0 @@ -# ImageInfo - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**height** | **float** | | -**width** | **float** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ImageMetadata.md b/docs/apis/public/ImageMetadata.md deleted file mode 100644 index 95236b47..00000000 --- a/docs/apis/public/ImageMetadata.md +++ /dev/null @@ -1,11 +0,0 @@ -# ImageMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**cells** | [**ImageCells**](ImageCells.md) | | -**info** | [**ImageInfo**](ImageInfo.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ImageSource.md b/docs/apis/public/ImageSource.md deleted file mode 100644 index a74545db..00000000 --- a/docs/apis/public/ImageSource.md +++ /dev/null @@ -1,12 +0,0 @@ -# ImageSource - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**proj_key** | **str** | | [optional] -**scratch_id** | **str** | | [optional] -**url** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ImportFromElasticToDataCatalogOptions.md b/docs/apis/public/ImportFromElasticToDataCatalogOptions.md deleted file mode 100644 index e86111ad..00000000 --- a/docs/apis/public/ImportFromElasticToDataCatalogOptions.md +++ /dev/null @@ -1,12 +0,0 @@ -# ImportFromElasticToDataCatalogOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**coordinates** | [**ElasticCoordinates**](ElasticCoordinates.md) | | [optional] -**elastic_id** | **str** | | [optional] -**parameters** | [**ImportFromElasticToDataCatalogOptionsParameters**](ImportFromElasticToDataCatalogOptionsParameters.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ImportFromElasticToDataCatalogOptionsParameters.md b/docs/apis/public/ImportFromElasticToDataCatalogOptionsParameters.md deleted file mode 100644 index eb9acc9d..00000000 --- a/docs/apis/public/ImportFromElasticToDataCatalogOptionsParameters.md +++ /dev/null @@ -1,14 +0,0 @@ -# ImportFromElasticToDataCatalogOptionsParameters - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**import_s3_data** | **bool** | | [optional] -**index** | **str** | | -**page_size** | **float** | | [optional] -**query_options** | [**ImportFromElasticToDataCatalogOptionsParametersQueryOptions**](ImportFromElasticToDataCatalogOptionsParametersQueryOptions.md) | | -**s3** | [**ImportFromElasticToDataCatalogS3Coords**](ImportFromElasticToDataCatalogS3Coords.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ImportFromElasticToDataCatalogOptionsParametersQueryOptions.md b/docs/apis/public/ImportFromElasticToDataCatalogOptionsParametersQueryOptions.md deleted file mode 100644 index 00a96386..00000000 --- a/docs/apis/public/ImportFromElasticToDataCatalogOptionsParametersQueryOptions.md +++ /dev/null @@ -1,12 +0,0 @@ -# ImportFromElasticToDataCatalogOptionsParametersQueryOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**source** | **list[str]** | | [optional] -**query** | **dict(str, object)** | | [optional] -**size** | **float** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ImportFromElasticToDataCatalogS3Coords.md b/docs/apis/public/ImportFromElasticToDataCatalogS3Coords.md deleted file mode 100644 index 38787a3a..00000000 --- a/docs/apis/public/ImportFromElasticToDataCatalogS3Coords.md +++ /dev/null @@ -1,18 +0,0 @@ -# ImportFromElasticToDataCatalogS3Coords - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**access_key** | **str** | | -**bucket** | **str** | | -**host** | **str** | | -**key_prefix** | **str** | | -**location** | **str** | | -**port** | **int** | | -**secret_key** | **str** | | -**ssl** | **bool** | | -**verify_ssl** | **bool** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ImportToDataCatalogCollectionOptions.md b/docs/apis/public/ImportToDataCatalogCollectionOptions.md deleted file mode 100644 index 10477851..00000000 --- a/docs/apis/public/ImportToDataCatalogCollectionOptions.md +++ /dev/null @@ -1,12 +0,0 @@ -# ImportToDataCatalogCollectionOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ccs** | [**ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcs**](ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcs.md) | | [optional] -**elastic** | [**ImportFromElasticToDataCatalogOptions**](ImportFromElasticToDataCatalogOptions.md) | | [optional] -**url** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ImportToDataCatalogOptions.md b/docs/apis/public/ImportToDataCatalogOptions.md deleted file mode 100644 index 8e4ac0e6..00000000 --- a/docs/apis/public/ImportToDataCatalogOptions.md +++ /dev/null @@ -1,11 +0,0 @@ -# ImportToDataCatalogOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**coordinates** | [**MongoS3CoordinatesWithCollectionList**](MongoS3CoordinatesWithCollectionList.md) | | [optional] -**url** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/InferProjectDataCatalogCategorySchema.md b/docs/apis/public/InferProjectDataCatalogCategorySchema.md deleted file mode 100644 index 83c8bc7b..00000000 --- a/docs/apis/public/InferProjectDataCatalogCategorySchema.md +++ /dev/null @@ -1,10 +0,0 @@ -# InferProjectDataCatalogCategorySchema - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**sample_size** | **int** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/IngestDocumentQARequest.md b/docs/apis/public/IngestDocumentQARequest.md deleted file mode 100644 index 041b9cda..00000000 --- a/docs/apis/public/IngestDocumentQARequest.md +++ /dev/null @@ -1,10 +0,0 @@ -# IngestDocumentQARequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**source** | [**object**](.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/InlineObject.md b/docs/apis/public/InlineObject.md deleted file mode 100644 index 52ff6d6a..00000000 --- a/docs/apis/public/InlineObject.md +++ /dev/null @@ -1,10 +0,0 @@ -# InlineObject - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**snapshot** | [**TakeSnapshotSettingsBackendAware**](TakeSnapshotSettingsBackendAware.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/InlineObject1.md b/docs/apis/public/InlineObject1.md deleted file mode 100644 index b0e1a998..00000000 --- a/docs/apis/public/InlineObject1.md +++ /dev/null @@ -1,15 +0,0 @@ -# InlineObject1 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**access_token** | **str** | | -**catalog_document_collections** | [**list[CatalogReference]**](CatalogReference.md) | | -**ccs_document_collections** | [**list[CcsCollectionReference]**](CcsCollectionReference.md) | | -**data_catalogs** | [**list[CatalogReference]**](CatalogReference.md) | | [optional] -**entity_mappings** | **dict(str, str)** | | [optional] -**models** | [**list[CpsModelReference]**](CpsModelReference.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/InlineObject2.md b/docs/apis/public/InlineObject2.md deleted file mode 100644 index be8935dd..00000000 --- a/docs/apis/public/InlineObject2.md +++ /dev/null @@ -1,10 +0,0 @@ -# InlineObject2 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**snapshot** | [**TakeSnapshotSettings**](TakeSnapshotSettings.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/InlineObject3.md b/docs/apis/public/InlineObject3.md deleted file mode 100644 index c9d328eb..00000000 --- a/docs/apis/public/InlineObject3.md +++ /dev/null @@ -1,10 +0,0 @@ -# InlineObject3 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**info** | [**ProjectProjKeyBagsBagKeyTasksExportDatasetInfo**](ProjectProjKeyBagsBagKeyTasksExportDatasetInfo.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/InlineObject4.md b/docs/apis/public/InlineObject4.md deleted file mode 100644 index 6b9a8a37..00000000 --- a/docs/apis/public/InlineObject4.md +++ /dev/null @@ -1,10 +0,0 @@ -# InlineObject4 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**file_url** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/InlineObject5.md b/docs/apis/public/InlineObject5.md deleted file mode 100644 index 02266f6f..00000000 --- a/docs/apis/public/InlineObject5.md +++ /dev/null @@ -1,11 +0,0 @@ -# InlineObject5 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**attachment_key** | **str** | | [optional] -**attachment_path** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/InlineResponse200.md b/docs/apis/public/InlineResponse200.md deleted file mode 100644 index 02231458..00000000 --- a/docs/apis/public/InlineResponse200.md +++ /dev/null @@ -1,10 +0,0 @@ -# InlineResponse200 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**elastic_query_max_size** | **float** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/InlineResponse2001.md b/docs/apis/public/InlineResponse2001.md deleted file mode 100644 index ef940e8f..00000000 --- a/docs/apis/public/InlineResponse2001.md +++ /dev/null @@ -1,10 +0,0 @@ -# InlineResponse2001 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**processing_models** | [**list[ProcessingModelDescription]**](ProcessingModelDescription.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/InlineResponse2002.md b/docs/apis/public/InlineResponse2002.md deleted file mode 100644 index d2221517..00000000 --- a/docs/apis/public/InlineResponse2002.md +++ /dev/null @@ -1,13 +0,0 @@ -# InlineResponse2002 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**done** | **bool** | | -**result** | [**object**](.md) | | -**task_id** | **str** | | -**task_status** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/InlineResponse2003.md b/docs/apis/public/InlineResponse2003.md deleted file mode 100644 index 4d3f4b31..00000000 --- a/docs/apis/public/InlineResponse2003.md +++ /dev/null @@ -1,17 +0,0 @@ -# InlineResponse2003 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**avail_cpu_slots** | **int** | | [optional] -**avail_mem_slots** | **int** | | [optional] -**avail_slots** | **int** | | [optional] -**name** | **str** | | [optional] -**num_nodes** | **int** | | [optional] -**number_kgs** | **int** | | [optional] -**running_kgs** | **int** | | [optional] -**workers_pool** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/InspectionReport.md b/docs/apis/public/InspectionReport.md deleted file mode 100644 index e35c541a..00000000 --- a/docs/apis/public/InspectionReport.md +++ /dev/null @@ -1,14 +0,0 @@ -# InspectionReport - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**document** | **str** | | -**id** | **str** | ID of the inpection report. | -**proj_key** | **str** | | -**timestamp** | **float** | | -**user_key** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/KgSnapshot.md b/docs/apis/public/KgSnapshot.md deleted file mode 100644 index 68a20369..00000000 --- a/docs/apis/public/KgSnapshot.md +++ /dev/null @@ -1,15 +0,0 @@ -# KgSnapshot - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data_flow** | [**object**](.md) | | [optional] -**is_current** | **bool** | | [optional] -**name** | **str** | | [optional] -**project_task_id** | **str** | | [optional] -**task_type** | **str** | | [optional] -**timestamp** | **float** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/KgcDataInput.md b/docs/apis/public/KgcDataInput.md deleted file mode 100644 index 59578c7b..00000000 --- a/docs/apis/public/KgcDataInput.md +++ /dev/null @@ -1,11 +0,0 @@ -# KgcDataInput - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**config** | [**object**](.md) | | -**data_flow** | **list[dict(str, object)]** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/KibanaSavedQueriesResult.md b/docs/apis/public/KibanaSavedQueriesResult.md deleted file mode 100644 index a89cb5f3..00000000 --- a/docs/apis/public/KibanaSavedQueriesResult.md +++ /dev/null @@ -1,13 +0,0 @@ -# KibanaSavedQueriesResult - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | **str** | | [optional] -**fields** | **list[str]** | | [optional] -**query** | **str** | | [optional] -**title** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/KnowledgeGraphAuthenticationCallback.md b/docs/apis/public/KnowledgeGraphAuthenticationCallback.md deleted file mode 100644 index f6e202e4..00000000 --- a/docs/apis/public/KnowledgeGraphAuthenticationCallback.md +++ /dev/null @@ -1,10 +0,0 @@ -# KnowledgeGraphAuthenticationCallback - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**callback_url** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/KnowledgeGraphChartUpgradeOptions.md b/docs/apis/public/KnowledgeGraphChartUpgradeOptions.md deleted file mode 100644 index fee3e38f..00000000 --- a/docs/apis/public/KnowledgeGraphChartUpgradeOptions.md +++ /dev/null @@ -1,10 +0,0 @@ -# KnowledgeGraphChartUpgradeOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**chart** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/KnowledgeGraphDeploymentRecreationOptions.md b/docs/apis/public/KnowledgeGraphDeploymentRecreationOptions.md deleted file mode 100644 index eb20ed9e..00000000 --- a/docs/apis/public/KnowledgeGraphDeploymentRecreationOptions.md +++ /dev/null @@ -1,10 +0,0 @@ -# KnowledgeGraphDeploymentRecreationOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**force** | **bool** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/KnowledgeGraphSnapshotOptions.md b/docs/apis/public/KnowledgeGraphSnapshotOptions.md deleted file mode 100644 index 7b3ae47b..00000000 --- a/docs/apis/public/KnowledgeGraphSnapshotOptions.md +++ /dev/null @@ -1,10 +0,0 @@ -# KnowledgeGraphSnapshotOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/KnowledgeGraphSystemInformation.md b/docs/apis/public/KnowledgeGraphSystemInformation.md deleted file mode 100644 index f9596aeb..00000000 --- a/docs/apis/public/KnowledgeGraphSystemInformation.md +++ /dev/null @@ -1,19 +0,0 @@ -# KnowledgeGraphSystemInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**backend** | [**dict(str, SystemKgsBackend)**](SystemKgsBackend.md) | | [optional] -**bag_domain** | **str** | | [optional] -**bag_key** | **str** | | [optional] -**bag_url** | **str** | | [optional] -**name** | **str** | | [optional] -**proj_key** | **str** | | [optional] -**project_name** | **str** | | [optional] -**public** | **bool** | | [optional] -**slug** | **str** | | [optional] -**timestamp** | **float** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/KnowledgeGraphsApi.md b/docs/apis/public/KnowledgeGraphsApi.md deleted file mode 100644 index ee1f85fc..00000000 --- a/docs/apis/public/KnowledgeGraphsApi.md +++ /dev/null @@ -1,2647 +0,0 @@ -# deepsearch.cps.apis.public.KnowledgeGraphsApi - -All URIs are relative to *http://localhost/api/cps/public/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**assemble_project_knowledge_graph_data_flow**](KnowledgeGraphsApi.md#assemble_project_knowledge_graph_data_flow) | **POST** /project/{proj_key}/bags/{bag_key}/tasks/assemble_dataflow | -[**backend_assemble_project_kg_data_flow**](KnowledgeGraphsApi.md#backend_assemble_project_kg_data_flow) | **POST** /backend/project/{proj_key}/bags/{bag_key}/tasks/assemble_dataflow | -[**backend_create_project_kg**](KnowledgeGraphsApi.md#backend_create_project_kg) | **POST** /backend/project/{proj_key}/bags | -[**backend_create_project_kg_snapshot_from_data_flow_assembly**](KnowledgeGraphsApi.md#backend_create_project_kg_snapshot_from_data_flow_assembly) | **POST** /backend/project/{proj_key}/bags/{bag_key}/tasks/assemble_dataflow/latest/snapshots | -[**backend_get_project_kg_status**](KnowledgeGraphsApi.md#backend_get_project_kg_status) | **GET** /backend/project/{proj_key}/bags/{bag_key}/status | -[**backend_list_project_kgs**](KnowledgeGraphsApi.md#backend_list_project_kgs) | **GET** /backend/project/{proj_key}/bags | -[**backend_update_project_kg_metadata**](KnowledgeGraphsApi.md#backend_update_project_kg_metadata) | **PATCH** /backend/project/{proj_key}/bags/{bag_key} | -[**create_project_knowledge_graph**](KnowledgeGraphsApi.md#create_project_knowledge_graph) | **POST** /project/{proj_key}/bags | -[**create_project_knowledge_graph_authentication_token**](KnowledgeGraphsApi.md#create_project_knowledge_graph_authentication_token) | **GET** /project/{proj_key}/bags/{bag_key}/auth_token | -[**create_project_knowledge_graph_backup**](KnowledgeGraphsApi.md#create_project_knowledge_graph_backup) | **POST** /project/{proj_key}/bags/{bag_key}/tasks/backup | -[**create_project_knowledge_graph_delete_token**](KnowledgeGraphsApi.md#create_project_knowledge_graph_delete_token) | **POST** /project/{proj_key}/bags/{bag_key}/delete_token | -[**create_project_knowledge_graph_snapshot**](KnowledgeGraphsApi.md#create_project_knowledge_graph_snapshot) | **POST** /project/{proj_key}/bags/{bag_key}/snapshots | -[**create_project_knowledge_graph_snapshot_from_data_flow_assembly**](KnowledgeGraphsApi.md#create_project_knowledge_graph_snapshot_from_data_flow_assembly) | **POST** /project/{proj_key}/bags/{bag_key}/tasks/assemble_dataflow/latest/snapshots | -[**delete_project_knowledge_graph**](KnowledgeGraphsApi.md#delete_project_knowledge_graph) | **DELETE** /project/{proj_key}/bags/{bag_key} | -[**delete_project_knowledge_graph_snapshot**](KnowledgeGraphsApi.md#delete_project_knowledge_graph_snapshot) | **DELETE** /project/{proj_key}/bags/{bag_key}/snapshots/{execution_id} | -[**download_project_knowledge_graph**](KnowledgeGraphsApi.md#download_project_knowledge_graph) | **POST** /project/{proj_key}/bags/{bag_key}/tasks/export | -[**get_project_knowledge_graph_authentication_callback**](KnowledgeGraphsApi.md#get_project_knowledge_graph_authentication_callback) | **GET** /project/{proj_key}/bags/{bag_key}/auth_callback | -[**get_project_knowledge_graph_status**](KnowledgeGraphsApi.md#get_project_knowledge_graph_status) | **GET** /project/{proj_key}/bags/{bag_key}/status | -[**get_project_knowledge_graph_usage_stats**](KnowledgeGraphsApi.md#get_project_knowledge_graph_usage_stats) | **GET** /project/{proj_key}/bags/{bag_key}/usage_stats | -[**list_project_knowledge_graph_assemble_tasks**](KnowledgeGraphsApi.md#list_project_knowledge_graph_assemble_tasks) | **GET** /project/{proj_key}/bags/{bag_key}/tasks/assemble_dataflow | -[**list_project_knowledge_graph_load_tasks**](KnowledgeGraphsApi.md#list_project_knowledge_graph_load_tasks) | **GET** /project/{proj_key}/bags/{bag_key}/tasks/load_dataflow | -[**list_project_knowledge_graph_snapshots**](KnowledgeGraphsApi.md#list_project_knowledge_graph_snapshots) | **GET** /project/{proj_key}/bags/{bag_key}/snapshots | -[**list_project_knowledge_graphs**](KnowledgeGraphsApi.md#list_project_knowledge_graphs) | **GET** /project/{proj_key}/bags | -[**list_public_knowledge_graphs**](KnowledgeGraphsApi.md#list_public_knowledge_graphs) | **GET** /project/public/bags | -[**load_project_knowledge_graph_data_flow**](KnowledgeGraphsApi.md#load_project_knowledge_graph_data_flow) | **POST** /project/{proj_key}/bags/{bag_key}/tasks/load_dataflow | -[**load_project_knowledge_graph_snapshot**](KnowledgeGraphsApi.md#load_project_knowledge_graph_snapshot) | **POST** /project/{proj_key}/bags/{bag_key}/snapshots/{execution_id}/actions/load | -[**recreate_project_knowledge_graph_deployment**](KnowledgeGraphsApi.md#recreate_project_knowledge_graph_deployment) | **POST** /project/{proj_key}/bags/{bag_key}/tasks/recreate_deployment | -[**restore_project_knowledge_graph_backup**](KnowledgeGraphsApi.md#restore_project_knowledge_graph_backup) | **POST** /project/{proj_key}/bags/{bag_key}/tasks/restore | -[**resume_project_knowledge_graph**](KnowledgeGraphsApi.md#resume_project_knowledge_graph) | **POST** /project/{proj_key}/bags/{bag_key}/tasks/resume | -[**suspend_project_knowledge_graph**](KnowledgeGraphsApi.md#suspend_project_knowledge_graph) | **POST** /project/{proj_key}/bags/{bag_key}/tasks/suspend | -[**update_project_knowledge_graph_metadata**](KnowledgeGraphsApi.md#update_project_knowledge_graph_metadata) | **PATCH** /project/{proj_key}/bags/{bag_key} | -[**upgrade_project_knowledge_graph_deployment**](KnowledgeGraphsApi.md#upgrade_project_knowledge_graph_deployment) | **POST** /project/{proj_key}/bags/{bag_key}/tasks/upgrade | - - -# **assemble_project_knowledge_graph_data_flow** -> ProjectTask assemble_project_knowledge_graph_data_flow(proj_key, bag_key, options) - - - -Assemble a data flow on a Knowledge Graph - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -bag_key = 'bag_key_example' # str | -options = deepsearch.cps.apis.public.AssembleDataFlowIntoKnowledgeGraphOptions1() # AssembleDataFlowIntoKnowledgeGraphOptions1 | - - try: - api_response = api_instance.assemble_project_knowledge_graph_data_flow(proj_key, bag_key, options) - pprint(api_response) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->assemble_project_knowledge_graph_data_flow: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **bag_key** | **str**| | - **options** | [**AssembleDataFlowIntoKnowledgeGraphOptions1**](AssembleDataFlowIntoKnowledgeGraphOptions1.md)| | - -### Return type - -[**ProjectTask**](ProjectTask.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Task started. | - | -**400** | Invalid dataflow. | - | -**404** | Data flow template doesn't exist. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **backend_assemble_project_kg_data_flow** -> ProjectTask backend_assemble_project_kg_data_flow(proj_key, bag_key, options) - - - -Assemble a data flow on a Knowledge Graph, backend-aware - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -bag_key = 'bag_key_example' # str | -options = deepsearch.cps.apis.public.AssembleDataFlowIntoKnowledgeGraphOptions() # AssembleDataFlowIntoKnowledgeGraphOptions | - - try: - api_response = api_instance.backend_assemble_project_kg_data_flow(proj_key, bag_key, options) - pprint(api_response) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->backend_assemble_project_kg_data_flow: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **bag_key** | **str**| | - **options** | [**AssembleDataFlowIntoKnowledgeGraphOptions**](AssembleDataFlowIntoKnowledgeGraphOptions.md)| | - -### Return type - -[**ProjectTask**](ProjectTask.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Task started. | - | -**400** | Invalid dataflow. | - | -**404** | Data flow template doesn't exist. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **backend_create_project_kg** -> BagBackendAware backend_create_project_kg(proj_key, data) - - - -Create new BAG, backend-aware - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -data = deepsearch.cps.apis.public.CreateKnowledgeGraphOptions() # CreateKnowledgeGraphOptions | - - try: - api_response = api_instance.backend_create_project_kg(proj_key, data) - pprint(api_response) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->backend_create_project_kg: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **data** | [**CreateKnowledgeGraphOptions**](CreateKnowledgeGraphOptions.md)| | - -### Return type - -[**BagBackendAware**](BagBackendAware.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**201** | OK | - | -**400** | Invalid parameters. | - | -**403** | Create knowledge graphs is disabled. | - | -**409** | Cannot create BAG because one already exists with that name. | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **backend_create_project_kg_snapshot_from_data_flow_assembly** -> ProjectTask backend_create_project_kg_snapshot_from_data_flow_assembly(proj_key, bag_key, body) - - - -Create a snapshot of a Knowledge Graph from the last data flow assembly task, backend-aware - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -bag_key = 'bag_key_example' # str | -body = deepsearch.cps.apis.public.InlineObject() # InlineObject | - - try: - api_response = api_instance.backend_create_project_kg_snapshot_from_data_flow_assembly(proj_key, bag_key, body) - pprint(api_response) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->backend_create_project_kg_snapshot_from_data_flow_assembly: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **bag_key** | **str**| | - **body** | [**InlineObject**](InlineObject.md)| | - -### Return type - -[**ProjectTask**](ProjectTask.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Task started. | - | -**404** | KG/BAG/Data Flow Assembly not found. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **backend_get_project_kg_status** -> BagStatusBackendAware backend_get_project_kg_status(proj_key, bag_key, details=details) - - - -Get the status of a Knowledge Graph, backend-aware - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -bag_key = 'bag_key_example' # str | -details = False # bool | (optional) (default to False) - - try: - api_response = api_instance.backend_get_project_kg_status(proj_key, bag_key, details=details) - pprint(api_response) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->backend_get_project_kg_status: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **bag_key** | **str**| | - **details** | **bool**| | [optional] [default to False] - -### Return type - -[**BagStatusBackendAware**](BagStatusBackendAware.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Knowledge Graph status. | - | -**404** | BAG not found. | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **backend_list_project_kgs** -> list[BagBackendAware] backend_list_project_kgs(proj_key, term=term) - - - -List all bags in the project, backend-aware - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -term = 'term_example' # str | (optional) - - try: - api_response = api_instance.backend_list_project_kgs(proj_key, term=term) - pprint(api_response) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->backend_list_project_kgs: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **term** | **str**| | [optional] - -### Return type - -[**list[BagBackendAware]**](BagBackendAware.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **backend_update_project_kg_metadata** -> BagBackendAware backend_update_project_kg_metadata(proj_key, bag_key, data) - - - -Update the metadata of a Knowledge graph, backend-aware - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -bag_key = 'bag_key_example' # str | -data = deepsearch.cps.apis.public.PatchKnowledgeGraphOptions() # PatchKnowledgeGraphOptions | - - try: - api_response = api_instance.backend_update_project_kg_metadata(proj_key, bag_key, data) - pprint(api_response) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->backend_update_project_kg_metadata: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **bag_key** | **str**| | - **data** | [**PatchKnowledgeGraphOptions**](PatchKnowledgeGraphOptions.md)| | - -### Return type - -[**BagBackendAware**](BagBackendAware.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Knowledge graph metadata updated. | - | -**404** | Knowledge graph not found | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_project_knowledge_graph** -> Bag create_project_knowledge_graph(proj_key, data) - - - -Create new BAG - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -data = deepsearch.cps.apis.public.CreateKnowledgeGraphOptions1() # CreateKnowledgeGraphOptions1 | - - try: - api_response = api_instance.create_project_knowledge_graph(proj_key, data) - pprint(api_response) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->create_project_knowledge_graph: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **data** | [**CreateKnowledgeGraphOptions1**](CreateKnowledgeGraphOptions1.md)| | - -### Return type - -[**Bag**](Bag.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**201** | OK | - | -**400** | Invalid parameters. | - | -**403** | Create knowledge graphs is disabled. | - | -**409** | Cannot create BAG because one already exists with that name. | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_project_knowledge_graph_authentication_token** -> TokenResponse create_project_knowledge_graph_authentication_token(proj_key, bag_key) - - - -Get a token used to authenticate in the Erlenmeyer / KG APIs of a BAG. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -bag_key = 'bag_key_example' # str | - - try: - api_response = api_instance.create_project_knowledge_graph_authentication_token(proj_key, bag_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->create_project_knowledge_graph_authentication_token: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **bag_key** | **str**| | - -### Return type - -[**TokenResponse**](TokenResponse.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | BAG auth token. | - | -**404** | BAG not found. | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_project_knowledge_graph_backup** -> Task create_project_knowledge_graph_backup(proj_key, bag_key, options) - - - -Back up a Knowledge Graph - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -bag_key = 'bag_key_example' # str | -options = deepsearch.cps.apis.public.BackupKnowledgeGraphOptions() # BackupKnowledgeGraphOptions | - - try: - api_response = api_instance.create_project_knowledge_graph_backup(proj_key, bag_key, options) - pprint(api_response) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->create_project_knowledge_graph_backup: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **bag_key** | **str**| | - **options** | [**BackupKnowledgeGraphOptions**](BackupKnowledgeGraphOptions.md)| | - -### Return type - -[**Task**](Task.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**201** | OK | - | -**400** | Invalid parameters. | - | -**404** | KG/BAG not found. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_project_knowledge_graph_delete_token** -> TokenResponse create_project_knowledge_graph_delete_token(proj_key, bag_key) - - - -Get a token used to confirm the deletion of a BAG. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -bag_key = 'bag_key_example' # str | - - try: - api_response = api_instance.create_project_knowledge_graph_delete_token(proj_key, bag_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->create_project_knowledge_graph_delete_token: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **bag_key** | **str**| | - -### Return type - -[**TokenResponse**](TokenResponse.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | BAG deletion token. | - | -**404** | BAG not found. | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_project_knowledge_graph_snapshot** -> ProjectTask create_project_knowledge_graph_snapshot(proj_key, bag_key, body) - - - -Create a snapshot of a Knowledge Graph, with its current state. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -bag_key = 'bag_key_example' # str | -body = deepsearch.cps.apis.public.KnowledgeGraphSnapshotOptions() # KnowledgeGraphSnapshotOptions | - - try: - api_response = api_instance.create_project_knowledge_graph_snapshot(proj_key, bag_key, body) - pprint(api_response) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->create_project_knowledge_graph_snapshot: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **bag_key** | **str**| | - **body** | [**KnowledgeGraphSnapshotOptions**](KnowledgeGraphSnapshotOptions.md)| | - -### Return type - -[**ProjectTask**](ProjectTask.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Task started. | - | -**403** | Feature is disabled on this instance. | - | -**404** | KG/BAG not found. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_project_knowledge_graph_snapshot_from_data_flow_assembly** -> ProjectTask create_project_knowledge_graph_snapshot_from_data_flow_assembly(proj_key, bag_key, body) - - - -Create a snapshot of a Knowledge Graph from the last data flow assembly task. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -bag_key = 'bag_key_example' # str | -body = deepsearch.cps.apis.public.InlineObject2() # InlineObject2 | - - try: - api_response = api_instance.create_project_knowledge_graph_snapshot_from_data_flow_assembly(proj_key, bag_key, body) - pprint(api_response) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->create_project_knowledge_graph_snapshot_from_data_flow_assembly: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **bag_key** | **str**| | - **body** | [**InlineObject2**](InlineObject2.md)| | - -### Return type - -[**ProjectTask**](ProjectTask.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Task started. | - | -**404** | KG/BAG/Data Flow Assembly not found. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **delete_project_knowledge_graph** -> delete_project_knowledge_graph(proj_key, bag_key, confirmation_token) - - - -Delete a BAG - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -bag_key = 'bag_key_example' # str | -confirmation_token = 'confirmation_token_example' # str | - - try: - api_instance.delete_project_knowledge_graph(proj_key, bag_key, confirmation_token) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->delete_project_knowledge_graph: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **bag_key** | **str**| | - **confirmation_token** | **str**| | - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | BAG deleted. | - | -**404** | BAG not found. | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **delete_project_knowledge_graph_snapshot** -> delete_project_knowledge_graph_snapshot(proj_key, bag_key, execution_id) - - - -Delete a snapshot resulting from an assembled data flow. The execution log itself is not deleted. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -bag_key = 'bag_key_example' # str | -execution_id = 'execution_id_example' # str | - - try: - api_instance.delete_project_knowledge_graph_snapshot(proj_key, bag_key, execution_id) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->delete_project_knowledge_graph_snapshot: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **bag_key** | **str**| | - **execution_id** | **str**| | - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | OK | - | -**400** | Invalid parameters. | - | -**404** | KG/BAG/Snapshot not found. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **download_project_knowledge_graph** -> Task download_project_knowledge_graph(proj_key, bag_key) - - - -Download a Knowledge Graph - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -bag_key = 'bag_key_example' # str | - - try: - api_response = api_instance.download_project_knowledge_graph(proj_key, bag_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->download_project_knowledge_graph: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **bag_key** | **str**| | - -### Return type - -[**Task**](Task.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**201** | OK | - | -**400** | Invalid parameters. | - | -**404** | KG/BAG not found. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_project_knowledge_graph_authentication_callback** -> KnowledgeGraphAuthenticationCallback get_project_knowledge_graph_authentication_callback(proj_key, bag_key, bag_token) - - - -Final step of redirection for authentication on a BAG. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -bag_key = 'bag_key_example' # str | -bag_token = 'bag_token_example' # str | - - try: - api_response = api_instance.get_project_knowledge_graph_authentication_callback(proj_key, bag_key, bag_token) - pprint(api_response) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->get_project_knowledge_graph_authentication_callback: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **bag_key** | **str**| | - **bag_token** | **str**| | - -### Return type - -[**KnowledgeGraphAuthenticationCallback**](KnowledgeGraphAuthenticationCallback.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | BAG auth redirect URL. | - | -**401** | Unauthorized. | - | -**404** | BAG not found. | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_project_knowledge_graph_status** -> BagStatus get_project_knowledge_graph_status(proj_key, bag_key, details=details) - - - -Get the status of a Knowledge Graph - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -bag_key = 'bag_key_example' # str | -details = False # bool | (optional) (default to False) - - try: - api_response = api_instance.get_project_knowledge_graph_status(proj_key, bag_key, details=details) - pprint(api_response) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->get_project_knowledge_graph_status: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **bag_key** | **str**| | - **details** | **bool**| | [optional] [default to False] - -### Return type - -[**BagStatus**](BagStatus.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Knowledge Graph status. | - | -**404** | BAG not found. | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_project_knowledge_graph_usage_stats** -> UsageStats get_project_knowledge_graph_usage_stats(proj_key, bag_key) - - - -Get the usage stats of a Knowledge Graph - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -bag_key = 'bag_key_example' # str | - - try: - api_response = api_instance.get_project_knowledge_graph_usage_stats(proj_key, bag_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->get_project_knowledge_graph_usage_stats: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **bag_key** | **str**| | - -### Return type - -[**UsageStats**](UsageStats.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Knowledge Graph usage stats. | - | -**404** | BAG not found. | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_project_knowledge_graph_assemble_tasks** -> list[DataFlowAssembleIntoKnowledgeGraphTask] list_project_knowledge_graph_assemble_tasks(proj_key, bag_key, limit=limit, skip=skip) - - - -List assemble tasks for a Knowledge Graph. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -bag_key = 'bag_key_example' # str | -limit = 50 # int | (optional) (default to 50) -skip = 0 # int | (optional) (default to 0) - - try: - api_response = api_instance.list_project_knowledge_graph_assemble_tasks(proj_key, bag_key, limit=limit, skip=skip) - pprint(api_response) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->list_project_knowledge_graph_assemble_tasks: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **bag_key** | **str**| | - **limit** | **int**| | [optional] [default to 50] - **skip** | **int**| | [optional] [default to 0] - -### Return type - -[**list[DataFlowAssembleIntoKnowledgeGraphTask]**](DataFlowAssembleIntoKnowledgeGraphTask.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | List of tasks. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_project_knowledge_graph_load_tasks** -> list[DataFlowLoadIntoKnowledgeGraphTask] list_project_knowledge_graph_load_tasks(proj_key, bag_key, limit=limit, skip=skip) - - - -List load tasks for a Knowledge Graph - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -bag_key = 'bag_key_example' # str | -limit = 50 # int | (optional) (default to 50) -skip = 0 # int | (optional) (default to 0) - - try: - api_response = api_instance.list_project_knowledge_graph_load_tasks(proj_key, bag_key, limit=limit, skip=skip) - pprint(api_response) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->list_project_knowledge_graph_load_tasks: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **bag_key** | **str**| | - **limit** | **int**| | [optional] [default to 50] - **skip** | **int**| | [optional] [default to 0] - -### Return type - -[**list[DataFlowLoadIntoKnowledgeGraphTask]**](DataFlowLoadIntoKnowledgeGraphTask.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | List of tasks. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_project_knowledge_graph_snapshots** -> list[KgSnapshot] list_project_knowledge_graph_snapshots(proj_key, bag_key) - - - -List snapshots for a knowledge graph from assembled data flows. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -bag_key = 'bag_key_example' # str | - - try: - api_response = api_instance.list_project_knowledge_graph_snapshots(proj_key, bag_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->list_project_knowledge_graph_snapshots: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **bag_key** | **str**| | - -### Return type - -[**list[KgSnapshot]**](KgSnapshot.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Snapshots | - | -**404** | KG/BAG not found. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_project_knowledge_graphs** -> list[Bag] list_project_knowledge_graphs(proj_key, term=term) - - - -List all bags in the project - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -term = 'term_example' # str | (optional) - - try: - api_response = api_instance.list_project_knowledge_graphs(proj_key, term=term) - pprint(api_response) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->list_project_knowledge_graphs: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **term** | **str**| | [optional] - -### Return type - -[**list[Bag]**](Bag.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_public_knowledge_graphs** -> list[Bag] list_public_knowledge_graphs(term=term) - - - -List all public BAGs - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - term = 'term_example' # str | (optional) - - try: - api_response = api_instance.list_public_knowledge_graphs(term=term) - pprint(api_response) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->list_public_knowledge_graphs: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **term** | **str**| | [optional] - -### Return type - -[**list[Bag]**](Bag.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **load_project_knowledge_graph_data_flow** -> ProjectTask load_project_knowledge_graph_data_flow(proj_key, bag_key, options) - - - -Load a data flow onto a Knowledge Graph. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -bag_key = 'bag_key_example' # str | -options = deepsearch.cps.apis.public.LoadDataFlowIntoKnowledgeGraphOptions() # LoadDataFlowIntoKnowledgeGraphOptions | - - try: - api_response = api_instance.load_project_knowledge_graph_data_flow(proj_key, bag_key, options) - pprint(api_response) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->load_project_knowledge_graph_data_flow: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **bag_key** | **str**| | - **options** | [**LoadDataFlowIntoKnowledgeGraphOptions**](LoadDataFlowIntoKnowledgeGraphOptions.md)| | - -### Return type - -[**ProjectTask**](ProjectTask.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Task started. | - | -**400** | Invalid dataflow. | - | -**404** | Data flow template doesn't exist. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **load_project_knowledge_graph_snapshot** -> Task load_project_knowledge_graph_snapshot(proj_key, bag_key, execution_id) - - - -Load a snapshot resulting from an assembled data flow - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -bag_key = 'bag_key_example' # str | -execution_id = 'execution_id_example' # str | - - try: - api_response = api_instance.load_project_knowledge_graph_snapshot(proj_key, bag_key, execution_id) - pprint(api_response) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->load_project_knowledge_graph_snapshot: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **bag_key** | **str**| | - **execution_id** | **str**| | - -### Return type - -[**Task**](Task.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Snapshot is being loaded. | - | -**400** | Invalid parameters. | - | -**403** | Feature is disabled on this instance. | - | -**404** | KG/BAG/Snapshot not found. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **recreate_project_knowledge_graph_deployment** -> recreate_project_knowledge_graph_deployment(proj_key, bag_key, body) - - - -(Re)create the deployment for a Knowledge Graph - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -bag_key = 'bag_key_example' # str | -body = deepsearch.cps.apis.public.KnowledgeGraphDeploymentRecreationOptions() # KnowledgeGraphDeploymentRecreationOptions | - - try: - api_instance.recreate_project_knowledge_graph_deployment(proj_key, bag_key, body) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->recreate_project_knowledge_graph_deployment: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **bag_key** | **str**| | - **body** | [**KnowledgeGraphDeploymentRecreationOptions**](KnowledgeGraphDeploymentRecreationOptions.md)| | - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Deployment upgrading. | - | -**404** | Knowledge Graph doesn't exist. | - | -**409** | Refused to recreate the deployment since it already exists and the `force` flag is not `true`. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **restore_project_knowledge_graph_backup** -> Task restore_project_knowledge_graph_backup(proj_key, bag_key, options) - - - -Restore a back up of a Knowledge Graph - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -bag_key = 'bag_key_example' # str | -options = deepsearch.cps.apis.public.RestoreKnowledgeGraphBackupOptions() # RestoreKnowledgeGraphBackupOptions | - - try: - api_response = api_instance.restore_project_knowledge_graph_backup(proj_key, bag_key, options) - pprint(api_response) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->restore_project_knowledge_graph_backup: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **bag_key** | **str**| | - **options** | [**RestoreKnowledgeGraphBackupOptions**](RestoreKnowledgeGraphBackupOptions.md)| | - -### Return type - -[**Task**](Task.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**201** | OK | - | -**400** | Invalid parameters. | - | -**404** | KG/BAG not found. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **resume_project_knowledge_graph** -> ProjectTask resume_project_knowledge_graph(proj_key, bag_key, body) - - - -Resume a Knowledge Graph - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -bag_key = 'bag_key_example' # str | -body = deepsearch.cps.apis.public.ResumeKnowledgeGraphOptions() # ResumeKnowledgeGraphOptions | - - try: - api_response = api_instance.resume_project_knowledge_graph(proj_key, bag_key, body) - pprint(api_response) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->resume_project_knowledge_graph: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **bag_key** | **str**| | - **body** | [**ResumeKnowledgeGraphOptions**](ResumeKnowledgeGraphOptions.md)| | - -### Return type - -[**ProjectTask**](ProjectTask.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Task started. | - | -**403** | Feature is disabled on this instance. | - | -**404** | Knowledge Graph doesn't exist. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **suspend_project_knowledge_graph** -> ProjectTask suspend_project_knowledge_graph(proj_key, bag_key, options) - - - -Suspend a Knowledge Graph - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -bag_key = 'bag_key_example' # str | -options = deepsearch.cps.apis.public.SuspendKnowledgeGraphOptions() # SuspendKnowledgeGraphOptions | - - try: - api_response = api_instance.suspend_project_knowledge_graph(proj_key, bag_key, options) - pprint(api_response) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->suspend_project_knowledge_graph: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **bag_key** | **str**| | - **options** | [**SuspendKnowledgeGraphOptions**](SuspendKnowledgeGraphOptions.md)| | - -### Return type - -[**ProjectTask**](ProjectTask.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Task started. | - | -**404** | Knowledge Graph doesn't exist. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_project_knowledge_graph_metadata** -> Bag update_project_knowledge_graph_metadata(proj_key, bag_key, data) - - - -Update the metadata of a Knowledge graph - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -bag_key = 'bag_key_example' # str | -data = deepsearch.cps.apis.public.PatchKnowledgeGraphOptions1() # PatchKnowledgeGraphOptions1 | - - try: - api_response = api_instance.update_project_knowledge_graph_metadata(proj_key, bag_key, data) - pprint(api_response) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->update_project_knowledge_graph_metadata: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **bag_key** | **str**| | - **data** | [**PatchKnowledgeGraphOptions1**](PatchKnowledgeGraphOptions1.md)| | - -### Return type - -[**Bag**](Bag.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Knowledge graph metadata updated. | - | -**404** | Knowledge graph not found | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **upgrade_project_knowledge_graph_deployment** -> upgrade_project_knowledge_graph_deployment(proj_key, bag_key, body) - - - -Upgrade the deployment chart of a Knowledge Graph - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.KnowledgeGraphsApi(api_client) - proj_key = 'proj_key_example' # str | -bag_key = 'bag_key_example' # str | -body = deepsearch.cps.apis.public.KnowledgeGraphChartUpgradeOptions() # KnowledgeGraphChartUpgradeOptions | - - try: - api_instance.upgrade_project_knowledge_graph_deployment(proj_key, bag_key, body) - except ApiException as e: - print("Exception when calling KnowledgeGraphsApi->upgrade_project_knowledge_graph_deployment: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **bag_key** | **str**| | - **body** | [**KnowledgeGraphChartUpgradeOptions**](KnowledgeGraphChartUpgradeOptions.md)| | - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Chart upgrading. | - | -**404** | Knowledge Graph doesn't exist. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/apis/public/LinkedCcsInstances.md b/docs/apis/public/LinkedCcsInstances.md deleted file mode 100644 index 71531dc3..00000000 --- a/docs/apis/public/LinkedCcsInstances.md +++ /dev/null @@ -1,11 +0,0 @@ -# LinkedCcsInstances - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | **str** | | -**id** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/LoadDataFlowIntoKnowledgeGraphOptions.md b/docs/apis/public/LoadDataFlowIntoKnowledgeGraphOptions.md deleted file mode 100644 index 009f9a6d..00000000 --- a/docs/apis/public/LoadDataFlowIntoKnowledgeGraphOptions.md +++ /dev/null @@ -1,12 +0,0 @@ -# LoadDataFlowIntoKnowledgeGraphOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data_flow** | [**BackendProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlow**](BackendProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlow.md) | | -**render** | [**BackendProjectProjKeyBagsBagKeyTasksAssembleDataflowRender**](BackendProjectProjKeyBagsBagKeyTasksAssembleDataflowRender.md) | | -**save** | [**object**](.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/LoadDataFlowIntoKnowledgeGraphOptions1.md b/docs/apis/public/LoadDataFlowIntoKnowledgeGraphOptions1.md deleted file mode 100644 index 08cbfc01..00000000 --- a/docs/apis/public/LoadDataFlowIntoKnowledgeGraphOptions1.md +++ /dev/null @@ -1,11 +0,0 @@ -# LoadDataFlowIntoKnowledgeGraphOptions1 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**render** | [**ProjectProjKeyKgcDataflowTemplatesDfTplKeyActionsLoadRender**](ProjectProjKeyKgcDataflowTemplatesDfTplKeyActionsLoadRender.md) | | [optional] -**target** | [**ProjectProjKeyKgcDataflowTemplatesDfTplKeyActionsLoadTarget**](ProjectProjKeyKgcDataflowTemplatesDfTplKeyActionsLoadTarget.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/LoadKgcDataInput.md b/docs/apis/public/LoadKgcDataInput.md deleted file mode 100644 index bb5de276..00000000 --- a/docs/apis/public/LoadKgcDataInput.md +++ /dev/null @@ -1,11 +0,0 @@ -# LoadKgcDataInput - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**dataflow** | [**LoadKgcDataInputDataflow**](LoadKgcDataInputDataflow.md) | | -**target** | [**LoadKgcDataInputTarget**](LoadKgcDataInputTarget.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/LoadKgcDataInputDataflow.md b/docs/apis/public/LoadKgcDataInputDataflow.md deleted file mode 100644 index e7b08f73..00000000 --- a/docs/apis/public/LoadKgcDataInputDataflow.md +++ /dev/null @@ -1,11 +0,0 @@ -# LoadKgcDataInputDataflow - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**config** | [**object**](.md) | | [optional] -**data_flow** | **list[object]** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/LoadKgcDataInputTarget.md b/docs/apis/public/LoadKgcDataInputTarget.md deleted file mode 100644 index b1deec22..00000000 --- a/docs/apis/public/LoadKgcDataInputTarget.md +++ /dev/null @@ -1,11 +0,0 @@ -# LoadKgcDataInputTarget - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**bag_key** | **str** | | -**save** | [**object**](.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ModelConfiguration.md b/docs/apis/public/ModelConfiguration.md deleted file mode 100644 index 5840510a..00000000 --- a/docs/apis/public/ModelConfiguration.md +++ /dev/null @@ -1,18 +0,0 @@ -# ModelConfiguration - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**configurations** | **dict(str, object)** | | [optional] -**created_at** | **float** | | -**created_by** | **str** | | -**description** | **str** | | -**model_config_key** | **str** | | -**name** | **str** | | -**proj_key** | **str** | | -**public** | **bool** | | -**supported_annotations** | [**object**](.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ModelConfigurationsApi.md b/docs/apis/public/ModelConfigurationsApi.md deleted file mode 100644 index b4d43e31..00000000 --- a/docs/apis/public/ModelConfigurationsApi.md +++ /dev/null @@ -1,644 +0,0 @@ -# deepsearch.cps.apis.public.ModelConfigurationsApi - -All URIs are relative to *http://localhost/api/cps/public/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_project_model_config**](ModelConfigurationsApi.md#create_project_model_config) | **POST** /project/{proj_key}/model_configs | -[**delete_project_model_config**](ModelConfigurationsApi.md#delete_project_model_config) | **DELETE** /project/{proj_key}/model_configs/{model_config_key} | -[**get_project_models_with_supported_annotations**](ModelConfigurationsApi.md#get_project_models_with_supported_annotations) | **GET** /project/{proj_key}/models | -[**list_project_model_configs**](ModelConfigurationsApi.md#list_project_model_configs) | **GET** /project/{proj_key}/model_configs | -[**list_public_model_configs**](ModelConfigurationsApi.md#list_public_model_configs) | **GET** /project/public/model_configs | -[**read_project_model_config**](ModelConfigurationsApi.md#read_project_model_config) | **GET** /project/{proj_key}/model_configs/{model_config_key} | -[**read_public_model_config**](ModelConfigurationsApi.md#read_public_model_config) | **GET** /project/public/model_configs/{model_config_key} | -[**update_project_model_config**](ModelConfigurationsApi.md#update_project_model_config) | **PATCH** /project/{proj_key}/model_configs/{model_config_key} | - - -# **create_project_model_config** -> ModelConfiguration create_project_model_config(proj_key, body) - - - -Create a Model Configuration - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.ModelConfigurationsApi(api_client) - proj_key = 'proj_key_example' # str | -body = deepsearch.cps.apis.public.CreateProjectModelConfigOptions() # CreateProjectModelConfigOptions | - - try: - api_response = api_instance.create_project_model_config(proj_key, body) - pprint(api_response) - except ApiException as e: - print("Exception when calling ModelConfigurationsApi->create_project_model_config: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **body** | [**CreateProjectModelConfigOptions**](CreateProjectModelConfigOptions.md)| | - -### Return type - -[**ModelConfiguration**](ModelConfiguration.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Model Configuration created. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **delete_project_model_config** -> delete_project_model_config(proj_key, model_config_key) - - - -Delete a single Model Configuration - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.ModelConfigurationsApi(api_client) - proj_key = 'proj_key_example' # str | -model_config_key = 'model_config_key_example' # str | - - try: - api_instance.delete_project_model_config(proj_key, model_config_key) - except ApiException as e: - print("Exception when calling ModelConfigurationsApi->delete_project_model_config: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **model_config_key** | **str**| | - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | Model Configuration deleted. | - | -**404** | Model Configuration doesn't exist. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_project_models_with_supported_annotations** -> list[ModelConfiguration] get_project_models_with_supported_annotations(proj_key) - - - -List models with the supported annotations for a project - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.ModelConfigurationsApi(api_client) - proj_key = 'proj_key_example' # str | - - try: - api_response = api_instance.get_project_models_with_supported_annotations(proj_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling ModelConfigurationsApi->get_project_models_with_supported_annotations: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - -### Return type - -[**list[ModelConfiguration]**](ModelConfiguration.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | List of Models with the supported annotations | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_project_model_configs** -> list[ModelConfiguration] list_project_model_configs(proj_key) - - - -List Model Configurations for a project - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.ModelConfigurationsApi(api_client) - proj_key = 'proj_key_example' # str | - - try: - api_response = api_instance.list_project_model_configs(proj_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling ModelConfigurationsApi->list_project_model_configs: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - -### Return type - -[**list[ModelConfiguration]**](ModelConfiguration.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | List of Model Configurations | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_public_model_configs** -> list[ModelConfiguration] list_public_model_configs() - - - -List public Model Configurations - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.ModelConfigurationsApi(api_client) - - try: - api_response = api_instance.list_public_model_configs() - pprint(api_response) - except ApiException as e: - print("Exception when calling ModelConfigurationsApi->list_public_model_configs: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -[**list[ModelConfiguration]**](ModelConfiguration.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | List of public Model Configurations | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **read_project_model_config** -> ModelConfiguration read_project_model_config(proj_key, model_config_key, include_collections=include_collections) - - - -Get a single Model Configuration - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.ModelConfigurationsApi(api_client) - proj_key = 'proj_key_example' # str | -model_config_key = 'model_config_key_example' # str | -include_collections = False # bool | (optional) (default to False) - - try: - api_response = api_instance.read_project_model_config(proj_key, model_config_key, include_collections=include_collections) - pprint(api_response) - except ApiException as e: - print("Exception when calling ModelConfigurationsApi->read_project_model_config: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **model_config_key** | **str**| | - **include_collections** | **bool**| | [optional] [default to False] - -### Return type - -[**ModelConfiguration**](ModelConfiguration.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Model Configuration | - | -**404** | Model Configuration not found | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **read_public_model_config** -> ModelConfiguration read_public_model_config(model_config_key, include_collections=include_collections) - - - -Get a single Model Configuration that was made public - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.ModelConfigurationsApi(api_client) - model_config_key = 'model_config_key_example' # str | -include_collections = False # bool | (optional) (default to False) - - try: - api_response = api_instance.read_public_model_config(model_config_key, include_collections=include_collections) - pprint(api_response) - except ApiException as e: - print("Exception when calling ModelConfigurationsApi->read_public_model_config: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **model_config_key** | **str**| | - **include_collections** | **bool**| | [optional] [default to False] - -### Return type - -[**ModelConfiguration**](ModelConfiguration.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Model configuration | - | -**404** | Model configuration not found or is not public | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_project_model_config** -> update_project_model_config(proj_key, model_config_key, body) - - - -Update a single Model Configuration - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.ModelConfigurationsApi(api_client) - proj_key = 'proj_key_example' # str | -model_config_key = 'model_config_key_example' # str | -body = deepsearch.cps.apis.public.UpdateProjectModelConfigOptions() # UpdateProjectModelConfigOptions | - - try: - api_instance.update_project_model_config(proj_key, model_config_key, body) - except ApiException as e: - print("Exception when calling ModelConfigurationsApi->update_project_model_config: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **model_config_key** | **str**| | - **body** | [**UpdateProjectModelConfigOptions**](UpdateProjectModelConfigOptions.md)| | - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | Model Configuration updated. | - | -**404** | Model Configuration doesn't exist. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/apis/public/ModelPipelineSettings.md b/docs/apis/public/ModelPipelineSettings.md deleted file mode 100644 index a0b06016..00000000 --- a/docs/apis/public/ModelPipelineSettings.md +++ /dev/null @@ -1,13 +0,0 @@ -# ModelPipelineSettings - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**clusters** | [**object**](.md) | | -**normalization** | [**object**](.md) | | -**page** | [**object**](.md) | | -**tables** | [**object**](.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ModelSupportedAnnotationsParameters.md b/docs/apis/public/ModelSupportedAnnotationsParameters.md deleted file mode 100644 index 43bc9eff..00000000 --- a/docs/apis/public/ModelSupportedAnnotationsParameters.md +++ /dev/null @@ -1,12 +0,0 @@ -# ModelSupportedAnnotationsParameters - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**model_config_key** | **str** | | -**proj_key** | **str** | | -**public** | **bool** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/MongoCoordinates.md b/docs/apis/public/MongoCoordinates.md deleted file mode 100644 index 05d9806d..00000000 --- a/docs/apis/public/MongoCoordinates.md +++ /dev/null @@ -1,11 +0,0 @@ -# MongoCoordinates - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**database** | **str** | | -**uri** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/MongoS3Coordinates.md b/docs/apis/public/MongoS3Coordinates.md deleted file mode 100644 index 745ba033..00000000 --- a/docs/apis/public/MongoS3Coordinates.md +++ /dev/null @@ -1,11 +0,0 @@ -# MongoS3Coordinates - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**mongo** | [**MongoCoordinates**](MongoCoordinates.md) | | [optional] -**s3** | [**S3Coordinates**](S3Coordinates.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/MongoS3CoordinatesWithCollectionList.md b/docs/apis/public/MongoS3CoordinatesWithCollectionList.md deleted file mode 100644 index 4c53ceb8..00000000 --- a/docs/apis/public/MongoS3CoordinatesWithCollectionList.md +++ /dev/null @@ -1,12 +0,0 @@ -# MongoS3CoordinatesWithCollectionList - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**mongo** | [**MongoCoordinates**](MongoCoordinates.md) | | [optional] -**s3** | [**S3Coordinates**](S3Coordinates.md) | | [optional] -**collections** | **list[str]** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/OCRSettings.md b/docs/apis/public/OCRSettings.md deleted file mode 100644 index 06d968a0..00000000 --- a/docs/apis/public/OCRSettings.md +++ /dev/null @@ -1,13 +0,0 @@ -# OCRSettings - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**backend** | **str** | | [optional] -**backend_settings** | [**object**](.md) | | [optional] -**enabled** | **bool** | | [optional] [default to False] -**merge_mode** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/PatchDataCatalogOptions.md b/docs/apis/public/PatchDataCatalogOptions.md deleted file mode 100644 index f5c89b54..00000000 --- a/docs/apis/public/PatchDataCatalogOptions.md +++ /dev/null @@ -1,15 +0,0 @@ -# PatchDataCatalogOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**category_schemas** | [**list[DataCatalogCategorySchema]**](DataCatalogCategorySchema.md) | | [optional] -**collections_data_flows** | [**list[DataCatalogDataFlow]**](DataCatalogDataFlow.md) | | [optional] -**description** | **str** | | [optional] -**name** | **str** | | [optional] -**public** | **bool** | | [optional] -**topology** | [**DataCatalogTopology**](DataCatalogTopology.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/PatchDictionaryOptions.md b/docs/apis/public/PatchDictionaryOptions.md deleted file mode 100644 index da270a8e..00000000 --- a/docs/apis/public/PatchDictionaryOptions.md +++ /dev/null @@ -1,12 +0,0 @@ -# PatchDictionaryOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | **str** | | [optional] -**name** | **str** | | [optional] -**public** | **bool** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/PatchKnowledgeGraphOptions.md b/docs/apis/public/PatchKnowledgeGraphOptions.md deleted file mode 100644 index 07655d84..00000000 --- a/docs/apis/public/PatchKnowledgeGraphOptions.md +++ /dev/null @@ -1,12 +0,0 @@ -# PatchKnowledgeGraphOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | **str** | | -**name** | **str** | | -**public** | **bool** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/PatchKnowledgeGraphOptions1.md b/docs/apis/public/PatchKnowledgeGraphOptions1.md deleted file mode 100644 index 1e41fc61..00000000 --- a/docs/apis/public/PatchKnowledgeGraphOptions1.md +++ /dev/null @@ -1,12 +0,0 @@ -# PatchKnowledgeGraphOptions1 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | **str** | | -**name** | **str** | | -**public** | **bool** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/Problem.md b/docs/apis/public/Problem.md deleted file mode 100644 index 73f536e0..00000000 --- a/docs/apis/public/Problem.md +++ /dev/null @@ -1,13 +0,0 @@ -# Problem - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**detail** | **str** | | [optional] -**status** | **int** | | [optional] -**title** | **str** | | [optional] -**type** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProcessingModel.md b/docs/apis/public/ProcessingModel.md deleted file mode 100644 index c93e36ca..00000000 --- a/docs/apis/public/ProcessingModel.md +++ /dev/null @@ -1,11 +0,0 @@ -# ProcessingModel - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**dataflow** | [**ProcessingModelDataFlow**](ProcessingModelDataFlow.md) | | -**variables** | [**dict(str, ProjectProjKeyModelConfigsConfigurations)**](ProjectProjKeyModelConfigsConfigurations.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProcessingModelApi.md b/docs/apis/public/ProcessingModelApi.md deleted file mode 100644 index df8b2f2e..00000000 --- a/docs/apis/public/ProcessingModelApi.md +++ /dev/null @@ -1,160 +0,0 @@ -# deepsearch.cps.apis.public.ProcessingModelApi - -All URIs are relative to *http://localhost/api/cps/public/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_data_flow_from_df_wizard**](ProcessingModelApi.md#create_data_flow_from_df_wizard) | **POST** /processing_models/docs_graph_with_databases | -[**get_processing_models**](ProcessingModelApi.md#get_processing_models) | **GET** /processing_models | - - -# **create_data_flow_from_df_wizard** -> ProcessingModel create_data_flow_from_df_wizard(body) - - - -Create a Data Flow from a list of CCS Collections and CPS Models. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.ProcessingModelApi(api_client) - body = deepsearch.cps.apis.public.InlineObject1() # InlineObject1 | - - try: - api_response = api_instance.create_data_flow_from_df_wizard(body) - pprint(api_response) - except ApiException as e: - print("Exception when calling ProcessingModelApi->create_data_flow_from_df_wizard: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | [**InlineObject1**](InlineObject1.md)| | - -### Return type - -[**ProcessingModel**](ProcessingModel.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Processing model generated successfully | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_processing_models** -> InlineResponse2001 get_processing_models() - - - -List the available processing models. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.ProcessingModelApi(api_client) - - try: - api_response = api_instance.get_processing_models() - pprint(api_response) - except ApiException as e: - print("Exception when calling ProcessingModelApi->get_processing_models: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -[**InlineResponse2001**](InlineResponse2001.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | List of processing models and their description | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/apis/public/ProcessingModelDataFlow.md b/docs/apis/public/ProcessingModelDataFlow.md deleted file mode 100644 index 91b0fc69..00000000 --- a/docs/apis/public/ProcessingModelDataFlow.md +++ /dev/null @@ -1,11 +0,0 @@ -# ProcessingModelDataFlow - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**config** | [**object**](.md) | | -**data_flow** | **list[object]** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProcessingModelDescription.md b/docs/apis/public/ProcessingModelDescription.md deleted file mode 100644 index e117671b..00000000 --- a/docs/apis/public/ProcessingModelDescription.md +++ /dev/null @@ -1,12 +0,0 @@ -# ProcessingModelDescription - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | **str** | | -**display_name** | **str** | | -**name** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectApi.md b/docs/apis/public/ProjectApi.md deleted file mode 100644 index f994827c..00000000 --- a/docs/apis/public/ProjectApi.md +++ /dev/null @@ -1,488 +0,0 @@ -# deepsearch.cps.apis.public.ProjectApi - -All URIs are relative to *http://localhost/api/cps/public/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**delete_project_integration_config**](ProjectApi.md#delete_project_integration_config) | **DELETE** /project/{proj_key}/integrations/{integration_name} | -[**get_project_default_values**](ProjectApi.md#get_project_default_values) | **GET** /project/{proj_key}/default_values | -[**get_project_integration_config**](ProjectApi.md#get_project_integration_config) | **GET** /project/{proj_key}/integrations/{integration_name} | -[**provision_project_packages**](ProjectApi.md#provision_project_packages) | **POST** /project/{proj_key}/packages | -[**update_project_default_values**](ProjectApi.md#update_project_default_values) | **POST** /project/{proj_key}/default_values | -[**update_project_integration_config**](ProjectApi.md#update_project_integration_config) | **POST** /project/{proj_key}/integrations/{integration_name} | - - -# **delete_project_integration_config** -> delete_project_integration_config(proj_key, integration_name) - - - -Delete the config for a given project integration - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.ProjectApi(api_client) - proj_key = 'proj_key_example' # str | -integration_name = 'integration_name_example' # str | - - try: - api_instance.delete_project_integration_config(proj_key, integration_name) - except ApiException as e: - print("Exception when calling ProjectApi->delete_project_integration_config: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **integration_name** | **str**| | - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_project_default_values** -> ProjectDefaultValues get_project_default_values(proj_key) - - - -List project's default values - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.ProjectApi(api_client) - proj_key = 'proj_key_example' # str | - - try: - api_response = api_instance.get_project_default_values(proj_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling ProjectApi->get_project_default_values: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - -### Return type - -[**ProjectDefaultValues**](ProjectDefaultValues.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_project_integration_config** -> object get_project_integration_config(proj_key, integration_name, decode_secrets=decode_secrets) - - - -Get the config for a given project integration - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.ProjectApi(api_client) - proj_key = 'proj_key_example' # str | -integration_name = 'integration_name_example' # str | -decode_secrets = False # bool | Project owners can retrieve decoded secrets (optional) (default to False) - - try: - api_response = api_instance.get_project_integration_config(proj_key, integration_name, decode_secrets=decode_secrets) - pprint(api_response) - except ApiException as e: - print("Exception when calling ProjectApi->get_project_integration_config: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **integration_name** | **str**| | - **decode_secrets** | **bool**| Project owners can retrieve decoded secrets | [optional] [default to False] - -### Return type - -**object** - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **provision_project_packages** -> Task provision_project_packages(proj_key, body=body) - - - -Install packages on a project - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.ProjectApi(api_client) - proj_key = 'proj_key_example' # str | -body = deepsearch.cps.apis.public.ProjectPackageInstalationManifest() # ProjectPackageInstalationManifest | (optional) - - try: - api_response = api_instance.provision_project_packages(proj_key, body=body) - pprint(api_response) - except ApiException as e: - print("Exception when calling ProjectApi->provision_project_packages: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **body** | [**ProjectPackageInstalationManifest**](ProjectPackageInstalationManifest.md)| | [optional] - -### Return type - -[**Task**](Task.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Task started. It can be found in the tasks endpoint for the project. | - | -**404** | Package not found. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_project_default_values** -> update_project_default_values(proj_key, default_values) - - - -List project's default values - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.ProjectApi(api_client) - proj_key = 'proj_key_example' # str | -default_values = deepsearch.cps.apis.public.ProjectDefaultValues() # ProjectDefaultValues | - - try: - api_instance.update_project_default_values(proj_key, default_values) - except ApiException as e: - print("Exception when calling ProjectApi->update_project_default_values: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **default_values** | [**ProjectDefaultValues**](ProjectDefaultValues.md)| | - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_project_integration_config** -> update_project_integration_config(proj_key, integration_name, config) - - - -Update the config for a given project integration - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.ProjectApi(api_client) - proj_key = 'proj_key_example' # str | -integration_name = 'integration_name_example' # str | -config = None # object | - - try: - api_instance.update_project_integration_config(proj_key, integration_name, config) - except ApiException as e: - print("Exception when calling ProjectApi->update_project_integration_config: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **integration_name** | **str**| | - **config** | **object**| | - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/apis/public/ProjectDataIndexConversionSettings.md b/docs/apis/public/ProjectDataIndexConversionSettings.md deleted file mode 100644 index 47af46be..00000000 --- a/docs/apis/public/ProjectDataIndexConversionSettings.md +++ /dev/null @@ -1,16 +0,0 @@ -# ProjectDataIndexConversionSettings - -Specify the conversion settings to use. -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**assemble** | [**AssembleSettings**](AssembleSettings.md) | | [optional] -**metadata** | [**CollectionMetadataSettings**](CollectionMetadataSettings.md) | | [optional] -**model_pipeline** | [**ModelPipelineSettings**](ModelPipelineSettings.md) | | [optional] -**ocr** | [**OCRSettings**](OCRSettings.md) | | [optional] -**page_labels** | [**object**](.md) | | [optional] -**type** | **str** | | [optional] [default to 'direct'] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectDataIndexNonView.md b/docs/apis/public/ProjectDataIndexNonView.md deleted file mode 100644 index fdafbf3b..00000000 --- a/docs/apis/public/ProjectDataIndexNonView.md +++ /dev/null @@ -1,13 +0,0 @@ -# ProjectDataIndexNonView - -Object to create a project data index -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | **str** | Description of the Index | [optional] -**name** | **str** | Name of the data index | -**schema_key** | **str** | Schema key | [optional] [default to 'generic'] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectDataIndexS3Coordinates.md b/docs/apis/public/ProjectDataIndexS3Coordinates.md deleted file mode 100644 index 2569d278..00000000 --- a/docs/apis/public/ProjectDataIndexS3Coordinates.md +++ /dev/null @@ -1,19 +0,0 @@ -# ProjectDataIndexS3Coordinates - -Coordinates to COS -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**access_key** | **str** | | -**bucket** | **str** | | -**host** | **str** | | -**key_prefix** | **str** | | [optional] -**location** | **str** | | -**port** | **float** | | -**secret_key** | **str** | | -**ssl** | **bool** | | -**verify_ssl** | **bool** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectDataIndexSource.md b/docs/apis/public/ProjectDataIndexSource.md deleted file mode 100644 index e571a6e2..00000000 --- a/docs/apis/public/ProjectDataIndexSource.md +++ /dev/null @@ -1,11 +0,0 @@ -# ProjectDataIndexSource - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**index_key** | **str** | | -**proj_key** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectDataIndexView.md b/docs/apis/public/ProjectDataIndexView.md deleted file mode 100644 index 8bea90ef..00000000 --- a/docs/apis/public/ProjectDataIndexView.md +++ /dev/null @@ -1,13 +0,0 @@ -# ProjectDataIndexView - -Object to create a project data index view -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | **str** | Description of the index view | [optional] -**name** | **str** | Name of the data index view | -**view_of** | [**ProjectDataIndexViewOf**](ProjectDataIndexViewOf.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectDataIndexViewOf.md b/docs/apis/public/ProjectDataIndexViewOf.md deleted file mode 100644 index 04711ce4..00000000 --- a/docs/apis/public/ProjectDataIndexViewOf.md +++ /dev/null @@ -1,13 +0,0 @@ -# ProjectDataIndexViewOf - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**index_key** | **str** | Data index key | -**instance_id** | **str** | Instance id key, if the source is a data asset | [optional] -**proj_key** | **str** | Project id key, if the source is a project data index | [optional] -**query_options** | [**ElasticIndexSearchQueryOptions**](ElasticIndexSearchQueryOptions.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectDataIndexWithStatus.md b/docs/apis/public/ProjectDataIndexWithStatus.md deleted file mode 100644 index c3cc3b9f..00000000 --- a/docs/apis/public/ProjectDataIndexWithStatus.md +++ /dev/null @@ -1,22 +0,0 @@ -# ProjectDataIndexWithStatus - -Project data index with elastic status -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**creation_date** | **str** | | -**description** | **str** | | -**documents** | **float** | | -**health** | **str** | | -**name** | **str** | | -**provenance** | **str** | | [optional] -**record_properties** | [**object**](.md) | | [optional] -**schema_key** | **str** | Index's schema key | [optional] -**source** | [**ProjectDataIndexSource**](ProjectDataIndexSource.md) | | -**status** | **str** | | -**type** | **str** | Index type, user friendly format | -**view_of** | [**ProjectDataIndexWithStatusViewOf**](ProjectDataIndexWithStatusViewOf.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectDataIndexWithStatusViewOf.md b/docs/apis/public/ProjectDataIndexWithStatusViewOf.md deleted file mode 100644 index 1cd8d03b..00000000 --- a/docs/apis/public/ProjectDataIndexWithStatusViewOf.md +++ /dev/null @@ -1,13 +0,0 @@ -# ProjectDataIndexWithStatusViewOf - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**elastic_id** | **str** | | [optional] -**index_key** | **str** | | -**proj_key** | **str** | | [optional] -**query_options** | [**ElasticIndexSearchQueryOptions**](ElasticIndexSearchQueryOptions.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectDefaultValues.md b/docs/apis/public/ProjectDefaultValues.md deleted file mode 100644 index e54e7d44..00000000 --- a/docs/apis/public/ProjectDefaultValues.md +++ /dev/null @@ -1,11 +0,0 @@ -# ProjectDefaultValues - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ccs_project** | [**ProjectDefaultValuesCcsProject**](ProjectDefaultValuesCcsProject.md) | | [optional] -**dataflow** | [**ProjectDefaultValuesDataflow**](ProjectDefaultValuesDataflow.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectDefaultValuesCcsProject.md b/docs/apis/public/ProjectDefaultValuesCcsProject.md deleted file mode 100644 index cf927cd3..00000000 --- a/docs/apis/public/ProjectDefaultValuesCcsProject.md +++ /dev/null @@ -1,12 +0,0 @@ -# ProjectDefaultValuesCcsProject - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**collection_name** | **str** | | [optional] -**name** | **str** | | -**proj_key** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectDefaultValuesDataflow.md b/docs/apis/public/ProjectDefaultValuesDataflow.md deleted file mode 100644 index baf8a67f..00000000 --- a/docs/apis/public/ProjectDefaultValuesDataflow.md +++ /dev/null @@ -1,11 +0,0 @@ -# ProjectDefaultValuesDataflow - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**df_tpl_key** | **str** | | -**name** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectFlavourTotalKgs.md b/docs/apis/public/ProjectFlavourTotalKgs.md deleted file mode 100644 index 6677e918..00000000 --- a/docs/apis/public/ProjectFlavourTotalKgs.md +++ /dev/null @@ -1,12 +0,0 @@ -# ProjectFlavourTotalKgs - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**flavour_name** | **str** | | -**proj_key** | **str** | | -**total_kgs** | **int** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectFlavours.md b/docs/apis/public/ProjectFlavours.md deleted file mode 100644 index 8bfb59c0..00000000 --- a/docs/apis/public/ProjectFlavours.md +++ /dev/null @@ -1,11 +0,0 @@ -# ProjectFlavours - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**flavours** | [**list[BagFlavourFullData]**](BagFlavourFullData.md) | | -**proj_key** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectPackageInstalationManifest.md b/docs/apis/public/ProjectPackageInstalationManifest.md deleted file mode 100644 index 3cf693f7..00000000 --- a/docs/apis/public/ProjectPackageInstalationManifest.md +++ /dev/null @@ -1,10 +0,0 @@ -# ProjectPackageInstalationManifest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**packages** | [**list[ProjectProjKeyPackagesPackages]**](ProjectProjKeyPackagesPackages.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectProjKeyAnnotateDocumentReportDocument.md b/docs/apis/public/ProjectProjKeyAnnotateDocumentReportDocument.md deleted file mode 100644 index 6f229df8..00000000 --- a/docs/apis/public/ProjectProjKeyAnnotateDocumentReportDocument.md +++ /dev/null @@ -1,11 +0,0 @@ -# ProjectProjKeyAnnotateDocumentReportDocument - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**input_scratch_id** | **str** | | -**output_scratch_id** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectProjKeyAnnotateDocumentReportReport.md b/docs/apis/public/ProjectProjKeyAnnotateDocumentReportReport.md deleted file mode 100644 index f3536c1e..00000000 --- a/docs/apis/public/ProjectProjKeyAnnotateDocumentReportReport.md +++ /dev/null @@ -1,11 +0,0 @@ -# ProjectProjKeyAnnotateDocumentReportReport - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | **str** | | [optional] -**review_consent** | **bool** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlow.md b/docs/apis/public/ProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlow.md deleted file mode 100644 index f03c4a33..00000000 --- a/docs/apis/public/ProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlow.md +++ /dev/null @@ -1,12 +0,0 @@ -# ProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlow - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**render_options** | [**ProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlowRenderOptions**](ProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlowRenderOptions.md) | | [optional] -**template** | **str** | | [optional] -**variables** | [**object**](.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlowRenderOptions.md b/docs/apis/public/ProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlowRenderOptions.md deleted file mode 100644 index e4a5ecf1..00000000 --- a/docs/apis/public/ProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlowRenderOptions.md +++ /dev/null @@ -1,11 +0,0 @@ -# ProjectProjKeyBagsBagKeyTasksAssembleDataflowDataFlowRenderOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**target_bag** | [**object**](.md) | | [optional] -**variables** | [**object**](.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectProjKeyBagsBagKeyTasksExportDatasetInfo.md b/docs/apis/public/ProjectProjKeyBagsBagKeyTasksExportDatasetInfo.md deleted file mode 100644 index 5c1e809e..00000000 --- a/docs/apis/public/ProjectProjKeyBagsBagKeyTasksExportDatasetInfo.md +++ /dev/null @@ -1,14 +0,0 @@ -# ProjectProjKeyBagsBagKeyTasksExportDatasetInfo - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**collection_key** | **str** | | [optional] -**coords** | [**ProjectProjKeyBagsBagKeyTasksExportDatasetInfoCoords**](ProjectProjKeyBagsBagKeyTasksExportDatasetInfoCoords.md) | | -**include_s3_data** | **bool** | | [optional] [default to False] -**node_list** | [**list[ProjectProjKeyBagsBagKeyTasksExportDatasetInfoNodeList]**](ProjectProjKeyBagsBagKeyTasksExportDatasetInfoNodeList.md) | | [optional] -**projection** | [**object**](.md) | A dict specifying the fields to include or exclude. Use a dict to exclude fields from the result (e.g. projection={'main-text': false}). | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectProjKeyBagsBagKeyTasksExportDatasetInfoCoords.md b/docs/apis/public/ProjectProjKeyBagsBagKeyTasksExportDatasetInfoCoords.md deleted file mode 100644 index f62aa205..00000000 --- a/docs/apis/public/ProjectProjKeyBagsBagKeyTasksExportDatasetInfoCoords.md +++ /dev/null @@ -1,11 +0,0 @@ -# ProjectProjKeyBagsBagKeyTasksExportDatasetInfoCoords - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**databases** | [**object**](.md) | | -**node_collection** | [**ProjectProjKeyBagsBagKeyTasksExportDatasetInfoCoordsNodeCollection**](ProjectProjKeyBagsBagKeyTasksExportDatasetInfoCoordsNodeCollection.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectProjKeyBagsBagKeyTasksExportDatasetInfoCoordsNodeCollection.md b/docs/apis/public/ProjectProjKeyBagsBagKeyTasksExportDatasetInfoCoordsNodeCollection.md deleted file mode 100644 index d7688c04..00000000 --- a/docs/apis/public/ProjectProjKeyBagsBagKeyTasksExportDatasetInfoCoordsNodeCollection.md +++ /dev/null @@ -1,13 +0,0 @@ -# ProjectProjKeyBagsBagKeyTasksExportDatasetInfoCoordsNodeCollection - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**collection** | **str** | | -**collection_name_prefix** | **str** | | -**database** | **str** | | -**uri** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectProjKeyBagsBagKeyTasksExportDatasetInfoNodeList.md b/docs/apis/public/ProjectProjKeyBagsBagKeyTasksExportDatasetInfoNodeList.md deleted file mode 100644 index 61961962..00000000 --- a/docs/apis/public/ProjectProjKeyBagsBagKeyTasksExportDatasetInfoNodeList.md +++ /dev/null @@ -1,11 +0,0 @@ -# ProjectProjKeyBagsBagKeyTasksExportDatasetInfoNodeList - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**db** | **str** | | -**id** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectProjKeyBagsBagKeyTasksSuspendSnapshot.md b/docs/apis/public/ProjectProjKeyBagsBagKeyTasksSuspendSnapshot.md deleted file mode 100644 index af9decd5..00000000 --- a/docs/apis/public/ProjectProjKeyBagsBagKeyTasksSuspendSnapshot.md +++ /dev/null @@ -1,10 +0,0 @@ -# ProjectProjKeyBagsBagKeyTasksSuspendSnapshot - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcs.md b/docs/apis/public/ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcs.md deleted file mode 100644 index 82282f3e..00000000 --- a/docs/apis/public/ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcs.md +++ /dev/null @@ -1,14 +0,0 @@ -# ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcs - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**auth_token** | **str** | | [optional] -**export_package_mongo_options** | [**ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptions**](ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptions.md) | | [optional] -**proj_key** | **str** | | -**source_collection_name** | **str** | | [optional] -**url** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptions.md b/docs/apis/public/ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptions.md deleted file mode 100644 index 72d9239a..00000000 --- a/docs/apis/public/ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptions.md +++ /dev/null @@ -1,13 +0,0 @@ -# ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**assemble_options** | [**ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsAssembleOptions**](ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsAssembleOptions.md) | | -**incremental** | **bool** | | -**inputs** | [**ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsInputs**](ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsInputs.md) | | [optional] -**package_options** | [**ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsPackageOptions**](ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsPackageOptions.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsAssembleOptions.md b/docs/apis/public/ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsAssembleOptions.md deleted file mode 100644 index e83c0958..00000000 --- a/docs/apis/public/ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsAssembleOptions.md +++ /dev/null @@ -1,11 +0,0 @@ -# ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsAssembleOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**mode** | [**ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsAssembleOptionsMode**](ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsAssembleOptionsMode.md) | | -**options** | [**ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsAssembleOptionsOptions**](ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsAssembleOptionsOptions.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsAssembleOptionsMode.md b/docs/apis/public/ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsAssembleOptionsMode.md deleted file mode 100644 index 6b2db980..00000000 --- a/docs/apis/public/ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsAssembleOptionsMode.md +++ /dev/null @@ -1,11 +0,0 @@ -# ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsAssembleOptionsMode - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**page_elements** | **list[str]** | Which type of annotations to filter for the page elements: H (human annotations), M (model generated) | -**tables** | **list[str]** | Which type of annotations to filter for the tables: H (human annotations), M (model generated) | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsAssembleOptionsOptions.md b/docs/apis/public/ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsAssembleOptionsOptions.md deleted file mode 100644 index dbafda64..00000000 --- a/docs/apis/public/ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsAssembleOptionsOptions.md +++ /dev/null @@ -1,10 +0,0 @@ -# ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsAssembleOptionsOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**include_incomplete_documents** | **bool** | Include documents with missing pages? (e.g. no annotations for some pages) | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsInputs.md b/docs/apis/public/ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsInputs.md deleted file mode 100644 index 3246d2df..00000000 --- a/docs/apis/public/ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsInputs.md +++ /dev/null @@ -1,10 +0,0 @@ -# ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsInputs - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**document_hashes** | **list[str]** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsPackageOptions.md b/docs/apis/public/ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsPackageOptions.md deleted file mode 100644 index 1431be6b..00000000 --- a/docs/apis/public/ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsPackageOptions.md +++ /dev/null @@ -1,11 +0,0 @@ -# ProjectProjKeyDataCataloguesDcKeyCollectionsCollectionNameActionsImportCcsExportPackageMongoOptionsPackageOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**match_mode** | **str** | | [optional] [default to 'document_hash'] -**redirect_keys_to_s3** | **list[str]** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectProjKeyDataCataloguesFromMongoOptions.md b/docs/apis/public/ProjectProjKeyDataCataloguesFromMongoOptions.md deleted file mode 100644 index 8547b629..00000000 --- a/docs/apis/public/ProjectProjKeyDataCataloguesFromMongoOptions.md +++ /dev/null @@ -1,10 +0,0 @@ -# ProjectProjKeyDataCataloguesFromMongoOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**coordinates** | [**MongoS3CoordinatesWithCollectionList**](MongoS3CoordinatesWithCollectionList.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectProjKeyDataCataloguesFromMongoTarget.md b/docs/apis/public/ProjectProjKeyDataCataloguesFromMongoTarget.md deleted file mode 100644 index 8369654c..00000000 --- a/docs/apis/public/ProjectProjKeyDataCataloguesFromMongoTarget.md +++ /dev/null @@ -1,12 +0,0 @@ -# ProjectProjKeyDataCataloguesFromMongoTarget - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | **str** | | -**name** | **str** | | -**public** | **bool** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectProjKeyDataCataloguesFromUrlOptions.md b/docs/apis/public/ProjectProjKeyDataCataloguesFromUrlOptions.md deleted file mode 100644 index a68648e7..00000000 --- a/docs/apis/public/ProjectProjKeyDataCataloguesFromUrlOptions.md +++ /dev/null @@ -1,10 +0,0 @@ -# ProjectProjKeyDataCataloguesFromUrlOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**url** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectProjKeyDataIndicesIndexKeyActionsCcsConvertUploadS3Source.md b/docs/apis/public/ProjectProjKeyDataIndicesIndexKeyActionsCcsConvertUploadS3Source.md deleted file mode 100644 index 41054b02..00000000 --- a/docs/apis/public/ProjectProjKeyDataIndicesIndexKeyActionsCcsConvertUploadS3Source.md +++ /dev/null @@ -1,12 +0,0 @@ -# ProjectProjKeyDataIndicesIndexKeyActionsCcsConvertUploadS3Source - -Coordinates to object store to get files to convert. Can specify which files with object keys. -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**coordinates** | [**ProjectDataIndexS3Coordinates**](ProjectDataIndexS3Coordinates.md) | | [optional] -**object_keys** | **list[str]** | List of s3 object keys to retrieve from bucket to be converted and uploaded to the data index | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectProjKeyDictionariesFromMongoTarget.md b/docs/apis/public/ProjectProjKeyDictionariesFromMongoTarget.md deleted file mode 100644 index c07fb23d..00000000 --- a/docs/apis/public/ProjectProjKeyDictionariesFromMongoTarget.md +++ /dev/null @@ -1,12 +0,0 @@ -# ProjectProjKeyDictionariesFromMongoTarget - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | **str** | | -**name** | **str** | | -**public** | **bool** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectProjKeyKgcDataflowTemplatesDebugDfTplKeyTargetBag.md b/docs/apis/public/ProjectProjKeyKgcDataflowTemplatesDebugDfTplKeyTargetBag.md deleted file mode 100644 index e6d52966..00000000 --- a/docs/apis/public/ProjectProjKeyKgcDataflowTemplatesDebugDfTplKeyTargetBag.md +++ /dev/null @@ -1,11 +0,0 @@ -# ProjectProjKeyKgcDataflowTemplatesDebugDfTplKeyTargetBag - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**bag_key** | **str** | | -**proj_key** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectProjKeyKgcDataflowTemplatesDfTplKeyActionsLoadRender.md b/docs/apis/public/ProjectProjKeyKgcDataflowTemplatesDfTplKeyActionsLoadRender.md deleted file mode 100644 index 4720b35d..00000000 --- a/docs/apis/public/ProjectProjKeyKgcDataflowTemplatesDfTplKeyActionsLoadRender.md +++ /dev/null @@ -1,11 +0,0 @@ -# ProjectProjKeyKgcDataflowTemplatesDfTplKeyActionsLoadRender - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**target_bag** | [**ProjectProjKeyKgcDataflowTemplatesDfTplKeyActionsLoadRenderTargetBag**](ProjectProjKeyKgcDataflowTemplatesDfTplKeyActionsLoadRenderTargetBag.md) | | -**variables** | **dict(str, object)** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectProjKeyKgcDataflowTemplatesDfTplKeyActionsLoadRenderTargetBag.md b/docs/apis/public/ProjectProjKeyKgcDataflowTemplatesDfTplKeyActionsLoadRenderTargetBag.md deleted file mode 100644 index a3d7e30f..00000000 --- a/docs/apis/public/ProjectProjKeyKgcDataflowTemplatesDfTplKeyActionsLoadRenderTargetBag.md +++ /dev/null @@ -1,11 +0,0 @@ -# ProjectProjKeyKgcDataflowTemplatesDfTplKeyActionsLoadRenderTargetBag - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**bag_key** | **str** | | -**proj_key** | **str** | If set, this will override the 'proj_key' parameter in the path, allowing cross-project KGs to be used. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectProjKeyKgcDataflowTemplatesDfTplKeyActionsLoadTarget.md b/docs/apis/public/ProjectProjKeyKgcDataflowTemplatesDfTplKeyActionsLoadTarget.md deleted file mode 100644 index 0b984d51..00000000 --- a/docs/apis/public/ProjectProjKeyKgcDataflowTemplatesDfTplKeyActionsLoadTarget.md +++ /dev/null @@ -1,10 +0,0 @@ -# ProjectProjKeyKgcDataflowTemplatesDfTplKeyActionsLoadTarget - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**save** | [**object**](.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectProjKeyKgcDataflowTemplatesVariables.md b/docs/apis/public/ProjectProjKeyKgcDataflowTemplatesVariables.md deleted file mode 100644 index a405d787..00000000 --- a/docs/apis/public/ProjectProjKeyKgcDataflowTemplatesVariables.md +++ /dev/null @@ -1,11 +0,0 @@ -# ProjectProjKeyKgcDataflowTemplatesVariables - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**default_value** | [**object**](.md) | | [optional] -**type** | [**DataFlowTemplateVariable**](DataFlowTemplateVariable.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectProjKeyKgcRawDataflowTemplatesActionsRunDataFlow.md b/docs/apis/public/ProjectProjKeyKgcRawDataflowTemplatesActionsRunDataFlow.md deleted file mode 100644 index a1754669..00000000 --- a/docs/apis/public/ProjectProjKeyKgcRawDataflowTemplatesActionsRunDataFlow.md +++ /dev/null @@ -1,11 +0,0 @@ -# ProjectProjKeyKgcRawDataflowTemplatesActionsRunDataFlow - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**template** | [**ProjectProjKeyKgcRawDataflowTemplatesActionsRunDataFlowTemplate**](ProjectProjKeyKgcRawDataflowTemplatesActionsRunDataFlowTemplate.md) | | -**variables** | **dict(str, object)** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectProjKeyKgcRawDataflowTemplatesActionsRunDataFlowTemplate.md b/docs/apis/public/ProjectProjKeyKgcRawDataflowTemplatesActionsRunDataFlowTemplate.md deleted file mode 100644 index aface6ef..00000000 --- a/docs/apis/public/ProjectProjKeyKgcRawDataflowTemplatesActionsRunDataFlowTemplate.md +++ /dev/null @@ -1,11 +0,0 @@ -# ProjectProjKeyKgcRawDataflowTemplatesActionsRunDataFlowTemplate - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**config** | [**object**](.md) | | -**data_flow** | **list[object]** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectProjKeyModelConfigsConfigurations.md b/docs/apis/public/ProjectProjKeyModelConfigsConfigurations.md deleted file mode 100644 index c874e95c..00000000 --- a/docs/apis/public/ProjectProjKeyModelConfigsConfigurations.md +++ /dev/null @@ -1,10 +0,0 @@ -# ProjectProjKeyModelConfigsConfigurations - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectProjKeyPackagesPackages.md b/docs/apis/public/ProjectProjKeyPackagesPackages.md deleted file mode 100644 index 94255ea2..00000000 --- a/docs/apis/public/ProjectProjKeyPackagesPackages.md +++ /dev/null @@ -1,11 +0,0 @@ -# ProjectProjKeyPackagesPackages - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**overrides** | [**object**](.md) | | [optional] -**package_id** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectTask.md b/docs/apis/public/ProjectTask.md deleted file mode 100644 index d54e624e..00000000 --- a/docs/apis/public/ProjectTask.md +++ /dev/null @@ -1,19 +0,0 @@ -# ProjectTask - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**completed_at** | **float** | | [optional] -**created_at** | **float** | | [optional] -**meta** | [**object**](.md) | | [optional] -**progress** | **float** | | [optional] -**proj_key** | **str** | | [optional] -**started_at** | **float** | | [optional] -**task_id** | **str** | | [optional] -**task_status** | **str** | | [optional] -**task_type** | **str** | | [optional] -**user_key** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectsFlavours.md b/docs/apis/public/ProjectsFlavours.md deleted file mode 100644 index c4ef2a31..00000000 --- a/docs/apis/public/ProjectsFlavours.md +++ /dev/null @@ -1,12 +0,0 @@ -# ProjectsFlavours - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**flavours** | [**list[ProjectsFlavoursFlavours]**](ProjectsFlavoursFlavours.md) | | -**name** | **str** | | -**proj_key** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectsFlavoursFlavours.md b/docs/apis/public/ProjectsFlavoursFlavours.md deleted file mode 100644 index 0b89c6cd..00000000 --- a/docs/apis/public/ProjectsFlavoursFlavours.md +++ /dev/null @@ -1,11 +0,0 @@ -# ProjectsFlavoursFlavours - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**display_name** | **str** | | [optional] -**name** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ProjectsFlavoursQuota.md b/docs/apis/public/ProjectsFlavoursQuota.md deleted file mode 100644 index d72a16c3..00000000 --- a/docs/apis/public/ProjectsFlavoursQuota.md +++ /dev/null @@ -1,12 +0,0 @@ -# ProjectsFlavoursQuota - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | | -**proj_key** | **str** | | -**quotas** | [**list[FlavoursQuota]**](FlavoursQuota.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/RelatedTask.md b/docs/apis/public/RelatedTask.md deleted file mode 100644 index 36282633..00000000 --- a/docs/apis/public/RelatedTask.md +++ /dev/null @@ -1,11 +0,0 @@ -# RelatedTask - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**task_id** | **str** | | -**task_type** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/RelationshipAnnotationColumn.md b/docs/apis/public/RelationshipAnnotationColumn.md deleted file mode 100644 index 46d6a362..00000000 --- a/docs/apis/public/RelationshipAnnotationColumn.md +++ /dev/null @@ -1,11 +0,0 @@ -# RelationshipAnnotationColumn - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**entities** | **list[str]** | | -**key** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/RelationshipAnnotationDescriptor.md b/docs/apis/public/RelationshipAnnotationDescriptor.md deleted file mode 100644 index 7160014b..00000000 --- a/docs/apis/public/RelationshipAnnotationDescriptor.md +++ /dev/null @@ -1,12 +0,0 @@ -# RelationshipAnnotationDescriptor - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**columns** | [**list[RelationshipAnnotationColumn]**](RelationshipAnnotationColumn.md) | | -**description** | **str** | | -**key** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/RenderDataFlowTemplateOptions.md b/docs/apis/public/RenderDataFlowTemplateOptions.md deleted file mode 100644 index bb4fd209..00000000 --- a/docs/apis/public/RenderDataFlowTemplateOptions.md +++ /dev/null @@ -1,11 +0,0 @@ -# RenderDataFlowTemplateOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**target_bag** | [**ProjectProjKeyKgcDataflowTemplatesDfTplKeyActionsLoadRenderTargetBag**](ProjectProjKeyKgcDataflowTemplatesDfTplKeyActionsLoadRenderTargetBag.md) | | -**variables** | **dict(str, object)** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/RestoreKnowledgeGraphBackupOptions.md b/docs/apis/public/RestoreKnowledgeGraphBackupOptions.md deleted file mode 100644 index 998bfa4d..00000000 --- a/docs/apis/public/RestoreKnowledgeGraphBackupOptions.md +++ /dev/null @@ -1,10 +0,0 @@ -# RestoreKnowledgeGraphBackupOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**coordinates** | [**S3CoordinatesWithBackupKey**](S3CoordinatesWithBackupKey.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/ResumeKnowledgeGraphOptions.md b/docs/apis/public/ResumeKnowledgeGraphOptions.md deleted file mode 100644 index e1af3d8b..00000000 --- a/docs/apis/public/ResumeKnowledgeGraphOptions.md +++ /dev/null @@ -1,11 +0,0 @@ -# ResumeKnowledgeGraphOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**reset** | **bool** | | [optional] -**snapshot_to_restore_id** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/RunDataFlowTemplateOptions.md b/docs/apis/public/RunDataFlowTemplateOptions.md deleted file mode 100644 index ac3481d0..00000000 --- a/docs/apis/public/RunDataFlowTemplateOptions.md +++ /dev/null @@ -1,11 +0,0 @@ -# RunDataFlowTemplateOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**target_bag_key** | **str** | | [optional] -**variables** | **dict(str, object)** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/RunDataFlowTemplateOptions1.md b/docs/apis/public/RunDataFlowTemplateOptions1.md deleted file mode 100644 index 6492c0a7..00000000 --- a/docs/apis/public/RunDataFlowTemplateOptions1.md +++ /dev/null @@ -1,12 +0,0 @@ -# RunDataFlowTemplateOptions1 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data_flow** | [**ProjectProjKeyKgcRawDataflowTemplatesActionsRunDataFlow**](ProjectProjKeyKgcRawDataflowTemplatesActionsRunDataFlow.md) | | -**log_task** | **bool** | | [default to True] -**variable_values** | **dict(str, object)** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/S3Coordinates.md b/docs/apis/public/S3Coordinates.md deleted file mode 100644 index 7c869b6b..00000000 --- a/docs/apis/public/S3Coordinates.md +++ /dev/null @@ -1,19 +0,0 @@ -# S3Coordinates - -If provided, the S3 data will be copied -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**access_key** | **str** | | -**bucket** | **str** | | -**host** | **str** | | -**key_prefix** | **str** | | -**location** | **str** | | -**port** | **int** | | -**secret_key** | **str** | | -**ssl** | **bool** | | -**verify_ssl** | **bool** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/S3CoordinatesWithBackupKey.md b/docs/apis/public/S3CoordinatesWithBackupKey.md deleted file mode 100644 index e25787c5..00000000 --- a/docs/apis/public/S3CoordinatesWithBackupKey.md +++ /dev/null @@ -1,19 +0,0 @@ -# S3CoordinatesWithBackupKey - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**access_key** | **str** | | [optional] -**backup_key** | **str** | | -**bucket** | **str** | | -**host** | **str** | | [optional] -**location** | **str** | | [optional] -**port** | **int** | | [optional] -**presigned** | [**S3CoordinatesWithBackupKeyPresigned**](S3CoordinatesWithBackupKeyPresigned.md) | | [optional] -**secret_key** | **str** | | [optional] -**ssl** | **bool** | | [optional] -**verify_ssl** | **bool** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/S3CoordinatesWithBackupKeyPresigned.md b/docs/apis/public/S3CoordinatesWithBackupKeyPresigned.md deleted file mode 100644 index 1b3d0922..00000000 --- a/docs/apis/public/S3CoordinatesWithBackupKeyPresigned.md +++ /dev/null @@ -1,11 +0,0 @@ -# S3CoordinatesWithBackupKeyPresigned - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**fields** | **dict(str, object)** | | -**url** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/SemanticApi.md b/docs/apis/public/SemanticApi.md deleted file mode 100644 index 8b2c85bf..00000000 --- a/docs/apis/public/SemanticApi.md +++ /dev/null @@ -1,168 +0,0 @@ -# deepsearch.cps.apis.public.SemanticApi - -All URIs are relative to *http://localhost/api/cps/public/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**ingest**](SemanticApi.md#ingest) | **POST** /project/{proj_key}/semantic/ingest | -[**ingest_documentqa**](SemanticApi.md#ingest_documentqa) | **POST** /project/{proj_key}/ingest/documentqa | - - -# **ingest** -> Task ingest(proj_key, body) - - - -Ingest documents and collections for RAG - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.SemanticApi(api_client) - proj_key = 'proj_key_example' # str | -body = deepsearch.cps.apis.public.SemanticIngestRequest() # SemanticIngestRequest | - - try: - api_response = api_instance.ingest(proj_key, body) - pprint(api_response) - except ApiException as e: - print("Exception when calling SemanticApi->ingest: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **body** | [**SemanticIngestRequest**](SemanticIngestRequest.md)| | - -### Return type - -[**Task**](Task.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **ingest_documentqa** -> Task ingest_documentqa(proj_key, body) - - - -Ingest a document for QA - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.SemanticApi(api_client) - proj_key = 'proj_key_example' # str | -body = deepsearch.cps.apis.public.IngestDocumentQARequest() # IngestDocumentQARequest | - - try: - api_response = api_instance.ingest_documentqa(proj_key, body) - pprint(api_response) - except ApiException as e: - print("Exception when calling SemanticApi->ingest_documentqa: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **body** | [**IngestDocumentQARequest**](IngestDocumentQARequest.md)| | - -### Return type - -[**Task**](Task.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/apis/public/SemanticIngestReqParams.md b/docs/apis/public/SemanticIngestReqParams.md deleted file mode 100644 index 4bacb6b9..00000000 --- a/docs/apis/public/SemanticIngestReqParams.md +++ /dev/null @@ -1,10 +0,0 @@ -# SemanticIngestReqParams - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**skip_ingested_docs** | **bool** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/SemanticIngestRequest.md b/docs/apis/public/SemanticIngestRequest.md deleted file mode 100644 index e78c90bb..00000000 --- a/docs/apis/public/SemanticIngestRequest.md +++ /dev/null @@ -1,11 +0,0 @@ -# SemanticIngestRequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**parameters** | [**SemanticIngestReqParams**](SemanticIngestReqParams.md) | | -**source** | [**object**](.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/StorageSummaryDC.md b/docs/apis/public/StorageSummaryDC.md deleted file mode 100644 index 74e5e1f3..00000000 --- a/docs/apis/public/StorageSummaryDC.md +++ /dev/null @@ -1,15 +0,0 @@ -# StorageSummaryDC - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**dc_key** | **str** | | -**name** | **str** | | -**size_bytes_db** | **float** | | -**size_bytes_s3** | **float** | | -**size_converted_db** | **str** | | -**size_converted_s3** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/StorageSummaryKG.md b/docs/apis/public/StorageSummaryKG.md deleted file mode 100644 index 2d83d6e3..00000000 --- a/docs/apis/public/StorageSummaryKG.md +++ /dev/null @@ -1,16 +0,0 @@ -# StorageSummaryKG - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**bag_key** | **str** | | -**categories_fraction** | [**list[StorageSummaryKGCategoriesFraction]**](StorageSummaryKGCategoriesFraction.md) | | -**name** | **str** | | -**size_bytes_db** | **float** | | -**size_bytes_s3** | **float** | | -**size_converted_db** | **str** | | -**size_converted_s3** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/StorageSummaryKGCategoriesFraction.md b/docs/apis/public/StorageSummaryKGCategoriesFraction.md deleted file mode 100644 index 50e71ff3..00000000 --- a/docs/apis/public/StorageSummaryKGCategoriesFraction.md +++ /dev/null @@ -1,14 +0,0 @@ -# StorageSummaryKGCategoriesFraction - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**color** | **str** | | [optional] -**name** | **str** | | -**percentage** | **float** | | -**size_bytes_db** | **float** | | -**size_converted_db** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/StorageSummaryTask.md b/docs/apis/public/StorageSummaryTask.md deleted file mode 100644 index 143491bd..00000000 --- a/docs/apis/public/StorageSummaryTask.md +++ /dev/null @@ -1,14 +0,0 @@ -# StorageSummaryTask - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**dc_key** | **str** | | [optional] -**kg_key** | **str** | | [optional] -**kind** | **str** | | -**proj_key** | **str** | | -**task_id** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/SupportedAnnotatorAnnotations.md b/docs/apis/public/SupportedAnnotatorAnnotations.md deleted file mode 100644 index 5d0afd48..00000000 --- a/docs/apis/public/SupportedAnnotatorAnnotations.md +++ /dev/null @@ -1,12 +0,0 @@ -# SupportedAnnotatorAnnotations - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**entities** | [**list[EntityAnnotationDescriptor]**](EntityAnnotationDescriptor.md) | | -**relationships** | [**list[RelationshipAnnotationDescriptor]**](RelationshipAnnotationDescriptor.md) | | -**supported_object_types** | **list[str]** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/SuspendKnowledgeGraphOptions.md b/docs/apis/public/SuspendKnowledgeGraphOptions.md deleted file mode 100644 index b600c874..00000000 --- a/docs/apis/public/SuspendKnowledgeGraphOptions.md +++ /dev/null @@ -1,11 +0,0 @@ -# SuspendKnowledgeGraphOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**force** | **bool** | If true, the KG will be suspended even if it's busy | -**snapshot** | [**ProjectProjKeyBagsBagKeyTasksSuspendSnapshot**](ProjectProjKeyBagsBagKeyTasksSuspendSnapshot.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/SystemApi.md b/docs/apis/public/SystemApi.md deleted file mode 100644 index 46b7630e..00000000 --- a/docs/apis/public/SystemApi.md +++ /dev/null @@ -1,1790 +0,0 @@ -# deepsearch.cps.apis.public.SystemApi - -All URIs are relative to *http://localhost/api/cps/public/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**delete_flavour**](SystemApi.md#delete_flavour) | **DELETE** /system/admin/delete_flavour/{flavour_name} | -[**get_flavour**](SystemApi.md#get_flavour) | **GET** /system/admin/get_flavour/{flavour_name} | -[**get_flavours_default_quotas**](SystemApi.md#get_flavours_default_quotas) | **GET** /system/admin/get_flavours_default_quota | -[**get_project_flavour_total_kgs**](SystemApi.md#get_project_flavour_total_kgs) | **GET** /system/admin/get_project_flavour_total_kgs/{proj_key}/{flavour_name} | -[**get_project_flavours_quota**](SystemApi.md#get_project_flavours_quota) | **GET** /system/admin/get_project_flavours_quota/{proj_key} | -[**get_projects_flavours_quota**](SystemApi.md#get_projects_flavours_quota) | **GET** /system/admin/get_projects_flavours_quota | -[**get_system_information**](SystemApi.md#get_system_information) | **GET** /system/info | -[**get_system_modules_configuration**](SystemApi.md#get_system_modules_configuration) | **GET** /system/modules/configuration | -[**get_system_modules_tasks**](SystemApi.md#get_system_modules_tasks) | **GET** /system/modules/tasks | -[**get_version_report**](SystemApi.md#get_version_report) | **GET** /deployment/info | -[**list_all_flavours**](SystemApi.md#list_all_flavours) | **GET** /system/admin/list_all_flavours | -[**list_flavours_by_project**](SystemApi.md#list_flavours_by_project) | **GET** /system/admin/get_project_flavours/{proj_key} | -[**list_packages**](SystemApi.md#list_packages) | **GET** /system/packages | -[**list_projects_flavours**](SystemApi.md#list_projects_flavours) | **GET** /system/admin/list_projects_flavours | -[**list_system_knowledge_graphs**](SystemApi.md#list_system_knowledge_graphs) | **GET** /system/kgs | -[**save_flavour**](SystemApi.md#save_flavour) | **PUT** /system/admin/save_flavour | -[**save_flavours_default_quotas**](SystemApi.md#save_flavours_default_quotas) | **PUT** /system/admin/save_flavours_default_quota | -[**save_project_flavours**](SystemApi.md#save_project_flavours) | **PUT** /system/admin/save_project_flavours | -[**save_project_flavours_quota**](SystemApi.md#save_project_flavours_quota) | **PUT** /system/admin/save_project_flavours_quota | -[**system_get_all_dcs_admin**](SystemApi.md#system_get_all_dcs_admin) | **GET** /system/admin/get_all_dcs | -[**system_get_all_kgs_admin**](SystemApi.md#system_get_all_kgs_admin) | **GET** /system/admin/get_all_kgs | -[**system_get_cps_summary**](SystemApi.md#system_get_cps_summary) | **GET** /system/admin/summary | -[**system_get_dc_storage_summary_async**](SystemApi.md#system_get_dc_storage_summary_async) | **GET** /system/admin/dc_storage_summary/{dc_key} | -[**system_get_kg_storage_summary_async**](SystemApi.md#system_get_kg_storage_summary_async) | **GET** /system/admin/kg_storage_summary/{kg_key} | - - -# **delete_flavour** -> delete_flavour(flavour_name) - - - -Delete flavour from db - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.SystemApi(api_client) - flavour_name = 'flavour_name_example' # str | - - try: - api_instance.delete_flavour(flavour_name) - except ApiException as e: - print("Exception when calling SystemApi->delete_flavour: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **flavour_name** | **str**| | - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Deleted flavour successful | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_flavour** -> BagFlavourFullData get_flavour(flavour_name) - - - -Get flavour from db - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.SystemApi(api_client) - flavour_name = 'flavour_name_example' # str | - - try: - api_response = api_instance.get_flavour(flavour_name) - pprint(api_response) - except ApiException as e: - print("Exception when calling SystemApi->get_flavour: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **flavour_name** | **str**| | - -### Return type - -[**BagFlavourFullData**](BagFlavourFullData.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Get flavour successful | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_flavours_default_quotas** -> list[BagFlavourDefaultQuota] get_flavours_default_quotas() - - - -Get flavours default values - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.SystemApi(api_client) - - try: - api_response = api_instance.get_flavours_default_quotas() - pprint(api_response) - except ApiException as e: - print("Exception when calling SystemApi->get_flavours_default_quotas: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -[**list[BagFlavourDefaultQuota]**](BagFlavourDefaultQuota.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Flavours default values | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_project_flavour_total_kgs** -> ProjectFlavourTotalKgs get_project_flavour_total_kgs(proj_key, flavour_name) - - - -Gets kg total number by proj_key and flavour_key - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.SystemApi(api_client) - proj_key = 'proj_key_example' # str | -flavour_name = 'flavour_name_example' # str | - - try: - api_response = api_instance.get_project_flavour_total_kgs(proj_key, flavour_name) - pprint(api_response) - except ApiException as e: - print("Exception when calling SystemApi->get_project_flavour_total_kgs: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **flavour_name** | **str**| | - -### Return type - -[**ProjectFlavourTotalKgs**](ProjectFlavourTotalKgs.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Project flavours total kg number | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_project_flavours_quota** -> list[FlavoursQuota] get_project_flavours_quota(proj_key) - - - -Get project flavours quota - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.SystemApi(api_client) - proj_key = 'proj_key_example' # str | - - try: - api_response = api_instance.get_project_flavours_quota(proj_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling SystemApi->get_project_flavours_quota: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - -### Return type - -[**list[FlavoursQuota]**](FlavoursQuota.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Project flavours quota | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_projects_flavours_quota** -> list[ProjectsFlavoursQuota] get_projects_flavours_quota() - - - -Get projects flavours quotas - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.SystemApi(api_client) - - try: - api_response = api_instance.get_projects_flavours_quota() - pprint(api_response) - except ApiException as e: - print("Exception when calling SystemApi->get_projects_flavours_quota: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -[**list[ProjectsFlavoursQuota]**](ProjectsFlavoursQuota.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Projects flavours quotas | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_system_information** -> SystemInfo get_system_information() - - - -Get system info - -### Example - -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient() as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.SystemApi(api_client) - - try: - api_response = api_instance.get_system_information() - pprint(api_response) - except ApiException as e: - print("Exception when calling SystemApi->get_system_information: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -[**SystemInfo**](SystemInfo.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**201** | OK | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_system_modules_configuration** -> SystemModulesConfiguration get_system_modules_configuration() - - - -Get modules configuration - -### Example - -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient() as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.SystemApi(api_client) - - try: - api_response = api_instance.get_system_modules_configuration() - pprint(api_response) - except ApiException as e: - print("Exception when calling SystemApi->get_system_modules_configuration: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -[**SystemModulesConfiguration**](SystemModulesConfiguration.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**201** | Modules configuration | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_system_modules_tasks** -> SystemModulesTasks get_system_modules_tasks() - - - -Get modules tasks - -### Example - -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient() as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.SystemApi(api_client) - - try: - api_response = api_instance.get_system_modules_tasks() - pprint(api_response) - except ApiException as e: - print("Exception when calling SystemApi->get_system_modules_tasks: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -[**SystemModulesTasks**](SystemModulesTasks.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**201** | Modules tasks | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_version_report** -> get_version_report() - - - -Get deployment version report - -### Example - -* Api Key Authentication (ManagementKey): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: ManagementKey -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.SystemApi(api_client) - - try: - api_instance.get_version_report() - except ApiException as e: - print("Exception when calling SystemApi->get_version_report: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -void (empty response body) - -### Authorization - -[ManagementKey](../README.md#ManagementKey) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Authentication failed, management api token is invalid or doesn't match | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_all_flavours** -> list[BagFlavourFullData] list_all_flavours() - - - -Get all KG flavours storage on db - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.SystemApi(api_client) - - try: - api_response = api_instance.list_all_flavours() - pprint(api_response) - except ApiException as e: - print("Exception when calling SystemApi->list_all_flavours: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -[**list[BagFlavourFullData]**](BagFlavourFullData.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Flavours storage on db | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_flavours_by_project** -> ProjectFlavours list_flavours_by_project(proj_key) - - - -Get project assignment flavours - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.SystemApi(api_client) - proj_key = 'proj_key_example' # str | - - try: - api_response = api_instance.list_flavours_by_project(proj_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling SystemApi->list_flavours_by_project: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - -### Return type - -[**ProjectFlavours**](ProjectFlavours.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Ok | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_packages** -> list[CpsPackage] list_packages() - - - -Get packages available in this CPS installation for installing in a project. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.SystemApi(api_client) - - try: - api_response = api_instance.list_packages() - pprint(api_response) - except ApiException as e: - print("Exception when calling SystemApi->list_packages: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -[**list[CpsPackage]**](CpsPackage.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Packages available to this CPS installation | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_projects_flavours** -> list[ProjectsFlavours] list_projects_flavours() - - - -Get all projects and their flavours - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.SystemApi(api_client) - - try: - api_response = api_instance.list_projects_flavours() - pprint(api_response) - except ApiException as e: - print("Exception when calling SystemApi->list_projects_flavours: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -[**list[ProjectsFlavours]**](ProjectsFlavours.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Flavours storage on db | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_system_knowledge_graphs** -> list[KnowledgeGraphSystemInformation] list_system_knowledge_graphs(proj_key=proj_key, term=term) - - - -List all Knowledge Graphs in the system - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.SystemApi(api_client) - proj_key = 'proj_key_example' # str | (optional) -term = 'term_example' # str | (optional) - - try: - api_response = api_instance.list_system_knowledge_graphs(proj_key=proj_key, term=term) - pprint(api_response) - except ApiException as e: - print("Exception when calling SystemApi->list_system_knowledge_graphs: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | [optional] - **term** | **str**| | [optional] - -### Return type - -[**list[KnowledgeGraphSystemInformation]**](KnowledgeGraphSystemInformation.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**0** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **save_flavour** -> save_flavour(new_flavour, body) - - - -Save flavour on db - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.SystemApi(api_client) - new_flavour = True # bool | -body = deepsearch.cps.apis.public.BagFlavourFullData() # BagFlavourFullData | - - try: - api_instance.save_flavour(new_flavour, body) - except ApiException as e: - print("Exception when calling SystemApi->save_flavour: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **new_flavour** | **bool**| | - **body** | [**BagFlavourFullData**](BagFlavourFullData.md)| | - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Save flavour successful | - | -**409** | Flavour name already taken | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **save_flavours_default_quotas** -> list[BagFlavourDefaultQuota] save_flavours_default_quotas(flavours) - - - -Save flavours default quota - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.SystemApi(api_client) - flavours = [deepsearch.cps.apis.public.BagFlavourDefaultQuota()] # list[BagFlavourDefaultQuota] | - - try: - api_response = api_instance.save_flavours_default_quotas(flavours) - pprint(api_response) - except ApiException as e: - print("Exception when calling SystemApi->save_flavours_default_quotas: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **flavours** | [**list[BagFlavourDefaultQuota]**](BagFlavourDefaultQuota.md)| | - -### Return type - -[**list[BagFlavourDefaultQuota]**](BagFlavourDefaultQuota.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Save flavours default quotas successful | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **save_project_flavours** -> save_project_flavours(body) - - - -Save project flavours assignment on db - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.SystemApi(api_client) - body = deepsearch.cps.apis.public.ProjectsFlavours() # ProjectsFlavours | - - try: - api_instance.save_project_flavours(body) - except ApiException as e: - print("Exception when calling SystemApi->save_project_flavours: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | [**ProjectsFlavours**](ProjectsFlavours.md)| | - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Save project flavours successful | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **save_project_flavours_quota** -> save_project_flavours_quota(projects_flavours_quotas) - - - -Save project flavours quota - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.SystemApi(api_client) - projects_flavours_quotas = deepsearch.cps.apis.public.ProjectsFlavoursQuota() # ProjectsFlavoursQuota | - - try: - api_instance.save_project_flavours_quota(projects_flavours_quotas) - except ApiException as e: - print("Exception when calling SystemApi->save_project_flavours_quota: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **projects_flavours_quotas** | [**ProjectsFlavoursQuota**](ProjectsFlavoursQuota.md)| | - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Save project flavours quota successful | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **system_get_all_dcs_admin** -> list[str] system_get_all_dcs_admin() - - - -Get all data catalogs (only dc_key) for admin use - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.SystemApi(api_client) - - try: - api_response = api_instance.system_get_all_dcs_admin() - pprint(api_response) - except ApiException as e: - print("Exception when calling SystemApi->system_get_all_dcs_admin: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -**list[str]** - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Array with all dcs's key | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **system_get_all_kgs_admin** -> list[str] system_get_all_kgs_admin() - - - -Get all kgs (only bag_key) for admin use - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.SystemApi(api_client) - - try: - api_response = api_instance.system_get_all_kgs_admin() - pprint(api_response) - except ApiException as e: - print("Exception when calling SystemApi->system_get_all_kgs_admin: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -**list[str]** - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Array with all kgs's key | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **system_get_cps_summary** -> list[InlineResponse2003] system_get_cps_summary() - - - -Get cps summary data. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.SystemApi(api_client) - - try: - api_response = api_instance.system_get_cps_summary() - pprint(api_response) - except ApiException as e: - print("Exception when calling SystemApi->system_get_cps_summary: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -[**list[InlineResponse2003]**](InlineResponse2003.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Cps summary | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **system_get_dc_storage_summary_async** -> StorageSummaryTask system_get_dc_storage_summary_async(dc_key) - - - -Get dc storage summary - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.SystemApi(api_client) - dc_key = 'dc_key_example' # str | Data catalog key - - try: - api_response = api_instance.system_get_dc_storage_summary_async(dc_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling SystemApi->system_get_dc_storage_summary_async: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **dc_key** | **str**| Data catalog key | - -### Return type - -[**StorageSummaryTask**](StorageSummaryTask.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | DC storage summary | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **system_get_kg_storage_summary_async** -> StorageSummaryTask system_get_kg_storage_summary_async(kg_key) - - - -Get kg storage summary - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.SystemApi(api_client) - kg_key = 'kg_key_example' # str | Knowledge graph key - - try: - api_response = api_instance.system_get_kg_storage_summary_async(kg_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling SystemApi->system_get_kg_storage_summary_async: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **kg_key** | **str**| Knowledge graph key | - -### Return type - -[**StorageSummaryTask**](StorageSummaryTask.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Kg storage summary | - | -**500** | Error occured on the server | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/apis/public/SystemCeleryTasksFailureFailures.md b/docs/apis/public/SystemCeleryTasksFailureFailures.md deleted file mode 100644 index 0b92c17a..00000000 --- a/docs/apis/public/SystemCeleryTasksFailureFailures.md +++ /dev/null @@ -1,13 +0,0 @@ -# SystemCeleryTasksFailureFailures - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**logs** | **dict(str, object)** | | [optional] -**meta** | **dict(str, object)** | | [optional] -**task_id** | **str** | | [optional] -**worker_name** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/SystemInfo.md b/docs/apis/public/SystemInfo.md deleted file mode 100644 index d76a3b99..00000000 --- a/docs/apis/public/SystemInfo.md +++ /dev/null @@ -1,13 +0,0 @@ -# SystemInfo - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**allow_non_admins_to_make_resources_public** | **bool** | | [optional] -**api** | [**SystemInfoApi**](SystemInfoApi.md) | | [optional] -**deployment** | [**SystemInfoDeployment**](SystemInfoDeployment.md) | | [optional] -**toolkit** | [**SystemInfoToolkit**](SystemInfoToolkit.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/SystemInfoApi.md b/docs/apis/public/SystemInfoApi.md deleted file mode 100644 index 413682db..00000000 --- a/docs/apis/public/SystemInfoApi.md +++ /dev/null @@ -1,12 +0,0 @@ -# SystemInfoApi - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**build_date** | **int** | | [optional] -**commit_hash** | **str** | | [optional] -**version** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/SystemInfoDeployment.md b/docs/apis/public/SystemInfoDeployment.md deleted file mode 100644 index d7f1926b..00000000 --- a/docs/apis/public/SystemInfoDeployment.md +++ /dev/null @@ -1,14 +0,0 @@ -# SystemInfoDeployment - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**disable_kg_actions** | **bool** | | [optional] -**disclaimer** | **str** | | [optional] -**linked_ccs_api** | [**SystemInfoDeploymentLinkedCcsApi**](SystemInfoDeploymentLinkedCcsApi.md) | | [optional] -**name** | **str** | | [optional] -**should_show_warning** | **bool** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/SystemInfoDeploymentLinkedCcsApi.md b/docs/apis/public/SystemInfoDeploymentLinkedCcsApi.md deleted file mode 100644 index 868c6073..00000000 --- a/docs/apis/public/SystemInfoDeploymentLinkedCcsApi.md +++ /dev/null @@ -1,11 +0,0 @@ -# SystemInfoDeploymentLinkedCcsApi - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**project_sync** | **bool** | | [optional] -**uri** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/SystemInfoToolkit.md b/docs/apis/public/SystemInfoToolkit.md deleted file mode 100644 index 156a772b..00000000 --- a/docs/apis/public/SystemInfoToolkit.md +++ /dev/null @@ -1,14 +0,0 @@ -# SystemInfoToolkit - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**cli_command** | **str** | | [optional] -**host** | **str** | | [optional] -**name** | **str** | | [optional] -**required_version** | **str** | | [optional] -**verify_ssl** | **bool** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/SystemKgsBackend.md b/docs/apis/public/SystemKgsBackend.md deleted file mode 100644 index e733ca8f..00000000 --- a/docs/apis/public/SystemKgsBackend.md +++ /dev/null @@ -1,11 +0,0 @@ -# SystemKgsBackend - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**deployment** | [**SystemKgsDeployment**](SystemKgsDeployment.md) | | [optional] -**flavour** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/SystemKgsDeployment.md b/docs/apis/public/SystemKgsDeployment.md deleted file mode 100644 index b575c7b3..00000000 --- a/docs/apis/public/SystemKgsDeployment.md +++ /dev/null @@ -1,13 +0,0 @@ -# SystemKgsDeployment - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**chart** | **str** | | [optional] -**flavour** | **str** | | [optional] -**name** | **str** | | [optional] -**resources** | [**dict(str, SystemKgsDeploymentResources)**](SystemKgsDeploymentResources.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/SystemKgsDeploymentResources.md b/docs/apis/public/SystemKgsDeploymentResources.md deleted file mode 100644 index 37d8a754..00000000 --- a/docs/apis/public/SystemKgsDeploymentResources.md +++ /dev/null @@ -1,11 +0,0 @@ -# SystemKgsDeploymentResources - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**limits** | [**object**](.md) | | [optional] -**requests** | [**object**](.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/SystemModulesConfiguration.md b/docs/apis/public/SystemModulesConfiguration.md deleted file mode 100644 index 672613dd..00000000 --- a/docs/apis/public/SystemModulesConfiguration.md +++ /dev/null @@ -1,12 +0,0 @@ -# SystemModulesConfiguration - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**df_template_variables** | [**list[WellKnownDfTemplateVariable]**](WellKnownDfTemplateVariable.md) | | -**linked_ccs_instances** | [**list[LinkedCcsInstances]**](LinkedCcsInstances.md) | | -**linked_elastic_instances** | [**list[LinkedCcsInstances]**](LinkedCcsInstances.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/SystemModulesTasks.md b/docs/apis/public/SystemModulesTasks.md deleted file mode 100644 index 44652789..00000000 --- a/docs/apis/public/SystemModulesTasks.md +++ /dev/null @@ -1,10 +0,0 @@ -# SystemModulesTasks - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**tasks** | [**dict(str, SystemModulesTasksTasks)**](SystemModulesTasksTasks.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/SystemModulesTasksTasks.md b/docs/apis/public/SystemModulesTasksTasks.md deleted file mode 100644 index 327168fb..00000000 --- a/docs/apis/public/SystemModulesTasksTasks.md +++ /dev/null @@ -1,10 +0,0 @@ -# SystemModulesTasksTasks - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**schema** | [**object**](.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/TakeSnapshotSettings.md b/docs/apis/public/TakeSnapshotSettings.md deleted file mode 100644 index a3a2c3d6..00000000 --- a/docs/apis/public/TakeSnapshotSettings.md +++ /dev/null @@ -1,12 +0,0 @@ -# TakeSnapshotSettings - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**flavour** | **str** | | -**load_into_kg_after_created** | **bool** | | [optional] [default to False] -**name** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/TakeSnapshotSettingsBackendAware.md b/docs/apis/public/TakeSnapshotSettingsBackendAware.md deleted file mode 100644 index 7f96d681..00000000 --- a/docs/apis/public/TakeSnapshotSettingsBackendAware.md +++ /dev/null @@ -1,12 +0,0 @@ -# TakeSnapshotSettingsBackendAware - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**backend_flavours** | [**BackendFlavour**](BackendFlavour.md) | | -**load_into_kg_after_created** | **bool** | | [optional] [default to False] -**name** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/Task.md b/docs/apis/public/Task.md deleted file mode 100644 index b28a47ac..00000000 --- a/docs/apis/public/Task.md +++ /dev/null @@ -1,16 +0,0 @@ -# Task - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**error_reason** | **str** | | -**kind** | **str** | | -**proj_key** | **str** | | -**related_tasks** | [**list[RelatedTask]**](RelatedTask.md) | | [optional] -**task_id** | **str** | | -**task_status** | **str** | | -**task_type** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/TasksApi.md b/docs/apis/public/TasksApi.md deleted file mode 100644 index 6d763798..00000000 --- a/docs/apis/public/TasksApi.md +++ /dev/null @@ -1,563 +0,0 @@ -# deepsearch.cps.apis.public.TasksApi - -All URIs are relative to *http://localhost/api/cps/public/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**abort_project_task**](TasksApi.md#abort_project_task) | **POST** /project/{proj_key}/tasks/{task_id}/actions/abort | -[**get_project_celery_task**](TasksApi.md#get_project_celery_task) | **GET** /project/{proj_key}/celery_tasks/{task_id} | -[**get_project_task**](TasksApi.md#get_project_task) | **GET** /project/{proj_key}/tasks/{task_id} | -[**list_failure_celery_tasks**](TasksApi.md#list_failure_celery_tasks) | **GET** /system/celery_tasks/failure | -[**list_project_tasks**](TasksApi.md#list_project_tasks) | **GET** /project/{proj_key}/tasks | -[**list_system_celery_tasks**](TasksApi.md#list_system_celery_tasks) | **GET** /system/celery_tasks/status | - - -# **abort_project_task** -> abort_project_task(proj_key, task_id) - - - -Abort a task. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.TasksApi(api_client) - proj_key = 'proj_key_example' # str | -task_id = 'task_id_example' # str | - - try: - api_instance.abort_project_task(proj_key, task_id) - except ApiException as e: - print("Exception when calling TasksApi->abort_project_task: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **task_id** | **str**| | - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | Task aborted. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_project_celery_task** -> CeleryTaskPromise get_project_celery_task(proj_key, task_id) - - - -Get a celery task for a project. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.TasksApi(api_client) - proj_key = 'proj_key_example' # str | -task_id = 'task_id_example' # str | - - try: - api_response = api_instance.get_project_celery_task(proj_key, task_id) - pprint(api_response) - except ApiException as e: - print("Exception when calling TasksApi->get_project_celery_task: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **task_id** | **str**| | - -### Return type - -[**CeleryTaskPromise**](CeleryTaskPromise.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Task | - | -**404** | Task not found. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_project_task** -> ProjectTask get_project_task(proj_key, task_id) - - - -Get a task for a project. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Configure API key authorization: KGAuth -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'X-CPS-KG-Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['X-CPS-KG-Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.TasksApi(api_client) - proj_key = 'proj_key_example' # str | -task_id = 'task_id_example' # str | - - try: - api_response = api_instance.get_project_task(proj_key, task_id) - pprint(api_response) - except ApiException as e: - print("Exception when calling TasksApi->get_project_task: %s\n" % e) -``` - -* Api Key Authentication (KGAuth): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Configure API key authorization: KGAuth -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'X-CPS-KG-Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['X-CPS-KG-Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.TasksApi(api_client) - proj_key = 'proj_key_example' # str | -task_id = 'task_id_example' # str | - - try: - api_response = api_instance.get_project_task(proj_key, task_id) - pprint(api_response) - except ApiException as e: - print("Exception when calling TasksApi->get_project_task: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **task_id** | **str**| | - -### Return type - -[**ProjectTask**](ProjectTask.md) - -### Authorization - -[Bearer](../README.md#Bearer), [KGAuth](../README.md#KGAuth) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Task | - | -**404** | Task not found. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_failure_celery_tasks** -> list[CeleryTask] list_failure_celery_tasks(proj_key, task_id) - - - -Get celery tasks that failed. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.TasksApi(api_client) - proj_key = 'proj_key_example' # str | -task_id = 'task_id_example' # str | - - try: - api_response = api_instance.list_failure_celery_tasks(proj_key, task_id) - pprint(api_response) - except ApiException as e: - print("Exception when calling TasksApi->list_failure_celery_tasks: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **task_id** | **str**| | - -### Return type - -[**list[CeleryTask]**](CeleryTask.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Celery tasks | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_project_tasks** -> list[ProjectTask] list_project_tasks(proj_key, task_type=task_type, limit=limit, skip=skip, sort_by=sort_by, sort_order=sort_order) - - - -List tasks for a project. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.TasksApi(api_client) - proj_key = 'proj_key_example' # str | -task_type = 'task_type_example' # str | (optional) -limit = 50 # int | (optional) (default to 50) -skip = 0 # int | (optional) (default to 0) -sort_by = 'sort_by_example' # str | (optional) -sort_order = 'asc' # str | (optional) (default to 'asc') - - try: - api_response = api_instance.list_project_tasks(proj_key, task_type=task_type, limit=limit, skip=skip, sort_by=sort_by, sort_order=sort_order) - pprint(api_response) - except ApiException as e: - print("Exception when calling TasksApi->list_project_tasks: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **task_type** | **str**| | [optional] - **limit** | **int**| | [optional] [default to 50] - **skip** | **int**| | [optional] [default to 0] - **sort_by** | **str**| | [optional] - **sort_order** | **str**| | [optional] [default to 'asc'] - -### Return type - -[**list[ProjectTask]**](ProjectTask.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | List of tasks. | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_system_celery_tasks** -> list[CeleryTask1] list_system_celery_tasks(proj_key=proj_key, project_task_id=project_task_id, started_since=started_since, task_status=task_status, limit=limit) - - - -Get the status of Celery tasks. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.TasksApi(api_client) - proj_key = 'proj_key_example' # str | (optional) -project_task_id = 'project_task_id_example' # str | (optional) -started_since = 3.4 # float | If set, return the tasks created at or after this timestamp. Otherwise, return the tasks created up to 60 minutes of the system's date, if `project_task_id` is not set. (optional) -task_status = 3.4 # float | (optional) -limit = 50 # int | (optional) (default to 50) - - try: - api_response = api_instance.list_system_celery_tasks(proj_key=proj_key, project_task_id=project_task_id, started_since=started_since, task_status=task_status, limit=limit) - pprint(api_response) - except ApiException as e: - print("Exception when calling TasksApi->list_system_celery_tasks: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | [optional] - **project_task_id** | **str**| | [optional] - **started_since** | **float**| If set, return the tasks created at or after this timestamp. Otherwise, return the tasks created up to 60 minutes of the system's date, if `project_task_id` is not set. | [optional] - **task_status** | **float**| | [optional] - **limit** | **int**| | [optional] [default to 50] - -### Return type - -[**list[CeleryTask1]**](CeleryTask1.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Celery tasks | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/apis/public/TemporaryUploadFileResult.md b/docs/apis/public/TemporaryUploadFileResult.md deleted file mode 100644 index 6f38699c..00000000 --- a/docs/apis/public/TemporaryUploadFileResult.md +++ /dev/null @@ -1,16 +0,0 @@ -# TemporaryUploadFileResult - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**download** | [**TemporaryUploadFileResultDownload**](TemporaryUploadFileResultDownload.md) | | -**download_private** | [**TemporaryUploadFileResultDownloadPrivate**](TemporaryUploadFileResultDownloadPrivate.md) | | -**id** | **str** | ID of the temporary file. | -**metadata** | [**TemporaryUploadFileResultMetadata**](TemporaryUploadFileResultMetadata.md) | | -**metadata_private** | [**TemporaryUploadFileResultMetadataPrivate**](TemporaryUploadFileResultMetadataPrivate.md) | | -**upload** | [**TemporaryUploadFileResultUpload**](TemporaryUploadFileResultUpload.md) | | -**upload_private** | [**TemporaryUploadFileResultUploadPrivate**](TemporaryUploadFileResultUploadPrivate.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/TemporaryUploadFileResultDownload.md b/docs/apis/public/TemporaryUploadFileResultDownload.md deleted file mode 100644 index 07dd97d9..00000000 --- a/docs/apis/public/TemporaryUploadFileResultDownload.md +++ /dev/null @@ -1,11 +0,0 @@ -# TemporaryUploadFileResultDownload - -URL to get the temporary file. -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**url** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/TemporaryUploadFileResultDownloadPrivate.md b/docs/apis/public/TemporaryUploadFileResultDownloadPrivate.md deleted file mode 100644 index d7d7609f..00000000 --- a/docs/apis/public/TemporaryUploadFileResultDownloadPrivate.md +++ /dev/null @@ -1,11 +0,0 @@ -# TemporaryUploadFileResultDownloadPrivate - -URL to get the temporary file. (private URL, usable within the infrastracture) -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**url** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/TemporaryUploadFileResultMetadata.md b/docs/apis/public/TemporaryUploadFileResultMetadata.md deleted file mode 100644 index bd7857d4..00000000 --- a/docs/apis/public/TemporaryUploadFileResultMetadata.md +++ /dev/null @@ -1,11 +0,0 @@ -# TemporaryUploadFileResultMetadata - -URL to metadata of the temporary file using the HEAD HTTP method. -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**url** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/TemporaryUploadFileResultMetadataPrivate.md b/docs/apis/public/TemporaryUploadFileResultMetadataPrivate.md deleted file mode 100644 index 2d07f6d9..00000000 --- a/docs/apis/public/TemporaryUploadFileResultMetadataPrivate.md +++ /dev/null @@ -1,11 +0,0 @@ -# TemporaryUploadFileResultMetadataPrivate - -URL to metadata of the temporary file using the HEAD HTTP method. (private URL, usable within the infrastracture) -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**url** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/TemporaryUploadFileResultUpload.md b/docs/apis/public/TemporaryUploadFileResultUpload.md deleted file mode 100644 index 9a5f9d42..00000000 --- a/docs/apis/public/TemporaryUploadFileResultUpload.md +++ /dev/null @@ -1,12 +0,0 @@ -# TemporaryUploadFileResultUpload - -URL to upload the temporary file. -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**fields** | [**object**](.md) | | [optional] -**url** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/TemporaryUploadFileResultUploadPrivate.md b/docs/apis/public/TemporaryUploadFileResultUploadPrivate.md deleted file mode 100644 index c04e38f5..00000000 --- a/docs/apis/public/TemporaryUploadFileResultUploadPrivate.md +++ /dev/null @@ -1,12 +0,0 @@ -# TemporaryUploadFileResultUploadPrivate - -URL to upload the temporary file. (private URL, usable within the infrastracture) -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**fields** | [**object**](.md) | | [optional] -**url** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/TokenResponse.md b/docs/apis/public/TokenResponse.md deleted file mode 100644 index ee5100e3..00000000 --- a/docs/apis/public/TokenResponse.md +++ /dev/null @@ -1,10 +0,0 @@ -# TokenResponse - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**token** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/Topology.md b/docs/apis/public/Topology.md deleted file mode 100644 index 2400668c..00000000 --- a/docs/apis/public/Topology.md +++ /dev/null @@ -1,11 +0,0 @@ -# Topology - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**categories** | [**list[TopologyNode]**](TopologyNode.md) | | -**edges** | [**list[TopologyEdge]**](TopologyEdge.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/TopologyEdge.md b/docs/apis/public/TopologyEdge.md deleted file mode 100644 index 23da19de..00000000 --- a/docs/apis/public/TopologyEdge.md +++ /dev/null @@ -1,12 +0,0 @@ -# TopologyEdge - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | | -**source** | **list[str]** | | -**target** | **list[str]** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/TopologyNode.md b/docs/apis/public/TopologyNode.md deleted file mode 100644 index a8a7e4aa..00000000 --- a/docs/apis/public/TopologyNode.md +++ /dev/null @@ -1,10 +0,0 @@ -# TopologyNode - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/UpdateDataFlowOptions.md b/docs/apis/public/UpdateDataFlowOptions.md deleted file mode 100644 index 3a7fcc84..00000000 --- a/docs/apis/public/UpdateDataFlowOptions.md +++ /dev/null @@ -1,14 +0,0 @@ -# UpdateDataFlowOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | **str** | | [optional] -**name** | **str** | | -**public** | **bool** | | -**template** | [**DataFlowTemplate**](DataFlowTemplate.md) | | -**variables** | [**dict(str, ProjectProjKeyKgcDataflowTemplatesVariables)**](ProjectProjKeyKgcDataflowTemplatesVariables.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/UpdateProjectModelConfigOptions.md b/docs/apis/public/UpdateProjectModelConfigOptions.md deleted file mode 100644 index 58a94886..00000000 --- a/docs/apis/public/UpdateProjectModelConfigOptions.md +++ /dev/null @@ -1,13 +0,0 @@ -# UpdateProjectModelConfigOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**configurations** | [**ProjectProjKeyModelConfigsConfigurations**](ProjectProjKeyModelConfigsConfigurations.md) | | -**description** | **str** | | -**name** | **str** | | -**public** | **bool** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/UploadedFile.md b/docs/apis/public/UploadedFile.md deleted file mode 100644 index bd19941f..00000000 --- a/docs/apis/public/UploadedFile.md +++ /dev/null @@ -1,14 +0,0 @@ -# UploadedFile - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**filename** | **str** | | -**id** | **str** | ID of the temporary file. | -**proj_key** | **str** | | -**timestamp** | **float** | | -**user_key** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/UploadedFileResult.md b/docs/apis/public/UploadedFileResult.md deleted file mode 100644 index 864dec5c..00000000 --- a/docs/apis/public/UploadedFileResult.md +++ /dev/null @@ -1,11 +0,0 @@ -# UploadedFileResult - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **str** | ID of the temporary file. | -**url** | **str** | URL to get the temporary file form. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/UploadsApi.md b/docs/apis/public/UploadsApi.md deleted file mode 100644 index a38e2456..00000000 --- a/docs/apis/public/UploadsApi.md +++ /dev/null @@ -1,336 +0,0 @@ -# deepsearch.cps.apis.public.UploadsApi - -All URIs are relative to *http://localhost/api/cps/public/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_project_scratch_file**](UploadsApi.md#create_project_scratch_file) | **POST** /project/{proj_key}/scratch/files/upload/{filename} | -[**list_project_scratch_files**](UploadsApi.md#list_project_scratch_files) | **GET** /project/{proj_key}/scratch/files | -[**list_project_scratch_files_paginated**](UploadsApi.md#list_project_scratch_files_paginated) | **GET** /project/{proj_key}/scratch/files_paginated | -[**upload_project_scratch_file**](UploadsApi.md#upload_project_scratch_file) | **POST** /project/{proj_key}/scratch/files | - - -# **create_project_scratch_file** -> TemporaryUploadFileResult create_project_scratch_file(proj_key, filename) - - - -Create file pointers for temporary storage - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.UploadsApi(api_client) - proj_key = 'proj_key_example' # str | -filename = 'filename_example' # str | - - try: - api_response = api_instance.create_project_scratch_file(proj_key, filename) - pprint(api_response) - except ApiException as e: - print("Exception when calling UploadsApi->create_project_scratch_file: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **filename** | **str**| | - -### Return type - -[**TemporaryUploadFileResult**](TemporaryUploadFileResult.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**201** | Temporary file details | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_project_scratch_files** -> list[UploadedFile] list_project_scratch_files(proj_key, scratch_ids=scratch_ids) - - - -Get temporary files uploaded to a project - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.UploadsApi(api_client) - proj_key = 'proj_key_example' # str | -scratch_ids = 'scratch_ids_example' # str | (optional) - - try: - api_response = api_instance.list_project_scratch_files(proj_key, scratch_ids=scratch_ids) - pprint(api_response) - except ApiException as e: - print("Exception when calling UploadsApi->list_project_scratch_files: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **scratch_ids** | **str**| | [optional] - -### Return type - -[**list[UploadedFile]**](UploadedFile.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Files | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_project_scratch_files_paginated** -> list[UploadedFile] list_project_scratch_files_paginated(proj_key, page=page, items_per_page=items_per_page, search_string=search_string, begin_date=begin_date, end_date=end_date) - - - -Get paginated list of temporary files uploaded to a project - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.UploadsApi(api_client) - proj_key = 'proj_key_example' # str | -page = 56 # int | page of the result list (optional) -items_per_page = 20 # int | items on one page of the result list (optional) (default to 20) -search_string = 'search_string_example' # str | search keyword (optional) -begin_date = 56 # int | begin date of the search date interval (optional) -end_date = 56 # int | end date of the search date interval (optional) - - try: - api_response = api_instance.list_project_scratch_files_paginated(proj_key, page=page, items_per_page=items_per_page, search_string=search_string, begin_date=begin_date, end_date=end_date) - pprint(api_response) - except ApiException as e: - print("Exception when calling UploadsApi->list_project_scratch_files_paginated: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **page** | **int**| page of the result list | [optional] - **items_per_page** | **int**| items on one page of the result list | [optional] [default to 20] - **search_string** | **str**| search keyword | [optional] - **begin_date** | **int**| begin date of the search date interval | [optional] - **end_date** | **int**| end date of the search date interval | [optional] - -### Return type - -[**list[UploadedFile]**](UploadedFile.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Files | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **upload_project_scratch_file** -> UploadedFileResult upload_project_scratch_file(proj_key, file) - - - -Upload a file to temporary storage - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.UploadsApi(api_client) - proj_key = 'proj_key_example' # str | -file = '/path/to/file' # file | - - try: - api_response = api_instance.upload_project_scratch_file(proj_key, file) - pprint(api_response) - except ApiException as e: - print("Exception when calling UploadsApi->upload_project_scratch_file: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **file** | **file**| | - -### Return type - -[**UploadedFileResult**](UploadedFileResult.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: multipart/form-data - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | File uploaded | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/apis/public/UsageStats.md b/docs/apis/public/UsageStats.md deleted file mode 100644 index dcb4be39..00000000 --- a/docs/apis/public/UsageStats.md +++ /dev/null @@ -1,12 +0,0 @@ -# UsageStats - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**bag_key** | **str** | | [optional] -**last_command** | **str** | | [optional] -**proj_key** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public/WellKnownDfTemplateVariable.md b/docs/apis/public/WellKnownDfTemplateVariable.md deleted file mode 100644 index 744ac58a..00000000 --- a/docs/apis/public/WellKnownDfTemplateVariable.md +++ /dev/null @@ -1,12 +0,0 @@ -# WellKnownDfTemplateVariable - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | **str** | | -**id** | **str** | | -**type** | [**DataFlowTemplateVariable**](DataFlowTemplateVariable.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/public_v2/CcsTask.md b/docs/apis/public_v2/CcsTask.md new file mode 100644 index 00000000..262395fc --- /dev/null +++ b/docs/apis/public_v2/CcsTask.md @@ -0,0 +1,31 @@ +# CcsTask + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**task_id** | **str** | | +**ccs_project_key** | **str** | | +**ccs_collection_name** | **str** | | + +## Example + +```python +from deepsearch.cps.apis.public_v2.models.ccs_task import CcsTask + +# TODO update the JSON string below +json = "{}" +# create an instance of CcsTask from a JSON string +ccs_task_instance = CcsTask.from_json(json) +# print the JSON string representation of the object +print(CcsTask.to_json()) + +# convert the object into a dict +ccs_task_dict = ccs_task_instance.to_dict() +# create an instance of CcsTask from a dict +ccs_task_form_dict = ccs_task.from_dict(ccs_task_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/apis/public_v2/ConvertDocumentRequest.md b/docs/apis/public_v2/ConvertDocumentRequest.md new file mode 100644 index 00000000..dfce43de --- /dev/null +++ b/docs/apis/public_v2/ConvertDocumentRequest.md @@ -0,0 +1,30 @@ +# ConvertDocumentRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**http_source** | [**HttpSource**](HttpSource.md) | | [optional] +**file_source** | [**FileSource**](FileSource.md) | | [optional] + +## Example + +```python +from deepsearch.cps.apis.public_v2.models.convert_document_request import ConvertDocumentRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of ConvertDocumentRequest from a JSON string +convert_document_request_instance = ConvertDocumentRequest.from_json(json) +# print the JSON string representation of the object +print(ConvertDocumentRequest.to_json()) + +# convert the object into a dict +convert_document_request_dict = convert_document_request_instance.to_dict() +# create an instance of ConvertDocumentRequest from a dict +convert_document_request_form_dict = convert_document_request.from_dict(convert_document_request_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/apis/public_v2/ConvertDocumentsRequestBody.md b/docs/apis/public_v2/ConvertDocumentsRequestBody.md index 49dc00c3..93f757c1 100644 --- a/docs/apis/public_v2/ConvertDocumentsRequestBody.md +++ b/docs/apis/public_v2/ConvertDocumentsRequestBody.md @@ -5,11 +5,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**file_url** | **List[str]** | List of File's URL to be converted and uploaded to the data index. | [optional] -**internal_file_url** | [**List[InternalUrl]**](InternalUrl.md) | List of Internal File's URLs to be converted and uploaded to the data index. | [optional] -**s3_source** | [**S3DocumentSource**](S3DocumentSource.md) | Coordinates to object store to get files to convert. Can specify which files with object keys. | [optional] -**upload_to_elastic** | **bool** | | [optional] **conversion_settings** | [**PartialDirectConversionParameters**](PartialDirectConversionParameters.md) | Specify the conversion settings to use. | [optional] +**target_settings** | [**TargetConversionParameters**](TargetConversionParameters.md) | Specify the target settings to use. | [optional] +**document_hashes** | **List[str]** | List of document hashes to be used as filter. | [optional] +**without_operations** | **List[str]** | List of Operation Status documents don't have to be used as filter. | [optional] +**upload_to_elastic** | **bool** | | [optional] ## Example diff --git a/docs/apis/public_v2/ConvertDocumentsSources.md b/docs/apis/public_v2/ConvertDocumentsSources.md new file mode 100644 index 00000000..6ce0a065 --- /dev/null +++ b/docs/apis/public_v2/ConvertDocumentsSources.md @@ -0,0 +1,31 @@ +# ConvertDocumentsSources + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**file_url** | **List[str]** | List of File's URL to be converted and uploaded to the data index. | [optional] +**internal_file_url** | [**List[InternalUrl]**](InternalUrl.md) | List of Internal File's URLs to be converted and uploaded to the data index. | [optional] +**s3_source** | [**S3DocumentSource**](S3DocumentSource.md) | Coordinates to object store to get files to convert. Can specify which files with object keys. | [optional] + +## Example + +```python +from deepsearch.cps.apis.public_v2.models.convert_documents_sources import ConvertDocumentsSources + +# TODO update the JSON string below +json = "{}" +# create an instance of ConvertDocumentsSources from a JSON string +convert_documents_sources_instance = ConvertDocumentsSources.from_json(json) +# print the JSON string representation of the object +print(ConvertDocumentsSources.to_json()) + +# convert the object into a dict +convert_documents_sources_dict = convert_documents_sources_instance.to_dict() +# create an instance of ConvertDocumentsSources from a dict +convert_documents_sources_form_dict = convert_documents_sources.from_dict(convert_documents_sources_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/apis/public_v2/ConvertUploadDocumentsRequestBody.md b/docs/apis/public_v2/ConvertUploadDocumentsRequestBody.md new file mode 100644 index 00000000..b03b375b --- /dev/null +++ b/docs/apis/public_v2/ConvertUploadDocumentsRequestBody.md @@ -0,0 +1,34 @@ +# ConvertUploadDocumentsRequestBody + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**file_url** | **List[str]** | List of File's URL to be converted and uploaded to the data index. | [optional] +**internal_file_url** | [**List[InternalUrl]**](InternalUrl.md) | List of Internal File's URLs to be converted and uploaded to the data index. | [optional] +**s3_source** | [**S3DocumentSource**](S3DocumentSource.md) | Coordinates to object store to get files to convert. Can specify which files with object keys. | [optional] +**upload_to_elastic** | **bool** | | [optional] +**conversion_settings** | [**PartialDirectConversionParameters**](PartialDirectConversionParameters.md) | Specify the conversion settings to use. | [optional] +**target_settings** | [**TargetConversionParameters**](TargetConversionParameters.md) | Specify the target settings to use. | [optional] + +## Example + +```python +from deepsearch.cps.apis.public_v2.models.convert_upload_documents_request_body import ConvertUploadDocumentsRequestBody + +# TODO update the JSON string below +json = "{}" +# create an instance of ConvertUploadDocumentsRequestBody from a JSON string +convert_upload_documents_request_body_instance = ConvertUploadDocumentsRequestBody.from_json(json) +# print the JSON string representation of the object +print(ConvertUploadDocumentsRequestBody.to_json()) + +# convert the object into a dict +convert_upload_documents_request_body_dict = convert_upload_documents_request_body_instance.to_dict() +# create an instance of ConvertUploadDocumentsRequestBody from a dict +convert_upload_documents_request_body_form_dict = convert_upload_documents_request_body.from_dict(convert_upload_documents_request_body_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/apis/public_v2/DataIndicesUploadApi.md b/docs/apis/public_v2/DataIndicesUploadApi.md index 56d3eb23..4ad0b595 100644 --- a/docs/apis/public_v2/DataIndicesUploadApi.md +++ b/docs/apis/public_v2/DataIndicesUploadApi.md @@ -4,15 +4,103 @@ All URIs are relative to */api/cps/public/v2* Method | HTTP request | Description ------------- | ------------- | ------------- +[**ccs_convert_file_project_data_index**](DataIndicesUploadApi.md#ccs_convert_file_project_data_index) | **POST** /project/{proj_key}/data_indices/{index_key}/actions/ccs_convert | Ccs Convert File Project Data Index [**ccs_convert_upload_file_project_data_index**](DataIndicesUploadApi.md#ccs_convert_upload_file_project_data_index) | **POST** /project/{proj_key}/data_indices/{index_key}/actions/ccs_convert_upload | Ccs Convert Upload File Project Data Index [**get_attachment_upload_data**](DataIndicesUploadApi.md#get_attachment_upload_data) | **GET** /project/{proj_key}/data_indices/{index_key}/documents/{index_item_id}/attachment_url/{filename} | Get Attachment Upload Data [**html_print_convert_upload**](DataIndicesUploadApi.md#html_print_convert_upload) | **POST** /project/{proj_key}/data_indices/{index_key}/actions/html_print_convert_upload | Html Print Convert Upload +[**load_project_data_index_files_elastic**](DataIndicesUploadApi.md#load_project_data_index_files_elastic) | **POST** /project/{proj_key}/data_indices/{index_key}/actions/load_elastic | Load Project Data Index Files Elastic [**register_attachment**](DataIndicesUploadApi.md#register_attachment) | **POST** /project/{proj_key}/data_indices/{index_key}/documents/{index_item_id}/attachment | Register Attachment [**upload_project_data_index_file**](DataIndicesUploadApi.md#upload_project_data_index_file) | **POST** /project/{proj_key}/data_indices/{index_key}/actions/upload | Upload Project Data Index File +[**upload_register_project_documents**](DataIndicesUploadApi.md#upload_register_project_documents) | **POST** /project/{proj_key}/data_indices/{index_key}/actions/upload_register_documents | Upload Register Project Documents +# **ccs_convert_file_project_data_index** +> CpsTask ccs_convert_file_project_data_index(index_key, proj_key, convert_documents_request_body) + +Ccs Convert File Project Data Index + +Convert files via CCS previously registered and in a project data index. + +### Example + +* Api Key Authentication (Bearer): + +```python +import deepsearch.cps.apis.public_v2 +from deepsearch.cps.apis.public_v2.models.convert_documents_request_body import ConvertDocumentsRequestBody +from deepsearch.cps.apis.public_v2.models.cps_task import CpsTask +from deepsearch.cps.apis.public_v2.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to /api/cps/public/v2 +# See configuration.py for a list of all supported configuration parameters. +configuration = deepsearch.cps.apis.public_v2.Configuration( + host = "/api/cps/public/v2" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: Bearer +configuration.api_key['Bearer'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Bearer'] = 'Bearer' + +# Enter a context with an instance of the API client +with deepsearch.cps.apis.public_v2.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = deepsearch.cps.apis.public_v2.DataIndicesUploadApi(api_client) + index_key = 'index_key_example' # str | + proj_key = 'proj_key_example' # str | + convert_documents_request_body = deepsearch.cps.apis.public_v2.ConvertDocumentsRequestBody() # ConvertDocumentsRequestBody | + + try: + # Ccs Convert File Project Data Index + api_response = api_instance.ccs_convert_file_project_data_index(index_key, proj_key, convert_documents_request_body) + print("The response of DataIndicesUploadApi->ccs_convert_file_project_data_index:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling DataIndicesUploadApi->ccs_convert_file_project_data_index: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **index_key** | **str**| | + **proj_key** | **str**| | + **convert_documents_request_body** | [**ConvertDocumentsRequestBody**](ConvertDocumentsRequestBody.md)| | + +### Return type + +[**CpsTask**](CpsTask.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Successful Response | - | +**422** | Validation Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **ccs_convert_upload_file_project_data_index** -> CpsTask ccs_convert_upload_file_project_data_index(index_key, proj_key, convert_documents_request_body) +> CpsTask ccs_convert_upload_file_project_data_index(index_key, proj_key, convert_upload_documents_request_body) Ccs Convert Upload File Project Data Index @@ -24,7 +112,7 @@ Convert files via CCS and upload to a project data index (only for indices with ```python import deepsearch.cps.apis.public_v2 -from deepsearch.cps.apis.public_v2.models.convert_documents_request_body import ConvertDocumentsRequestBody +from deepsearch.cps.apis.public_v2.models.convert_upload_documents_request_body import ConvertUploadDocumentsRequestBody from deepsearch.cps.apis.public_v2.models.cps_task import CpsTask from deepsearch.cps.apis.public_v2.rest import ApiException from pprint import pprint @@ -52,11 +140,11 @@ with deepsearch.cps.apis.public_v2.ApiClient(configuration) as api_client: api_instance = deepsearch.cps.apis.public_v2.DataIndicesUploadApi(api_client) index_key = 'index_key_example' # str | proj_key = 'proj_key_example' # str | - convert_documents_request_body = deepsearch.cps.apis.public_v2.ConvertDocumentsRequestBody() # ConvertDocumentsRequestBody | + convert_upload_documents_request_body = deepsearch.cps.apis.public_v2.ConvertUploadDocumentsRequestBody() # ConvertUploadDocumentsRequestBody | try: # Ccs Convert Upload File Project Data Index - api_response = api_instance.ccs_convert_upload_file_project_data_index(index_key, proj_key, convert_documents_request_body) + api_response = api_instance.ccs_convert_upload_file_project_data_index(index_key, proj_key, convert_upload_documents_request_body) print("The response of DataIndicesUploadApi->ccs_convert_upload_file_project_data_index:\n") pprint(api_response) except Exception as e: @@ -72,7 +160,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **index_key** | **str**| | **proj_key** | **str**| | - **convert_documents_request_body** | [**ConvertDocumentsRequestBody**](ConvertDocumentsRequestBody.md)| | + **convert_upload_documents_request_body** | [**ConvertUploadDocumentsRequestBody**](ConvertUploadDocumentsRequestBody.md)| | ### Return type @@ -267,6 +355,91 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **load_project_data_index_files_elastic** +> CpsTask load_project_data_index_files_elastic(index_key, proj_key, upload_elastic_request_body) + +Load Project Data Index Files Elastic + +Load file(s) in a project data index to elastic. + +### Example + +* Api Key Authentication (Bearer): + +```python +import deepsearch.cps.apis.public_v2 +from deepsearch.cps.apis.public_v2.models.cps_task import CpsTask +from deepsearch.cps.apis.public_v2.models.upload_elastic_request_body import UploadElasticRequestBody +from deepsearch.cps.apis.public_v2.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to /api/cps/public/v2 +# See configuration.py for a list of all supported configuration parameters. +configuration = deepsearch.cps.apis.public_v2.Configuration( + host = "/api/cps/public/v2" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: Bearer +configuration.api_key['Bearer'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Bearer'] = 'Bearer' + +# Enter a context with an instance of the API client +with deepsearch.cps.apis.public_v2.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = deepsearch.cps.apis.public_v2.DataIndicesUploadApi(api_client) + index_key = 'index_key_example' # str | + proj_key = 'proj_key_example' # str | + upload_elastic_request_body = deepsearch.cps.apis.public_v2.UploadElasticRequestBody() # UploadElasticRequestBody | + + try: + # Load Project Data Index Files Elastic + api_response = api_instance.load_project_data_index_files_elastic(index_key, proj_key, upload_elastic_request_body) + print("The response of DataIndicesUploadApi->load_project_data_index_files_elastic:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling DataIndicesUploadApi->load_project_data_index_files_elastic: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **index_key** | **str**| | + **proj_key** | **str**| | + **upload_elastic_request_body** | [**UploadElasticRequestBody**](UploadElasticRequestBody.md)| | + +### Return type + +[**CpsTask**](CpsTask.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Successful Response | - | +**422** | Validation Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **register_attachment** > register_attachment(index_key, index_item_id, proj_key, attachment_upload_request_body) @@ -436,3 +609,88 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **upload_register_project_documents** +> CpsTask upload_register_project_documents(index_key, proj_key, convert_documents_sources) + +Upload Register Project Documents + +Upload and register documents to be converted later. + +### Example + +* Api Key Authentication (Bearer): + +```python +import deepsearch.cps.apis.public_v2 +from deepsearch.cps.apis.public_v2.models.convert_documents_sources import ConvertDocumentsSources +from deepsearch.cps.apis.public_v2.models.cps_task import CpsTask +from deepsearch.cps.apis.public_v2.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to /api/cps/public/v2 +# See configuration.py for a list of all supported configuration parameters. +configuration = deepsearch.cps.apis.public_v2.Configuration( + host = "/api/cps/public/v2" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: Bearer +configuration.api_key['Bearer'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Bearer'] = 'Bearer' + +# Enter a context with an instance of the API client +with deepsearch.cps.apis.public_v2.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = deepsearch.cps.apis.public_v2.DataIndicesUploadApi(api_client) + index_key = 'index_key_example' # str | + proj_key = 'proj_key_example' # str | + convert_documents_sources = deepsearch.cps.apis.public_v2.ConvertDocumentsSources() # ConvertDocumentsSources | + + try: + # Upload Register Project Documents + api_response = api_instance.upload_register_project_documents(index_key, proj_key, convert_documents_sources) + print("The response of DataIndicesUploadApi->upload_register_project_documents:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling DataIndicesUploadApi->upload_register_project_documents: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **index_key** | **str**| | + **proj_key** | **str**| | + **convert_documents_sources** | [**ConvertDocumentsSources**](ConvertDocumentsSources.md)| | + +### Return type + +[**CpsTask**](CpsTask.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Successful Response | - | +**422** | Validation Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/apis/public_v2/FileSource.md b/docs/apis/public_v2/FileSource.md new file mode 100644 index 00000000..8aecd42b --- /dev/null +++ b/docs/apis/public_v2/FileSource.md @@ -0,0 +1,30 @@ +# FileSource + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**base64_string** | **str** | | +**filename** | **str** | | + +## Example + +```python +from deepsearch.cps.apis.public_v2.models.file_source import FileSource + +# TODO update the JSON string below +json = "{}" +# create an instance of FileSource from a JSON string +file_source_instance = FileSource.from_json(json) +# print the JSON string representation of the object +print(FileSource.to_json()) + +# convert the object into a dict +file_source_dict = file_source_instance.to_dict() +# create an instance of FileSource from a dict +file_source_form_dict = file_source.from_dict(file_source_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/apis/public_v2/GenAIParams.md b/docs/apis/public_v2/GenAIParams.md index 7af07acf..2c30d53b 100644 --- a/docs/apis/public_v2/GenAIParams.md +++ b/docs/apis/public_v2/GenAIParams.md @@ -8,6 +8,7 @@ Name | Type | Description | Notes **model_id** | **str** | | **prompt_template** | **str** | | **params** | **object** | | +**timeout** | **float** | | ## Example diff --git a/docs/apis/public_v2/GenAIPartialParams.md b/docs/apis/public_v2/GenAIPartialParams.md index 8bcdb964..d775b835 100644 --- a/docs/apis/public_v2/GenAIPartialParams.md +++ b/docs/apis/public_v2/GenAIPartialParams.md @@ -8,6 +8,7 @@ Name | Type | Description | Notes **model_id** | **str** | | [optional] **prompt_template** | **str** | | [optional] **params** | **object** | | [optional] +**timeout** | **float** | | [optional] ## Example diff --git a/docs/apis/public_v2/HttpSource.md b/docs/apis/public_v2/HttpSource.md new file mode 100644 index 00000000..24590c82 --- /dev/null +++ b/docs/apis/public_v2/HttpSource.md @@ -0,0 +1,30 @@ +# HttpSource + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**url** | **str** | | +**headers** | **object** | | + +## Example + +```python +from deepsearch.cps.apis.public_v2.models.http_source import HttpSource + +# TODO update the JSON string below +json = "{}" +# create an instance of HttpSource from a JSON string +http_source_instance = HttpSource.from_json(json) +# print the JSON string representation of the object +print(HttpSource.to_json()) + +# convert the object into a dict +http_source_dict = http_source_instance.to_dict() +# create an instance of HttpSource from a dict +http_source_form_dict = http_source.from_dict(http_source_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/apis/public_v2/ProjectApi.md b/docs/apis/public_v2/ProjectApi.md index 539ec93a..5a224d65 100644 --- a/docs/apis/public_v2/ProjectApi.md +++ b/docs/apis/public_v2/ProjectApi.md @@ -4,6 +4,8 @@ All URIs are relative to */api/cps/public/v2* Method | HTTP request | Description ------------- | ------------- | ------------- +[**check_wait_ccs_task_task**](ProjectApi.md#check_wait_ccs_task_task) | **GET** /project/{proj_key}/convert_tasks/{task_id} | Check Wait Ccs Task Task +[**convert_pdf_document**](ProjectApi.md#convert_pdf_document) | **POST** /project/{proj_key}/convert | Convert Pdf Document [**delete_project_integration_config_genai**](ProjectApi.md#delete_project_integration_config_genai) | **DELETE** /project/{proj_key}/integrations/genai | Delete Project Integration Config Genai [**get_project_default_values**](ProjectApi.md#get_project_default_values) | **GET** /project/{proj_key}/default_values | Get Project Default Values [**get_project_integration_config_genai**](ProjectApi.md#get_project_integration_config_genai) | **GET** /project/{proj_key}/integrations/genai | Get Project Integration Config Genai @@ -12,6 +14,173 @@ Method | HTTP request | Description [**update_project_integration_config_genai**](ProjectApi.md#update_project_integration_config_genai) | **POST** /project/{proj_key}/integrations/genai | Update Project Integration Config Genai +# **check_wait_ccs_task_task** +> TaskResult check_wait_ccs_task_task(task_id, proj_key, wait=wait) + +Check Wait Ccs Task Task + +Check status of a CCS conversion task. + +### Example + +* Api Key Authentication (Bearer): + +```python +import deepsearch.cps.apis.public_v2 +from deepsearch.cps.apis.public_v2.models.task_result import TaskResult +from deepsearch.cps.apis.public_v2.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to /api/cps/public/v2 +# See configuration.py for a list of all supported configuration parameters. +configuration = deepsearch.cps.apis.public_v2.Configuration( + host = "/api/cps/public/v2" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: Bearer +configuration.api_key['Bearer'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Bearer'] = 'Bearer' + +# Enter a context with an instance of the API client +with deepsearch.cps.apis.public_v2.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = deepsearch.cps.apis.public_v2.ProjectApi(api_client) + task_id = 'task_id_example' # str | + proj_key = 'proj_key_example' # str | + wait = 3.4 # float | Optionally block this method call for a few seconds to wait for the result instead of polling through multiple calls. (optional) + + try: + # Check Wait Ccs Task Task + api_response = api_instance.check_wait_ccs_task_task(task_id, proj_key, wait=wait) + print("The response of ProjectApi->check_wait_ccs_task_task:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ProjectApi->check_wait_ccs_task_task: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **task_id** | **str**| | + **proj_key** | **str**| | + **wait** | **float**| Optionally block this method call for a few seconds to wait for the result instead of polling through multiple calls. | [optional] + +### Return type + +[**TaskResult**](TaskResult.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Successful Response | - | +**422** | Validation Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **convert_pdf_document** +> CcsTask convert_pdf_document(proj_key, convert_document_request) + +Convert Pdf Document + +Convert a PDF document directly to CCS. + +### Example + +* Api Key Authentication (Bearer): + +```python +import deepsearch.cps.apis.public_v2 +from deepsearch.cps.apis.public_v2.models.ccs_task import CcsTask +from deepsearch.cps.apis.public_v2.models.convert_document_request import ConvertDocumentRequest +from deepsearch.cps.apis.public_v2.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to /api/cps/public/v2 +# See configuration.py for a list of all supported configuration parameters. +configuration = deepsearch.cps.apis.public_v2.Configuration( + host = "/api/cps/public/v2" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: Bearer +configuration.api_key['Bearer'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Bearer'] = 'Bearer' + +# Enter a context with an instance of the API client +with deepsearch.cps.apis.public_v2.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = deepsearch.cps.apis.public_v2.ProjectApi(api_client) + proj_key = 'proj_key_example' # str | + convert_document_request = deepsearch.cps.apis.public_v2.ConvertDocumentRequest() # ConvertDocumentRequest | + + try: + # Convert Pdf Document + api_response = api_instance.convert_pdf_document(proj_key, convert_document_request) + print("The response of ProjectApi->convert_pdf_document:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ProjectApi->convert_pdf_document: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **proj_key** | **str**| | + **convert_document_request** | [**ConvertDocumentRequest**](ConvertDocumentRequest.md)| | + +### Return type + +[**CcsTask**](CcsTask.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Successful Response | - | +**422** | Validation Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **delete_project_integration_config_genai** > delete_project_integration_config_genai(proj_key) diff --git a/docs/apis/public_v2/TargetConversionParameters.md b/docs/apis/public_v2/TargetConversionParameters.md new file mode 100644 index 00000000..d5b62a52 --- /dev/null +++ b/docs/apis/public_v2/TargetConversionParameters.md @@ -0,0 +1,31 @@ +# TargetConversionParameters + +Specify target settings (add_raw_pages, add_annotations). Fields left null are set to platform defaults. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**add_raw_pages** | **bool** | | [optional] +**add_annotations** | **bool** | | [optional] + +## Example + +```python +from deepsearch.cps.apis.public_v2.models.target_conversion_parameters import TargetConversionParameters + +# TODO update the JSON string below +json = "{}" +# create an instance of TargetConversionParameters from a JSON string +target_conversion_parameters_instance = TargetConversionParameters.from_json(json) +# print the JSON string representation of the object +print(TargetConversionParameters.to_json()) + +# convert the object into a dict +target_conversion_parameters_dict = target_conversion_parameters_instance.to_dict() +# create an instance of TargetConversionParameters from a dict +target_conversion_parameters_form_dict = target_conversion_parameters.from_dict(target_conversion_parameters_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/apis/public_v2/UploadElasticRequestBody.md b/docs/apis/public_v2/UploadElasticRequestBody.md new file mode 100644 index 00000000..912c9e1c --- /dev/null +++ b/docs/apis/public_v2/UploadElasticRequestBody.md @@ -0,0 +1,30 @@ +# UploadElasticRequestBody + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**document_hashes** | **List[str]** | List of document hashes to be used as filter. | [optional] +**with_operations** | **List[str]** | List of Operation Status documents don't have to be used as filter. | [optional] + +## Example + +```python +from deepsearch.cps.apis.public_v2.models.upload_elastic_request_body import UploadElasticRequestBody + +# TODO update the JSON string below +json = "{}" +# create an instance of UploadElasticRequestBody from a JSON string +upload_elastic_request_body_instance = UploadElasticRequestBody.from_json(json) +# print the JSON string representation of the object +print(UploadElasticRequestBody.to_json()) + +# convert the object into a dict +upload_elastic_request_body_dict = upload_elastic_request_body_instance.to_dict() +# create an instance of UploadElasticRequestBody from a dict +upload_elastic_request_body_form_dict = upload_elastic_request_body.from_dict(upload_elastic_request_body_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/apis/user/AccessToken.md b/docs/apis/user/AccessToken.md deleted file mode 100644 index 9aa9d48e..00000000 --- a/docs/apis/user/AccessToken.md +++ /dev/null @@ -1,10 +0,0 @@ -# AccessToken - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**access_token** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/user/AdminApi.md b/docs/apis/user/AdminApi.md deleted file mode 100644 index e0b3bbba..00000000 --- a/docs/apis/user/AdminApi.md +++ /dev/null @@ -1,650 +0,0 @@ -# deepsearch.cps.apis.user.AdminApi - -All URIs are relative to *http://localhost/api/cps/user/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**admin_add_user**](AdminApi.md#admin_add_user) | **POST** /admin/projects/{proj_key}/users | -[**admin_list_users**](AdminApi.md#admin_list_users) | **GET** /admin/projects/{proj_key}/users | -[**admin_remove_user**](AdminApi.md#admin_remove_user) | **DELETE** /admin/projects/{proj_key}/users/{username} | -[**confirm_user**](AdminApi.md#confirm_user) | **POST** /admin/users/{user_key}/confirmation | -[**create_project**](AdminApi.md#create_project) | **POST** /admin/projects | -[**list_all_projects**](AdminApi.md#list_all_projects) | **GET** /admin/projects/all | -[**list_audits**](AdminApi.md#list_audits) | **GET** /admin/audits | -[**list_pending_users**](AdminApi.md#list_pending_users) | **GET** /admin/users/pending | - - -# **admin_add_user** -> SuccessMessage admin_add_user(proj_key, data) - - - -Assign a new user to a project - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.AdminApi(api_client) - proj_key = 'proj_key_example' # str | The project key -data = deepsearch.cps.apis.user.ProjectUserAssignment() # ProjectUserAssignment | - - try: - api_response = api_instance.admin_add_user(proj_key, data) - pprint(api_response) - except ApiException as e: - print("Exception when calling AdminApi->admin_add_user: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| The project key | - **data** | [**ProjectUserAssignment**](ProjectUserAssignment.md)| | - -### Return type - -[**SuccessMessage**](SuccessMessage.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | User assigned to project. | - | -**400** | Invalid new_user_type. | - | -**403** | The user that's performing this operation does not have permission to assign the user. | - | -**404** | User that's going to be assigned doesn't exist, or the project doesn't exist. | - | -**409** | Reassigning the user would leave the project in an invalid state. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **admin_list_users** -> dict(str, list[UserDetails]) admin_list_users(proj_key, page=page, items_per_page=items_per_page) - - - -List all users belonging to a cps project - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.AdminApi(api_client) - proj_key = 'proj_key_example' # str | The project key -page = 56 # int | page of the result list (optional) -items_per_page = 2 # int | items on one page of the result list (optional) (default to 2) - - try: - api_response = api_instance.admin_list_users(proj_key, page=page, items_per_page=items_per_page) - pprint(api_response) - except ApiException as e: - print("Exception when calling AdminApi->admin_list_users: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| The project key | - **page** | **int**| page of the result list | [optional] - **items_per_page** | **int**| items on one page of the result list | [optional] [default to 2] - -### Return type - -**dict(str, list[UserDetails])** - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized. | - | -**404** | User does not exist. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **admin_remove_user** -> admin_remove_user(proj_key, username) - - - -Delete an user from a project. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.AdminApi(api_client) - proj_key = 'proj_key_example' # str | The project key -username = 'username_example' # str | The username for the user - - try: - api_instance.admin_remove_user(proj_key, username) - except ApiException as e: - print("Exception when calling AdminApi->admin_remove_user: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| The project key | - **username** | **str**| The username for the user | - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | User deleted from project successfully. | - | -**403** | The user that is executing this operation is not an owner of the project. | - | -**404** | Project or user not found. | - | -**409** | User not assigned to project, or the project only has one owner left. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **confirm_user** -> confirm_user(user_key) - - - -Confirm a pending user. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.AdminApi(api_client) - user_key = 'user_key_example' # str | - - try: - api_instance.confirm_user(user_key) - except ApiException as e: - print("Exception when calling AdminApi->confirm_user: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **user_key** | **str**| | - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_project** -> Project create_project(data) - - - -Create a new project - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.AdminApi(api_client) - data = deepsearch.cps.apis.user.CreateProjectRequestBody() # CreateProjectRequestBody | - - try: - api_response = api_instance.create_project(data) - pprint(api_response) - except ApiException as e: - print("Exception when calling AdminApi->create_project: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **data** | [**CreateProjectRequestBody**](CreateProjectRequestBody.md)| | - -### Return type - -[**Project**](Project.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | New project details | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_all_projects** -> list[Project] list_all_projects() - - - -List all projects - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.AdminApi(api_client) - - try: - api_response = api_instance.list_all_projects() - pprint(api_response) - except ApiException as e: - print("Exception when calling AdminApi->list_all_projects: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -[**list[Project]**](Project.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**404** | Project does not exist. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_audits** -> InlineResponse200 list_audits(user_key=user_key, type_=type_, search_term=search_term, before=before, after=after, limit=limit) - - - -List audits globally - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.AdminApi(api_client) - user_key = 'user_key_example' # str | (optional) -type_ = 'type__example' # str | (optional) -search_term = 'search_term_example' # str | (optional) -before = 'before_example' # str | (optional) -after = 'after_example' # str | (optional) -limit = 50 # int | (optional) (default to 50) - - try: - api_response = api_instance.list_audits(user_key=user_key, type_=type_, search_term=search_term, before=before, after=after, limit=limit) - pprint(api_response) - except ApiException as e: - print("Exception when calling AdminApi->list_audits: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **user_key** | **str**| | [optional] - **type_** | **str**| | [optional] - **search_term** | **str**| | [optional] - **before** | **str**| | [optional] - **after** | **str**| | [optional] - **limit** | **int**| | [optional] [default to 50] - -### Return type - -[**InlineResponse200**](InlineResponse200.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized. | - | -**404** | Project does not exist. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_pending_users** -> list[UserDetails] list_pending_users(term=term) - - - -List pending user requests. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.AdminApi(api_client) - term = 'term_example' # str | (optional) - - try: - api_response = api_instance.list_pending_users(term=term) - pprint(api_response) - except ApiException as e: - print("Exception when calling AdminApi->list_pending_users: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **term** | **str**| | [optional] - -### Return type - -[**list[UserDetails]**](UserDetails.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/apis/user/ApiKey.md b/docs/apis/user/ApiKey.md deleted file mode 100644 index 63d2f130..00000000 --- a/docs/apis/user/ApiKey.md +++ /dev/null @@ -1,11 +0,0 @@ -# ApiKey - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**api_key** | **str** | | -**email** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/user/AuditRecord.md b/docs/apis/user/AuditRecord.md deleted file mode 100644 index 7456c268..00000000 --- a/docs/apis/user/AuditRecord.md +++ /dev/null @@ -1,16 +0,0 @@ -# AuditRecord - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**details** | [**object**](.md) | | -**id** | **str** | | -**message** | **str** | | -**proj_key** | **str** | | -**timestamp** | **str** | | -**type** | **str** | | -**user_key** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/user/CreateProjectRequestBody.md b/docs/apis/user/CreateProjectRequestBody.md deleted file mode 100644 index 1c81a0f3..00000000 --- a/docs/apis/user/CreateProjectRequestBody.md +++ /dev/null @@ -1,11 +0,0 @@ -# CreateProjectRequestBody - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | Name of the project | -**proj_key** | **str** | Internal project key to use. (use only if you really know what you are doing) | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/user/CreateProjectRequestBody1.md b/docs/apis/user/CreateProjectRequestBody1.md deleted file mode 100644 index 9dfbcdab..00000000 --- a/docs/apis/user/CreateProjectRequestBody1.md +++ /dev/null @@ -1,11 +0,0 @@ -# CreateProjectRequestBody1 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | Name of the project | -**proj_key** | **str** | Internal project key to use. (use only if you really know what you are doing) | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/user/CreateTokensRequestBody.md b/docs/apis/user/CreateTokensRequestBody.md deleted file mode 100644 index d73855e1..00000000 --- a/docs/apis/user/CreateTokensRequestBody.md +++ /dev/null @@ -1,11 +0,0 @@ -# CreateTokensRequestBody - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**code** | **str** | The oidc code response | [optional] -**refresh_token** | **str** | The refresh token | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/user/ErrorResponse.md b/docs/apis/user/ErrorResponse.md deleted file mode 100644 index 39647b8f..00000000 --- a/docs/apis/user/ErrorResponse.md +++ /dev/null @@ -1,10 +0,0 @@ -# ErrorResponse - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**error** | **str** | Description of the error. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/user/GetAccessTokenRequestBody.md b/docs/apis/user/GetAccessTokenRequestBody.md deleted file mode 100644 index b8d1d635..00000000 --- a/docs/apis/user/GetAccessTokenRequestBody.md +++ /dev/null @@ -1,10 +0,0 @@ -# GetAccessTokenRequestBody - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**admin** | **bool** | | [optional] [default to False] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/user/ImpersonateUserTokenRequestBody.md b/docs/apis/user/ImpersonateUserTokenRequestBody.md deleted file mode 100644 index b1fed323..00000000 --- a/docs/apis/user/ImpersonateUserTokenRequestBody.md +++ /dev/null @@ -1,11 +0,0 @@ -# ImpersonateUserTokenRequestBody - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**impersonate_secret** | **str** | | -**target_user_key** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/user/InlineResponse200.md b/docs/apis/user/InlineResponse200.md deleted file mode 100644 index 08f28bba..00000000 --- a/docs/apis/user/InlineResponse200.md +++ /dev/null @@ -1,10 +0,0 @@ -# InlineResponse200 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**audits** | [**list[AuditRecord]**](AuditRecord.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/user/OidcApi.md b/docs/apis/user/OidcApi.md deleted file mode 100644 index d652560a..00000000 --- a/docs/apis/user/OidcApi.md +++ /dev/null @@ -1,253 +0,0 @@ -# deepsearch.cps.apis.user.OidcApi - -All URIs are relative to *http://localhost/api/cps/user/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**authenticate**](OidcApi.md#authenticate) | **GET** /oidc/authenticate | -[**create_tokens**](OidcApi.md#create_tokens) | **POST** /oidc/token | -[**register_user**](OidcApi.md#register_user) | **POST** /oidc/register_user | -[**token**](OidcApi.md#token) | **GET** /oidc/token | - - -# **authenticate** -> authenticate() - - - -Redirect to the OIDC authenticate endpoint. - -### Example - -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient() as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.OidcApi(api_client) - - try: - api_instance.authenticate() - except ApiException as e: - print("Exception when calling OidcApi->authenticate: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -void (empty response body) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: Not defined - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**302** | Redirect to the OIDC authenticate endpoint | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_tokens** -> OidcTokenResponse create_tokens(body=body) - - - -Retrieve the user access and identity tokens using either the code or the refresh_token. - -### Example - -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient() as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.OidcApi(api_client) - body = deepsearch.cps.apis.user.CreateTokensRequestBody() # CreateTokensRequestBody | (optional) - - try: - api_response = api_instance.create_tokens(body=body) - pprint(api_response) - except ApiException as e: - print("Exception when calling OidcApi->create_tokens: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | [**CreateTokensRequestBody**](CreateTokensRequestBody.md)| | [optional] - -### Return type - -[**OidcTokenResponse**](OidcTokenResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **register_user** -> UserDetails register_user(data) - - - -Register a new user, provided a valid access_token and id_token from the oidc provider. - -### Example - -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient() as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.OidcApi(api_client) - data = deepsearch.cps.apis.user.RegisterUserRequestBody() # RegisterUserRequestBody | - - try: - api_response = api_instance.register_user(data) - pprint(api_response) - except ApiException as e: - print("Exception when calling OidcApi->register_user: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **data** | [**RegisterUserRequestBody**](RegisterUserRequestBody.md)| | - -### Return type - -[**UserDetails**](UserDetails.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **token** -> OidcTokenResponse token(code=code, refresh_token=refresh_token) - - - -Retrieve the user access and identity tokens using either the code or the refresh_token. - -### Example - -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient() as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.OidcApi(api_client) - code = 'code_example' # str | The oidc code response (optional) -refresh_token = 'refresh_token_example' # str | The oidc code response (optional) - - try: - api_response = api_instance.token(code=code, refresh_token=refresh_token) - pprint(api_response) - except ApiException as e: - print("Exception when calling OidcApi->token: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **code** | **str**| The oidc code response | [optional] - **refresh_token** | **str**| The oidc code response | [optional] - -### Return type - -[**OidcTokenResponse**](OidcTokenResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/apis/user/OidcTokenResponse.md b/docs/apis/user/OidcTokenResponse.md deleted file mode 100644 index 24245736..00000000 --- a/docs/apis/user/OidcTokenResponse.md +++ /dev/null @@ -1,12 +0,0 @@ -# OidcTokenResponse - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**access_token** | **str** | | [optional] -**id_token** | **str** | | -**refresh_token** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/user/Project.md b/docs/apis/user/Project.md deleted file mode 100644 index c183ed83..00000000 --- a/docs/apis/user/Project.md +++ /dev/null @@ -1,13 +0,0 @@ -# Project - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**date** | **str** | | [optional] -**name** | **str** | | [optional] -**proj_key** | **str** | | [optional] -**role** | [**UserType**](UserType.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/user/ProjectUserAssignment.md b/docs/apis/user/ProjectUserAssignment.md deleted file mode 100644 index 22b56cb0..00000000 --- a/docs/apis/user/ProjectUserAssignment.md +++ /dev/null @@ -1,12 +0,0 @@ -# ProjectUserAssignment - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**force_role** | **bool** | If true, the role will be assigned also for existing users | [optional] [default to True] -**role** | **str** | The role to assign to the user | -**username** | **str** | The username | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/user/ProjectsApi.md b/docs/apis/user/ProjectsApi.md deleted file mode 100644 index 6405d11f..00000000 --- a/docs/apis/user/ProjectsApi.md +++ /dev/null @@ -1,1065 +0,0 @@ -# deepsearch.cps.apis.user.ProjectsApi - -All URIs are relative to *http://localhost/api/cps/user/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**add_user**](ProjectsApi.md#add_user) | **POST** /projects/{proj_key}/users | -[**create**](ProjectsApi.md#create) | **POST** /projects | -[**delete**](ProjectsApi.md#delete) | **DELETE** /projects/{proj_key} | -[**details**](ProjectsApi.md#details) | **GET** /projects/{proj_key} | -[**edit_user**](ProjectsApi.md#edit_user) | **PUT** /projects/{proj_key}/users | -[**get_delete_confirmation_token**](ProjectsApi.md#get_delete_confirmation_token) | **GET** /projects/{proj_key}/delete | -[**get_project_token**](ProjectsApi.md#get_project_token) | **GET** /projects/{proj_key}/token | -[**is_authorized**](ProjectsApi.md#is_authorized) | **GET** /projects/{proj_key}/is_authorized | -[**list_audits_in_project**](ProjectsApi.md#list_audits_in_project) | **GET** /projects/{proj_key}/audits | -[**list_projects**](ProjectsApi.md#list_projects) | **GET** /projects | -[**list_users**](ProjectsApi.md#list_users) | **GET** /projects/{proj_key}/users | -[**list_users_paginated**](ProjectsApi.md#list_users_paginated) | **GET** /projects/{proj_key}/users_paginated | -[**remove_user**](ProjectsApi.md#remove_user) | **DELETE** /projects/{proj_key}/users/{username} | - - -# **add_user** -> SuccessMessage add_user(proj_key, data) - - - -Assign a new user to a project - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.ProjectsApi(api_client) - proj_key = 'proj_key_example' # str | The project key -data = deepsearch.cps.apis.user.ProjectUserAssignment() # ProjectUserAssignment | - - try: - api_response = api_instance.add_user(proj_key, data) - pprint(api_response) - except ApiException as e: - print("Exception when calling ProjectsApi->add_user: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| The project key | - **data** | [**ProjectUserAssignment**](ProjectUserAssignment.md)| | - -### Return type - -[**SuccessMessage**](SuccessMessage.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | User assigned to project. | - | -**400** | Invalid new_user_type. | - | -**403** | The user that's performing this operation does not have permission to assign the user. | - | -**404** | User that's going to be assigned doesn't exist, or the project doesn't exist. | - | -**409** | Reassigning the user would leave the project in an invalid state. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create** -> Project create(data) - - - -Create a new project - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.ProjectsApi(api_client) - data = deepsearch.cps.apis.user.CreateProjectRequestBody1() # CreateProjectRequestBody1 | - - try: - api_response = api_instance.create(data) - pprint(api_response) - except ApiException as e: - print("Exception when calling ProjectsApi->create: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **data** | [**CreateProjectRequestBody1**](CreateProjectRequestBody1.md)| | - -### Return type - -[**Project**](Project.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | New project details | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **delete** -> delete(proj_key, confirmation_token) - - - -Delete a project. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.ProjectsApi(api_client) - proj_key = 'proj_key_example' # str | The project key -confirmation_token = 'confirmation_token_example' # str | The delete confirmation token - - try: - api_instance.delete(proj_key, confirmation_token) - except ApiException as e: - print("Exception when calling ProjectsApi->delete: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| The project key | - **confirmation_token** | **str**| The delete confirmation token | - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | Project deleted successfully. | - | -**403** | The user that is executing this operation is not an owner of the project. | - | -**404** | Project not found. | - | -**409** | User not assigned to project. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **details** -> Project details(proj_key) - - - -Returns the details of the project - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.ProjectsApi(api_client) - proj_key = 'proj_key_example' # str | The project key - - try: - api_response = api_instance.details(proj_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling ProjectsApi->details: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| The project key | - -### Return type - -[**Project**](Project.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized. | - | -**404** | Project does not exist. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **edit_user** -> SuccessMessage edit_user(proj_key, data) - - - -Assign a new user to a project - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.ProjectsApi(api_client) - proj_key = 'proj_key_example' # str | The project key -data = deepsearch.cps.apis.user.ProjectUserAssignment() # ProjectUserAssignment | - - try: - api_response = api_instance.edit_user(proj_key, data) - pprint(api_response) - except ApiException as e: - print("Exception when calling ProjectsApi->edit_user: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| The project key | - **data** | [**ProjectUserAssignment**](ProjectUserAssignment.md)| | - -### Return type - -[**SuccessMessage**](SuccessMessage.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | User assigned to project. | - | -**400** | Invalid new_user_type. | - | -**403** | The user that's performing this operation does not have permission to assign the user. | - | -**404** | User that's going to be assigned doesn't exist, or the project doesn't exist. | - | -**409** | Reassigning the user would leave the project in an invalid state. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_delete_confirmation_token** -> TokenResponse get_delete_confirmation_token(proj_key) - - - -Get a delete confirmation token for the provided project. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.ProjectsApi(api_client) - proj_key = 'proj_key_example' # str | The project key - - try: - api_response = api_instance.get_delete_confirmation_token(proj_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling ProjectsApi->get_delete_confirmation_token: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| The project key | - -### Return type - -[**TokenResponse**](TokenResponse.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Confirmation token. | - | -**403** | The user that is executing this operation is not an owner of the project. | - | -**404** | Project not found. | - | -**409** | User not assigned to project. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_project_token** -> AccessToken get_project_token(proj_key) - - - -Request a token granting access to the current project - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.ProjectsApi(api_client) - proj_key = 'proj_key_example' # str | The project key - - try: - api_response = api_instance.get_project_token(proj_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling ProjectsApi->get_project_token: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| The project key | - -### Return type - -[**AccessToken**](AccessToken.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized. | - | -**404** | Project does not exist. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **is_authorized** -> SuccessMessage is_authorized(proj_key, role=role) - - - -Provide user-key and project-key to coordinates a project - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.ProjectsApi(api_client) - proj_key = 'proj_key_example' # str | The project key -role = 'role_example' # str | The specific role to probe (optional) - - try: - api_response = api_instance.is_authorized(proj_key, role=role) - pprint(api_response) - except ApiException as e: - print("Exception when calling ProjectsApi->is_authorized: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| The project key | - **role** | **str**| The specific role to probe | [optional] - -### Return type - -[**SuccessMessage**](SuccessMessage.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | -**404** | Project does not exist. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_audits_in_project** -> InlineResponse200 list_audits_in_project(proj_key, user_key=user_key, type_=type_, search_term=search_term, before=before, after=after, limit=limit) - - - -List audits related to the project - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.ProjectsApi(api_client) - proj_key = 'proj_key_example' # str | The project key -user_key = 'user_key_example' # str | (optional) -type_ = 'type__example' # str | (optional) -search_term = 'search_term_example' # str | (optional) -before = 'before_example' # str | (optional) -after = 'after_example' # str | (optional) -limit = 50 # int | (optional) (default to 50) - - try: - api_response = api_instance.list_audits_in_project(proj_key, user_key=user_key, type_=type_, search_term=search_term, before=before, after=after, limit=limit) - pprint(api_response) - except ApiException as e: - print("Exception when calling ProjectsApi->list_audits_in_project: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| The project key | - **user_key** | **str**| | [optional] - **type_** | **str**| | [optional] - **search_term** | **str**| | [optional] - **before** | **str**| | [optional] - **after** | **str**| | [optional] - **limit** | **int**| | [optional] [default to 50] - -### Return type - -[**InlineResponse200**](InlineResponse200.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized. | - | -**404** | Project does not exist. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_projects** -> list[Project] list_projects(role=role, include_collaborators=include_collaborators) - - - -List all projects assigned to a user - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.ProjectsApi(api_client) - role = 'role_example' # str | filter for the user role (optional) -include_collaborators = True # bool | (optional) (default to True) - - try: - api_response = api_instance.list_projects(role=role, include_collaborators=include_collaborators) - pprint(api_response) - except ApiException as e: - print("Exception when calling ProjectsApi->list_projects: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **role** | **str**| filter for the user role | [optional] - **include_collaborators** | **bool**| | [optional] [default to True] - -### Return type - -[**list[Project]**](Project.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**404** | Project does not exist. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_users** -> dict(str, list[UserDetails]) list_users(proj_key) - - - -List all users belonging to a project - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.ProjectsApi(api_client) - proj_key = 'proj_key_example' # str | The project key - - try: - api_response = api_instance.list_users(proj_key) - pprint(api_response) - except ApiException as e: - print("Exception when calling ProjectsApi->list_users: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| The project key | - -### Return type - -**dict(str, list[UserDetails])** - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized. | - | -**404** | User does not exist. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_users_paginated** -> dict(str, list[UserDetails]) list_users_paginated(proj_key, page=page, items_per_page=items_per_page) - - - -List all users belonging to a cps project - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.ProjectsApi(api_client) - proj_key = 'proj_key_example' # str | The project key -page = 56 # int | page of the result list (optional) -items_per_page = 2 # int | items on one page of the result list (optional) (default to 2) - - try: - api_response = api_instance.list_users_paginated(proj_key, page=page, items_per_page=items_per_page) - pprint(api_response) - except ApiException as e: - print("Exception when calling ProjectsApi->list_users_paginated: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| The project key | - **page** | **int**| page of the result list | [optional] - **items_per_page** | **int**| items on one page of the result list | [optional] [default to 2] - -### Return type - -**dict(str, list[UserDetails])** - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized. | - | -**404** | User does not exist. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **remove_user** -> remove_user(proj_key, username) - - - -Delete an user from a project. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.ProjectsApi(api_client) - proj_key = 'proj_key_example' # str | The project key -username = 'username_example' # str | The username for the user - - try: - api_instance.remove_user(proj_key, username) - except ApiException as e: - print("Exception when calling ProjectsApi->remove_user: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| The project key | - **username** | **str**| The username for the user | - -### Return type - -void (empty response body) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | User deleted from project successfully. | - | -**403** | The user that is executing this operation is not an owner of the project. | - | -**404** | Project or user not found. | - | -**409** | User not assigned to project, or the project only has one owner left. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/apis/user/RegisterUserRequestBody.md b/docs/apis/user/RegisterUserRequestBody.md deleted file mode 100644 index adfa196f..00000000 --- a/docs/apis/user/RegisterUserRequestBody.md +++ /dev/null @@ -1,11 +0,0 @@ -# RegisterUserRequestBody - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**access_token** | **str** | OIDC access_token signed by the provider | -**id_token** | **str** | OIDC id_token signed by the provider | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/user/ServiceAccount.md b/docs/apis/user/ServiceAccount.md deleted file mode 100644 index ec5a86d2..00000000 --- a/docs/apis/user/ServiceAccount.md +++ /dev/null @@ -1,12 +0,0 @@ -# ServiceAccount - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**credentials** | [**ServiceAccountCredentials**](ServiceAccountCredentials.md) | | [optional] -**name** | **str** | | [optional] -**user_key** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/user/ServiceAccountCredentials.md b/docs/apis/user/ServiceAccountCredentials.md deleted file mode 100644 index c1e13436..00000000 --- a/docs/apis/user/ServiceAccountCredentials.md +++ /dev/null @@ -1,11 +0,0 @@ -# ServiceAccountCredentials - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**password** | **str** | | -**username** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/user/SettingsApi.md b/docs/apis/user/SettingsApi.md deleted file mode 100644 index 9a8f0eef..00000000 --- a/docs/apis/user/SettingsApi.md +++ /dev/null @@ -1,82 +0,0 @@ -# deepsearch.cps.apis.user.SettingsApi - -All URIs are relative to *http://localhost/api/cps/user/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**global_permissions**](SettingsApi.md#global_permissions) | **GET** /permissions | - - -# **global_permissions** -> dict(str, bool) global_permissions() - - - -Get the global permissions for users. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.SettingsApi(api_client) - - try: - api_response = api_instance.global_permissions() - pprint(api_response) - except ApiException as e: - print("Exception when calling SettingsApi->global_permissions: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -**dict(str, bool)** - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/apis/user/SuccessMessage.md b/docs/apis/user/SuccessMessage.md deleted file mode 100644 index b66e15f6..00000000 --- a/docs/apis/user/SuccessMessage.md +++ /dev/null @@ -1,10 +0,0 @@ -# SuccessMessage - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**success** | **str** | Human readable message. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/user/TokenResponse.md b/docs/apis/user/TokenResponse.md deleted file mode 100644 index 13da8132..00000000 --- a/docs/apis/user/TokenResponse.md +++ /dev/null @@ -1,10 +0,0 @@ -# TokenResponse - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**token** | **str** | The delete confirmation token. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/user/UserApi.md b/docs/apis/user/UserApi.md deleted file mode 100644 index 86d4ee6c..00000000 --- a/docs/apis/user/UserApi.md +++ /dev/null @@ -1,81 +0,0 @@ -# deepsearch.cps.apis.user.UserApi - -All URIs are relative to *http://localhost/api/cps/user/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**api_key_create**](UserApi.md#api_key_create) | **POST** /user/api_key | - - -# **api_key_create** -> ApiKey api_key_create() - - - -Create an API Key for your user - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.UserApi(api_client) - - try: - api_response = api_instance.api_key_create() - pprint(api_response) - except ApiException as e: - print("Exception when calling UserApi->api_key_create: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -[**ApiKey**](ApiKey.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/apis/user/UserDetails.md b/docs/apis/user/UserDetails.md deleted file mode 100644 index 7c136874..00000000 --- a/docs/apis/user/UserDetails.md +++ /dev/null @@ -1,12 +0,0 @@ -# UserDetails - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**email** | **str** | | [optional] -**role** | **str** | | [optional] -**username** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/user/UserType.md b/docs/apis/user/UserType.md deleted file mode 100644 index 5f7722dd..00000000 --- a/docs/apis/user/UserType.md +++ /dev/null @@ -1,9 +0,0 @@ -# UserType - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/apis/user/UsersApi.md b/docs/apis/user/UsersApi.md deleted file mode 100644 index 108fcc0c..00000000 --- a/docs/apis/user/UsersApi.md +++ /dev/null @@ -1,640 +0,0 @@ -# deepsearch.cps.apis.user.UsersApi - -All URIs are relative to *http://localhost/api/cps/user/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**api_key_get**](UsersApi.md#api_key_get) | **GET** /user/api_key | -[**get_access_token**](UsersApi.md#get_access_token) | **POST** /user/token | -[**get_current_user_details**](UsersApi.md#get_current_user_details) | **GET** /user/current | -[**impersonate_user_token**](UsersApi.md#impersonate_user_token) | **POST** /user/impersonate | -[**search**](UsersApi.md#search) | **GET** /user/search | -[**service_accounts_create**](UsersApi.md#service_accounts_create) | **POST** /user/service_accounts | -[**service_accounts_list**](UsersApi.md#service_accounts_list) | **GET** /user/service_accounts | - - -# **api_key_get** -> ApiKey api_key_get() - - - -Show the API Key for your user - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.UsersApi(api_client) - - try: - api_response = api_instance.api_key_get() - pprint(api_response) - except ApiException as e: - print("Exception when calling UsersApi->api_key_get: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -[**ApiKey**](ApiKey.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_access_token** -> AccessToken get_access_token(options=options) - - - -Request a user API token - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Configure HTTP basic authorization: UserAPIKey -configuration = deepsearch.cps.apis.user.Configuration( - username = 'YOUR_USERNAME', - password = 'YOUR_PASSWORD' -) - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.UsersApi(api_client) - options = deepsearch.cps.apis.user.GetAccessTokenRequestBody() # GetAccessTokenRequestBody | (optional) - - try: - api_response = api_instance.get_access_token(options=options) - pprint(api_response) - except ApiException as e: - print("Exception when calling UsersApi->get_access_token: %s\n" % e) -``` - -* Basic Authentication (UserAPIKey): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Configure HTTP basic authorization: UserAPIKey -configuration = deepsearch.cps.apis.user.Configuration( - username = 'YOUR_USERNAME', - password = 'YOUR_PASSWORD' -) - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.UsersApi(api_client) - options = deepsearch.cps.apis.user.GetAccessTokenRequestBody() # GetAccessTokenRequestBody | (optional) - - try: - api_response = api_instance.get_access_token(options=options) - pprint(api_response) - except ApiException as e: - print("Exception when calling UsersApi->get_access_token: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **options** | [**GetAccessTokenRequestBody**](GetAccessTokenRequestBody.md)| | [optional] - -### Return type - -[**AccessToken**](AccessToken.md) - -### Authorization - -[Bearer](../README.md#Bearer), [UserAPIKey](../README.md#UserAPIKey) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_current_user_details** -> UserDetails get_current_user_details() - - - -Gets the current user's details. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.UsersApi(api_client) - - try: - api_response = api_instance.get_current_user_details() - pprint(api_response) - except ApiException as e: - print("Exception when calling UsersApi->get_current_user_details: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -[**UserDetails**](UserDetails.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **impersonate_user_token** -> TokenResponse impersonate_user_token(body) - - - -Request an impersonate user token. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Configure HTTP basic authorization: UserAPIKey -configuration = deepsearch.cps.apis.user.Configuration( - username = 'YOUR_USERNAME', - password = 'YOUR_PASSWORD' -) - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.UsersApi(api_client) - body = deepsearch.cps.apis.user.ImpersonateUserTokenRequestBody() # ImpersonateUserTokenRequestBody | - - try: - api_response = api_instance.impersonate_user_token(body) - pprint(api_response) - except ApiException as e: - print("Exception when calling UsersApi->impersonate_user_token: %s\n" % e) -``` - -* Basic Authentication (UserAPIKey): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Configure HTTP basic authorization: UserAPIKey -configuration = deepsearch.cps.apis.user.Configuration( - username = 'YOUR_USERNAME', - password = 'YOUR_PASSWORD' -) - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.UsersApi(api_client) - body = deepsearch.cps.apis.user.ImpersonateUserTokenRequestBody() # ImpersonateUserTokenRequestBody | - - try: - api_response = api_instance.impersonate_user_token(body) - pprint(api_response) - except ApiException as e: - print("Exception when calling UsersApi->impersonate_user_token: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | [**ImpersonateUserTokenRequestBody**](ImpersonateUserTokenRequestBody.md)| | - -### Return type - -[**TokenResponse**](TokenResponse.md) - -### Authorization - -[Bearer](../README.md#Bearer), [UserAPIKey](../README.md#UserAPIKey) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**401** | Unauthorized. | - | -**403** | The user that's performing this operation does not have permission or the impersonate secret isn't valid. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **search** -> list[UserDetails] search(term) - - - -Search for users matching the email or name. Depending on the user's permissions, only owners and assignees from their projects may be shown. - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.UsersApi(api_client) - term = 'term_example' # str | Search term - - try: - api_response = api_instance.search(term) - pprint(api_response) - except ApiException as e: - print("Exception when calling UsersApi->search: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **term** | **str**| Search term | - -### Return type - -[**list[UserDetails]**](UserDetails.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **service_accounts_create** -> ServiceAccount service_accounts_create() - - - -Create a new service accounts for your user - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.UsersApi(api_client) - - try: - api_response = api_instance.service_accounts_create() - pprint(api_response) - except ApiException as e: - print("Exception when calling UsersApi->service_accounts_create: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -[**ServiceAccount**](ServiceAccount.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **service_accounts_list** -> list[ServiceAccount] service_accounts_list() - - - -List all service accounts of your user - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.user -from deepsearch.cps.apis.user.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/user/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.user.Configuration( - host = "http://localhost/api/cps/user/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.user.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.user.UsersApi(api_client) - - try: - api_response = api_instance.service_accounts_list() - pprint(api_response) - except ApiException as e: - print("Exception when calling UsersApi->service_accounts_list: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -[**list[ServiceAccount]**](ServiceAccount.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -