revengai 1.88.0__tar.gz → 1.89.2__tar.gz

revengai-1.89.2/.sdk-version

@@ -0,0 +1 @@
+v1.89.2

{revengai-1.88.0 → revengai-1.89.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: revengai
-Version: 1.88.0
+Version: 1.89.2
 Summary: RevEng.AI API
 Project-URL: Repository, https://github.com/RevEngAI/revengai-python
 Keywords: RevEng.AI API
@@ -372,10 +372,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)

{revengai-1.88.0 → revengai-1.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)

{revengai-1.88.0 → revengai-1.89.2}/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
 

revengai-1.88.0/docs/FunctionMatchingScopeRequest.md → revengai-1.89.2/docs/FunctionMatchingFilters.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)
 

revengai-1.89.2/docs/FunctionMatchingRequest.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)
+
+

{revengai-1.88.0 → revengai-1.89.2}/docs/FunctionMatchingResultWithBestMatch.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
 

{revengai-1.88.0 → revengai-1.89.2}/docs/FunctionsCoreApi.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

{revengai-1.88.0 → revengai-1.89.2}/revengai/__init__.py

@@ -13,7 +13,7 @@
 """  # noqa: E501
 
 
-__version__ = "v1.88.0"
+__version__ = "v1.89.2"
 
 # Define package exports
 __all__ = [
@@ -242,10 +242,10 @@ __all__ = [
     "FunctionLocalVariableResponse",
     "FunctionMapping",
     "FunctionMappingFull",
-    "FunctionMatchingBatchRequest",
     "FunctionMatchingBatchResponse",
+    "FunctionMatchingFilters",
+    "FunctionMatchingRequest",
     "FunctionMatchingResultWithBestMatch",
-    "FunctionMatchingScopeRequest",
     "FunctionNameConfidenceBody",
     "FunctionNameHistory",
     "FunctionNameInput",
@@ -590,10 +590,10 @@ from revengai.models.function_info_output import FunctionInfoOutput as FunctionI
 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-1.88.0 → revengai-1.89.2}/revengai/api/functions_core_api.py

@@ -29,8 +29,8 @@ from revengai.models.base_response_function_capability_response import BaseRespo
 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 @@ class FunctionsCoreApi:
     ) -> 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 @@ class FunctionsCoreApi:
     ) -> 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 @@ class FunctionsCoreApi:
     ) -> 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 @@ class FunctionsCoreApi:
     @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 @@ class FunctionsCoreApi:
 
         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 @@ class FunctionsCoreApi:
         """ # 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 @@ class FunctionsCoreApi:
     @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 @@ class FunctionsCoreApi:
 
         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 @@ class FunctionsCoreApi:
         """ # 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 @@ class FunctionsCoreApi:
     @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 @@ class FunctionsCoreApi:
 
         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 @@ class FunctionsCoreApi:
         """ # 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 @@ class FunctionsCoreApi:
 
     def _batch_function_matching_serialize(
         self,
-        function_matching_batch_request,
+        function_matching_request,
         authorization,
         _request_auth,
         _content_type,
@@ -1214,8 +1214,8 @@ class FunctionsCoreApi:
             _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`

{revengai-1.88.0 → revengai-1.89.2}/revengai/api_client.py

@@ -90,7 +90,7 @@ class ApiClient:
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'OpenAPI-Generator/v1.88.0/python'
+        self.user_agent = 'OpenAPI-Generator/v1.89.2/python'
         self.client_side_validation = configuration.client_side_validation
 
     def __enter__(self):

{revengai-1.88.0 → revengai-1.89.2}/revengai/configuration.py

@@ -529,8 +529,8 @@ conf = revengai.Configuration(
         return "Python SDK Debug Report:\n"\
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
-               "Version of the API: v1.88.0\n"\
-               "SDK Package Version: v1.88.0".\
+               "Version of the API: v1.89.2\n"\
+               "SDK Package Version: v1.89.2".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self) -> List[HostSetting]:

{revengai-1.88.0 → revengai-1.89.2}/revengai/models/__init__.py

@@ -208,10 +208,10 @@ from revengai.models.function_info_output import FunctionInfoOutput
 from revengai.models.function_local_variable_response import FunctionLocalVariableResponse
 from revengai.models.function_mapping import FunctionMapping
 from revengai.models.function_mapping_full import FunctionMappingFull
-from revengai.models.function_matching_batch_request import FunctionMatchingBatchRequest
 from revengai.models.function_matching_batch_response import FunctionMatchingBatchResponse
+from revengai.models.function_matching_filters import FunctionMatchingFilters
+from revengai.models.function_matching_request import FunctionMatchingRequest
 from revengai.models.function_matching_result_with_best_match import FunctionMatchingResultWithBestMatch
-from revengai.models.function_matching_scope_request import FunctionMatchingScopeRequest
 from revengai.models.function_name_confidence_body import FunctionNameConfidenceBody
 from revengai.models.function_name_history import FunctionNameHistory
 from revengai.models.function_name_input import FunctionNameInput

{revengai-1.88.0 → revengai-1.89.2}/revengai/models/analysis_function_matching_request.py

@@ -19,6 +19,7 @@ import json
 from pydantic import BaseModel, ConfigDict, Field
 from typing import Any, ClassVar, Dict, List, Optional, Union
 from typing_extensions import Annotated
+from revengai.models.function_matching_filters import FunctionMatchingFilters
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -27,7 +28,8 @@ class AnalysisFunctionMatchingRequest(BaseModel):
     AnalysisFunctionMatchingRequest
     """ # noqa: E501
     min_similarity: Optional[Union[Annotated[float, Field(le=1.0, strict=True, ge=0.0)], Annotated[int, Field(le=1, strict=True, ge=0)]]] = Field(default=0.9, description="Minimum similarity expected for a match, default is 0.9")
-    __properties: ClassVar[List[str]] = ["min_similarity"]
+    filters: Optional[FunctionMatchingFilters] = None
+    __properties: ClassVar[List[str]] = ["min_similarity", "filters"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -68,6 +70,14 @@ class AnalysisFunctionMatchingRequest(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
+        # override the default output from pydantic by calling `to_dict()` of filters
+        if self.filters:
+            _dict['filters'] = self.filters.to_dict()
+        # set to None if filters (nullable) is None
+        # and model_fields_set contains the field
+        if self.filters is None and "filters" in self.model_fields_set:
+            _dict['filters'] = None
+
         return _dict
 
     @classmethod
@@ -80,7 +90,8 @@ class AnalysisFunctionMatchingRequest(BaseModel):
             return cls.model_validate(obj)
 
         _obj = cls.model_validate({
-            "min_similarity": obj.get("min_similarity") if obj.get("min_similarity") is not None else 0.9
+            "min_similarity": obj.get("min_similarity") if obj.get("min_similarity") is not None else 0.9,
+            "filters": FunctionMatchingFilters.from_dict(obj["filters"]) if obj.get("filters") is not None else None
         })
         return _obj
 

revengai-1.88.0/revengai/models/function_matching_scope_request.py → revengai-1.89.2/revengai/models/function_matching_filters.py

@@ -17,21 +17,19 @@ import re  # noqa: F401
 import json
 
 from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr, field_validator
-from typing import Any, ClassVar, Dict, List, Optional, Union
-from typing_extensions import Annotated
+from typing import Any, ClassVar, Dict, List, Optional
 from typing import Optional, Set
 from typing_extensions import Self
 
-class FunctionMatchingScopeRequest(BaseModel):
+class FunctionMatchingFilters(BaseModel):
     """
-    FunctionMatchingScopeRequest
+    FunctionMatchingFilters
     """ # noqa: E501
     binary_ids: Optional[List[StrictInt]] = Field(default=None, description="ID's of binaries to limit the search to, if empty, search all scoped binaries")
     collection_ids: Optional[List[StrictInt]] = Field(default=None, description="ID's of collections to limit the search to, if empty, search all scoped collections")
     function_ids: Optional[List[StrictInt]] = Field(default=None, description="ID's of functions to limit the search to, if empty, search all scoped functions")
-    min_similarity: Optional[Union[Annotated[float, Field(le=1.0, strict=True, ge=0.0)], Annotated[int, Field(le=1, strict=True, ge=0)]]] = Field(default=0.9, description="Minimum similarity expected for a match, default is 0.9")
     debug_types: Optional[List[StrictStr]] = Field(default=None, description="Limit the search to specific debug types, if empty, search all scoped debug & non-debug functions")
-    __properties: ClassVar[List[str]] = ["binary_ids", "collection_ids", "function_ids", "min_similarity", "debug_types"]
+    __properties: ClassVar[List[str]] = ["binary_ids", "collection_ids", "function_ids", "debug_types"]
 
     @field_validator('debug_types')
     def debug_types_validate_enum(cls, value):
@@ -62,7 +60,7 @@ class FunctionMatchingScopeRequest(BaseModel):
 
     @classmethod
     def from_json(cls, json_str: str) -> Optional[Self]:
-        """Create an instance of FunctionMatchingScopeRequest from a JSON string"""
+        """Create an instance of FunctionMatchingFilters from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
     def to_dict(self) -> Dict[str, Any]:
@@ -87,7 +85,7 @@ class FunctionMatchingScopeRequest(BaseModel):
 
     @classmethod
     def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of FunctionMatchingScopeRequest from a dict"""
+        """Create an instance of FunctionMatchingFilters from a dict"""
         if obj is None:
             return None
 
@@ -98,7 +96,6 @@ class FunctionMatchingScopeRequest(BaseModel):
             "binary_ids": obj.get("binary_ids"),
             "collection_ids": obj.get("collection_ids"),
             "function_ids": obj.get("function_ids"),
-            "min_similarity": obj.get("min_similarity") if obj.get("min_similarity") is not None else 0.9,
             "debug_types": obj.get("debug_types")
         })
         return _obj

revengai-1.89.2/revengai/models/function_matching_request.py

@@ -0,0 +1,102 @@
+# coding: utf-8
+
+"""
+    RevEng.AI API
+
+    RevEng.AI is Similarity Search Engine for executable binaries
+
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictInt
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing_extensions import Annotated
+from revengai.models.function_matching_filters import FunctionMatchingFilters
+from typing import Optional, Set
+from typing_extensions import Self
+
+class FunctionMatchingRequest(BaseModel):
+    """
+    FunctionMatchingRequest
+    """ # noqa: E501
+    model_id: StrictInt = Field(description="ID of the model used for function matching, used to determine the embedding model")
+    function_ids: List[StrictInt] = Field(description="ID's of functions to find matches for, must be at least one function ID")
+    min_similarity: Optional[Union[Annotated[float, Field(le=1.0, strict=True, ge=0.0)], Annotated[int, Field(le=1, strict=True, ge=0)]]] = Field(default=0.9, description="Minimum similarity expected for a match, default is 0.9")
+    filters: Optional[FunctionMatchingFilters] = None
+    __properties: ClassVar[List[str]] = ["model_id", "function_ids", "min_similarity", "filters"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of FunctionMatchingRequest from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of filters
+        if self.filters:
+            _dict['filters'] = self.filters.to_dict()
+        # set to None if filters (nullable) is None
+        # and model_fields_set contains the field
+        if self.filters is None and "filters" in self.model_fields_set:
+            _dict['filters'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of FunctionMatchingRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "model_id": obj.get("model_id"),
+            "function_ids": obj.get("function_ids"),
+            "min_similarity": obj.get("min_similarity") if obj.get("min_similarity") is not None else 0.9,
+            "filters": FunctionMatchingFilters.from_dict(obj["filters"]) if obj.get("filters") is not None else None
+        })
+        return _obj
+
+

{revengai-1.88.0 → revengai-1.89.2}/revengai/models/function_matching_result_with_best_match.py

@@ -27,10 +27,10 @@ class FunctionMatchingResultWithBestMatch(BaseModel):
     FunctionMatchingResultWithBestMatch
     """ # noqa: E501
     function_id: StrictInt
-    similarity: Union[StrictFloat, StrictInt]
     matched_function: MatchedFunction
     suggested_name: Optional[StrictStr] = None
-    __properties: ClassVar[List[str]] = ["function_id", "similarity", "matched_function", "suggested_name"]
+    suggested_name_confidence: Optional[Union[StrictFloat, StrictInt]] = None
+    __properties: ClassVar[List[str]] = ["function_id", "matched_function", "suggested_name", "suggested_name_confidence"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -79,6 +79,11 @@ class FunctionMatchingResultWithBestMatch(BaseModel):
         if self.suggested_name is None and "suggested_name" in self.model_fields_set:
             _dict['suggested_name'] = None
 
+        # set to None if suggested_name_confidence (nullable) is None
+        # and model_fields_set contains the field
+        if self.suggested_name_confidence is None and "suggested_name_confidence" in self.model_fields_set:
+            _dict['suggested_name_confidence'] = None
+
         return _dict
 
     @classmethod
@@ -92,9 +97,9 @@ class FunctionMatchingResultWithBestMatch(BaseModel):
 
         _obj = cls.model_validate({
             "function_id": obj.get("function_id"),
-            "similarity": obj.get("similarity"),
             "matched_function": MatchedFunction.from_dict(obj["matched_function"]) if obj.get("matched_function") is not None else None,
-            "suggested_name": obj.get("suggested_name")
+            "suggested_name": obj.get("suggested_name"),
+            "suggested_name_confidence": obj.get("suggested_name_confidence")
         })
         return _obj