Module mailslurp_client.api.ai_controller_api
MailSlurp API
MailSlurp is an API for sending and receiving emails and SMS from dynamically allocated email addresses and phone numbers. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - Homepage - Get an API KEY - Generated SDK Clients - Examples repository # noqa: E501
The version of the OpenAPI document: 6.5.2 Contact: contact@mailslurp.dev Generated by: https://openapi-generator.tech
Classes
class AIControllerApi (api_client=None)-
NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech
Do not edit the class manually.
Expand source code
class AIControllerApi(object): """NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech Do not edit the class manually. """ def __init__(self, api_client=None): if api_client is None: api_client = ApiClient() self.api_client = api_client def assert_ai_message(self, assert_ai_message_options, **kwargs): # noqa: E501 """Check named natural-language assertions against an existing email or SMS # noqa: E501 Check named natural-language assertions against an existing email or SMS. Returns PASS, FAIL, INCONCLUSIVE or a distinct operational status. Idempotency-Key enables 15-minute retry deduplication; reuse it only for an identical logical request. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.assert_ai_message(assert_ai_message_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param AssertAIMessageOptions assert_ai_message_options: (required) :param str idempotency_key: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: AIMessageResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.assert_ai_message_with_http_info(assert_ai_message_options, **kwargs) # noqa: E501 def assert_ai_message_with_http_info(self, assert_ai_message_options, **kwargs): # noqa: E501 """Check named natural-language assertions against an existing email or SMS # noqa: E501 Check named natural-language assertions against an existing email or SMS. Returns PASS, FAIL, INCONCLUSIVE or a distinct operational status. Idempotency-Key enables 15-minute retry deduplication; reuse it only for an identical logical request. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.assert_ai_message_with_http_info(assert_ai_message_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param AssertAIMessageOptions assert_ai_message_options: (required) :param str idempotency_key: :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: tuple(AIMessageResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'assert_ai_message_options', 'idempotency_key' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method assert_ai_message" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'assert_ai_message_options' is set if self.api_client.client_side_validation and ('assert_ai_message_options' not in local_var_params or # noqa: E501 local_var_params['assert_ai_message_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `assert_ai_message_options` when calling `assert_ai_message`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} if 'idempotency_key' in local_var_params: header_params['Idempotency-Key'] = local_var_params['idempotency_key'] # noqa: E501 form_params = [] local_var_files = {} body_params = None if 'assert_ai_message_options' in local_var_params: body_params = local_var_params['assert_ai_message_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/ai/messages/assert', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='AIMessageResult', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def create_transformer(self, ai_transform_create_options, **kwargs): # noqa: E501 """Create a transformer for reuse in automations # noqa: E501 Save an AI transform instructions and schema for use with webhooks and automations # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_transformer(ai_transform_create_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param AITransformCreateOptions ai_transform_create_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: AITransformDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.create_transformer_with_http_info(ai_transform_create_options, **kwargs) # noqa: E501 def create_transformer_with_http_info(self, ai_transform_create_options, **kwargs): # noqa: E501 """Create a transformer for reuse in automations # noqa: E501 Save an AI transform instructions and schema for use with webhooks and automations # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_transformer_with_http_info(ai_transform_create_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param AITransformCreateOptions ai_transform_create_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: tuple(AITransformDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'ai_transform_create_options' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method create_transformer" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'ai_transform_create_options' is set if self.api_client.client_side_validation and ('ai_transform_create_options' not in local_var_params or # noqa: E501 local_var_params['ai_transform_create_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `ai_transform_create_options` when calling `create_transformer`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'ai_transform_create_options' in local_var_params: body_params = local_var_params['ai_transform_create_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/ai/transformer', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='AITransformDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def create_transformer_mappings(self, create_ai_transformer_mapping_options, **kwargs): # noqa: E501 """Create transformer mapping # noqa: E501 Create AI transformer mappings to other entities # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_transformer_mappings(create_ai_transformer_mapping_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CreateAITransformerMappingOptions create_ai_transformer_mapping_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: AITransformMappingDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.create_transformer_mappings_with_http_info(create_ai_transformer_mapping_options, **kwargs) # noqa: E501 def create_transformer_mappings_with_http_info(self, create_ai_transformer_mapping_options, **kwargs): # noqa: E501 """Create transformer mapping # noqa: E501 Create AI transformer mappings to other entities # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_transformer_mappings_with_http_info(create_ai_transformer_mapping_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CreateAITransformerMappingOptions create_ai_transformer_mapping_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: tuple(AITransformMappingDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'create_ai_transformer_mapping_options' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method create_transformer_mappings" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'create_ai_transformer_mapping_options' is set if self.api_client.client_side_validation and ('create_ai_transformer_mapping_options' not in local_var_params or # noqa: E501 local_var_params['create_ai_transformer_mapping_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `create_ai_transformer_mapping_options` when calling `create_transformer_mappings`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'create_ai_transformer_mapping_options' in local_var_params: body_params = local_var_params['create_ai_transformer_mapping_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/ai/transformer/mappings', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='AITransformMappingDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def delete_all_transformer_mappings(self, **kwargs): # noqa: E501 """Delete all transformer mapping # noqa: E501 Delete all AI transformer mappings # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_all_transformer_mappings(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.delete_all_transformer_mappings_with_http_info(**kwargs) # noqa: E501 def delete_all_transformer_mappings_with_http_info(self, **kwargs): # noqa: E501 """Delete all transformer mapping # noqa: E501 Delete all AI transformer mappings # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_all_transformer_mappings_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: None If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method delete_all_transformer_mappings" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/ai/transformer/mappings', 'DELETE', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type=None, # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def delete_transformer(self, id, **kwargs): # noqa: E501 """Delete a transformer # noqa: E501 Delete an AI transformer and schemas by ID # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_transformer(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.delete_transformer_with_http_info(id, **kwargs) # noqa: E501 def delete_transformer_with_http_info(self, id, **kwargs): # noqa: E501 """Delete a transformer # noqa: E501 Delete an AI transformer and schemas by ID # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_transformer_with_http_info(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: None If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method delete_transformer" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if self.api_client.client_side_validation and ('id' not in local_var_params or # noqa: E501 local_var_params['id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `id` when calling `delete_transformer`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/ai/transformer/{id}', 'DELETE', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type=None, # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def delete_transformer_mapping(self, id, **kwargs): # noqa: E501 """Delete transformer mapping # noqa: E501 Delete an AI transformer mapping # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_transformer_mapping(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: ID of transform mapping (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.delete_transformer_mapping_with_http_info(id, **kwargs) # noqa: E501 def delete_transformer_mapping_with_http_info(self, id, **kwargs): # noqa: E501 """Delete transformer mapping # noqa: E501 Delete an AI transformer mapping # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_transformer_mapping_with_http_info(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: ID of transform mapping (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: None If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method delete_transformer_mapping" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if self.api_client.client_side_validation and ('id' not in local_var_params or # noqa: E501 local_var_params['id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `id` when calling `delete_transformer_mapping`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/ai/transformer/mappings/{id}', 'DELETE', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type=None, # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def delete_transformer_result(self, id, **kwargs): # noqa: E501 """Delete a transformer result # noqa: E501 Delete a saved AI transformer result owned by your account. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_transformer_result(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.delete_transformer_result_with_http_info(id, **kwargs) # noqa: E501 def delete_transformer_result_with_http_info(self, id, **kwargs): # noqa: E501 """Delete a transformer result # noqa: E501 Delete a saved AI transformer result owned by your account. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_transformer_result_with_http_info(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: None If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method delete_transformer_result" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if self.api_client.client_side_validation and ('id' not in local_var_params or # noqa: E501 local_var_params['id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `id` when calling `delete_transformer_result`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/ai/transformer/results/{id}', 'DELETE', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type=None, # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def delete_transformer_results(self, **kwargs): # noqa: E501 """Delete transformer results # noqa: E501 Delete your account's saved AI results, optionally for one transformer. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_transformer_results(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str ai_transform_id: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.delete_transformer_results_with_http_info(**kwargs) # noqa: E501 def delete_transformer_results_with_http_info(self, **kwargs): # noqa: E501 """Delete transformer results # noqa: E501 Delete your account's saved AI results, optionally for one transformer. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_transformer_results_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str ai_transform_id: :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: None If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'ai_transform_id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method delete_transformer_results" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] if 'ai_transform_id' in local_var_params and local_var_params['ai_transform_id'] is not None: # noqa: E501 query_params.append(('aiTransformId', local_var_params['ai_transform_id'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/ai/transformer/results', 'DELETE', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type=None, # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def delete_transformers(self, **kwargs): # noqa: E501 """Delete all transformers # noqa: E501 Delete all AI transformers and schemas # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_transformers(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.delete_transformers_with_http_info(**kwargs) # noqa: E501 def delete_transformers_with_http_info(self, **kwargs): # noqa: E501 """Delete all transformers # noqa: E501 Delete all AI transformers and schemas # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_transformers_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: None If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method delete_transformers" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/ai/transformer', 'DELETE', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type=None, # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def export_transformer_results(self, export_transformer_options, **kwargs): # noqa: E501 """Export transformer results # noqa: E501 Export AI transformer results in formats such as Excel, CSV, XML etc. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.export_transformer_results(export_transformer_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param ExportTransformerOptions export_transformer_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: ExportTransformerResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.export_transformer_results_with_http_info(export_transformer_options, **kwargs) # noqa: E501 def export_transformer_results_with_http_info(self, export_transformer_options, **kwargs): # noqa: E501 """Export transformer results # noqa: E501 Export AI transformer results in formats such as Excel, CSV, XML etc. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.export_transformer_results_with_http_info(export_transformer_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param ExportTransformerOptions export_transformer_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: tuple(ExportTransformerResponse, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'export_transformer_options' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method export_transformer_results" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'export_transformer_options' is set if self.api_client.client_side_validation and ('export_transformer_options' not in local_var_params or # noqa: E501 local_var_params['export_transformer_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `export_transformer_options` when calling `export_transformer_results`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'export_transformer_options' in local_var_params: body_params = local_var_params['export_transformer_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/ai/transformer/results/export', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='ExportTransformerResponse', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def extract_ai_message(self, extract_ai_message_options, **kwargs): # noqa: E501 """Extract schema-validated data from an existing email or SMS with verified source evidence # noqa: E501 Extract schema-validated data from an existing email or SMS with verified source evidence. Missing or ambiguous data is not invented. Idempotency-Key enables 15-minute retry deduplication; reuse it only for an identical logical request. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.extract_ai_message(extract_ai_message_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param ExtractAIMessageOptions extract_ai_message_options: (required) :param str idempotency_key: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: AIMessageResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.extract_ai_message_with_http_info(extract_ai_message_options, **kwargs) # noqa: E501 def extract_ai_message_with_http_info(self, extract_ai_message_options, **kwargs): # noqa: E501 """Extract schema-validated data from an existing email or SMS with verified source evidence # noqa: E501 Extract schema-validated data from an existing email or SMS with verified source evidence. Missing or ambiguous data is not invented. Idempotency-Key enables 15-minute retry deduplication; reuse it only for an identical logical request. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.extract_ai_message_with_http_info(extract_ai_message_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param ExtractAIMessageOptions extract_ai_message_options: (required) :param str idempotency_key: :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: tuple(AIMessageResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'extract_ai_message_options', 'idempotency_key' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method extract_ai_message" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'extract_ai_message_options' is set if self.api_client.client_side_validation and ('extract_ai_message_options' not in local_var_params or # noqa: E501 local_var_params['extract_ai_message_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `extract_ai_message_options` when calling `extract_ai_message`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} if 'idempotency_key' in local_var_params: header_params['Idempotency-Key'] = local_var_params['idempotency_key'] # noqa: E501 form_params = [] local_var_files = {} body_params = None if 'extract_ai_message_options' in local_var_params: body_params = local_var_params['extract_ai_message_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/ai/messages/extract', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='AIMessageResult', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def generate_structured_content_from_attachment(self, generate_structured_content_attachment_options, **kwargs): # noqa: E501 """Generate structured content for an attachment # noqa: E501 Use output schemas to extract data from an attachment using AI # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.generate_structured_content_from_attachment(generate_structured_content_attachment_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param GenerateStructuredContentAttachmentOptions generate_structured_content_attachment_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: StructuredContentResultDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.generate_structured_content_from_attachment_with_http_info(generate_structured_content_attachment_options, **kwargs) # noqa: E501 def generate_structured_content_from_attachment_with_http_info(self, generate_structured_content_attachment_options, **kwargs): # noqa: E501 """Generate structured content for an attachment # noqa: E501 Use output schemas to extract data from an attachment using AI # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.generate_structured_content_from_attachment_with_http_info(generate_structured_content_attachment_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param GenerateStructuredContentAttachmentOptions generate_structured_content_attachment_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: tuple(StructuredContentResultDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'generate_structured_content_attachment_options' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method generate_structured_content_from_attachment" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'generate_structured_content_attachment_options' is set if self.api_client.client_side_validation and ('generate_structured_content_attachment_options' not in local_var_params or # noqa: E501 local_var_params['generate_structured_content_attachment_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `generate_structured_content_attachment_options` when calling `generate_structured_content_from_attachment`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'generate_structured_content_attachment_options' in local_var_params: body_params = local_var_params['generate_structured_content_attachment_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/ai/structured-content/attachment', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='StructuredContentResultDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def generate_structured_content_from_email(self, generate_structured_content_email_options, **kwargs): # noqa: E501 """Generate structured content for an email # noqa: E501 Use output schemas to extract data from an email using AI # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.generate_structured_content_from_email(generate_structured_content_email_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param GenerateStructuredContentEmailOptions generate_structured_content_email_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: StructuredContentResultDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.generate_structured_content_from_email_with_http_info(generate_structured_content_email_options, **kwargs) # noqa: E501 def generate_structured_content_from_email_with_http_info(self, generate_structured_content_email_options, **kwargs): # noqa: E501 """Generate structured content for an email # noqa: E501 Use output schemas to extract data from an email using AI # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.generate_structured_content_from_email_with_http_info(generate_structured_content_email_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param GenerateStructuredContentEmailOptions generate_structured_content_email_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: tuple(StructuredContentResultDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'generate_structured_content_email_options' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method generate_structured_content_from_email" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'generate_structured_content_email_options' is set if self.api_client.client_side_validation and ('generate_structured_content_email_options' not in local_var_params or # noqa: E501 local_var_params['generate_structured_content_email_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `generate_structured_content_email_options` when calling `generate_structured_content_from_email`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'generate_structured_content_email_options' in local_var_params: body_params = local_var_params['generate_structured_content_email_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/ai/structured-content/email', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='StructuredContentResultDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def generate_structured_content_from_sms(self, generate_structured_content_sms_options, **kwargs): # noqa: E501 """Generate structured content for a TXT message # noqa: E501 Use output schemas to extract data from an SMS using AI # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.generate_structured_content_from_sms(generate_structured_content_sms_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param GenerateStructuredContentSmsOptions generate_structured_content_sms_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: StructuredContentResultDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.generate_structured_content_from_sms_with_http_info(generate_structured_content_sms_options, **kwargs) # noqa: E501 def generate_structured_content_from_sms_with_http_info(self, generate_structured_content_sms_options, **kwargs): # noqa: E501 """Generate structured content for a TXT message # noqa: E501 Use output schemas to extract data from an SMS using AI # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.generate_structured_content_from_sms_with_http_info(generate_structured_content_sms_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param GenerateStructuredContentSmsOptions generate_structured_content_sms_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: tuple(StructuredContentResultDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'generate_structured_content_sms_options' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method generate_structured_content_from_sms" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'generate_structured_content_sms_options' is set if self.api_client.client_side_validation and ('generate_structured_content_sms_options' not in local_var_params or # noqa: E501 local_var_params['generate_structured_content_sms_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `generate_structured_content_sms_options` when calling `generate_structured_content_from_sms`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'generate_structured_content_sms_options' in local_var_params: body_params = local_var_params['generate_structured_content_sms_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/ai/structured-content/sms', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='StructuredContentResultDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_ai_message_models(self, **kwargs): # noqa: E501 """List supported message-testing AI models # noqa: E501 Discover enum model selectors, resolved provider models, evaluator versions and token multipliers. Pinned models never silently fall back. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_ai_message_models(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: list[AIMessageModelDto] If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_ai_message_models_with_http_info(**kwargs) # noqa: E501 def get_ai_message_models_with_http_info(self, **kwargs): # noqa: E501 """List supported message-testing AI models # noqa: E501 Discover enum model selectors, resolved provider models, evaluator versions and token multipliers. Pinned models never silently fall back. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_ai_message_models_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: tuple(list[AIMessageModelDto], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_ai_message_models" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/ai/models', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='list[AIMessageModelDto]', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_export_transformer_results_job(self, id, **kwargs): # noqa: E501 """Get export transformer results job # noqa: E501 Get the job status for an export # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_export_transformer_results_job(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: ExportTransformerResultJobDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_export_transformer_results_job_with_http_info(id, **kwargs) # noqa: E501 def get_export_transformer_results_job_with_http_info(self, id, **kwargs): # noqa: E501 """Get export transformer results job # noqa: E501 Get the job status for an export # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_export_transformer_results_job_with_http_info(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: tuple(ExportTransformerResultJobDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_export_transformer_results_job" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if self.api_client.client_side_validation and ('id' not in local_var_params or # noqa: E501 local_var_params['id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `id` when calling `get_export_transformer_results_job`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/ai/transformer/results/export/{id}', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='ExportTransformerResultJobDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_transformer(self, id, **kwargs): # noqa: E501 """Get a transformer # noqa: E501 Get AI transformer and schemas by ID # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_transformer(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: AITransformDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_transformer_with_http_info(id, **kwargs) # noqa: E501 def get_transformer_with_http_info(self, id, **kwargs): # noqa: E501 """Get a transformer # noqa: E501 Get AI transformer and schemas by ID # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_transformer_with_http_info(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: tuple(AITransformDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_transformer" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if self.api_client.client_side_validation and ('id' not in local_var_params or # noqa: E501 local_var_params['id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `id` when calling `get_transformer`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/ai/transformer/{id}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='AITransformDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_transformer_mapping(self, id, **kwargs): # noqa: E501 """Get transformer mapping # noqa: E501 Get an AI transformer mapping # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_transformer_mapping(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: ID of transform mapping (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: AITransformMappingDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_transformer_mapping_with_http_info(id, **kwargs) # noqa: E501 def get_transformer_mapping_with_http_info(self, id, **kwargs): # noqa: E501 """Get transformer mapping # noqa: E501 Get an AI transformer mapping # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_transformer_mapping_with_http_info(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: ID of transform mapping (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: tuple(AITransformMappingDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_transformer_mapping" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if self.api_client.client_side_validation and ('id' not in local_var_params or # noqa: E501 local_var_params['id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `id` when calling `get_transformer_mapping`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/ai/transformer/mappings/{id}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='AITransformMappingDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_transformer_mappings(self, **kwargs): # noqa: E501 """Get transformer mappings # noqa: E501 Get AI transformer mappings to other entities # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_transformer_mappings(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str ai_transform_id: :param str entity_id: :param str entity_type: :param int page: :param int size: Optional page size. Maximum size is 100. Use page index and sort to page through larger results :param str sort: Optional createdAt sort direction ASC or DESC :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: PageAITransformMappingProjection If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_transformer_mappings_with_http_info(**kwargs) # noqa: E501 def get_transformer_mappings_with_http_info(self, **kwargs): # noqa: E501 """Get transformer mappings # noqa: E501 Get AI transformer mappings to other entities # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_transformer_mappings_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str ai_transform_id: :param str entity_id: :param str entity_type: :param int page: :param int size: Optional page size. Maximum size is 100. Use page index and sort to page through larger results :param str sort: Optional createdAt sort direction ASC or DESC :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: tuple(PageAITransformMappingProjection, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'ai_transform_id', 'entity_id', 'entity_type', 'page', 'size', 'sort' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_transformer_mappings" % key ) local_var_params[key] = val del local_var_params['kwargs'] if self.api_client.client_side_validation and 'size' in local_var_params and local_var_params['size'] > 100: # noqa: E501 raise ApiValueError("Invalid value for parameter `size` when calling `get_transformer_mappings`, must be a value less than or equal to `100`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'ai_transform_id' in local_var_params and local_var_params['ai_transform_id'] is not None: # noqa: E501 query_params.append(('aiTransformId', local_var_params['ai_transform_id'])) # noqa: E501 if 'entity_id' in local_var_params and local_var_params['entity_id'] is not None: # noqa: E501 query_params.append(('entityId', local_var_params['entity_id'])) # noqa: E501 if 'entity_type' in local_var_params and local_var_params['entity_type'] is not None: # noqa: E501 query_params.append(('entityType', local_var_params['entity_type'])) # noqa: E501 if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 query_params.append(('page', local_var_params['page'])) # noqa: E501 if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501 query_params.append(('sort', local_var_params['sort'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/ai/transformer/mappings', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageAITransformMappingProjection', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_transformer_result(self, id, **kwargs): # noqa: E501 """Get transformer result # noqa: E501 Get AI transformer result # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_transformer_result(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: ID of transform result (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: AITransformResultDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_transformer_result_with_http_info(id, **kwargs) # noqa: E501 def get_transformer_result_with_http_info(self, id, **kwargs): # noqa: E501 """Get transformer result # noqa: E501 Get AI transformer result # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_transformer_result_with_http_info(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: ID of transform result (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: tuple(AITransformResultDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_transformer_result" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if self.api_client.client_side_validation and ('id' not in local_var_params or # noqa: E501 local_var_params['id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `id` when calling `get_transformer_result`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/ai/transformer/results/{id}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='AITransformResultDto', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_transformer_results(self, **kwargs): # noqa: E501 """Get transformer results # noqa: E501 Get AI transformer results # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_transformer_results(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: :param str sms_id: :param str attachment_id: :param str ai_transform_id: :param str ai_transform_mapping_id: :param str entity_id: :param str entity_type: :param int page: :param int size: Optional page size. Maximum size is 100. Use page index and sort to page through larger results :param str sort: Optional createdAt sort direction ASC or DESC :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: PageAITransformResultProjection If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_transformer_results_with_http_info(**kwargs) # noqa: E501 def get_transformer_results_with_http_info(self, **kwargs): # noqa: E501 """Get transformer results # noqa: E501 Get AI transformer results # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_transformer_results_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str email_id: :param str sms_id: :param str attachment_id: :param str ai_transform_id: :param str ai_transform_mapping_id: :param str entity_id: :param str entity_type: :param int page: :param int size: Optional page size. Maximum size is 100. Use page index and sort to page through larger results :param str sort: Optional createdAt sort direction ASC or DESC :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: tuple(PageAITransformResultProjection, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'email_id', 'sms_id', 'attachment_id', 'ai_transform_id', 'ai_transform_mapping_id', 'entity_id', 'entity_type', 'page', 'size', 'sort' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_transformer_results" % key ) local_var_params[key] = val del local_var_params['kwargs'] if self.api_client.client_side_validation and 'size' in local_var_params and local_var_params['size'] > 100: # noqa: E501 raise ApiValueError("Invalid value for parameter `size` when calling `get_transformer_results`, must be a value less than or equal to `100`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'email_id' in local_var_params and local_var_params['email_id'] is not None: # noqa: E501 query_params.append(('emailId', local_var_params['email_id'])) # noqa: E501 if 'sms_id' in local_var_params and local_var_params['sms_id'] is not None: # noqa: E501 query_params.append(('smsId', local_var_params['sms_id'])) # noqa: E501 if 'attachment_id' in local_var_params and local_var_params['attachment_id'] is not None: # noqa: E501 query_params.append(('attachmentId', local_var_params['attachment_id'])) # noqa: E501 if 'ai_transform_id' in local_var_params and local_var_params['ai_transform_id'] is not None: # noqa: E501 query_params.append(('aiTransformId', local_var_params['ai_transform_id'])) # noqa: E501 if 'ai_transform_mapping_id' in local_var_params and local_var_params['ai_transform_mapping_id'] is not None: # noqa: E501 query_params.append(('aiTransformMappingId', local_var_params['ai_transform_mapping_id'])) # noqa: E501 if 'entity_id' in local_var_params and local_var_params['entity_id'] is not None: # noqa: E501 query_params.append(('entityId', local_var_params['entity_id'])) # noqa: E501 if 'entity_type' in local_var_params and local_var_params['entity_type'] is not None: # noqa: E501 query_params.append(('entityType', local_var_params['entity_type'])) # noqa: E501 if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 query_params.append(('page', local_var_params['page'])) # noqa: E501 if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501 query_params.append(('sort', local_var_params['sort'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/ai/transformer/results', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageAITransformResultProjection', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_transformer_results_table(self, include_meta_data, flatten_arrays_to_rows, **kwargs): # noqa: E501 """Get transformer results table # noqa: E501 Get AI transformer results in table format # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_transformer_results_table(include_meta_data, flatten_arrays_to_rows, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param bool include_meta_data: (required) :param bool flatten_arrays_to_rows: (required) :param str email_id: :param str sms_id: :param str attachment_id: :param str ai_transform_id: :param str ai_transform_mapping_id: :param str entity_id: :param str entity_type: :param int page: :param int size: Optional page size. Maximum size is 100. Use page index and sort to page through larger results :param str sort: Optional createdAt sort direction ASC or DESC :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: PageTableData If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_transformer_results_table_with_http_info(include_meta_data, flatten_arrays_to_rows, **kwargs) # noqa: E501 def get_transformer_results_table_with_http_info(self, include_meta_data, flatten_arrays_to_rows, **kwargs): # noqa: E501 """Get transformer results table # noqa: E501 Get AI transformer results in table format # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_transformer_results_table_with_http_info(include_meta_data, flatten_arrays_to_rows, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param bool include_meta_data: (required) :param bool flatten_arrays_to_rows: (required) :param str email_id: :param str sms_id: :param str attachment_id: :param str ai_transform_id: :param str ai_transform_mapping_id: :param str entity_id: :param str entity_type: :param int page: :param int size: Optional page size. Maximum size is 100. Use page index and sort to page through larger results :param str sort: Optional createdAt sort direction ASC or DESC :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: tuple(PageTableData, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'include_meta_data', 'flatten_arrays_to_rows', 'email_id', 'sms_id', 'attachment_id', 'ai_transform_id', 'ai_transform_mapping_id', 'entity_id', 'entity_type', 'page', 'size', 'sort' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_transformer_results_table" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'include_meta_data' is set if self.api_client.client_side_validation and ('include_meta_data' not in local_var_params or # noqa: E501 local_var_params['include_meta_data'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `include_meta_data` when calling `get_transformer_results_table`") # noqa: E501 # verify the required parameter 'flatten_arrays_to_rows' is set if self.api_client.client_side_validation and ('flatten_arrays_to_rows' not in local_var_params or # noqa: E501 local_var_params['flatten_arrays_to_rows'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `flatten_arrays_to_rows` when calling `get_transformer_results_table`") # noqa: E501 if self.api_client.client_side_validation and 'size' in local_var_params and local_var_params['size'] > 100: # noqa: E501 raise ApiValueError("Invalid value for parameter `size` when calling `get_transformer_results_table`, must be a value less than or equal to `100`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'email_id' in local_var_params and local_var_params['email_id'] is not None: # noqa: E501 query_params.append(('emailId', local_var_params['email_id'])) # noqa: E501 if 'sms_id' in local_var_params and local_var_params['sms_id'] is not None: # noqa: E501 query_params.append(('smsId', local_var_params['sms_id'])) # noqa: E501 if 'attachment_id' in local_var_params and local_var_params['attachment_id'] is not None: # noqa: E501 query_params.append(('attachmentId', local_var_params['attachment_id'])) # noqa: E501 if 'ai_transform_id' in local_var_params and local_var_params['ai_transform_id'] is not None: # noqa: E501 query_params.append(('aiTransformId', local_var_params['ai_transform_id'])) # noqa: E501 if 'ai_transform_mapping_id' in local_var_params and local_var_params['ai_transform_mapping_id'] is not None: # noqa: E501 query_params.append(('aiTransformMappingId', local_var_params['ai_transform_mapping_id'])) # noqa: E501 if 'entity_id' in local_var_params and local_var_params['entity_id'] is not None: # noqa: E501 query_params.append(('entityId', local_var_params['entity_id'])) # noqa: E501 if 'entity_type' in local_var_params and local_var_params['entity_type'] is not None: # noqa: E501 query_params.append(('entityType', local_var_params['entity_type'])) # noqa: E501 if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 query_params.append(('page', local_var_params['page'])) # noqa: E501 if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501 query_params.append(('sort', local_var_params['sort'])) # noqa: E501 if 'include_meta_data' in local_var_params and local_var_params['include_meta_data'] is not None: # noqa: E501 query_params.append(('includeMetaData', local_var_params['include_meta_data'])) # noqa: E501 if 'flatten_arrays_to_rows' in local_var_params and local_var_params['flatten_arrays_to_rows'] is not None: # noqa: E501 query_params.append(('flattenArraysToRows', local_var_params['flatten_arrays_to_rows'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/ai/transformer/results/table', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageTableData', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_transformers(self, **kwargs): # noqa: E501 """List transformers # noqa: E501 List all AI transforms # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_transformers(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int page: :param int size: Optional page size in SMS list pagination. Maximum size is 100. Use page index and sort to page through larger results :param str sort: Optional createdAt sort direction ASC or DESC :param list[str] include: Optional list of IDs to include in result :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: PageAITransformProjection If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_transformers_with_http_info(**kwargs) # noqa: E501 def get_transformers_with_http_info(self, **kwargs): # noqa: E501 """List transformers # noqa: E501 List all AI transforms # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_transformers_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int page: :param int size: Optional page size in SMS list pagination. Maximum size is 100. Use page index and sort to page through larger results :param str sort: Optional createdAt sort direction ASC or DESC :param list[str] include: Optional list of IDs to include in result :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: tuple(PageAITransformProjection, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'page', 'size', 'sort', 'include' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_transformers" % key ) local_var_params[key] = val del local_var_params['kwargs'] if self.api_client.client_side_validation and 'size' in local_var_params and local_var_params['size'] > 100: # noqa: E501 raise ApiValueError("Invalid value for parameter `size` when calling `get_transformers`, must be a value less than or equal to `100`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 query_params.append(('page', local_var_params['page'])) # noqa: E501 if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501 query_params.append(('sort', local_var_params['sort'])) # noqa: E501 if 'include' in local_var_params and local_var_params['include'] is not None: # noqa: E501 query_params.append(('include', local_var_params['include'])) # noqa: E501 collection_formats['include'] = 'multi' # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/ai/transformer', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageAITransformProjection', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def invoke_transformer(self, invoke_transformer_options, **kwargs): # noqa: E501 """Invoke a transformer # noqa: E501 Execute an AI transformer to generate structured content # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.invoke_transformer(invoke_transformer_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param InvokeTransformerOptions invoke_transformer_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: ConditionalStructuredContentResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.invoke_transformer_with_http_info(invoke_transformer_options, **kwargs) # noqa: E501 def invoke_transformer_with_http_info(self, invoke_transformer_options, **kwargs): # noqa: E501 """Invoke a transformer # noqa: E501 Execute an AI transformer to generate structured content # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.invoke_transformer_with_http_info(invoke_transformer_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param InvokeTransformerOptions invoke_transformer_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: tuple(ConditionalStructuredContentResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'invoke_transformer_options' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method invoke_transformer" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'invoke_transformer_options' is set if self.api_client.client_side_validation and ('invoke_transformer_options' not in local_var_params or # noqa: E501 local_var_params['invoke_transformer_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `invoke_transformer_options` when calling `invoke_transformer`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'invoke_transformer_options' in local_var_params: body_params = local_var_params['invoke_transformer_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/ai/transformer/invoke', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='ConditionalStructuredContentResult', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def test_transformer_mapping_match(self, id, **kwargs): # noqa: E501 """Test transformer mapping match result # noqa: E501 Evaluate transform mapping match conditions for given email, sms, or attachment # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.test_transformer_mapping_match(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: ID of transform mapping (required) :param str email_id: :param str sms_id: :param str attachment_id: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: AITransformMappingMatchResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.test_transformer_mapping_match_with_http_info(id, **kwargs) # noqa: E501 def test_transformer_mapping_match_with_http_info(self, id, **kwargs): # noqa: E501 """Test transformer mapping match result # noqa: E501 Evaluate transform mapping match conditions for given email, sms, or attachment # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.test_transformer_mapping_match_with_http_info(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: ID of transform mapping (required) :param str email_id: :param str sms_id: :param str attachment_id: :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: tuple(AITransformMappingMatchResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'id', 'email_id', 'sms_id', 'attachment_id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method test_transformer_mapping_match" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if self.api_client.client_side_validation and ('id' not in local_var_params or # noqa: E501 local_var_params['id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `id` when calling `test_transformer_mapping_match`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 query_params = [] if 'email_id' in local_var_params and local_var_params['email_id'] is not None: # noqa: E501 query_params.append(('emailId', local_var_params['email_id'])) # noqa: E501 if 'sms_id' in local_var_params and local_var_params['sms_id'] is not None: # noqa: E501 query_params.append(('smsId', local_var_params['sms_id'])) # noqa: E501 if 'attachment_id' in local_var_params and local_var_params['attachment_id'] is not None: # noqa: E501 query_params.append(('attachmentId', local_var_params['attachment_id'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/ai/transformer/mappings/{id}/match', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='AITransformMappingMatchResult', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def validate_structured_output_schema(self, structured_output_schema, **kwargs): # noqa: E501 """Validate structured content schema # noqa: E501 Check if a schema is valid and can be used to extract data using AI # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.validate_structured_output_schema(structured_output_schema, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param StructuredOutputSchema structured_output_schema: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: StructuredOutputSchemaValidation If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.validate_structured_output_schema_with_http_info(structured_output_schema, **kwargs) # noqa: E501 def validate_structured_output_schema_with_http_info(self, structured_output_schema, **kwargs): # noqa: E501 """Validate structured content schema # noqa: E501 Check if a schema is valid and can be used to extract data using AI # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.validate_structured_output_schema_with_http_info(structured_output_schema, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param StructuredOutputSchema structured_output_schema: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: tuple(StructuredOutputSchemaValidation, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'structured_output_schema' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method validate_structured_output_schema" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'structured_output_schema' is set if self.api_client.client_side_validation and ('structured_output_schema' not in local_var_params or # noqa: E501 local_var_params['structured_output_schema'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `structured_output_schema` when calling `validate_structured_output_schema`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'structured_output_schema' in local_var_params: body_params = local_var_params['structured_output_schema'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/ai/structured-content/validate', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='StructuredOutputSchemaValidation', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def wait_for_ai_message(self, wait_for_ai_message_options, **kwargs): # noqa: E501 """Find a message across explicit inboxes or phones, then assert and extract from that same message # noqa: E501 Find a message across explicit inboxes or phones, then assert and extract from that same message. Checks never select a replacement message after failure. Idempotency-Key enables 15-minute retry deduplication; reuse it only for an identical logical request. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.wait_for_ai_message(wait_for_ai_message_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param WaitForAIMessageOptions wait_for_ai_message_options: (required) :param str idempotency_key: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: AIMessageResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.wait_for_ai_message_with_http_info(wait_for_ai_message_options, **kwargs) # noqa: E501 def wait_for_ai_message_with_http_info(self, wait_for_ai_message_options, **kwargs): # noqa: E501 """Find a message across explicit inboxes or phones, then assert and extract from that same message # noqa: E501 Find a message across explicit inboxes or phones, then assert and extract from that same message. Checks never select a replacement message after failure. Idempotency-Key enables 15-minute retry deduplication; reuse it only for an identical logical request. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.wait_for_ai_message_with_http_info(wait_for_ai_message_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param WaitForAIMessageOptions wait_for_ai_message_options: (required) :param str idempotency_key: :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: tuple(AIMessageResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'wait_for_ai_message_options', 'idempotency_key' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method wait_for_ai_message" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'wait_for_ai_message_options' is set if self.api_client.client_side_validation and ('wait_for_ai_message_options' not in local_var_params or # noqa: E501 local_var_params['wait_for_ai_message_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `wait_for_ai_message_options` when calling `wait_for_ai_message`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} if 'idempotency_key' in local_var_params: header_params['Idempotency-Key'] = local_var_params['idempotency_key'] # noqa: E501 form_params = [] local_var_files = {} body_params = None if 'wait_for_ai_message_options' in local_var_params: body_params = local_var_params['wait_for_ai_message_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/ai/messages/wait', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='AIMessageResult', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def wait_for_ai_messages(self, wait_for_ai_messages_options, **kwargs): # noqa: E501 """Wait for all named email and SMS expectations under one shared deadline and AI token budget # noqa: E501 Wait for all named email and SMS expectations under one shared deadline and AI token budget. Idempotency-Key enables 15-minute retry deduplication; reuse it only for an identical logical request. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.wait_for_ai_messages(wait_for_ai_messages_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param WaitForAIMessagesOptions wait_for_ai_messages_options: (required) :param str idempotency_key: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: AIMessagesResult If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.wait_for_ai_messages_with_http_info(wait_for_ai_messages_options, **kwargs) # noqa: E501 def wait_for_ai_messages_with_http_info(self, wait_for_ai_messages_options, **kwargs): # noqa: E501 """Wait for all named email and SMS expectations under one shared deadline and AI token budget # noqa: E501 Wait for all named email and SMS expectations under one shared deadline and AI token budget. Idempotency-Key enables 15-minute retry deduplication; reuse it only for an identical logical request. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.wait_for_ai_messages_with_http_info(wait_for_ai_messages_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param WaitForAIMessagesOptions wait_for_ai_messages_options: (required) :param str idempotency_key: :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: tuple(AIMessagesResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'wait_for_ai_messages_options', 'idempotency_key' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method wait_for_ai_messages" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'wait_for_ai_messages_options' is set if self.api_client.client_side_validation and ('wait_for_ai_messages_options' not in local_var_params or # noqa: E501 local_var_params['wait_for_ai_messages_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `wait_for_ai_messages_options` when calling `wait_for_ai_messages`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} if 'idempotency_key' in local_var_params: header_params['Idempotency-Key'] = local_var_params['idempotency_key'] # noqa: E501 form_params = [] local_var_files = {} body_params = None if 'wait_for_ai_messages_options' in local_var_params: body_params = local_var_params['wait_for_ai_messages_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/ai/messages/wait-all', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='AIMessagesResult', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)Methods
def assert_ai_message(self, assert_ai_message_options, **kwargs)-
Check named natural-language assertions against an existing email or SMS # noqa: E501
Check named natural-language assertions against an existing email or SMS. Returns PASS, FAIL, INCONCLUSIVE or a distinct operational status. Idempotency-Key enables 15-minute retry deduplication; reuse it only for an identical logical request. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.assert_ai_message(assert_ai_message_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param AssertAIMessageOptions assert_ai_message_options: (required) :param str idempotency_key: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: AIMessageResult If the method is called asynchronously, returns the request thread.
def assert_ai_message_with_http_info(self, assert_ai_message_options, **kwargs)-
Check named natural-language assertions against an existing email or SMS # noqa: E501
Check named natural-language assertions against an existing email or SMS. Returns PASS, FAIL, INCONCLUSIVE or a distinct operational status. Idempotency-Key enables 15-minute retry deduplication; reuse it only for an identical logical request. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.assert_ai_message_with_http_info(assert_ai_message_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param AssertAIMessageOptions assert_ai_message_options: (required) :param str idempotency_key: :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: tuple(AIMessageResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def create_transformer(self, ai_transform_create_options, **kwargs)-
Create a transformer for reuse in automations # noqa: E501
Save an AI transform instructions and schema for use with webhooks and automations # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_transformer(ai_transform_create_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param AITransformCreateOptions ai_transform_create_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: AITransformDto If the method is called asynchronously, returns the request thread.
def create_transformer_mappings(self, create_ai_transformer_mapping_options, **kwargs)-
Create transformer mapping # noqa: E501
Create AI transformer mappings to other entities # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_transformer_mappings(create_ai_transformer_mapping_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param CreateAITransformerMappingOptions create_ai_transformer_mapping_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: AITransformMappingDto If the method is called asynchronously, returns the request thread.
def create_transformer_mappings_with_http_info(self, create_ai_transformer_mapping_options, **kwargs)-
Create transformer mapping # noqa: E501
Create AI transformer mappings to other entities # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_transformer_mappings_with_http_info(create_ai_transformer_mapping_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param CreateAITransformerMappingOptions create_ai_transformer_mapping_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: tuple(AITransformMappingDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def create_transformer_with_http_info(self, ai_transform_create_options, **kwargs)-
Create a transformer for reuse in automations # noqa: E501
Save an AI transform instructions and schema for use with webhooks and automations # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_transformer_with_http_info(ai_transform_create_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param AITransformCreateOptions ai_transform_create_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: tuple(AITransformDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def delete_all_transformer_mappings(self, **kwargs)-
Delete all transformer mapping # noqa: E501
Delete all AI transformer mappings # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_all_transformer_mappings(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: None If the method is called asynchronously, returns the request thread.
def delete_all_transformer_mappings_with_http_info(self, **kwargs)-
Delete all transformer mapping # noqa: E501
Delete all AI transformer mappings # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_all_transformer_mappings_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: None If the method is called asynchronously, returns the request thread.
def delete_transformer(self, id, **kwargs)-
Delete a transformer # noqa: E501
Delete an AI transformer and schemas by ID # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_transformer(id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: None If the method is called asynchronously, returns the request thread.
def delete_transformer_mapping(self, id, **kwargs)-
Delete transformer mapping # noqa: E501
Delete an AI transformer mapping # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_transformer_mapping(id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: ID of transform mapping (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: None If the method is called asynchronously, returns the request thread.
def delete_transformer_mapping_with_http_info(self, id, **kwargs)-
Delete transformer mapping # noqa: E501
Delete an AI transformer mapping # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_transformer_mapping_with_http_info(id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: ID of transform mapping (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: None If the method is called asynchronously, returns the request thread.
def delete_transformer_result(self, id, **kwargs)-
Delete a transformer result # noqa: E501
Delete a saved AI transformer result owned by your account. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_transformer_result(id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: None If the method is called asynchronously, returns the request thread.
def delete_transformer_result_with_http_info(self, id, **kwargs)-
Delete a transformer result # noqa: E501
Delete a saved AI transformer result owned by your account. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_transformer_result_with_http_info(id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: None If the method is called asynchronously, returns the request thread.
def delete_transformer_results(self, **kwargs)-
Delete transformer results # noqa: E501
Delete your account's saved AI results, optionally for one transformer. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_transformer_results(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str ai_transform_id: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: None If the method is called asynchronously, returns the request thread.
def delete_transformer_results_with_http_info(self, **kwargs)-
Delete transformer results # noqa: E501
Delete your account's saved AI results, optionally for one transformer. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_transformer_results_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str ai_transform_id: :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: None If the method is called asynchronously, returns the request thread.
def delete_transformer_with_http_info(self, id, **kwargs)-
Delete a transformer # noqa: E501
Delete an AI transformer and schemas by ID # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_transformer_with_http_info(id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: None If the method is called asynchronously, returns the request thread.
def delete_transformers(self, **kwargs)-
Delete all transformers # noqa: E501
Delete all AI transformers and schemas # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_transformers(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: None If the method is called asynchronously, returns the request thread.
def delete_transformers_with_http_info(self, **kwargs)-
Delete all transformers # noqa: E501
Delete all AI transformers and schemas # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_transformers_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: None If the method is called asynchronously, returns the request thread.
def export_transformer_results(self, export_transformer_options, **kwargs)-
Export transformer results # noqa: E501
Export AI transformer results in formats such as Excel, CSV, XML etc. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.export_transformer_results(export_transformer_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param ExportTransformerOptions export_transformer_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: ExportTransformerResponse If the method is called asynchronously, returns the request thread.
def export_transformer_results_with_http_info(self, export_transformer_options, **kwargs)-
Export transformer results # noqa: E501
Export AI transformer results in formats such as Excel, CSV, XML etc. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.export_transformer_results_with_http_info(export_transformer_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param ExportTransformerOptions export_transformer_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: tuple(ExportTransformerResponse, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def extract_ai_message(self, extract_ai_message_options, **kwargs)-
Extract schema-validated data from an existing email or SMS with verified source evidence # noqa: E501
Extract schema-validated data from an existing email or SMS with verified source evidence. Missing or ambiguous data is not invented. Idempotency-Key enables 15-minute retry deduplication; reuse it only for an identical logical request. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.extract_ai_message(extract_ai_message_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param ExtractAIMessageOptions extract_ai_message_options: (required) :param str idempotency_key: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: AIMessageResult If the method is called asynchronously, returns the request thread.
def extract_ai_message_with_http_info(self, extract_ai_message_options, **kwargs)-
Extract schema-validated data from an existing email or SMS with verified source evidence # noqa: E501
Extract schema-validated data from an existing email or SMS with verified source evidence. Missing or ambiguous data is not invented. Idempotency-Key enables 15-minute retry deduplication; reuse it only for an identical logical request. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.extract_ai_message_with_http_info(extract_ai_message_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param ExtractAIMessageOptions extract_ai_message_options: (required) :param str idempotency_key: :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: tuple(AIMessageResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def generate_structured_content_from_attachment(self, generate_structured_content_attachment_options, **kwargs)-
Generate structured content for an attachment # noqa: E501
Use output schemas to extract data from an attachment using AI # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.generate_structured_content_from_attachment(generate_structured_content_attachment_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param GenerateStructuredContentAttachmentOptions generate_structured_content_attachment_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: StructuredContentResultDto If the method is called asynchronously, returns the request thread.
def generate_structured_content_from_attachment_with_http_info(self, generate_structured_content_attachment_options, **kwargs)-
Generate structured content for an attachment # noqa: E501
Use output schemas to extract data from an attachment using AI # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.generate_structured_content_from_attachment_with_http_info(generate_structured_content_attachment_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param GenerateStructuredContentAttachmentOptions generate_structured_content_attachment_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: tuple(StructuredContentResultDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def generate_structured_content_from_email(self, generate_structured_content_email_options, **kwargs)-
Generate structured content for an email # noqa: E501
Use output schemas to extract data from an email using AI # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.generate_structured_content_from_email(generate_structured_content_email_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param GenerateStructuredContentEmailOptions generate_structured_content_email_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: StructuredContentResultDto If the method is called asynchronously, returns the request thread.
def generate_structured_content_from_email_with_http_info(self, generate_structured_content_email_options, **kwargs)-
Generate structured content for an email # noqa: E501
Use output schemas to extract data from an email using AI # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.generate_structured_content_from_email_with_http_info(generate_structured_content_email_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param GenerateStructuredContentEmailOptions generate_structured_content_email_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: tuple(StructuredContentResultDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def generate_structured_content_from_sms(self, generate_structured_content_sms_options, **kwargs)-
Generate structured content for a TXT message # noqa: E501
Use output schemas to extract data from an SMS using AI # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.generate_structured_content_from_sms(generate_structured_content_sms_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param GenerateStructuredContentSmsOptions generate_structured_content_sms_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: StructuredContentResultDto If the method is called asynchronously, returns the request thread.
def generate_structured_content_from_sms_with_http_info(self, generate_structured_content_sms_options, **kwargs)-
Generate structured content for a TXT message # noqa: E501
Use output schemas to extract data from an SMS using AI # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.generate_structured_content_from_sms_with_http_info(generate_structured_content_sms_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param GenerateStructuredContentSmsOptions generate_structured_content_sms_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: tuple(StructuredContentResultDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_ai_message_models(self, **kwargs)-
List supported message-testing AI models # noqa: E501
Discover enum model selectors, resolved provider models, evaluator versions and token multipliers. Pinned models never silently fall back. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_ai_message_models(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: list[AIMessageModelDto] If the method is called asynchronously, returns the request thread.
def get_ai_message_models_with_http_info(self, **kwargs)-
List supported message-testing AI models # noqa: E501
Discover enum model selectors, resolved provider models, evaluator versions and token multipliers. Pinned models never silently fall back. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_ai_message_models_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: tuple(list[AIMessageModelDto], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_export_transformer_results_job(self, id, **kwargs)-
Get export transformer results job # noqa: E501
Get the job status for an export # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_export_transformer_results_job(id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: ExportTransformerResultJobDto If the method is called asynchronously, returns the request thread.
def get_export_transformer_results_job_with_http_info(self, id, **kwargs)-
Get export transformer results job # noqa: E501
Get the job status for an export # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_export_transformer_results_job_with_http_info(id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: tuple(ExportTransformerResultJobDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_transformer(self, id, **kwargs)-
Get a transformer # noqa: E501
Get AI transformer and schemas by ID # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_transformer(id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: AITransformDto If the method is called asynchronously, returns the request thread.
def get_transformer_mapping(self, id, **kwargs)-
Get transformer mapping # noqa: E501
Get an AI transformer mapping # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_transformer_mapping(id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: ID of transform mapping (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: AITransformMappingDto If the method is called asynchronously, returns the request thread.
def get_transformer_mapping_with_http_info(self, id, **kwargs)-
Get transformer mapping # noqa: E501
Get an AI transformer mapping # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_transformer_mapping_with_http_info(id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: ID of transform mapping (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: tuple(AITransformMappingDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_transformer_mappings(self, **kwargs)-
Get transformer mappings # noqa: E501
Get AI transformer mappings to other entities # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_transformer_mappings(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str ai_transform_id: :param str entity_id: :param str entity_type: :param int page: :param int size: Optional page size. Maximum size is 100. Use page index and sort to page through larger results :param str sort: Optional createdAt sort direction ASC or DESC :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: PageAITransformMappingProjection If the method is called asynchronously, returns the request thread.
def get_transformer_mappings_with_http_info(self, **kwargs)-
Get transformer mappings # noqa: E501
Get AI transformer mappings to other entities # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_transformer_mappings_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str ai_transform_id: :param str entity_id: :param str entity_type: :param int page: :param int size: Optional page size. Maximum size is 100. Use page index and sort to page through larger results :param str sort: Optional createdAt sort direction ASC or DESC :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: tuple(PageAITransformMappingProjection, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_transformer_result(self, id, **kwargs)-
Get transformer result # noqa: E501
Get AI transformer result # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_transformer_result(id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: ID of transform result (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: AITransformResultDto If the method is called asynchronously, returns the request thread.
def get_transformer_result_with_http_info(self, id, **kwargs)-
Get transformer result # noqa: E501
Get AI transformer result # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_transformer_result_with_http_info(id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: ID of transform result (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: tuple(AITransformResultDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_transformer_results(self, **kwargs)-
Get transformer results # noqa: E501
Get AI transformer results # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_transformer_results(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_id: :param str sms_id: :param str attachment_id: :param str ai_transform_id: :param str ai_transform_mapping_id: :param str entity_id: :param str entity_type: :param int page: :param int size: Optional page size. Maximum size is 100. Use page index and sort to page through larger results :param str sort: Optional createdAt sort direction ASC or DESC :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: PageAITransformResultProjection If the method is called asynchronously, returns the request thread.
def get_transformer_results_table(self, include_meta_data, flatten_arrays_to_rows, **kwargs)-
Get transformer results table # noqa: E501
Get AI transformer results in table format # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_transformer_results_table(include_meta_data, flatten_arrays_to_rows, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param bool include_meta_data: (required) :param bool flatten_arrays_to_rows: (required) :param str email_id: :param str sms_id: :param str attachment_id: :param str ai_transform_id: :param str ai_transform_mapping_id: :param str entity_id: :param str entity_type: :param int page: :param int size: Optional page size. Maximum size is 100. Use page index and sort to page through larger results :param str sort: Optional createdAt sort direction ASC or DESC :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: PageTableData If the method is called asynchronously, returns the request thread.
def get_transformer_results_table_with_http_info(self, include_meta_data, flatten_arrays_to_rows, **kwargs)-
Get transformer results table # noqa: E501
Get AI transformer results in table format # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_transformer_results_table_with_http_info(include_meta_data, flatten_arrays_to_rows, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param bool include_meta_data: (required) :param bool flatten_arrays_to_rows: (required) :param str email_id: :param str sms_id: :param str attachment_id: :param str ai_transform_id: :param str ai_transform_mapping_id: :param str entity_id: :param str entity_type: :param int page: :param int size: Optional page size. Maximum size is 100. Use page index and sort to page through larger results :param str sort: Optional createdAt sort direction ASC or DESC :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: tuple(PageTableData, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_transformer_results_with_http_info(self, **kwargs)-
Get transformer results # noqa: E501
Get AI transformer results # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_transformer_results_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str email_id: :param str sms_id: :param str attachment_id: :param str ai_transform_id: :param str ai_transform_mapping_id: :param str entity_id: :param str entity_type: :param int page: :param int size: Optional page size. Maximum size is 100. Use page index and sort to page through larger results :param str sort: Optional createdAt sort direction ASC or DESC :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: tuple(PageAITransformResultProjection, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_transformer_with_http_info(self, id, **kwargs)-
Get a transformer # noqa: E501
Get AI transformer and schemas by ID # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_transformer_with_http_info(id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: tuple(AITransformDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_transformers(self, **kwargs)-
List transformers # noqa: E501
List all AI transforms # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_transformers(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param int page: :param int size: Optional page size in SMS list pagination. Maximum size is 100. Use page index and sort to page through larger results :param str sort: Optional createdAt sort direction ASC or DESC :param list[str] include: Optional list of IDs to include in result :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: PageAITransformProjection If the method is called asynchronously, returns the request thread.
def get_transformers_with_http_info(self, **kwargs)-
List transformers # noqa: E501
List all AI transforms # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_transformers_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param int page: :param int size: Optional page size in SMS list pagination. Maximum size is 100. Use page index and sort to page through larger results :param str sort: Optional createdAt sort direction ASC or DESC :param list[str] include: Optional list of IDs to include in result :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: tuple(PageAITransformProjection, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def invoke_transformer(self, invoke_transformer_options, **kwargs)-
Invoke a transformer # noqa: E501
Execute an AI transformer to generate structured content # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.invoke_transformer(invoke_transformer_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param InvokeTransformerOptions invoke_transformer_options: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: ConditionalStructuredContentResult If the method is called asynchronously, returns the request thread.
def invoke_transformer_with_http_info(self, invoke_transformer_options, **kwargs)-
Invoke a transformer # noqa: E501
Execute an AI transformer to generate structured content # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.invoke_transformer_with_http_info(invoke_transformer_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param InvokeTransformerOptions invoke_transformer_options: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: tuple(ConditionalStructuredContentResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def test_transformer_mapping_match(self, id, **kwargs)-
Test transformer mapping match result # noqa: E501
Evaluate transform mapping match conditions for given email, sms, or attachment # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.test_transformer_mapping_match(id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: ID of transform mapping (required) :param str email_id: :param str sms_id: :param str attachment_id: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: AITransformMappingMatchResult If the method is called asynchronously, returns the request thread.
def test_transformer_mapping_match_with_http_info(self, id, **kwargs)-
Test transformer mapping match result # noqa: E501
Evaluate transform mapping match conditions for given email, sms, or attachment # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.test_transformer_mapping_match_with_http_info(id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: ID of transform mapping (required) :param str email_id: :param str sms_id: :param str attachment_id: :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: tuple(AITransformMappingMatchResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def validate_structured_output_schema(self, structured_output_schema, **kwargs)-
Validate structured content schema # noqa: E501
Check if a schema is valid and can be used to extract data using AI # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.validate_structured_output_schema(structured_output_schema, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param StructuredOutputSchema structured_output_schema: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: StructuredOutputSchemaValidation If the method is called asynchronously, returns the request thread.
def validate_structured_output_schema_with_http_info(self, structured_output_schema, **kwargs)-
Validate structured content schema # noqa: E501
Check if a schema is valid and can be used to extract data using AI # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.validate_structured_output_schema_with_http_info(structured_output_schema, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param StructuredOutputSchema structured_output_schema: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: tuple(StructuredOutputSchemaValidation, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def wait_for_ai_message(self, wait_for_ai_message_options, **kwargs)-
Find a message across explicit inboxes or phones, then assert and extract from that same message # noqa: E501
Find a message across explicit inboxes or phones, then assert and extract from that same message. Checks never select a replacement message after failure. Idempotency-Key enables 15-minute retry deduplication; reuse it only for an identical logical request. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.wait_for_ai_message(wait_for_ai_message_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param WaitForAIMessageOptions wait_for_ai_message_options: (required) :param str idempotency_key: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: AIMessageResult If the method is called asynchronously, returns the request thread.
def wait_for_ai_message_with_http_info(self, wait_for_ai_message_options, **kwargs)-
Find a message across explicit inboxes or phones, then assert and extract from that same message # noqa: E501
Find a message across explicit inboxes or phones, then assert and extract from that same message. Checks never select a replacement message after failure. Idempotency-Key enables 15-minute retry deduplication; reuse it only for an identical logical request. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.wait_for_ai_message_with_http_info(wait_for_ai_message_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param WaitForAIMessageOptions wait_for_ai_message_options: (required) :param str idempotency_key: :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: tuple(AIMessageResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def wait_for_ai_messages(self, wait_for_ai_messages_options, **kwargs)-
Wait for all named email and SMS expectations under one shared deadline and AI token budget # noqa: E501
Wait for all named email and SMS expectations under one shared deadline and AI token budget. Idempotency-Key enables 15-minute retry deduplication; reuse it only for an identical logical request. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.wait_for_ai_messages(wait_for_ai_messages_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param WaitForAIMessagesOptions wait_for_ai_messages_options: (required) :param str idempotency_key: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: AIMessagesResult If the method is called asynchronously, returns the request thread.
def wait_for_ai_messages_with_http_info(self, wait_for_ai_messages_options, **kwargs)-
Wait for all named email and SMS expectations under one shared deadline and AI token budget # noqa: E501
Wait for all named email and SMS expectations under one shared deadline and AI token budget. Idempotency-Key enables 15-minute retry deduplication; reuse it only for an identical logical request. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.wait_for_ai_messages_with_http_info(wait_for_ai_messages_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param WaitForAIMessagesOptions wait_for_ai_messages_options: (required) :param str idempotency_key: :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :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. :return: tuple(AIMessagesResult, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.