Skip to content

Commit 7ebed50

Browse files
Update SDK to version v2.0.0
- Generated from OpenAPI spec version v2.0.0 - Auto-generated by GitHub Actions
1 parent 572b25a commit 7ebed50

27 files changed

Lines changed: 69 additions & 872 deletions

.sdk-version

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
v1.98.1
1+
v2.0.0

README.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,6 @@ Class | Method | HTTP request | Description
4545
*AnalysesCommentsApi* | [**delete_analysis_comment**](docs/AnalysesCommentsApi.md#delete_analysis_comment) | **DELETE** /v2/analyses/{analysis_id}/comments/{comment_id} | Delete a comment
4646
*AnalysesCommentsApi* | [**get_analysis_comments**](docs/AnalysesCommentsApi.md#get_analysis_comments) | **GET** /v2/analyses/{analysis_id}/comments | Get comments for this analysis
4747
*AnalysesCommentsApi* | [**update_analysis_comment**](docs/AnalysesCommentsApi.md#update_analysis_comment) | **PATCH** /v2/analyses/{analysis_id}/comments/{comment_id} | Update a comment
48-
*AnalysesCoreApi* | [**batch_symbol_ann**](docs/AnalysesCoreApi.md#batch_symbol_ann) | **POST** /v1/ann/symbol/batch | Batch Symbol ANN using function IDs
4948
*AnalysesCoreApi* | [**create_analysis**](docs/AnalysesCoreApi.md#create_analysis) | **POST** /v2/analyses | Create Analysis
5049
*AnalysesCoreApi* | [**delete_analysis**](docs/AnalysesCoreApi.md#delete_analysis) | **DELETE** /v2/analyses/{analysis_id} | Delete Analysis
5150
*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
@@ -159,6 +158,7 @@ Class | Method | HTTP request | Description
159158

160159
## Documentation For Models
161160

161+
- [ANNFunction](docs/ANNFunction.md)
162162
- [Addr](docs/Addr.md)
163163
- [AiDecompilationRating](docs/AiDecompilationRating.md)
164164
- [AiUnstripRequest](docs/AiUnstripRequest.md)
@@ -177,14 +177,12 @@ Class | Method | HTTP request | Description
177177
- [AnalysisUpdateRequest](docs/AnalysisUpdateRequest.md)
178178
- [AnalysisUpdateTagsRequest](docs/AnalysisUpdateTagsRequest.md)
179179
- [AnalysisUpdateTagsResponse](docs/AnalysisUpdateTagsResponse.md)
180-
- [AppApiRestV1AnnSchemaANNFunction](docs/AppApiRestV1AnnSchemaANNFunction.md)
181180
- [AppApiRestV2AnalysesEnumsDynamicExecutionStatus](docs/AppApiRestV2AnalysesEnumsDynamicExecutionStatus.md)
182181
- [AppApiRestV2AnalysesEnumsOrderBy](docs/AppApiRestV2AnalysesEnumsOrderBy.md)
183182
- [AppApiRestV2AnalysesResponsesTagItem](docs/AppApiRestV2AnalysesResponsesTagItem.md)
184183
- [AppApiRestV2CollectionsEnumsOrderBy](docs/AppApiRestV2CollectionsEnumsOrderBy.md)
185184
- [AppApiRestV2FunctionsResponsesFunction](docs/AppApiRestV2FunctionsResponsesFunction.md)
186185
- [AppApiRestV2FunctionsTypesFunction](docs/AppApiRestV2FunctionsTypesFunction.md)
187-
- [AppApiRestV2SimilaritySchemaANNFunction](docs/AppApiRestV2SimilaritySchemaANNFunction.md)
188186
- [AppServicesBinaryAnnSchemaTagItem](docs/AppServicesBinaryAnnSchemaTagItem.md)
189187
- [AppServicesDynamicExecutionSchemasDynamicExecutionStatus](docs/AppServicesDynamicExecutionSchemasDynamicExecutionStatus.md)
190188
- [Argument](docs/Argument.md)
@@ -330,7 +328,6 @@ Class | Method | HTTP request | Description
330328
- [FileHashes](docs/FileHashes.md)
331329
- [FileMetadata](docs/FileMetadata.md)
332330
- [Filters](docs/Filters.md)
333-
- [FunctionBatchAnn](docs/FunctionBatchAnn.md)
334331
- [FunctionBlockDestinationResponse](docs/FunctionBlockDestinationResponse.md)
335332
- [FunctionBlockResponse](docs/FunctionBlockResponse.md)
336333
- [FunctionBlocksResponse](docs/FunctionBlocksResponse.md)

docs/AppApiRestV2SimilaritySchemaANNFunction.md renamed to docs/ANNFunction.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# AppApiRestV2SimilaritySchemaANNFunction
1+
# ANNFunction
22

33

44
## Properties
@@ -16,19 +16,19 @@ Name | Type | Description | Notes
1616
## Example
1717

1818
```python
19-
from revengai.models.app_api_rest_v2_similarity_schema_ann_function import AppApiRestV2SimilaritySchemaANNFunction
19+
from revengai.models.ann_function import ANNFunction
2020

2121
# TODO update the JSON string below
2222
json = "{}"
23-
# create an instance of AppApiRestV2SimilaritySchemaANNFunction from a JSON string
24-
app_api_rest_v2_similarity_schema_ann_function_instance = AppApiRestV2SimilaritySchemaANNFunction.from_json(json)
23+
# create an instance of ANNFunction from a JSON string
24+
ann_function_instance = ANNFunction.from_json(json)
2525
# print the JSON string representation of the object
26-
print(AppApiRestV2SimilaritySchemaANNFunction.to_json())
26+
print(ANNFunction.to_json())
2727

2828
# convert the object into a dict
29-
app_api_rest_v2_similarity_schema_ann_function_dict = app_api_rest_v2_similarity_schema_ann_function_instance.to_dict()
30-
# create an instance of AppApiRestV2SimilaritySchemaANNFunction from a dict
31-
app_api_rest_v2_similarity_schema_ann_function_from_dict = AppApiRestV2SimilaritySchemaANNFunction.from_dict(app_api_rest_v2_similarity_schema_ann_function_dict)
29+
ann_function_dict = ann_function_instance.to_dict()
30+
# create an instance of ANNFunction from a dict
31+
ann_function_from_dict = ANNFunction.from_dict(ann_function_dict)
3232
```
3333
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
3434

docs/AnalysesCoreApi.md

Lines changed: 5 additions & 87 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ All URIs are relative to *https://api.reveng.ai*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7-
[**batch_symbol_ann**](AnalysesCoreApi.md#batch_symbol_ann) | **POST** /v1/ann/symbol/batch | Batch Symbol ANN using function IDs
87
[**create_analysis**](AnalysesCoreApi.md#create_analysis) | **POST** /v2/analyses | Create Analysis
98
[**delete_analysis**](AnalysesCoreApi.md#delete_analysis) | **DELETE** /v2/analyses/{analysis_id} | Delete Analysis
109
[**find_similar_functions_batch**](AnalysesCoreApi.md#find_similar_functions_batch) | **POST** /v2/analyses/{analysis_id}/similarity/functions | Batch Symbol ANN using Analysis ID
@@ -22,87 +21,6 @@ Method | HTTP request | Description
2221
[**upload_file**](AnalysesCoreApi.md#upload_file) | **POST** /v2/upload | Upload File
2322

2423

25-
# **batch_symbol_ann**
26-
> FunctionBatchAnn batch_symbol_ann(app_api_rest_v1_ann_schema_ann_function)
27-
28-
Batch Symbol ANN using function IDs
29-
30-
Takes in an input of functions ID's and settings and finds the nearest functions for each function that's within the database
31-
32-
### Example
33-
34-
* Api Key Authentication (APIKey):
35-
36-
```python
37-
import revengai
38-
from revengai.models.app_api_rest_v1_ann_schema_ann_function import AppApiRestV1AnnSchemaANNFunction
39-
from revengai.models.function_batch_ann import FunctionBatchAnn
40-
from revengai.rest import ApiException
41-
from pprint import pprint
42-
43-
# Defining the host is optional and defaults to https://api.reveng.ai
44-
# See configuration.py for a list of all supported configuration parameters.
45-
configuration = revengai.Configuration(
46-
host = "https://api.reveng.ai"
47-
)
48-
49-
# The client must configure the authentication and authorization parameters
50-
# in accordance with the API server security policy.
51-
# Examples for each auth method are provided below, use the example that
52-
# satisfies your auth use case.
53-
54-
# Configure API key authorization: APIKey
55-
configuration.api_key['APIKey'] = os.environ["API_KEY"]
56-
57-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
58-
# configuration.api_key_prefix['APIKey'] = 'Bearer'
59-
60-
# Enter a context with an instance of the API client
61-
with revengai.ApiClient(configuration) as api_client:
62-
# Create an instance of the API class
63-
api_instance = revengai.AnalysesCoreApi(api_client)
64-
app_api_rest_v1_ann_schema_ann_function = revengai.AppApiRestV1AnnSchemaANNFunction() # AppApiRestV1AnnSchemaANNFunction |
65-
66-
try:
67-
# Batch Symbol ANN using function IDs
68-
api_response = api_instance.batch_symbol_ann(app_api_rest_v1_ann_schema_ann_function)
69-
print("The response of AnalysesCoreApi->batch_symbol_ann:\n")
70-
pprint(api_response)
71-
except Exception as e:
72-
print("Exception when calling AnalysesCoreApi->batch_symbol_ann: %s\n" % e)
73-
```
74-
75-
76-
77-
### Parameters
78-
79-
80-
Name | Type | Description | Notes
81-
------------- | ------------- | ------------- | -------------
82-
**app_api_rest_v1_ann_schema_ann_function** | [**AppApiRestV1AnnSchemaANNFunction**](AppApiRestV1AnnSchemaANNFunction.md)| |
83-
84-
### Return type
85-
86-
[**FunctionBatchAnn**](FunctionBatchAnn.md)
87-
88-
### Authorization
89-
90-
[APIKey](../README.md#APIKey)
91-
92-
### HTTP request headers
93-
94-
- **Content-Type**: application/json
95-
- **Accept**: application/json
96-
97-
### HTTP response details
98-
99-
| Status code | Description | Response headers |
100-
|-------------|-------------|------------------|
101-
**200** | Successful Response | - |
102-
**422** | Invalid request parameters | - |
103-
104-
[[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)
105-
10624
# **create_analysis**
10725
> BaseResponseAnalysisCreateResponse create_analysis(analysis_create_request)
10826
@@ -269,7 +187,7 @@ Name | Type | Description | Notes
269187
[[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)
270188

271189
# **find_similar_functions_batch**
272-
> BaseResponseNearestNeighborAnalysis find_similar_functions_batch(analysis_id, app_api_rest_v2_similarity_schema_ann_function)
190+
> BaseResponseNearestNeighborAnalysis find_similar_functions_batch(analysis_id, ann_function)
273191
274192
Batch Symbol ANN using Analysis ID
275193

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

282200
```python
283201
import revengai
284-
from revengai.models.app_api_rest_v2_similarity_schema_ann_function import AppApiRestV2SimilaritySchemaANNFunction
202+
from revengai.models.ann_function import ANNFunction
285203
from revengai.models.base_response_nearest_neighbor_analysis import BaseResponseNearestNeighborAnalysis
286204
from revengai.rest import ApiException
287205
from pprint import pprint
@@ -308,11 +226,11 @@ with revengai.ApiClient(configuration) as api_client:
308226
# Create an instance of the API class
309227
api_instance = revengai.AnalysesCoreApi(api_client)
310228
analysis_id = 56 # int |
311-
app_api_rest_v2_similarity_schema_ann_function = revengai.AppApiRestV2SimilaritySchemaANNFunction() # AppApiRestV2SimilaritySchemaANNFunction |
229+
ann_function = revengai.ANNFunction() # ANNFunction |
312230

313231
try:
314232
# Batch Symbol ANN using Analysis ID
315-
api_response = api_instance.find_similar_functions_batch(analysis_id, app_api_rest_v2_similarity_schema_ann_function)
233+
api_response = api_instance.find_similar_functions_batch(analysis_id, ann_function)
316234
print("The response of AnalysesCoreApi->find_similar_functions_batch:\n")
317235
pprint(api_response)
318236
except Exception as e:
@@ -327,7 +245,7 @@ with revengai.ApiClient(configuration) as api_client:
327245
Name | Type | Description | Notes
328246
------------- | ------------- | ------------- | -------------
329247
**analysis_id** | **int**| |
330-
**app_api_rest_v2_similarity_schema_ann_function** | [**AppApiRestV2SimilaritySchemaANNFunction**](AppApiRestV2SimilaritySchemaANNFunction.md)| |
248+
**ann_function** | [**ANNFunction**](ANNFunction.md)| |
331249

332250
### Return type
333251

docs/AppApiRestV1AnnSchemaANNFunction.md

Lines changed: 0 additions & 37 deletions
This file was deleted.

docs/AppApiRestV2FunctionsResponsesFunction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Function schema used in function strings response.
77
Name | Type | Description | Notes
88
------------ | ------------- | ------------- | -------------
99
**function_id** | **int** | |
10-
**function_vaddr** | **int** | |
10+
**function_vaddr** | **int** | Function virtual address |
1111

1212
## Example
1313

docs/AppApiRestV2FunctionsTypesFunction.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@
66
Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
88
**function_id** | **int** | Function id |
9-
**function_name** | **str** | Function name |
9+
**function_name** | **str** | Demangled name of the function |
10+
**function_mangled_name** | **str** | Mangled name of the function |
1011
**function_vaddr** | **int** | Function virtual address |
1112
**function_size** | **int** | Function size |
1213
**debug** | **bool** | Whether the function is debug |

docs/FunctionBatchAnn.md

Lines changed: 0 additions & 31 deletions
This file was deleted.

docs/FunctionMatchingRequest.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
99
**function_ids** | **List[int]** | ID's of functions to find matches for, must be at least one function ID |
1010
**min_similarity** | **float** | Minimum similarity expected for a match as a percentage, default is 90 | [optional] [default to 90.0]
1111
**filters** | [**FunctionMatchingFilters**](FunctionMatchingFilters.md) | | [optional]
12-
**results_per_function** | **int** | Maximum number of matches to return per function, default is 1, max is 10 | [optional] [default to 1]
12+
**results_per_function** | **int** | Maximum number of matches to return per function, default is 1, max is 50 | [optional] [default to 1]
1313
**page** | **int** | Page number for paginated results, default is 1 (first page) | [optional] [default to 1]
1414
**page_size** | **int** | Number of functions to return per page, default is 0 (all functions), max is 1000 | [optional] [default to 0]
1515

revengai/__init__.py

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
""" # noqa: E501
1414

1515

16-
__version__ = "v1.98.1"
16+
__version__ = "v2.0.0"
1717

1818
# Define package exports
1919
__all__ = [
@@ -45,6 +45,7 @@
4545
"ApiKeyError",
4646
"ApiAttributeError",
4747
"ApiException",
48+
"ANNFunction",
4849
"Addr",
4950
"AiDecompilationRating",
5051
"AiUnstripRequest",
@@ -63,14 +64,12 @@
6364
"AnalysisUpdateRequest",
6465
"AnalysisUpdateTagsRequest",
6566
"AnalysisUpdateTagsResponse",
66-
"AppApiRestV1AnnSchemaANNFunction",
6767
"AppApiRestV2AnalysesEnumsDynamicExecutionStatus",
6868
"AppApiRestV2AnalysesEnumsOrderBy",
6969
"AppApiRestV2AnalysesResponsesTagItem",
7070
"AppApiRestV2CollectionsEnumsOrderBy",
7171
"AppApiRestV2FunctionsResponsesFunction",
7272
"AppApiRestV2FunctionsTypesFunction",
73-
"AppApiRestV2SimilaritySchemaANNFunction",
7473
"AppServicesBinaryAnnSchemaTagItem",
7574
"AppServicesDynamicExecutionSchemasDynamicExecutionStatus",
7675
"Argument",
@@ -216,7 +215,6 @@
216215
"FileHashes",
217216
"FileMetadata",
218217
"Filters",
219-
"FunctionBatchAnn",
220218
"FunctionBlockDestinationResponse",
221219
"FunctionBlockResponse",
222220
"FunctionBlocksResponse",
@@ -385,6 +383,7 @@
385383
from revengai.exceptions import ApiException as ApiException
386384

387385
# import models into sdk package
386+
from revengai.models.ann_function import ANNFunction as ANNFunction
388387
from revengai.models.addr import Addr as Addr
389388
from revengai.models.ai_decompilation_rating import AiDecompilationRating as AiDecompilationRating
390389
from revengai.models.ai_unstrip_request import AiUnstripRequest as AiUnstripRequest
@@ -403,14 +402,12 @@
403402
from revengai.models.analysis_update_request import AnalysisUpdateRequest as AnalysisUpdateRequest
404403
from revengai.models.analysis_update_tags_request import AnalysisUpdateTagsRequest as AnalysisUpdateTagsRequest
405404
from revengai.models.analysis_update_tags_response import AnalysisUpdateTagsResponse as AnalysisUpdateTagsResponse
406-
from revengai.models.app_api_rest_v1_ann_schema_ann_function import AppApiRestV1AnnSchemaANNFunction as AppApiRestV1AnnSchemaANNFunction
407405
from revengai.models.app_api_rest_v2_analyses_enums_dynamic_execution_status import AppApiRestV2AnalysesEnumsDynamicExecutionStatus as AppApiRestV2AnalysesEnumsDynamicExecutionStatus
408406
from revengai.models.app_api_rest_v2_analyses_enums_order_by import AppApiRestV2AnalysesEnumsOrderBy as AppApiRestV2AnalysesEnumsOrderBy
409407
from revengai.models.app_api_rest_v2_analyses_responses_tag_item import AppApiRestV2AnalysesResponsesTagItem as AppApiRestV2AnalysesResponsesTagItem
410408
from revengai.models.app_api_rest_v2_collections_enums_order_by import AppApiRestV2CollectionsEnumsOrderBy as AppApiRestV2CollectionsEnumsOrderBy
411409
from revengai.models.app_api_rest_v2_functions_responses_function import AppApiRestV2FunctionsResponsesFunction as AppApiRestV2FunctionsResponsesFunction
412410
from revengai.models.app_api_rest_v2_functions_types_function import AppApiRestV2FunctionsTypesFunction as AppApiRestV2FunctionsTypesFunction
413-
from revengai.models.app_api_rest_v2_similarity_schema_ann_function import AppApiRestV2SimilaritySchemaANNFunction as AppApiRestV2SimilaritySchemaANNFunction
414411
from revengai.models.app_services_binary_ann_schema_tag_item import AppServicesBinaryAnnSchemaTagItem as AppServicesBinaryAnnSchemaTagItem
415412
from revengai.models.app_services_dynamic_execution_schemas_dynamic_execution_status import AppServicesDynamicExecutionSchemasDynamicExecutionStatus as AppServicesDynamicExecutionSchemasDynamicExecutionStatus
416413
from revengai.models.argument import Argument as Argument
@@ -556,7 +553,6 @@
556553
from revengai.models.file_hashes import FileHashes as FileHashes
557554
from revengai.models.file_metadata import FileMetadata as FileMetadata
558555
from revengai.models.filters import Filters as Filters
559-
from revengai.models.function_batch_ann import FunctionBatchAnn as FunctionBatchAnn
560556
from revengai.models.function_block_destination_response import FunctionBlockDestinationResponse as FunctionBlockDestinationResponse
561557
from revengai.models.function_block_response import FunctionBlockResponse as FunctionBlockResponse
562558
from revengai.models.function_blocks_response import FunctionBlocksResponse as FunctionBlocksResponse

0 commit comments

Comments
 (0)