Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .sdk-version
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v1.98.1
v2.0.0
5 changes: 1 addition & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,6 @@ 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
Expand Down Expand Up @@ -159,6 +158,7 @@ Class | Method | HTTP request | Description

## Documentation For Models

- [ANNFunction](docs/ANNFunction.md)
- [Addr](docs/Addr.md)
- [AiDecompilationRating](docs/AiDecompilationRating.md)
- [AiUnstripRequest](docs/AiUnstripRequest.md)
Expand All @@ -177,14 +177,12 @@ Class | Method | HTTP request | Description
- [AnalysisUpdateRequest](docs/AnalysisUpdateRequest.md)
- [AnalysisUpdateTagsRequest](docs/AnalysisUpdateTagsRequest.md)
- [AnalysisUpdateTagsResponse](docs/AnalysisUpdateTagsResponse.md)
- [AppApiRestV1AnnSchemaANNFunction](docs/AppApiRestV1AnnSchemaANNFunction.md)
- [AppApiRestV2AnalysesEnumsDynamicExecutionStatus](docs/AppApiRestV2AnalysesEnumsDynamicExecutionStatus.md)
- [AppApiRestV2AnalysesEnumsOrderBy](docs/AppApiRestV2AnalysesEnumsOrderBy.md)
- [AppApiRestV2AnalysesResponsesTagItem](docs/AppApiRestV2AnalysesResponsesTagItem.md)
- [AppApiRestV2CollectionsEnumsOrderBy](docs/AppApiRestV2CollectionsEnumsOrderBy.md)
- [AppApiRestV2FunctionsResponsesFunction](docs/AppApiRestV2FunctionsResponsesFunction.md)
- [AppApiRestV2FunctionsTypesFunction](docs/AppApiRestV2FunctionsTypesFunction.md)
- [AppApiRestV2SimilaritySchemaANNFunction](docs/AppApiRestV2SimilaritySchemaANNFunction.md)
- [AppServicesBinaryAnnSchemaTagItem](docs/AppServicesBinaryAnnSchemaTagItem.md)
- [AppServicesDynamicExecutionSchemasDynamicExecutionStatus](docs/AppServicesDynamicExecutionSchemasDynamicExecutionStatus.md)
- [Argument](docs/Argument.md)
Expand Down Expand Up @@ -330,7 +328,6 @@ Class | Method | HTTP request | Description
- [FileHashes](docs/FileHashes.md)
- [FileMetadata](docs/FileMetadata.md)
- [Filters](docs/Filters.md)
- [FunctionBatchAnn](docs/FunctionBatchAnn.md)
- [FunctionBlockDestinationResponse](docs/FunctionBlockDestinationResponse.md)
- [FunctionBlockResponse](docs/FunctionBlockResponse.md)
- [FunctionBlocksResponse](docs/FunctionBlocksResponse.md)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# AppApiRestV2SimilaritySchemaANNFunction
# ANNFunction


## Properties
Expand All @@ -16,19 +16,19 @@ Name | Type | Description | Notes
## Example

