Merge pull request #17 from RevEngAI/sdk-update-v1.89.2

🤖 Update SDK to version v1.89.2

Author: robertmarsal

.sdk-version

@@ -1 +1 @@
-v1.88.0
+v1.89.2

README.md

@@ -358,10 +358,10 @@ Class | Method | HTTP request | Description
  - [FunctionLocalVariableResponse](docs/FunctionLocalVariableResponse.md)
  - [FunctionMapping](docs/FunctionMapping.md)
  - [FunctionMappingFull](docs/FunctionMappingFull.md)
- - [FunctionMatchingBatchRequest](docs/FunctionMatchingBatchRequest.md)
  - [FunctionMatchingBatchResponse](docs/FunctionMatchingBatchResponse.md)
+ - [FunctionMatchingFilters](docs/FunctionMatchingFilters.md)
+ - [FunctionMatchingRequest](docs/FunctionMatchingRequest.md)
  - [FunctionMatchingResultWithBestMatch](docs/FunctionMatchingResultWithBestMatch.md)
- - [FunctionMatchingScopeRequest](docs/FunctionMatchingScopeRequest.md)
  - [FunctionNameConfidenceBody](docs/FunctionNameConfidenceBody.md)
  - [FunctionNameHistory](docs/FunctionNameHistory.md)
  - [FunctionNameInput](docs/FunctionNameInput.md)

docs/AnalysisFunctionMatchingRequest.md

@@ -6,6 +6,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **min_similarity** | **float** | Minimum similarity expected for a match, default is 0.9 | [optional] [default to 0.9]
+**filters** | [**FunctionMatchingFilters**](FunctionMatchingFilters.md) |  | [optional] 
 
 ## Example
 

docs/FunctionMatchingBatchRequest.md

@@ -1,4 +1,4 @@
-# FunctionMatchingScopeRequest
+# FunctionMatchingFilters
 
 
 ## Properties
@@ -8,25 +8,24 @@ Name | Type | Description | Notes
 **binary_ids** | **List[int]** | ID's of binaries to limit the search to, if empty, search all scoped binaries | [optional] [default to []]
 **collection_ids** | **List[int]** | ID's of collections to limit the search to, if empty, search all scoped collections | [optional] [default to []]
 **function_ids** | **List[int]** | ID's of functions to limit the search to, if empty, search all scoped functions | [optional] [default to []]
-**min_similarity** | **float** | Minimum similarity expected for a match, default is 0.9 | [optional] [default to 0.9]
 **debug_types** | **List[str]** | Limit the search to specific debug types, if empty, search all scoped debug & non-debug functions | [optional] [default to []]
 
 ## Example
 
 ```python
-from revengai.models.function_matching_scope_request import FunctionMatchingScopeRequest
+from revengai.models.function_matching_filters import FunctionMatchingFilters
 
 # TODO update the JSON string below
 json = "{}"
-# create an instance of FunctionMatchingScopeRequest from a JSON string
-function_matching_scope_request_instance = FunctionMatchingScopeRequest.from_json(json)
+# create an instance of FunctionMatchingFilters from a JSON string
+function_matching_filters_instance = FunctionMatchingFilters.from_json(json)
 # print the JSON string representation of the object
-print(FunctionMatchingScopeRequest.to_json())
+print(FunctionMatchingFilters.to_json())
 
 # convert the object into a dict
-function_matching_scope_request_dict = function_matching_scope_request_instance.to_dict()
-# create an instance of FunctionMatchingScopeRequest from a dict
-function_matching_scope_request_from_dict = FunctionMatchingScopeRequest.from_dict(function_matching_scope_request_dict)
+function_matching_filters_dict = function_matching_filters_instance.to_dict()
+# create an instance of FunctionMatchingFilters from a dict
+function_matching_filters_from_dict = FunctionMatchingFilters.from_dict(function_matching_filters_dict)
 ```
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

docs/FunctionMatchingScopeRequest.md docs/FunctionMatchingFilters.mddocs/FunctionMatchingScopeRequest.md renamed to docs/FunctionMatchingFilters.md

