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 @@
v2.11.1
v2.11.7
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Add this dependency to your project's POM:
<dependency>
<groupId>ai.reveng</groupId>
<artifactId>sdk</artifactId>
<version>2.11.1</version>
<version>2.11.7</version>
<scope>compile</scope>
</dependency>
```
Expand All @@ -31,7 +31,7 @@ repositories {
}

dependencies {
implementation "ai.reveng:sdk:2.11.1"
implementation "ai.reveng:sdk:2.11.7"
}
```

Expand Down Expand Up @@ -129,6 +129,7 @@ Class | Method | HTTP request | Description
*CollectionsApi* | [**updateCollection**](docs/CollectionsApi.md#updateCollection) | **PATCH** /v2/collections/{collection_id} | Updates a collection
*CollectionsApi* | [**updateCollectionBinaries**](docs/CollectionsApi.md#updateCollectionBinaries) | **PATCH** /v2/collections/{collection_id}/binaries | Updates a collection binaries
*CollectionsApi* | [**updateCollectionTags**](docs/CollectionsApi.md#updateCollectionTags) | **PATCH** /v2/collections/{collection_id}/tags | Updates a collection tags
*ConfidenceApi* | [**getAnalysisTagScore**](docs/ConfidenceApi.md#getAnalysisTagScore) | **POST** /v2/confidence/analysis/{analysis_id}/tag_score | Calculate Tag Confidence Score for an Analysis
*ExternalSourcesApi* | [**createExternalTaskMb**](docs/ExternalSourcesApi.md#createExternalTaskMb) | **POST** /v2/analysis/{analysis_id}/external/mb | Pulls data from VirusTotal
*ExternalSourcesApi* | [**createExternalTaskVt**](docs/ExternalSourcesApi.md#createExternalTaskVt) | **POST** /v2/analysis/{analysis_id}/external/vt | Pulls data from VirusTotal
*ExternalSourcesApi* | [**getMbData**](docs/ExternalSourcesApi.md#getMbData) | **GET** /v2/analysis/{analysis_id}/external/mb | Get MalwareBazaar data
Expand Down Expand Up @@ -267,6 +268,7 @@ Class | Method | HTTP request | Description
- [BaseResponseListDieMatch](docs/BaseResponseListDieMatch.md)
- [BaseResponseListFunctionNameHistory](docs/BaseResponseListFunctionNameHistory.md)
- [BaseResponseListSBOM](docs/BaseResponseListSBOM.md)
- [BaseResponseListTagOriginBoxPlotConfidence](docs/BaseResponseListTagOriginBoxPlotConfidence.md)
- [BaseResponseListUserActivityResponse](docs/BaseResponseListUserActivityResponse.md)
- [BaseResponseLoginResponse](docs/BaseResponseLoginResponse.md)
- [BaseResponseLogs](docs/BaseResponseLogs.md)
Expand Down Expand Up @@ -299,6 +301,7 @@ Class | Method | HTTP request | Description
- [BinaryTaskStatus](docs/BinaryTaskStatus.md)
- [Block](docs/Block.md)
- [BlockCommentsGenerationForFunctionResponse](docs/BlockCommentsGenerationForFunctionResponse.md)
- [BoxPlotConfidence](docs/BoxPlotConfidence.md)
- [CalleeFunctionInfo](docs/CalleeFunctionInfo.md)
- [CalleesCallerFunctionsResponse](docs/CalleesCallerFunctionsResponse.md)
- [CallerFunctionInfo](docs/CallerFunctionInfo.md)
Expand Down Expand Up @@ -414,6 +417,7 @@ Class | Method | HTTP request | Description
- [NetworkOverviewMetadata](docs/NetworkOverviewMetadata.md)
- [NetworkOverviewResponse](docs/NetworkOverviewResponse.md)
- [Order](docs/Order.md)
- [Origin](docs/Origin.md)
- [PDBDebugModel](docs/PDBDebugModel.md)
- [PEModel](docs/PEModel.md)
- [PaginationModel](docs/PaginationModel.md)
Expand Down Expand Up @@ -457,9 +461,12 @@ Class | Method | HTTP request | Description
- [TTPSElement](docs/TTPSElement.md)
- [TTPSOccurance](docs/TTPSOccurance.md)
- [Tag](docs/Tag.md)
- [TagConfidenceBody](docs/TagConfidenceBody.md)
- [TagOriginBoxPlotConfidence](docs/TagOriginBoxPlotConfidence.md)
- [TagResponse](docs/TagResponse.md)
- [TagSearchResponse](docs/TagSearchResponse.md)
- [TagSearchResult](docs/TagSearchResult.md)
- [Tags](docs/Tags.md)
- [TaskResponse](docs/TaskResponse.md)
- [TaskStatus](docs/TaskStatus.md)
- [TimestampModel](docs/TimestampModel.md)
Expand Down
4 changes: 2 additions & 2 deletions build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ apply plugin: 'java'
apply plugin: 'com.diffplug.spotless'

group = 'ai.reveng'
version = '2.11.1'
version = '2.11.7'



Expand Down Expand Up @@ -171,7 +171,7 @@ mavenPublishing {
publishToMavenCentral(true)
signAllPublications()

coordinates("ai.reveng", "sdk", "2.11.1")
coordinates("ai.reveng", "sdk", "2.11.7")

pom {
name = "sdk"
Expand Down
2 changes: 1 addition & 1 deletion build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ lazy val root = (project in file(".")).
settings(
organization := "ai.reveng",
name := "sdk",
version := "2.11.1",
version := "2.11.7",
scalaVersion := "2.11.12",
scalacOptions ++= Seq("-feature"),
compile / javacOptions ++= Seq("-Xlint:deprecation"),
Expand Down
17 changes: 17 additions & 0 deletions docs/BaseResponseListTagOriginBoxPlotConfidence.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@


# BaseResponseListTagOriginBoxPlotConfidence


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**status** | **Boolean** | Response status on whether the request succeeded | [optional] |
|**data** | [**List&lt;TagOriginBoxPlotConfidence&gt;**](TagOriginBoxPlotConfidence.md) | | [optional] |
|**message** | **String** | | [optional] |
|**errors** | [**List&lt;ErrorModel&gt;**](ErrorModel.md) | | [optional] |
|**meta** | [**MetaModel**](MetaModel.md) | Metadata | [optional] |



20 changes: 20 additions & 0 deletions docs/BoxPlotConfidence.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@


# BoxPlotConfidence

Format for confidence - returned in the box plot format

## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**min** | **BigDecimal** | | |
|**max** | **BigDecimal** | | |
|**average** | **BigDecimal** | | |
|**upperQuartile** | **BigDecimal** | | |
|**lowerQuartile** | **BigDecimal** | | |
|**positiveCount** | **Integer** | | |
|**negativeCount** | **Integer** | | |



81 changes: 81 additions & 0 deletions docs/ConfidenceApi.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
# ConfidenceApi

All URIs are relative to *https://api.reveng.ai*

| Method | HTTP request | Description |
|------------- | ------------- | -------------|
| [**getAnalysisTagScore**](ConfidenceApi.md#getAnalysisTagScore) | **POST** /v2/confidence/analysis/{analysis_id}/tag_score | Calculate Tag Confidence Score for an Analysis |


<a id="getAnalysisTagScore"></a>
# **getAnalysisTagScore**
> BaseResponseListTagOriginBoxPlotConfidence getAnalysisTagScore(analysisId, tagConfidenceBody)

Calculate Tag Confidence Score for an Analysis

Accepts a analysis ID and a list of tags, returns the confidence score for each tag in the list

### Example
```java
// Import classes:
import ai.reveng.invoker.ApiClient;
import ai.reveng.invoker.ApiException;
import ai.reveng.invoker.Configuration;
import ai.reveng.invoker.auth.*;
import ai.reveng.invoker.models.*;
import ai.reveng.api.ConfidenceApi;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.reveng.ai");

// Configure API key authorization: APIKey
ApiKeyAuth APIKey = (ApiKeyAuth) defaultClient.getAuthentication("APIKey");
APIKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//APIKey.setApiKeyPrefix("Token");

ConfidenceApi apiInstance = new ConfidenceApi(defaultClient);
Integer analysisId = 56; // Integer | The analysis to calculate the tag scores for
TagConfidenceBody tagConfidenceBody = new TagConfidenceBody(); // TagConfidenceBody |
try {
BaseResponseListTagOriginBoxPlotConfidence result = apiInstance.getAnalysisTagScore(analysisId, tagConfidenceBody);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ConfidenceApi#getAnalysisTagScore");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
```

### Parameters

| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **analysisId** | **Integer**| The analysis to calculate the tag scores for | |
| **tagConfidenceBody** | [**TagConfidenceBody**](TagConfidenceBody.md)| | |

### Return type

[**BaseResponseListTagOriginBoxPlotConfidence**](BaseResponseListTagOriginBoxPlotConfidence.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 | - |

2 changes: 1 addition & 1 deletion docs/FunctionDataTypesParams.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**functionIds** | **List&lt;Integer&gt;** | The function ID&#39;s to generate/get data types for | |
|**functionIds** | **List&lt;Long&gt;** | The function ID&#39;s to generate/get data types for | |



2 changes: 1 addition & 1 deletion docs/FunctionMatchingFilters.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**binaryIds** | **List&lt;Integer&gt;** | ID&#39;s of binaries to limit the search to, if empty, search all scoped binaries | [optional] |
|**collectionIds** | **List&lt;Integer&gt;** | ID&#39;s of collections to limit the search to, if empty, search all scoped collections | [optional] |
|**functionIds** | **List&lt;Integer&gt;** | ID&#39;s of functions to limit the search to, if empty, search all scoped functions | [optional] |
|**functionIds** | **List&lt;Long&gt;** | ID&#39;s of functions to limit the search to, if empty, search all scoped functions | [optional] |
|**debugTypes** | [**List&lt;DebugTypesEnum&gt;**](#List&lt;DebugTypesEnum&gt;) | Limit the search to specific debug types, if empty, search all scoped debug &amp; non-debug functions | [optional] |


Expand Down
2 changes: 1 addition & 1 deletion docs/FunctionMatchingRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**modelId** | **Integer** | ID of the model used for function matching, used to determine the embedding model | |
|**functionIds** | **List&lt;Integer&gt;** | ID&#39;s of functions to find matches for, must be at least one function ID | |
|**functionIds** | **List&lt;Long&gt;** | ID&#39;s of functions to find matches for, must be at least one function ID | |
|**minSimilarity** | **BigDecimal** | Minimum similarity expected for a match as a percentage, default is 90 | [optional] |
|**filters** | [**FunctionMatchingFilters**](FunctionMatchingFilters.md) | | [optional] |
|**resultsPerFunction** | **Integer** | Maximum number of matches to return per function, default is 1, max is 50 | [optional] |
Expand Down
25 changes: 25 additions & 0 deletions docs/Origin.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@


# Origin

## Enum


* `REV_ENG_MALWARE` (value: `"RevEng-Malware"`)

* `REV_ENG_LIBRARY` (value: `"RevEng-Library"`)

* `REV_ENG_BENIGN` (value: `"RevEng-Benign"`)

* `REV_ENG` (value: `"RevEng"`)

* `REV_ENG_HEURISTIC` (value: `"RevEng-Heuristic"`)

* `REV_ENG_UNKNOWN` (value: `"RevEng-Unknown"`)

* `VIRUS_TOTAL` (value: `"VirusTotal"`)

* `MALWARE_BAZAAR` (value: `"MalwareBazaar"`)



13 changes: 13 additions & 0 deletions docs/TagConfidenceBody.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@


# TagConfidenceBody


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**tags** | [**List&lt;Tags&gt;**](Tags.md) | | |



14 changes: 14 additions & 0 deletions docs/TagOriginBoxPlotConfidence.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@


# TagOriginBoxPlotConfidence


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**tag** | [**Tags**](Tags.md) | | |
|**boxPlot** | [**BoxPlotConfidence**](BoxPlotConfidence.md) | | |



14 changes: 14 additions & 0 deletions docs/Tags.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@


# Tags


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**tag** | **String** | The tag name | |
|**origin** | **Origin** | The origin of the tag | |



2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<artifactId>sdk</artifactId>
<packaging>jar</packaging>
<name>sdk</name>
<version>2.11.1</version>
<version>2.11.7</version>
<url>https://github.com/RevEngAI/sdk-java</url>
<description>Java SDK for the RevEng.AI API</description>
<scm>
Expand Down
Loading