```python
from revengai.models.app_api_rest_v2_similarity_schema_ann_function import AppApiRestV2SimilaritySchemaANNFunction
from revengai.models.ann_function import ANNFunction

# TODO update the JSON string below
json = "{}"
# create an instance of AppApiRestV2SimilaritySchemaANNFunction from a JSON string
app_api_rest_v2_similarity_schema_ann_function_instance = AppApiRestV2SimilaritySchemaANNFunction.from_json(json)
# create an instance of ANNFunction from a JSON string
ann_function_instance = ANNFunction.from_json(json)
# print the JSON string representation of the object
print(AppApiRestV2SimilaritySchemaANNFunction.to_json())
print(ANNFunction.to_json())

# convert the object into a dict
app_api_rest_v2_similarity_schema_ann_function_dict = app_api_rest_v2_similarity_schema_ann_function_instance.to_dict()
# create an instance of AppApiRestV2SimilaritySchemaANNFunction from a dict
app_api_rest_v2_similarity_schema_ann_function_from_dict = AppApiRestV2SimilaritySchemaANNFunction.from_dict(app_api_rest_v2_similarity_schema_ann_function_dict)
ann_function_dict = ann_function_instance.to_dict()
# create an instance of ANNFunction from a dict
ann_function_from_dict = ANNFunction.from_dict(ann_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)

Expand Down
92 changes: 5 additions & 87 deletions docs/AnalysesCoreApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ 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
Expand All @@ -22,87 +21,6 @@ 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)

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 |

try:
# Batch Symbol ANN using function IDs
api_response = api_instance.batch_symbol_ann(app_api_rest_v1_ann_schema_ann_function)
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)| |

### 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)

Expand Down Expand Up @@ -269,7 +187,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)

# **find_similar_functions_batch**
> BaseResponseNearestNeighborAnalysis find_similar_functions_batch(analysis_id, app_api_rest_v2_similarity_schema_ann_function)
> BaseResponseNearestNeighborAnalysis find_similar_functions_batch(analysis_id, ann_function)

Batch Symbol ANN using Analysis ID

Expand All @@ -281,7 +199,7 @@ Takes a analysis ID and returns the nearest functions within the database that m

```python
import revengai
from revengai.models.app_api_rest_v2_similarity_schema_ann_function import AppApiRestV2SimilaritySchemaANNFunction
from revengai.models.ann_function import ANNFunction
from revengai.models.base_response_nearest_neighbor_analysis import BaseResponseNearestNeighborAnalysis
from revengai.rest import ApiException
from pprint import pprint
Expand All @@ -308,11 +226,11 @@ with revengai.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = revengai.AnalysesCoreApi(api_client)
analysis_id = 56 # int |
app_api_rest_v2_similarity_schema_ann_function = revengai.AppApiRestV2SimilaritySchemaANNFunction() # AppApiRestV2SimilaritySchemaANNFunction |
ann_function = revengai.ANNFunction() # ANNFunction |

try:
# Batch Symbol ANN using Analysis ID
api_response = api_instance.find_similar_functions_batch(analysis_id, app_api_rest_v2_similarity_schema_ann_function)
api_response = api_instance.find_similar_functions_batch(analysis_id, ann_function)
print("The response of AnalysesCoreApi->find_similar_functions_batch:\n")
pprint(api_response)
except Exception as e:
Expand All @@ -327,7 +245,7 @@ with revengai.ApiClient(configuration) as api_client:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**analysis_id** | **int**| |
**app_api_rest_v2_similarity_schema_ann_function** | [**AppApiRestV2SimilaritySchemaANNFunction**](AppApiRestV2SimilaritySchemaANNFunction.md)| |
**ann_function** | [**ANNFunction**](ANNFunction.md)| |

### Return type

Expand Down
37 changes: 0 additions & 37 deletions docs/AppApiRestV1AnnSchemaANNFunction.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/AppApiRestV2FunctionsResponsesFunction.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Function schema used in function strings response.
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**function_id** | **int** | |
**function_vaddr** | **int** | |
**function_vaddr** | **int** | Function virtual address |

## Example

Expand Down
3 changes: 2 additions & 1 deletion docs/AppApiRestV2FunctionsTypesFunction.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**function_id** | **int** | Function id |
**function_name** | **str** | Function name |
**function_name** | **str** | Demangled name of the function |
**function_mangled_name** | **str** | Mangled name of the function |
**function_vaddr** | **int** | Function virtual address |
**function_size** | **int** | Function size |
**debug** | **bool** | Whether the function is debug |
Expand Down
31 changes: 0 additions & 31 deletions docs/FunctionBatchAnn.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/FunctionMatchingRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Name | Type | Description | Notes
**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 as a percentage, default is 90 | [optional] [default to 90.0]
**filters** | [**FunctionMatchingFilters**](FunctionMatchingFilters.md) | | [optional]
**results_per_function** | **int** | Maximum number of matches to return per function, default is 1, max is 10 | [optional] [default to 1]
**results_per_function** | **int** | Maximum number of matches to return per function, default is 1, max is 50 | [optional] [default to 1]
**page** | **int** | Page number for paginated results, default is 1 (first page) | [optional] [default to 1]
**page_size** | **int** | Number of functions to return per page, default is 0 (all functions), max is 1000 | [optional] [default to 0]