@@ -0,0 +1,32 @@
+# FunctionMatchingRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**model_id** | **int** | ID of the model used for function matching, used to determine the embedding model | 
+**function_ids** | **List[int]** | ID's of functions to find matches for, must be at least one function ID | 
+**min_similarity** | **float** | Minimum similarity expected for a match, default is 0.9 | [optional] [default to 0.9]
+**filters** | [**FunctionMatchingFilters**](FunctionMatchingFilters.md) |  | [optional] 
+
+## Example
+
+```python
+from revengai.models.function_matching_request import FunctionMatchingRequest
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of FunctionMatchingRequest from a JSON string
+function_matching_request_instance = FunctionMatchingRequest.from_json(json)
+# print the JSON string representation of the object
+print(FunctionMatchingRequest.to_json())
+
+# convert the object into a dict
+function_matching_request_dict = function_matching_request_instance.to_dict()
+# create an instance of FunctionMatchingRequest from a dict
+function_matching_request_from_dict = FunctionMatchingRequest.from_dict(function_matching_request_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

docs/FunctionMatchingRequest.md

@@ -6,9 +6,9 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **function_id** | **int** |  | 
-**similarity** | **float** |  | 
 **matched_function** | [**MatchedFunction**](MatchedFunction.md) |  | 
 **suggested_name** | **str** |  | [optional] 
+**suggested_name_confidence** | **float** |  | [optional] 
 
 ## Example
 

docs/FunctionMatchingResultWithBestMatch.md

@@ -109,7 +109,7 @@ Name | Type | Description  | Notes
 
 Perform matching for the functions of an analysis
 
-Takes in an analysis id and settings and finds the nearest functions for each function that's within the system
+Takes in an analysis id and settings and matches the nearest functions to the ones associated with it. Results can optionally be filtered by collection, binary, debug type or (other) function ids
 
 ### Example
 
@@ -275,7 +275,7 @@ Name | Type | Description  | Notes
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
 # **batch_function_matching**
-> FunctionMatchingBatchResponse batch_function_matching(function_matching_batch_request, authorization=authorization)
+> FunctionMatchingBatchResponse batch_function_matching(function_matching_request, authorization=authorization)
 
 Perform function matching for an arbitrary batch of functions, binaries or collections
 
@@ -287,8 +287,8 @@ Takes in an input of functions ID's and settings and finds the nearest functions
 
 ```python
 import revengai
-from revengai.models.function_matching_batch_request import FunctionMatchingBatchRequest
 from revengai.models.function_matching_batch_response import FunctionMatchingBatchResponse
+from revengai.models.function_matching_request import FunctionMatchingRequest
 from revengai.rest import ApiException
 from pprint import pprint
 
@@ -313,12 +313,12 @@ configuration.api_key['APIKey'] = os.environ["API_KEY"]
 with revengai.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = revengai.FunctionsCoreApi(api_client)
-    function_matching_batch_request = revengai.FunctionMatchingBatchRequest() # FunctionMatchingBatchRequest | 
+    function_matching_request = revengai.FunctionMatchingRequest() # FunctionMatchingRequest | 
     authorization = 'authorization_example' # str | API Key bearer token (optional)
 
     try:
         # Perform function matching for an arbitrary batch of functions, binaries or collections
-        api_response = api_instance.batch_function_matching(function_matching_batch_request, authorization=authorization)
+        api_response = api_instance.batch_function_matching(function_matching_request, authorization=authorization)
         print("The response of FunctionsCoreApi->batch_function_matching:\n")
         pprint(api_response)
     except Exception as e:
@@ -332,7 +332,7 @@ with revengai.ApiClient(configuration) as api_client:
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **function_matching_batch_request** | [**FunctionMatchingBatchRequest**](FunctionMatchingBatchRequest.md)|  | 
+ **function_matching_request** | [**FunctionMatchingRequest**](FunctionMatchingRequest.md)|  | 
  **authorization** | **str**| API Key bearer token | [optional] 
 
 ### Return type

docs/FunctionsCoreApi.md

