Skip to content

Commit c6aa946

Browse files
box-sdk-buildbox-sdk-build
authored
docs: documentation release 4.15.0 (#1291)
1 parent d4c7b41 commit c6aa946

34 files changed

+4973
-4169
lines changed

‎javadoc/allclasses-frame.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -221,6 +221,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
221221
<li><a href="com/box/sdk/StandardCharsets.html" title="class in com.box.sdk" target="classFrame">StandardCharsets</a></li>
222222
<li><a href="com/box/sdk/UploadFileCallback.html" title="interface in com.box.sdk" target="classFrame"><span class="interfaceName">UploadFileCallback</span></a></li>
223223
<li><a href="com/box/sdk/URLTemplate.html" title="class in com.box.sdk" target="classFrame">URLTemplate</a></li>
224+
<li><a href="com/box/sdk/ZstdInterceptor.html" title="class in com.box.sdk" target="classFrame">ZstdInterceptor</a></li>
224225
</ul>
225226
</div>
226227
</body>

‎javadoc/allclasses-noframe.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -221,6 +221,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
221221
<li><a href="com/box/sdk/StandardCharsets.html" title="class in com.box.sdk">StandardCharsets</a></li>
222222
<li><a href="com/box/sdk/UploadFileCallback.html" title="interface in com.box.sdk"><span class="interfaceName">UploadFileCallback</span></a></li>
223223
<li><a href="com/box/sdk/URLTemplate.html" title="class in com.box.sdk">URLTemplate</a></li>
224+
<li><a href="com/box/sdk/ZstdInterceptor.html" title="class in com.box.sdk">ZstdInterceptor</a></li>
224225
</ul>
225226
</div>
226227
</body>

‎javadoc/com/box/sdk/BoxAIExtractStructuredResponse.html‎

Lines changed: 65 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
catch(err) {
1919
}
2020
//-->
21-
var methods = {"i0":10};
21+
var methods = {"i0":10,"i1":10,"i2":10,"i3":10};
2222
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
2323
var altColor = "altColor";
2424
var rowColor = "rowColor";
@@ -52,7 +52,7 @@ <h2 title="Class BoxAIExtractStructuredResponse" class="title">Class BoxAIExtrac
5252
<li class="blockList">
5353
<hr>
5454
<br>
55-
<pre>public class <a href="../../../src-html/com/box/sdk/BoxAIExtractStructuredResponse.html#line.9">BoxAIExtractStructuredResponse</a>
55+
<pre>public class <a href="../../../src-html/com/box/sdk/BoxAIExtractStructuredResponse.html#line.12">BoxAIExtractStructuredResponse</a>
5656
extends <a href="../../../com/box/sdk/BoxJSONObject.html" title="class in com.box.sdk">BoxJSONObject</a></pre>
5757
<div class="block">AI response to a user request.</div>
5858
</li>
@@ -94,6 +94,24 @@ <h3>Method Summary</h3>
9494
</tr>
9595
<tr id="i0" class="altColor">
9696
<td class="colFirst"><code>JsonObject</code></td>
97+
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/box/sdk/BoxAIExtractStructuredResponse.html#getAnswer--">getAnswer</a></span>()</code>
98+
<div class="block">Gets the answer of the AI.</div>
99+
</td>
100+
</tr>
101+
<tr id="i1" class="rowColor">
102+
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
103+
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/box/sdk/BoxAIExtractStructuredResponse.html#getCompletionReason--">getCompletionReason</a></span>()</code>
104+
<div class="block">Gets reason the response finishes.</div>
105+
</td>
106+
</tr>
107+
<tr id="i2" class="altColor">
108+
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a></code></td>
109+
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/box/sdk/BoxAIExtractStructuredResponse.html#getCreatedAt--">getCreatedAt</a></span>()</code>
110+
<div class="block">Gets the ISO date formatted timestamp of when the answer to the prompt was created.</div>
111+
</td>
112+
</tr>
113+
<tr id="i3" class="rowColor">
114+
<td class="colFirst"><code>JsonObject</code></td>
97115
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/box/sdk/BoxAIExtractStructuredResponse.html#getSourceJson--">getSourceJson</a></span>()</code>
98116
<div class="block">Gets the source JSON of the AI response.</div>
99117
</td>
@@ -133,7 +151,7 @@ <h3>Constructor Detail</h3>
133151
<ul class="blockListLast">
134152
<li class="blockList">
135153
<h4>BoxAIExtractStructuredResponse</h4>
136-
<pre>public&nbsp;<a href="../../../src-html/com/box/sdk/BoxAIExtractStructuredResponse.html#line.15">BoxAIExtractStructuredResponse</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;json)</pre>
154+
<pre>public&nbsp;<a href="../../../src-html/com/box/sdk/BoxAIExtractStructuredResponse.html#line.21">BoxAIExtractStructuredResponse</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;json)</pre>
137155
<div class="block">Constructs a BoxAIResponse object.</div>
138156
</li>
139157
</ul>
@@ -148,17 +166,59 @@ <h3>Method Detail</h3>
148166
<a name="getSourceJson--">
149167
<!-- -->
150168
</a>
151-
<ul class="blockListLast">
169+
<ul class="blockList">
152170
<li class="blockList">
153171
<h4>getSourceJson</h4>
154-
<pre>public&nbsp;JsonObject&nbsp;<a href="../../../src-html/com/box/sdk/BoxAIExtractStructuredResponse.html#line.35">getSourceJson</a>()</pre>
172+
<pre>public&nbsp;JsonObject&nbsp;<a href="../../../src-html/com/box/sdk/BoxAIExtractStructuredResponse.html#line.41">getSourceJson</a>()</pre>
155173
<div class="block">Gets the source JSON of the AI response.</div>
156174
<dl>
157175
<dt><span class="returnLabel">Returns:</span></dt>
158176
<dd>the source JSON of the AI response.</dd>
159177
</dl>
160178
</li>
161179
</ul>
180+
<a name="getAnswer--">
181+
<!-- -->
182+
</a>
183+
<ul class="blockList">
184+
<li class="blockList">
185+
<h4>getAnswer</h4>
186+
<pre>public&nbsp;JsonObject&nbsp;<a href="../../../src-html/com/box/sdk/BoxAIExtractStructuredResponse.html#line.50">getAnswer</a>()</pre>
187+
<div class="block">Gets the answer of the AI.</div>
188+
<dl>
189+
<dt><span class="returnLabel">Returns:</span></dt>
190+
<dd>the answer of the AI.</dd>
191+
</dl>
192+
</li>
193+
</ul>
194+
<a name="getCompletionReason--">
195+
<!-- -->
196+
</a>
197+
<ul class="blockList">
198+
<li class="blockList">
199+
<h4>getCompletionReason</h4>
200+
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;<a href="../../../src-html/com/box/sdk/BoxAIExtractStructuredResponse.html#line.59">getCompletionReason</a>()</pre>
201+
<div class="block">Gets reason the response finishes.</div>
202+
<dl>
203+
<dt><span class="returnLabel">Returns:</span></dt>
204+
<dd>the reason the response finishes.</dd>
205+
</dl>
206+
</li>
207+
</ul>
208+
<a name="getCreatedAt--">
209+
<!-- -->
210+
</a>
211+
<ul class="blockListLast">
212+
<li class="blockList">
213+
<h4>getCreatedAt</h4>
214+
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a>&nbsp;<a href="../../../src-html/com/box/sdk/BoxAIExtractStructuredResponse.html#line.68">getCreatedAt</a>()</pre>
215+
<div class="block">Gets the ISO date formatted timestamp of when the answer to the prompt was created.</div>
216+
<dl>
217+
<dt><span class="returnLabel">Returns:</span></dt>
218+
<dd>The ISO date formatted timestamp of when the answer to the prompt was created.</dd>
219+
</dl>
220+
</li>
221+
</ul>
162222
</li>
163223
</ul>
164224
</li>