Expand Down
10 changes: 3 additions & 7 deletions revengai/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
""" # noqa: E501


__version__ = "v1.98.1"
__version__ = "v2.0.0"

# Define package exports
__all__ = [
Expand Down Expand Up @@ -45,6 +45,7 @@
"ApiKeyError",
"ApiAttributeError",
"ApiException",
"ANNFunction",
"Addr",
"AiDecompilationRating",
"AiUnstripRequest",
Expand All @@ -63,14 +64,12 @@
"AnalysisUpdateRequest",
"AnalysisUpdateTagsRequest",
"AnalysisUpdateTagsResponse",
"AppApiRestV1AnnSchemaANNFunction",
"AppApiRestV2AnalysesEnumsDynamicExecutionStatus",
"AppApiRestV2AnalysesEnumsOrderBy",
"AppApiRestV2AnalysesResponsesTagItem",
"AppApiRestV2CollectionsEnumsOrderBy",
"AppApiRestV2FunctionsResponsesFunction",
"AppApiRestV2FunctionsTypesFunction",
"AppApiRestV2SimilaritySchemaANNFunction",
"AppServicesBinaryAnnSchemaTagItem",
"AppServicesDynamicExecutionSchemasDynamicExecutionStatus",
"Argument",
Expand Down Expand Up @@ -216,7 +215,6 @@
"FileHashes",
"FileMetadata",
"Filters",
"FunctionBatchAnn",
"FunctionBlockDestinationResponse",
"FunctionBlockResponse",
"FunctionBlocksResponse",
Expand Down Expand Up @@ -385,6 +383,7 @@
from revengai.exceptions import ApiException as ApiException

# import models into sdk package
from revengai.models.ann_function import ANNFunction as ANNFunction
from revengai.models.addr import Addr as Addr
from revengai.models.ai_decompilation_rating import AiDecompilationRating as AiDecompilationRating
from revengai.models.ai_unstrip_request import AiUnstripRequest as AiUnstripRequest
Expand All @@ -403,14 +402,12 @@
from revengai.models.analysis_update_request import AnalysisUpdateRequest as AnalysisUpdateRequest
from revengai.models.analysis_update_tags_request import AnalysisUpdateTagsRequest as AnalysisUpdateTagsRequest
from revengai.models.analysis_update_tags_response import AnalysisUpdateTagsResponse as AnalysisUpdateTagsResponse
from revengai.models.app_api_rest_v1_ann_schema_ann_function import AppApiRestV1AnnSchemaANNFunction as AppApiRestV1AnnSchemaANNFunction
from revengai.models.app_api_rest_v2_analyses_enums_dynamic_execution_status import AppApiRestV2AnalysesEnumsDynamicExecutionStatus as AppApiRestV2AnalysesEnumsDynamicExecutionStatus
from revengai.models.app_api_rest_v2_analyses_enums_order_by import AppApiRestV2AnalysesEnumsOrderBy as AppApiRestV2AnalysesEnumsOrderBy
from revengai.models.app_api_rest_v2_analyses_responses_tag_item import AppApiRestV2AnalysesResponsesTagItem as AppApiRestV2AnalysesResponsesTagItem
from revengai.models.app_api_rest_v2_collections_enums_order_by import AppApiRestV2CollectionsEnumsOrderBy as AppApiRestV2CollectionsEnumsOrderBy
from revengai.models.app_api_rest_v2_functions_responses_function import AppApiRestV2FunctionsResponsesFunction as AppApiRestV2FunctionsResponsesFunction
from revengai.models.app_api_rest_v2_functions_types_function import AppApiRestV2FunctionsTypesFunction as AppApiRestV2FunctionsTypesFunction
from revengai.models.app_api_rest_v2_similarity_schema_ann_function import AppApiRestV2SimilaritySchemaANNFunction as AppApiRestV2SimilaritySchemaANNFunction
from revengai.models.app_services_binary_ann_schema_tag_item import AppServicesBinaryAnnSchemaTagItem as AppServicesBinaryAnnSchemaTagItem
from revengai.models.app_services_dynamic_execution_schemas_dynamic_execution_status import AppServicesDynamicExecutionSchemasDynamicExecutionStatus as AppServicesDynamicExecutionSchemasDynamicExecutionStatus
from revengai.models.argument import Argument as Argument
Expand Down Expand Up @@ -556,7 +553,6 @@
from revengai.models.file_hashes import FileHashes as FileHashes
from revengai.models.file_metadata import FileMetadata as FileMetadata
from revengai.models.filters import Filters as Filters
from revengai.models.function_batch_ann import FunctionBatchAnn as FunctionBatchAnn
from revengai.models.function_block_destination_response import FunctionBlockDestinationResponse as FunctionBlockDestinationResponse
from revengai.models.function_block_response import FunctionBlockResponse as FunctionBlockResponse
from revengai.models.function_blocks_response import FunctionBlocksResponse as FunctionBlocksResponse
Expand Down
Loading