@@ -13,7 +13,7 @@
 """  # noqa: E501
 
 
-__version__ = "v1.88.0"
+__version__ = "v1.89.2"
 
 # Define package exports
 __all__ = [
@@ -242,10 +242,10 @@
     "FunctionLocalVariableResponse",
     "FunctionMapping",
     "FunctionMappingFull",
-    "FunctionMatchingBatchRequest",
     "FunctionMatchingBatchResponse",
+    "FunctionMatchingFilters",
+    "FunctionMatchingRequest",
     "FunctionMatchingResultWithBestMatch",
-    "FunctionMatchingScopeRequest",
     "FunctionNameConfidenceBody",
     "FunctionNameHistory",
     "FunctionNameInput",
@@ -590,10 +590,10 @@
 from revengai.models.function_local_variable_response import FunctionLocalVariableResponse as FunctionLocalVariableResponse
 from revengai.models.function_mapping import FunctionMapping as FunctionMapping
 from revengai.models.function_mapping_full import FunctionMappingFull as FunctionMappingFull
-from revengai.models.function_matching_batch_request import FunctionMatchingBatchRequest as FunctionMatchingBatchRequest
 from revengai.models.function_matching_batch_response import FunctionMatchingBatchResponse as FunctionMatchingBatchResponse
+from revengai.models.function_matching_filters import FunctionMatchingFilters as FunctionMatchingFilters
+from revengai.models.function_matching_request import FunctionMatchingRequest as FunctionMatchingRequest
 from revengai.models.function_matching_result_with_best_match import FunctionMatchingResultWithBestMatch as FunctionMatchingResultWithBestMatch
-from revengai.models.function_matching_scope_request import FunctionMatchingScopeRequest as FunctionMatchingScopeRequest
 from revengai.models.function_name_confidence_body import FunctionNameConfidenceBody as FunctionNameConfidenceBody
 from revengai.models.function_name_history import FunctionNameHistory as FunctionNameHistory
 from revengai.models.function_name_input import FunctionNameInput as FunctionNameInput

revengai/__init__.py

@@ -29,8 +29,8 @@
 from revengai.models.base_response_function_strings_response import BaseResponseFunctionStringsResponse
 from revengai.models.base_response_functions_detail_response import BaseResponseFunctionsDetailResponse
 from revengai.models.base_response_list_similar_functions_response import BaseResponseListSimilarFunctionsResponse
-from revengai.models.function_matching_batch_request import FunctionMatchingBatchRequest
 from revengai.models.function_matching_batch_response import FunctionMatchingBatchResponse
+from revengai.models.function_matching_request import FunctionMatchingRequest
 
 from revengai.api_client import ApiClient, RequestSerialized
 from revengai.api_response import ApiResponse
@@ -378,7 +378,7 @@ def analysis_function_matching(
     ) -> FunctionMatchingBatchResponse:
         """Perform matching for the functions of an analysis
 
-        Takes in an analysis id and settings and finds the nearest functions for each function that's within the system
+        Takes in an analysis id and settings and matches the nearest functions to the ones associated with it. Results can optionally be filtered by collection, binary, debug type or (other) function ids
 
         :param analysis_id: (required)
         :type analysis_id: int
@@ -454,7 +454,7 @@ def analysis_function_matching_with_http_info(
     ) -> ApiResponse[FunctionMatchingBatchResponse]:
         """Perform matching for the functions of an analysis
 
-        Takes in an analysis id and settings and finds the nearest functions for each function that's within the system
+        Takes in an analysis id and settings and matches the nearest functions to the ones associated with it. Results can optionally be filtered by collection, binary, debug type or (other) function ids
 
         :param analysis_id: (required)
         :type analysis_id: int
@@ -530,7 +530,7 @@ def analysis_function_matching_without_preload_content(
     ) -> RESTResponseType:
         """Perform matching for the functions of an analysis
 
-        Takes in an analysis id and settings and finds the nearest functions for each function that's within the system
+        Takes in an analysis id and settings and matches the nearest functions to the ones associated with it. Results can optionally be filtered by collection, binary, debug type or (other) function ids
 
         :param analysis_id: (required)
         :type analysis_id: int
