revengai 1.85.0__tar.gz → 1.88.0__tar.gz

revengai-1.88.0/.sdk-version

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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: revengai
-Version: 1.85.0
+Version: 1.88.0
 Summary: RevEng.AI API
 Project-URL: Repository, https://github.com/RevEngAI/revengai-python
 Keywords: RevEng.AI API
@@ -59,6 +59,7 @@ Class | Method | HTTP request | Description
 *AnalysesCommentsApi* | [**delete_analysis_comment**](docs/AnalysesCommentsApi.md#delete_analysis_comment) | **DELETE** /v2/analyses/{analysis_id}/comments/{comment_id} | Delete a comment
 *AnalysesCommentsApi* | [**get_analysis_comments**](docs/AnalysesCommentsApi.md#get_analysis_comments) | **GET** /v2/analyses/{analysis_id}/comments | Get comments for this analysis
 *AnalysesCommentsApi* | [**update_analysis_comment**](docs/AnalysesCommentsApi.md#update_analysis_comment) | **PATCH** /v2/analyses/{analysis_id}/comments/{comment_id} | Update a comment
+*AnalysesCoreApi* | [**batch_symbol_ann**](docs/AnalysesCoreApi.md#batch_symbol_ann) | **POST** /v1/ann/symbol/batch | Batch Symbol ANN using function IDs
 *AnalysesCoreApi* | [**create_analysis**](docs/AnalysesCoreApi.md#create_analysis) | **POST** /v2/analyses | Create Analysis
 *AnalysesCoreApi* | [**delete_analysis**](docs/AnalysesCoreApi.md#delete_analysis) | **DELETE** /v2/analyses/{analysis_id} | Delete Analysis
 *AnalysesCoreApi* | [**find_similar_functions_batch**](docs/AnalysesCoreApi.md#find_similar_functions_batch) | **POST** /v2/analyses/{analysis_id}/similarity/functions | Batch Symbol ANN using Analysis ID
@@ -135,7 +136,9 @@ Class | Method | HTTP request | Description
 *FunctionsBlockCommentsApi* | [**generate_block_comments_for_function**](docs/FunctionsBlockCommentsApi.md#generate_block_comments_for_function) | **POST** /v2/functions/{function_id}/block-comments | Generate block comments for a function
 *FunctionsBlockCommentsApi* | [**generate_overview_comment_for_function**](docs/FunctionsBlockCommentsApi.md#generate_overview_comment_for_function) | **POST** /v2/functions/{function_id}/block-comments/overview | Generate overview comment for a function
 *FunctionsCoreApi* | [**ai_unstrip**](docs/FunctionsCoreApi.md#ai_unstrip) | **POST** /v2/analyses/{analysis_id}/functions/ai-unstrip | Performs matching and auto-unstrip for an analysis and its functions
+*FunctionsCoreApi* | [**analysis_function_matching**](docs/FunctionsCoreApi.md#analysis_function_matching) | **POST** /v2/analyses/{analysis_id}/functions/matches | Perform matching for the functions of an analysis
 *FunctionsCoreApi* | [**auto_unstrip**](docs/FunctionsCoreApi.md#auto_unstrip) | **POST** /v2/analyses/{analysis_id}/functions/auto-unstrip | Performs matching and auto-unstrip for an analysis and its functions
+*FunctionsCoreApi* | [**batch_function_matching**](docs/FunctionsCoreApi.md#batch_function_matching) | **POST** /v2/functions/matches | Perform function matching for an arbitrary batch of functions, binaries or collections
 *FunctionsCoreApi* | [**cancel_ai_unstrip**](docs/FunctionsCoreApi.md#cancel_ai_unstrip) | **DELETE** /v2/analyses/{analysis_id}/functions/ai-unstrip/cancel | Cancels a running ai-unstrip
 *FunctionsCoreApi* | [**cancel_auto_unstrip**](docs/FunctionsCoreApi.md#cancel_auto_unstrip) | **DELETE** /v2/analyses/{analysis_id}/functions/unstrip/cancel | Cancels a running auto-unstrip
 *FunctionsCoreApi* | [**get_analysis_strings**](docs/FunctionsCoreApi.md#get_analysis_strings) | **GET** /v2/analyses/{analysis_id}/functions/strings | Get string information found in the Analysis
@@ -169,7 +172,6 @@ Class | Method | HTTP request | Description
 *SearchApi* | [**search_collections**](docs/SearchApi.md#search_collections) | **GET** /v2/search/collections | Collections search
 *SearchApi* | [**search_functions**](docs/SearchApi.md#search_functions) | **GET** /v2/search/functions | Functions search
 *SearchApi* | [**search_tags**](docs/SearchApi.md#search_tags) | **GET** /v2/search/tags | Tags search
-*V1Api* | [**batch_symbol_ann**](docs/V1Api.md#batch_symbol_ann) | **POST** /v1/ann/symbol/batch | Batch Symbol ANN using function IDs
 
 
 ## Documentation For Models
@@ -183,6 +185,7 @@ Class | Method | HTTP request | Description
  - [AnalysisCreateResponse](docs/AnalysisCreateResponse.md)
  - [AnalysisDetailResponse](docs/AnalysisDetailResponse.md)
  - [AnalysisFunctionMapping](docs/AnalysisFunctionMapping.md)
+ - [AnalysisFunctionMatchingRequest](docs/AnalysisFunctionMatchingRequest.md)
  - [AnalysisFunctions](docs/AnalysisFunctions.md)
  - [AnalysisRecord](docs/AnalysisRecord.md)
  - [AnalysisScope](docs/AnalysisScope.md)
@@ -369,6 +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)
+ - [FunctionMatchingResultWithBestMatch](docs/FunctionMatchingResultWithBestMatch.md)
+ - [FunctionMatchingScopeRequest](docs/FunctionMatchingScopeRequest.md)
  - [FunctionNameConfidenceBody](docs/FunctionNameConfidenceBody.md)
  - [FunctionNameHistory](docs/FunctionNameHistory.md)
  - [FunctionNameInput](docs/FunctionNameInput.md)
@@ -403,6 +410,7 @@ Class | Method | HTTP request | Description
  - [LoginRequest](docs/LoginRequest.md)
  - [LoginResponse](docs/LoginResponse.md)
  - [Logs](docs/Logs.md)
+ - [MatchedFunction](docs/MatchedFunction.md)
  - [MatchedFunctionSuggestion](docs/MatchedFunctionSuggestion.md)
  - [MetaModel](docs/MetaModel.md)
  - [ModelName](docs/ModelName.md)

{revengai-1.85.0 → revengai-1.88.0}/README.md

@@ -45,6 +45,7 @@ Class | Method | HTTP request | Description
 *AnalysesCommentsApi* | [**delete_analysis_comment**](docs/AnalysesCommentsApi.md#delete_analysis_comment) | **DELETE** /v2/analyses/{analysis_id}/comments/{comment_id} | Delete a comment
 *AnalysesCommentsApi* | [**get_analysis_comments**](docs/AnalysesCommentsApi.md#get_analysis_comments) | **GET** /v2/analyses/{analysis_id}/comments | Get comments for this analysis
 *AnalysesCommentsApi* | [**update_analysis_comment**](docs/AnalysesCommentsApi.md#update_analysis_comment) | **PATCH** /v2/analyses/{analysis_id}/comments/{comment_id} | Update a comment
+*AnalysesCoreApi* | [**batch_symbol_ann**](docs/AnalysesCoreApi.md#batch_symbol_ann) | **POST** /v1/ann/symbol/batch | Batch Symbol ANN using function IDs
 *AnalysesCoreApi* | [**create_analysis**](docs/AnalysesCoreApi.md#create_analysis) | **POST** /v2/analyses | Create Analysis
 *AnalysesCoreApi* | [**delete_analysis**](docs/AnalysesCoreApi.md#delete_analysis) | **DELETE** /v2/analyses/{analysis_id} | Delete Analysis
 *AnalysesCoreApi* | [**find_similar_functions_batch**](docs/AnalysesCoreApi.md#find_similar_functions_batch) | **POST** /v2/analyses/{analysis_id}/similarity/functions | Batch Symbol ANN using Analysis ID
@@ -121,7 +122,9 @@ Class | Method | HTTP request | Description
 *FunctionsBlockCommentsApi* | [**generate_block_comments_for_function**](docs/FunctionsBlockCommentsApi.md#generate_block_comments_for_function) | **POST** /v2/functions/{function_id}/block-comments | Generate block comments for a function
 *FunctionsBlockCommentsApi* | [**generate_overview_comment_for_function**](docs/FunctionsBlockCommentsApi.md#generate_overview_comment_for_function) | **POST** /v2/functions/{function_id}/block-comments/overview | Generate overview comment for a function
 *FunctionsCoreApi* | [**ai_unstrip**](docs/FunctionsCoreApi.md#ai_unstrip) | **POST** /v2/analyses/{analysis_id}/functions/ai-unstrip | Performs matching and auto-unstrip for an analysis and its functions
+*FunctionsCoreApi* | [**analysis_function_matching**](docs/FunctionsCoreApi.md#analysis_function_matching) | **POST** /v2/analyses/{analysis_id}/functions/matches | Perform matching for the functions of an analysis
 *FunctionsCoreApi* | [**auto_unstrip**](docs/FunctionsCoreApi.md#auto_unstrip) | **POST** /v2/analyses/{analysis_id}/functions/auto-unstrip | Performs matching and auto-unstrip for an analysis and its functions
+*FunctionsCoreApi* | [**batch_function_matching**](docs/FunctionsCoreApi.md#batch_function_matching) | **POST** /v2/functions/matches | Perform function matching for an arbitrary batch of functions, binaries or collections
 *FunctionsCoreApi* | [**cancel_ai_unstrip**](docs/FunctionsCoreApi.md#cancel_ai_unstrip) | **DELETE** /v2/analyses/{analysis_id}/functions/ai-unstrip/cancel | Cancels a running ai-unstrip
 *FunctionsCoreApi* | [**cancel_auto_unstrip**](docs/FunctionsCoreApi.md#cancel_auto_unstrip) | **DELETE** /v2/analyses/{analysis_id}/functions/unstrip/cancel | Cancels a running auto-unstrip
 *FunctionsCoreApi* | [**get_analysis_strings**](docs/FunctionsCoreApi.md#get_analysis_strings) | **GET** /v2/analyses/{analysis_id}/functions/strings | Get string information found in the Analysis
@@ -155,7 +158,6 @@ Class | Method | HTTP request | Description
 *SearchApi* | [**search_collections**](docs/SearchApi.md#search_collections) | **GET** /v2/search/collections | Collections search
 *SearchApi* | [**search_functions**](docs/SearchApi.md#search_functions) | **GET** /v2/search/functions | Functions search
 *SearchApi* | [**search_tags**](docs/SearchApi.md#search_tags) | **GET** /v2/search/tags | Tags search
-*V1Api* | [**batch_symbol_ann**](docs/V1Api.md#batch_symbol_ann) | **POST** /v1/ann/symbol/batch | Batch Symbol ANN using function IDs
 
 
 ## Documentation For Models
@@ -169,6 +171,7 @@ Class | Method | HTTP request | Description
  - [AnalysisCreateResponse](docs/AnalysisCreateResponse.md)
  - [AnalysisDetailResponse](docs/AnalysisDetailResponse.md)
  - [AnalysisFunctionMapping](docs/AnalysisFunctionMapping.md)
+ - [AnalysisFunctionMatchingRequest](docs/AnalysisFunctionMatchingRequest.md)
  - [AnalysisFunctions](docs/AnalysisFunctions.md)
  - [AnalysisRecord](docs/AnalysisRecord.md)
  - [AnalysisScope](docs/AnalysisScope.md)
@@ -355,6 +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)
+ - [FunctionMatchingResultWithBestMatch](docs/FunctionMatchingResultWithBestMatch.md)
+ - [FunctionMatchingScopeRequest](docs/FunctionMatchingScopeRequest.md)
  - [FunctionNameConfidenceBody](docs/FunctionNameConfidenceBody.md)
  - [FunctionNameHistory](docs/FunctionNameHistory.md)
  - [FunctionNameInput](docs/FunctionNameInput.md)
@@ -389,6 +396,7 @@ Class | Method | HTTP request | Description
  - [LoginRequest](docs/LoginRequest.md)
  - [LoginResponse](docs/LoginResponse.md)
  - [Logs](docs/Logs.md)
+ - [MatchedFunction](docs/MatchedFunction.md)
  - [MatchedFunctionSuggestion](docs/MatchedFunctionSuggestion.md)
  - [MetaModel](docs/MetaModel.md)
  - [ModelName](docs/ModelName.md)

{revengai-1.85.0 → revengai-1.88.0}/docs/AnalysesCoreApi.md

@@ -4,6 +4,7 @@ All URIs are relative to *https://api.reveng.ai*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**batch_symbol_ann**](AnalysesCoreApi.md#batch_symbol_ann) | **POST** /v1/ann/symbol/batch | Batch Symbol ANN using function IDs
 [**create_analysis**](AnalysesCoreApi.md#create_analysis) | **POST** /v2/analyses | Create Analysis
 [**delete_analysis**](AnalysesCoreApi.md#delete_analysis) | **DELETE** /v2/analyses/{analysis_id} | Delete Analysis
 [**find_similar_functions_batch**](AnalysesCoreApi.md#find_similar_functions_batch) | **POST** /v2/analyses/{analysis_id}/similarity/functions | Batch Symbol ANN using Analysis ID
@@ -21,6 +22,89 @@ Method | HTTP request | Description
 [**upload_file**](AnalysesCoreApi.md#upload_file) | **POST** /v2/upload | Upload File
 
 
+# **batch_symbol_ann**
+> FunctionBatchAnn batch_symbol_ann(app_api_rest_v1_ann_schema_ann_function, authorization=authorization)
+
+Batch Symbol ANN using function IDs
+
+Takes in an input of functions ID's and settings and finds the nearest functions for each function that's within the database
+
+### Example
+
+* Api Key Authentication (APIKey):
+
+```python
+import revengai
+from revengai.models.app_api_rest_v1_ann_schema_ann_function import AppApiRestV1AnnSchemaANNFunction
+from revengai.models.function_batch_ann import FunctionBatchAnn
+from revengai.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to https://api.reveng.ai
+# See configuration.py for a list of all supported configuration parameters.
+configuration = revengai.Configuration(
+    host = "https://api.reveng.ai"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure API key authorization: APIKey
+configuration.api_key['APIKey'] = os.environ["API_KEY"]
+
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['APIKey'] = 'Bearer'
+
+# Enter a context with an instance of the API client
+with revengai.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = revengai.AnalysesCoreApi(api_client)
+    app_api_rest_v1_ann_schema_ann_function = revengai.AppApiRestV1AnnSchemaANNFunction() # AppApiRestV1AnnSchemaANNFunction | 
+    authorization = 'authorization_example' # str | API Key bearer token (optional)
+
+    try:
+        # Batch Symbol ANN using function IDs
+        api_response = api_instance.batch_symbol_ann(app_api_rest_v1_ann_schema_ann_function, authorization=authorization)
+        print("The response of AnalysesCoreApi->batch_symbol_ann:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling AnalysesCoreApi->batch_symbol_ann: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_api_rest_v1_ann_schema_ann_function** | [**AppApiRestV1AnnSchemaANNFunction**](AppApiRestV1AnnSchemaANNFunction.md)|  | 
+ **authorization** | **str**| API Key bearer token | [optional] 
+
+### Return type
+
+[**FunctionBatchAnn**](FunctionBatchAnn.md)
+
+### Authorization
+
+[APIKey](../README.md#APIKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Successful Response |  -  |
+**422** | Invalid request parameters |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
 # **create_analysis**
 > BaseResponseAnalysisCreateResponse create_analysis(analysis_create_request, authorization=authorization)
 

revengai-1.88.0/docs/AnalysisFunctionMatchingRequest.md

@@ -0,0 +1,29 @@
+# AnalysisFunctionMatchingRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**min_similarity** | **float** | Minimum similarity expected for a match, default is 0.9 | [optional] [default to 0.9]
+
+## Example
+
+```python
+from revengai.models.analysis_function_matching_request import AnalysisFunctionMatchingRequest
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of AnalysisFunctionMatchingRequest from a JSON string
+analysis_function_matching_request_instance = AnalysisFunctionMatchingRequest.from_json(json)
+# print the JSON string representation of the object
+print(AnalysisFunctionMatchingRequest.to_json())
+
+# convert the object into a dict
+analysis_function_matching_request_dict = analysis_function_matching_request_instance.to_dict()
+# create an instance of AnalysisFunctionMatchingRequest from a dict
+analysis_function_matching_request_from_dict = AnalysisFunctionMatchingRequest.from_dict(analysis_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/docs/FunctionMatchingBatchRequest.md

@@ -0,0 +1,30 @@
+# FunctionMatchingBatchRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**model_id** | **int** |  | [optional] 
+**scope** | [**FunctionMatchingScopeRequest**](FunctionMatchingScopeRequest.md) | Scope of the function matching request, used to limit the search to specific binaries, collections, and functions | 
+
+## Example
+
+```python
+from revengai.models.function_matching_batch_request import FunctionMatchingBatchRequest
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of FunctionMatchingBatchRequest from a JSON string
+function_matching_batch_request_instance = FunctionMatchingBatchRequest.from_json(json)
+# print the JSON string representation of the object
+print(FunctionMatchingBatchRequest.to_json())
+
+# convert the object into a dict
+function_matching_batch_request_dict = function_matching_batch_request_instance.to_dict()
+# create an instance of FunctionMatchingBatchRequest from a dict
+function_matching_batch_request_from_dict = FunctionMatchingBatchRequest.from_dict(function_matching_batch_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/docs/FunctionMatchingBatchResponse.md

@@ -0,0 +1,33 @@
+# FunctionMatchingBatchResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**progress** | **int** | Progress of the matching operation, represented as a percentage | [optional] [default to 0]
+**status** | **str** |  | [optional] 
+**total_time** | **int** |  | [optional] 
+**error_message** | **str** |  | [optional] 
+**matches** | [**List[FunctionMatchingResultWithBestMatch]**](FunctionMatchingResultWithBestMatch.md) |  | 
+
+## Example
+
+```python
+from revengai.models.function_matching_batch_response import FunctionMatchingBatchResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of FunctionMatchingBatchResponse from a JSON string
+function_matching_batch_response_instance = FunctionMatchingBatchResponse.from_json(json)
+# print the JSON string representation of the object
+print(FunctionMatchingBatchResponse.to_json())
+
+# convert the object into a dict
+function_matching_batch_response_dict = function_matching_batch_response_instance.to_dict()
+# create an instance of FunctionMatchingBatchResponse from a dict
+function_matching_batch_response_from_dict = FunctionMatchingBatchResponse.from_dict(function_matching_batch_response_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/docs/FunctionMatchingResultWithBestMatch.md

@@ -0,0 +1,32 @@
+# FunctionMatchingResultWithBestMatch
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**function_id** | **int** |  | 
+**similarity** | **float** |  | 
+**matched_function** | [**MatchedFunction**](MatchedFunction.md) |  | 
+**suggested_name** | **str** |  | [optional] 
+
+## Example
+
+```python
+from revengai.models.function_matching_result_with_best_match import FunctionMatchingResultWithBestMatch
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of FunctionMatchingResultWithBestMatch from a JSON string
+function_matching_result_with_best_match_instance = FunctionMatchingResultWithBestMatch.from_json(json)
+# print the JSON string representation of the object
+print(FunctionMatchingResultWithBestMatch.to_json())
+
+# convert the object into a dict
+function_matching_result_with_best_match_dict = function_matching_result_with_best_match_instance.to_dict()
+# create an instance of FunctionMatchingResultWithBestMatch from a dict
+function_matching_result_with_best_match_from_dict = FunctionMatchingResultWithBestMatch.from_dict(function_matching_result_with_best_match_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/docs/FunctionMatchingScopeRequest.md

@@ -0,0 +1,33 @@
+# FunctionMatchingScopeRequest
+
+
+## Properties
+
+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
+
+# 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)
+# print the JSON string representation of the object
+print(FunctionMatchingScopeRequest.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)
+```
+[[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.85.0 → revengai-1.88.0}/docs/FunctionsCoreApi.md

@@ -5,7 +5,9 @@ All URIs are relative to *https://api.reveng.ai*
 Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**ai_unstrip**](FunctionsCoreApi.md#ai_unstrip) | **POST** /v2/analyses/{analysis_id}/functions/ai-unstrip | Performs matching and auto-unstrip for an analysis and its functions
+[**analysis_function_matching**](FunctionsCoreApi.md#analysis_function_matching) | **POST** /v2/analyses/{analysis_id}/functions/matches | Perform matching for the functions of an analysis
 [**auto_unstrip**](FunctionsCoreApi.md#auto_unstrip) | **POST** /v2/analyses/{analysis_id}/functions/auto-unstrip | Performs matching and auto-unstrip for an analysis and its functions
+[**batch_function_matching**](FunctionsCoreApi.md#batch_function_matching) | **POST** /v2/functions/matches | Perform function matching for an arbitrary batch of functions, binaries or collections
 [**cancel_ai_unstrip**](FunctionsCoreApi.md#cancel_ai_unstrip) | **DELETE** /v2/analyses/{analysis_id}/functions/ai-unstrip/cancel | Cancels a running ai-unstrip
 [**cancel_auto_unstrip**](FunctionsCoreApi.md#cancel_auto_unstrip) | **DELETE** /v2/analyses/{analysis_id}/functions/unstrip/cancel | Cancels a running auto-unstrip
 [**get_analysis_strings**](FunctionsCoreApi.md#get_analysis_strings) | **GET** /v2/analyses/{analysis_id}/functions/strings | Get string information found in the Analysis
@@ -102,6 +104,91 @@ Name | Type | Description  | Notes
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
+# **analysis_function_matching**
+> FunctionMatchingBatchResponse analysis_function_matching(analysis_id, analysis_function_matching_request, authorization=authorization)
+
+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
+
+### Example
+
+* Api Key Authentication (APIKey):
+
+```python
+import revengai
+from revengai.models.analysis_function_matching_request import AnalysisFunctionMatchingRequest
+from revengai.models.function_matching_batch_response import FunctionMatchingBatchResponse
+from revengai.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to https://api.reveng.ai
+# See configuration.py for a list of all supported configuration parameters.
+configuration = revengai.Configuration(
+    host = "https://api.reveng.ai"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure API key authorization: APIKey
+configuration.api_key['APIKey'] = os.environ["API_KEY"]
+
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['APIKey'] = 'Bearer'
+
+# Enter a context with an instance of the API client
+with revengai.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = revengai.FunctionsCoreApi(api_client)
+    analysis_id = 56 # int | 
+    analysis_function_matching_request = revengai.AnalysisFunctionMatchingRequest() # AnalysisFunctionMatchingRequest | 
+    authorization = 'authorization_example' # str | API Key bearer token (optional)
+
+    try:
+        # Perform matching for the functions of an analysis
+        api_response = api_instance.analysis_function_matching(analysis_id, analysis_function_matching_request, authorization=authorization)
+        print("The response of FunctionsCoreApi->analysis_function_matching:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling FunctionsCoreApi->analysis_function_matching: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **analysis_id** | **int**|  | 
+ **analysis_function_matching_request** | [**AnalysisFunctionMatchingRequest**](AnalysisFunctionMatchingRequest.md)|  | 
+ **authorization** | **str**| API Key bearer token | [optional] 
+
+### Return type
+
+[**FunctionMatchingBatchResponse**](FunctionMatchingBatchResponse.md)
+
+### Authorization
+
+[APIKey](../README.md#APIKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Successful Response |  -  |
+**422** | Invalid request parameters |  -  |
+
+[[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)
+
 # **auto_unstrip**
 > AutoUnstripResponse auto_unstrip(analysis_id, auto_unstrip_request, authorization=authorization)
 
@@ -187,6 +274,89 @@ 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)
+
+Perform function matching for an arbitrary batch of functions, binaries or collections
+
+Takes in an input of functions ID's and settings and finds the nearest functions for each function that's within the system
+
+### Example
+
+* Api Key Authentication (APIKey):
+
+```python
+import revengai
+from revengai.models.function_matching_batch_request import FunctionMatchingBatchRequest
+from revengai.models.function_matching_batch_response import FunctionMatchingBatchResponse
+from revengai.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to https://api.reveng.ai
+# See configuration.py for a list of all supported configuration parameters.
+configuration = revengai.Configuration(
+    host = "https://api.reveng.ai"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure API key authorization: APIKey
+configuration.api_key['APIKey'] = os.environ["API_KEY"]
+
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['APIKey'] = 'Bearer'
+
+# Enter a context with an instance of the API client
+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 | 
+    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)
+        print("The response of FunctionsCoreApi->batch_function_matching:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling FunctionsCoreApi->batch_function_matching: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **function_matching_batch_request** | [**FunctionMatchingBatchRequest**](FunctionMatchingBatchRequest.md)|  | 
+ **authorization** | **str**| API Key bearer token | [optional] 
+
+### Return type
+
+[**FunctionMatchingBatchResponse**](FunctionMatchingBatchResponse.md)
+
+### Authorization
+
+[APIKey](../README.md#APIKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Successful Response |  -  |
+**422** | Invalid request parameters |  -  |
+
+[[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)
+
 # **cancel_ai_unstrip**
 > AutoUnstripResponse cancel_ai_unstrip(analysis_id, authorization=authorization)
 

revengai-1.88.0/docs/MatchedFunction.md

@@ -0,0 +1,38 @@
+# MatchedFunction
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**function_id** | **int** |  | 
+**binary_id** | **int** |  | 
+**function_name** | **str** |  | 
+**function_vaddr** | **int** |  | 
+**mangled_name** | **str** |  | 
+**debug** | **bool** |  | 
+**binary_name** | **str** |  | 
+**sha_256_hash** | **str** |  | 
+**analysis_id** | **int** |  | 
+**similarity** | **float** |  | [optional] 
+
+## Example
+
+```python
+from revengai.models.matched_function import MatchedFunction
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of MatchedFunction from a JSON string
+matched_function_instance = MatchedFunction.from_json(json)
+# print the JSON string representation of the object
+print(MatchedFunction.to_json())
+
+# convert the object into a dict
+matched_function_dict = matched_function_instance.to_dict()
+# create an instance of MatchedFunction from a dict
+matched_function_from_dict = MatchedFunction.from_dict(matched_function_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)
+
+