‎javadoc/com/box/sdk/BoxAPIConnection.ResourceLinkType.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ <h2 title="Enum BoxAPIConnection.ResourceLinkType" class="title">Enum BoxAPIConn
6060
</dl>
6161
<hr>
6262
<br>
63-
<pre>protected static enum <a href="../../../src-html/com/box/sdk/BoxAPIConnection.html#line.1285">BoxAPIConnection.ResourceLinkType</a>
63+
<pre>protected static enum <a href="../../../src-html/com/box/sdk/BoxAPIConnection.html#line.1307">BoxAPIConnection.ResourceLinkType</a>
6464
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a>&lt;<a href="../../../com/box/sdk/BoxAPIConnection.ResourceLinkType.html" title="enum in com.box.sdk">BoxAPIConnection.ResourceLinkType</a>&gt;</pre>
6565
<div class="block">Used to categorize the types of resource links.</div>
6666
</li>
@@ -160,7 +160,7 @@ <h3>Enum Constant Detail</h3>
160160
<ul class="blockList">
161161
<li class="blockList">
162162
<h4>Unknown</h4>
163-
<pre>public static final&nbsp;<a href="../../../com/box/sdk/BoxAPIConnection.ResourceLinkType.html" title="enum in com.box.sdk">BoxAPIConnection.ResourceLinkType</a> <a href="../../../src-html/com/box/sdk/BoxAPIConnection.ResourceLinkType.html#line.1289">Unknown</a></pre>
163+
<pre>public static final&nbsp;<a href="../../../com/box/sdk/BoxAPIConnection.ResourceLinkType.html" title="enum in com.box.sdk">BoxAPIConnection.ResourceLinkType</a> <a href="../../../src-html/com/box/sdk/BoxAPIConnection.ResourceLinkType.html#line.1311">Unknown</a></pre>
164164
<div class="block">Catch-all default for resource links that are unknown.</div>
165165
</li>
166166
</ul>
@@ -170,7 +170,7 @@ <h4>Unknown</h4>
170170
<ul class="blockList">
171171
<li class="blockList">
172172
<h4>APIEndpoint</h4>
173-
<pre>public static final&nbsp;<a href="../../../com/box/sdk/BoxAPIConnection.ResourceLinkType.html" title="enum in com.box.sdk">BoxAPIConnection.ResourceLinkType</a> <a href="../../../src-html/com/box/sdk/BoxAPIConnection.ResourceLinkType.html#line.1294">APIEndpoint</a></pre>
173+
<pre>public static final&nbsp;<a href="../../../com/box/sdk/BoxAPIConnection.ResourceLinkType.html" title="enum in com.box.sdk">BoxAPIConnection.ResourceLinkType</a> <a href="../../../src-html/com/box/sdk/BoxAPIConnection.ResourceLinkType.html#line.1316">APIEndpoint</a></pre>
174174
<div class="block">Resource URLs that point to an API endipoint such as https://api.box.com/2.0/files/:file_id.</div>
175175
</li>
176176
</ul>
@@ -180,7 +180,7 @@ <h4>APIEndpoint</h4>
180180
<ul class="blockListLast">
181181
<li class="blockList">
182182
<h4>SharedLink</h4>
183-
<pre>public static final&nbsp;<a href="../../../com/box/sdk/BoxAPIConnection.ResourceLinkType.html" title="enum in com.box.sdk">BoxAPIConnection.ResourceLinkType</a> <a href="../../../src-html/com/box/sdk/BoxAPIConnection.ResourceLinkType.html#line.1301">SharedLink</a></pre>
183+
<pre>public static final&nbsp;<a href="../../../com/box/sdk/BoxAPIConnection.ResourceLinkType.html" title="enum in com.box.sdk">BoxAPIConnection.ResourceLinkType</a> <a href="../../../src-html/com/box/sdk/BoxAPIConnection.ResourceLinkType.html#line.1323">SharedLink</a></pre>
184184
<div class="block">Resource URLs that point to a resource that has been shared
185185
such as https://example.box.com/s/qwertyuiop1234567890asdfghjk
186186
or https://example.app.box.com/notes/0987654321?s=zxcvbnm1234567890asdfghjk.</div>

0 commit comments

Comments
 (0)