@@ -974,7 +974,7 @@ def _auto_unstrip_serialize(
     @validate_call
     def batch_function_matching(
         self,
-        function_matching_batch_request: FunctionMatchingBatchRequest,
+        function_matching_request: FunctionMatchingRequest,
         authorization: Annotated[Optional[StrictStr], Field(description="API Key bearer token")] = None,
         _request_timeout: Union[
             None,
@@ -993,8 +993,8 @@ def batch_function_matching(
 
         Takes in an input of functions ID's and settings and finds the nearest functions for each function that's within the system
 
-        :param function_matching_batch_request: (required)
-        :type function_matching_batch_request: FunctionMatchingBatchRequest
+        :param function_matching_request: (required)
+        :type function_matching_request: FunctionMatchingRequest
         :param authorization: API Key bearer token
         :type authorization: str
         :param _request_timeout: timeout setting for this request. If one
@@ -1020,7 +1020,7 @@ def batch_function_matching(
         """ # noqa: E501
 
         _param = self._batch_function_matching_serialize(
-            function_matching_batch_request=function_matching_batch_request,
+            function_matching_request=function_matching_request,
             authorization=authorization,
             _request_auth=_request_auth,
             _content_type=_content_type,
@@ -1046,7 +1046,7 @@ def batch_function_matching(
     @validate_call
     def batch_function_matching_with_http_info(
         self,
-        function_matching_batch_request: FunctionMatchingBatchRequest,
+        function_matching_request: FunctionMatchingRequest,
         authorization: Annotated[Optional[StrictStr], Field(description="API Key bearer token")] = None,
         _request_timeout: Union[
             None,
@@ -1065,8 +1065,8 @@ def batch_function_matching_with_http_info(
 
         Takes in an input of functions ID's and settings and finds the nearest functions for each function that's within the system
 
-        :param function_matching_batch_request: (required)
-        :type function_matching_batch_request: FunctionMatchingBatchRequest
+        :param function_matching_request: (required)
+        :type function_matching_request: FunctionMatchingRequest
         :param authorization: API Key bearer token
         :type authorization: str
         :param _request_timeout: timeout setting for this request. If one
@@ -1092,7 +1092,7 @@ def batch_function_matching_with_http_info(
         """ # noqa: E501
 
         _param = self._batch_function_matching_serialize(
-            function_matching_batch_request=function_matching_batch_request,
+            function_matching_request=function_matching_request,
             authorization=authorization,
             _request_auth=_request_auth,
             _content_type=_content_type,
@@ -1118,7 +1118,7 @@ def batch_function_matching_with_http_info(
     @validate_call
     def batch_function_matching_without_preload_content(
         self,
-        function_matching_batch_request: FunctionMatchingBatchRequest,
+        function_matching_request: FunctionMatchingRequest,
         authorization: Annotated[Optional[StrictStr], Field(description="API Key bearer token")] = None,
         _request_timeout: Union[
             None,
@@ -1137,8 +1137,8 @@ def batch_function_matching_without_preload_content(
 
         Takes in an input of functions ID's and settings and finds the nearest functions for each function that's within the system
 
-        :param function_matching_batch_request: (required)
-        :type function_matching_batch_request: FunctionMatchingBatchRequest
+        :param function_matching_request: (required)
+        :type function_matching_request: FunctionMatchingRequest
         :param authorization: API Key bearer token
         :type authorization: str
         :param _request_timeout: timeout setting for this request. If one
@@ -1164,7 +1164,7 @@ def batch_function_matching_without_preload_content(
         """ # noqa: E501
 
         _param = self._batch_function_matching_serialize(
-            function_matching_batch_request=function_matching_batch_request,
+            function_matching_request=function_matching_request,
             authorization=authorization,
             _request_auth=_request_auth,
             _content_type=_content_type,
@@ -1185,7 +1185,7 @@ def batch_function_matching_without_preload_content(
 
     def _batch_function_matching_serialize(
         self,
-        function_matching_batch_request,
+        function_matching_request,
         authorization,
         _request_auth,
         _content_type,
@@ -1214,8 +1214,8 @@ def _batch_function_matching_serialize(
             _header_params['authorization'] = authorization
         # process the form parameters
         # process the body parameter
-        if function_matching_batch_request is not None:
-            _body_params = function_matching_batch_request
+        if function_matching_request is not None:
+            _body_params = function_matching_request
 
 
         # set the HTTP header `Accept`