Skip to content

OpenAPI schema sync (v3.3.1) #25

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mcnulty-fp merged 1 commit into from
May 20, 2026
Merged

OpenAPI schema sync (v3.3.1) #25

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions .changeset/identification-confidence-labels-high-recall-examples.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'java-sdk': patch
---

**events**: Require `label` on smart signal `Labels` items
2 changes: 1 addition & 1 deletion .schema-version
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v3.3.0
v3.3.1
5 changes: 3 additions & 2 deletions docs/IdentificationConfidence.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,14 @@

# IdentificationConfidence

The confidence score represents the probability of a false-positive identification. To learn more, visit [Confidence Score](https://docs.fingerprint.com/docs/identification-accuracy-and-confidence#confidence-score). Please note that the confidence score is not yet supported for [High Recall ID](https://docs.fingerprint.com/docs/supplementary-identifiers-highrecall).

## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**score** | **Double** | The confidence score is a floating-point number between 0 and 1 that represents the probability of accurate identification. | |
|**version** | **String** | The version name of the method used to calculate the Confidence score. This field is only present for customers who opted in to an alternative calculation method. | [optional] |
|**score** | **Double** | A floating-point number between 0 and 1 that represents the probability of a false-positive identification. For High Recall ID, this value is 0. | |
|**version** | **String** | The version name of the method used to calculate the confidence score. For High Recall ID, this value is \"Not Supported\". | [optional] |
|**comment** | **String** | | [optional] |


Expand Down
2 changes: 1 addition & 1 deletion docs/LabelsInner.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**label** | **String** | | [optional] |
|**label** | **String** | | |
|**prediction** | **Boolean** | | [optional] |
|**mlScore** | **Double** | | [optional] |

Expand Down
19 changes: 14 additions & 5 deletions res/fingerprint-server-api.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1097,6 +1097,13 @@ components:
otherwise.
IdentificationConfidence:
type: object
description: >-
The confidence score represents the probability of a false-positive
identification. To learn more, visit [Confidence
Score](https://docs.fingerprint.com/docs/identification-accuracy-and-confidence#confidence-score).
Please note that the confidence score is not yet supported for [High
Recall
ID](https://docs.fingerprint.com/docs/supplementary-identifiers-highrecall).
required:
- score
properties:
Expand All @@ -1106,14 +1113,14 @@ components:
minimum: 0
maximum: 1
description: >-
The confidence score is a floating-point number between 0 and 1 that
represents the probability of accurate identification.
A floating-point number between 0 and 1 that represents the
probability of a false-positive identification. For High Recall ID,
this value is 0.
version:
type: string
description: >-
The version name of the method used to calculate the Confidence
score. This field is only present for customers who opted in to an
alternative calculation method.
The version name of the method used to calculate the confidence
score. For High Recall ID, this value is "Not Supported".
comment:
type: string
Identification:
Expand Down Expand Up @@ -2398,6 +2405,8 @@ components:
type: array
items:
type: object
required:
- label
properties:
label:
type: string
Expand Down
6 changes: 3 additions & 3 deletions sdk/src/main/java/com/fingerprint/v4/model/IdentificationConfidence.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
import java.util.Objects;

/**
* IdentificationConfidence
* The confidence score represents the probability of a false-positive identification. To learn more, visit [Confidence Score](https://docs.fingerprint.com/docs/identification-accuracy-and-confidence#confidence-score). Please note that the confidence score is not yet supported for [High Recall ID](https://docs.fingerprint.com/docs/supplementary-identifiers-highrecall).
*/
@JsonPropertyOrder({
IdentificationConfidence.JSON_PROPERTY_SCORE,
Expand Down Expand Up @@ -46,7 +46,7 @@ public IdentificationConfidence score(@jakarta.annotation.Nonnull Double score)
}

/**
* The confidence score is a floating-point number between 0 and 1 that represents the probability of accurate identification.
* A floating-point number between 0 and 1 that represents the probability of a false-positive identification. For High Recall ID, this value is 0.
* minimum: 0
* maximum: 1
* @return score
Expand All @@ -70,7 +70,7 @@ public IdentificationConfidence version(@jakarta.annotation.Nullable String vers
}

/**
* The version name of the method used to calculate the Confidence score. This field is only present for customers who opted in to an alternative calculation method.
* The version name of the method used to calculate the confidence score. For High Recall ID, this value is \"Not Supported\".
* @return version
*/
@jakarta.annotation.Nullable
Expand Down
16 changes: 8 additions & 8 deletions sdk/src/main/java/com/fingerprint/v4/model/LabelsInner.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
comments = "Generator version: 7.16.0")
public class LabelsInner {
public static final String JSON_PROPERTY_LABEL = "label";
@jakarta.annotation.Nullable private String label;
@jakarta.annotation.Nonnull private String label;

public static final String JSON_PROPERTY_PREDICTION = "prediction";
@jakarta.annotation.Nullable private Boolean prediction;
Expand All @@ -42,7 +42,7 @@ public class LabelsInner {

public LabelsInner() {}

public LabelsInner label(@jakarta.annotation.Nullable String label) {
public LabelsInner label(@jakarta.annotation.Nonnull String label) {
this.label = label;
return this;
}
Expand All @@ -51,16 +51,16 @@ public LabelsInner label(@jakarta.annotation.Nullable String label) {
* Get label
* @return label
*/
@jakarta.annotation.Nullable
@JsonProperty(value = JSON_PROPERTY_LABEL, required = false)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
@jakarta.annotation.Nonnull
@JsonProperty(value = JSON_PROPERTY_LABEL, required = true)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public String getLabel() {
return label;
}

@JsonProperty(value = JSON_PROPERTY_LABEL, required = false)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setLabel(@jakarta.annotation.Nullable String label) {
@JsonProperty(value = JSON_PROPERTY_LABEL, required = true)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setLabel(@jakarta.annotation.Nonnull String label) {
this.label = label;
}

Expand Down
12 changes: 6 additions & 6 deletions sdk/src/test/resources/mocks/events/get_event_200.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,14 @@
"last_seen_at": 1708102555327
},
"supplementary_id_high_recall": {
"visitor_id": "3HNey93AkBW6CRbxV6xP",
"visitor_id": "0jnGMkPYXX37DqVa4ZIO3f_hr",
"visitor_found": true,
"confidence": {
"score": 0.97,
"version": "1.1"
"score": 0,
"version": "Not Supported"
},
"first_seen_at": 1708102555327,
"last_seen_at": 1708102555327
"first_seen_at": 1778086556130,
"last_seen_at": 1778604975494
},
"proximity": {
"id": "w1aTfd4MCvl",
Expand Down Expand Up @@ -294,4 +294,4 @@
"ml_score": 0.01
}
]
}
}
10 changes: 5 additions & 5 deletions sdk/src/test/resources/mocks/events/get_event_ruleset_200.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,14 @@
"last_seen_at": 1708102555327
},
"supplementary_id_high_recall": {
"visitor_id": "3HNey93AkBW6CRbxV6xP",
"visitor_id": "0jnGMkPYXX37DqVa4ZIO3f_hr",
"visitor_found": true,
"confidence": {
"score": 0.97,
"version": "1.1"
"score": 0,
"version": "Not Supported"
},
"first_seen_at": 1708102555327,
"last_seen_at": 1708102555327
"first_seen_at": 1778086556130,
"last_seen_at": 1778604975494
},
"proximity": {
"id": "w1aTfd4MCvl",
Expand Down
10 changes: 5 additions & 5 deletions sdk/src/test/resources/mocks/events/search/get_event_search_200.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,14 @@
"last_seen_at": 1708102555327
},
"supplementary_id_high_recall": {
"visitor_id": "3HNey93AkBW6CRbxV6xP",
"visitor_id": "0jnGMkPYXX37DqVa4ZIO3f_hr",
"visitor_found": true,
"confidence": {
"score": 0.97,
"version": "1.1"
"score": 0,
"version": "Not Supported"
},
"first_seen_at": 1708102555327,
"last_seen_at": 1708102555327
"first_seen_at": 1778086556130,
"last_seen_at": 1778604975494
},
"proximity": {
"id": "w1aTfd4MCvl",
Expand Down
Loading