Skip to content

Commit 28640c7

Browse files
box-sdk-buildbox-sdk-build
authored
docs(boxsdkgen): bounding boxes&confidence score (box/box-openapi#619)
1 parent 15ef038 commit 28640c7

7 files changed

Lines changed: 60 additions & 136 deletions

File tree

‎.codegen.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{ "engineHash": "daeb1ea", "specHash": "88cd5aa", "version": "5.17.0" }
1+
{ "engineHash": "daeb1ea", "specHash": "c5a35a6", "version": "5.17.0" }

‎src/main/java/com/box/sdkgen/schemas/aiextractstructured/AiExtractStructured.java‎

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,22 @@ public class AiExtractStructured extends SerializableObject {
3535
@JsonProperty("ai_agent")
3636
protected AiExtractStructuredAgent aiAgent;
3737

38-
/** A flag to indicate whether confidence scores for every extracted field should be returned. */
38+
/**
39+
* A flag to indicate whether confidence scores for every extracted field should be returned.
40+
* Estimates the likelihood that an extracted metadata field value is accurate and correct.
41+
* Displays a numerical and categorical confidence score to help users and automated systems
42+
* quickly determine extraction reliability.
43+
*/
3944
@JsonProperty("include_confidence_score")
4045
protected Boolean includeConfidenceScore;
4146

42-
/** A flag to indicate whether references for every extracted field should be returned. */
47+
/**
48+
* A flag to indicate whether references for every extracted field should be returned. References
49+
* and bounding boxes show where the agent extracted the metadata from. They help you check for
50+
* accuracy and fix any mistakes. References are short, exact quotes from the original document
51+
* used to verify results. Bounding boxes highlight the specific areas on the page where that text
52+
* is found.
53+
*/
4354
@JsonProperty("include_reference")
4455
protected Boolean includeReference;
4556

‎src/main/java/com/box/sdkgen/schemas/collaboration/Collaboration.java‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@
77
import com.box.sdkgen.schemas.appitem.AppItem;
88
import com.box.sdkgen.schemas.collaborationaccessgrantee.CollaborationAccessGrantee;
99
import com.box.sdkgen.schemas.collaborationitem.CollaborationItem;
10-
import com.box.sdkgen.schemas.file.File;
11-
import com.box.sdkgen.schemas.folder.Folder;
10+
import com.box.sdkgen.schemas.filemini.FileMini;
11+
import com.box.sdkgen.schemas.foldermini.FolderMini;
1212
import com.box.sdkgen.schemas.groupmini.GroupMini;
1313
import com.box.sdkgen.schemas.usercollaborations.UserCollaborations;
14-
import com.box.sdkgen.schemas.weblink.WebLink;
14+
import com.box.sdkgen.schemas.weblinkmini.WebLinkMini;
1515
import com.box.sdkgen.serialization.json.EnumWrapper;
1616
import com.fasterxml.jackson.annotation.JsonFilter;
1717
import com.fasterxml.jackson.annotation.JsonProperty;
@@ -349,19 +349,19 @@ public Builder type(EnumWrapper<CollaborationTypeField> type) {
349349
return this;
350350
}
351351

352-
public Builder item(File item) {
352+
public Builder item(FileMini item) {
353353
this.item = new CollaborationItem(item);
354354
this.markNullableFieldAsSet("item");
355355
return this;
356356
}
357357

358-
public Builder item(Folder item) {
358+
public Builder item(FolderMini item) {
359359
this.item = new CollaborationItem(item);
360360
this.markNullableFieldAsSet("item");
361361
return this;
362362
}
363363

364-
public Builder item(WebLink item) {
364+
public Builder item(WebLinkMini item) {
365365
this.item = new CollaborationItem(item);
366366
this.markNullableFieldAsSet("item");
367367
return this;

‎src/main/java/com/box/sdkgen/schemas/collaborationitem/CollaborationItem.java‎

Lines changed: 33 additions & 126 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
11
package com.box.sdkgen.schemas.collaborationitem;
22

33
import com.box.sdkgen.internal.OneOfThree;
4-
import com.box.sdkgen.schemas.file.File;
5-
import com.box.sdkgen.schemas.folder.Folder;
4+
import com.box.sdkgen.schemas.filemini.FileMini;
65
import com.box.sdkgen.schemas.foldermini.FolderMini;
7-
import com.box.sdkgen.schemas.usermini.UserMini;
8-
import com.box.sdkgen.schemas.weblink.WebLink;
6+
import com.box.sdkgen.schemas.weblinkmini.WebLinkMini;
97
import com.box.sdkgen.serialization.json.EnumWrapper;
108
import com.box.sdkgen.serialization.json.JsonManager;
119
import com.fasterxml.jackson.core.JsonParser;
@@ -16,31 +14,10 @@
1614
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
1715
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
1816
import java.io.IOException;
19-
import java.time.OffsetDateTime;
2017

2118
@JsonDeserialize(using = CollaborationItem.CollaborationItemDeserializer.class)
2219
@JsonSerialize(using = OneOfThree.OneOfThreeSerializer.class)
23-
public class CollaborationItem extends OneOfThree<File, Folder, WebLink> {
24-
25-
protected final String description;
26-
27-
protected final OffsetDateTime createdAt;
28-
29-
protected final OffsetDateTime modifiedAt;
30-
31-
protected final OffsetDateTime trashedAt;
32-
33-
protected final OffsetDateTime purgedAt;
34-
35-
protected final UserMini createdBy;
36-
37-
protected final UserMini modifiedBy;
38-
39-
protected final UserMini ownedBy;
40-
41-
protected final FolderMini parent;
42-
43-
protected final String itemStatus;
20+
public class CollaborationItem extends OneOfThree<FileMini, FolderMini, WebLinkMini> {
4421

4522
protected final String sequenceId;
4623

@@ -52,127 +29,57 @@ public class CollaborationItem extends OneOfThree<File, Folder, WebLink> {
5229

5330
protected final String type;
5431

55-
public CollaborationItem(File file) {
56-
super(file, null, null);
57-
this.description = file.getDescription();
58-
this.createdAt = file.getCreatedAt();
59-
this.modifiedAt = file.getModifiedAt();
60-
this.trashedAt = file.getTrashedAt();
61-
this.purgedAt = file.getPurgedAt();
62-
this.createdBy = file.getCreatedBy();
63-
this.modifiedBy = file.getModifiedBy();
64-
this.ownedBy = file.getOwnedBy();
65-
this.parent = file.getParent();
66-
this.itemStatus = EnumWrapper.convertToString(file.getItemStatus());
67-
this.sequenceId = file.getSequenceId();
68-
this.name = file.getName();
69-
this.id = file.getId();
70-
this.etag = file.getEtag();
71-
this.type = EnumWrapper.convertToString(file.getType());
32+
public CollaborationItem(FileMini fileMini) {
33+
super(fileMini, null, null);
34+
this.sequenceId = fileMini.getSequenceId();
35+
this.name = fileMini.getName();
36+
this.id = fileMini.getId();
37+
this.etag = fileMini.getEtag();
38+
this.type = EnumWrapper.convertToString(fileMini.getType());
7239
}
7340

74-
public CollaborationItem(Folder folder) {
75-
super(null, folder, null);
76-
this.description = folder.getDescription();
77-
this.createdAt = folder.getCreatedAt();
78-
this.modifiedAt = folder.getModifiedAt();
79-
this.trashedAt = folder.getTrashedAt();
80-
this.purgedAt = folder.getPurgedAt();
81-
this.createdBy = folder.getCreatedBy();
82-
this.modifiedBy = folder.getModifiedBy();
83-
this.ownedBy = folder.getOwnedBy();
84-
this.parent = folder.getParent();
85-
this.itemStatus = EnumWrapper.convertToString(folder.getItemStatus());
86-
this.sequenceId = folder.getSequenceId();
87-
this.name = folder.getName();
88-
this.id = folder.getId();
89-
this.etag = folder.getEtag();
90-
this.type = EnumWrapper.convertToString(folder.getType());
41+
public CollaborationItem(FolderMini folderMini) {
42+
super(null, folderMini, null);
43+
this.sequenceId = folderMini.getSequenceId();
44+
this.name = folderMini.getName();
45+
this.id = folderMini.getId();
46+
this.etag = folderMini.getEtag();
47+
this.type = EnumWrapper.convertToString(folderMini.getType());
9148
}
9249

93-
public CollaborationItem(WebLink webLink) {
94-
super(null, null, webLink);
95-
this.description = webLink.getDescription();
96-
this.createdAt = webLink.getCreatedAt();
97-
this.modifiedAt = webLink.getModifiedAt();
98-
this.trashedAt = webLink.getTrashedAt();
99-
this.purgedAt = webLink.getPurgedAt();
100-
this.createdBy = webLink.getCreatedBy();
101-
this.modifiedBy = webLink.getModifiedBy();
102-
this.ownedBy = webLink.getOwnedBy();
103-
this.parent = webLink.getParent();
104-
this.itemStatus = EnumWrapper.convertToString(webLink.getItemStatus());
105-
this.sequenceId = webLink.getSequenceId();
106-
this.name = webLink.getName();
107-
this.id = webLink.getId();
108-
this.etag = webLink.getEtag();
109-
this.type = EnumWrapper.convertToString(webLink.getType());
50+
public CollaborationItem(WebLinkMini webLinkMini) {
51+
super(null, null, webLinkMini);
52+
this.sequenceId = webLinkMini.getSequenceId();
53+
this.name = webLinkMini.getName();
54+
this.id = webLinkMini.getId();
55+
this.etag = webLinkMini.getEtag();
56+
this.type = EnumWrapper.convertToString(webLinkMini.getType());
11057
}
11158

112-
public boolean isFile() {
59+
public boolean isFileMini() {
11360
return value0 != null;
11461
}
11562

116-
public File getFile() {
63+
public FileMini getFileMini() {
11764
return value0;
11865
}
11966

120-
public boolean isFolder() {
67+
public boolean isFolderMini() {
12168
return value1 != null;
12269
}
12370

124-
public Folder getFolder() {
71+
public FolderMini getFolderMini() {
12572
return value1;
12673
}
12774

128-
public boolean isWebLink() {
75+
public boolean isWebLinkMini() {
12976
return value2 != null;
13077
}
13178

132-
public WebLink getWebLink() {
79+
public WebLinkMini getWebLinkMini() {
13380
return value2;
13481
}
13582

136-
public String getDescription() {
137-
return description;
138-
}
139-
140-
public OffsetDateTime getCreatedAt() {
141-
return createdAt;
142-
}
143-
144-
public OffsetDateTime getModifiedAt() {
145-
return modifiedAt;
146-
}
147-
148-
public OffsetDateTime getTrashedAt() {
149-
return trashedAt;
150-
}
151-
152-
public OffsetDateTime getPurgedAt() {
153-
return purgedAt;
154-
}
155-
156-
public UserMini getCreatedBy() {
157-
return createdBy;
158-
}
159-
160-
public UserMini getModifiedBy() {
161-
return modifiedBy;
162-
}
163-
164-
public UserMini getOwnedBy() {
165-
return ownedBy;
166-
}
167-
168-
public FolderMini getParent() {
169-
return parent;
170-
}
171-
172-
public String getItemStatus() {
173-
return itemStatus;
174-
}
175-
17683
public String getSequenceId() {
17784
return sequenceId;
17885
}
@@ -207,11 +114,11 @@ public CollaborationItem deserialize(JsonParser jp, DeserializationContext ctxt)
207114
if (!(discriminant0 == null)) {
208115
switch (discriminant0.asText()) {
209116
case "file":
210-
return new CollaborationItem(JsonManager.deserialize(node, File.class));
117+
return new CollaborationItem(JsonManager.deserialize(node, FileMini.class));
211118
case "folder":
212-
return new CollaborationItem(JsonManager.deserialize(node, Folder.class));
119+
return new CollaborationItem(JsonManager.deserialize(node, FolderMini.class));
213120
case "web_link":
214-
return new CollaborationItem(JsonManager.deserialize(node, WebLink.class));
121+
return new CollaborationItem(JsonManager.deserialize(node, WebLinkMini.class));
215122
}
216123
}
217124
throw new JsonMappingException(jp, "Unable to deserialize CollaborationItem");

‎src/main/java/com/box/sdkgen/schemas/file/File.java‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,7 @@ public class File extends FileMini {
9090
protected UserMini ownedBy;
9191

9292
@JsonProperty("shared_link")
93+
@Nullable
9394
protected FileSharedLinkField sharedLink;
9495

9596
@Nullable protected FolderMini parent;
@@ -444,6 +445,7 @@ public Builder ownedBy(UserMini ownedBy) {
444445

445446
public Builder sharedLink(FileSharedLinkField sharedLink) {
446447
this.sharedLink = sharedLink;
448+
this.markNullableFieldAsSet("shared_link");
447449
return this;
448450
}
449451

‎src/main/java/com/box/sdkgen/schemas/filefull/FileFull.java‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ public class FileFull extends File {
9999

100100
protected FileFullRepresentationsField representations;
101101

102-
protected FileFullClassificationField classification;
102+
@Nullable protected FileFullClassificationField classification;
103103

104104
@JsonProperty("uploader_display_name")
105105
protected String uploaderDisplayName;
@@ -770,6 +770,7 @@ public Builder representations(FileFullRepresentationsField representations) {
770770

771771
public Builder classification(FileFullClassificationField classification) {
772772
this.classification = classification;
773+
this.markNullableFieldAsSet("classification");
773774
return this;
774775
}
775776

@@ -948,6 +949,7 @@ public Builder ownedBy(UserMini ownedBy) {
948949
@Override
949950
public Builder sharedLink(FileSharedLinkField sharedLink) {
950951
this.sharedLink = sharedLink;
952+
this.markNullableFieldAsSet("shared_link");
951953
return this;
952954
}
953955

‎src/main/java/com/box/sdkgen/schemas/weblink/WebLink.java‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,7 @@ public class WebLink extends WebLinkMini {
8080
protected UserMini ownedBy;
8181

8282
@JsonProperty("shared_link")
83+
@Nullable
8384
protected WebLinkSharedLinkField sharedLink;
8485

8586
/**
@@ -422,6 +423,7 @@ public Builder ownedBy(UserMini ownedBy) {
422423

423424
public Builder sharedLink(WebLinkSharedLinkField sharedLink) {
424425
this.sharedLink = sharedLink;
426+
this.markNullableFieldAsSet("shared_link");
425427
return this;
426428
}
427429

0 commit comments

Comments
 (0)