Class BetaVectorStoreFileBatchListFilesParams
-
- All Implemented Interfaces:
-
com.openai.core.Params
public final class BetaVectorStoreFileBatchListFilesParams implements Params
Returns a list of vector store files in a batch.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
BetaVectorStoreFileBatchListFilesParams.Builder
A builder for BetaVectorStoreFileBatchListFilesParams.
public final class
BetaVectorStoreFileBatchListFilesParams.Filter
Filter by file status. One of
in_progress
,completed
,failed
,cancelled
.public final class
BetaVectorStoreFileBatchListFilesParams.Order
Sort order by the
created_at
timestamp of the objects.asc
for ascending order anddesc
for descending order.
-
Method Summary
Modifier and Type Method Description final String
vectorStoreId()
final String
batchId()
final Optional<String>
after()
A cursor for use in pagination. final Optional<String>
before()
A cursor for use in pagination. final Optional<BetaVectorStoreFileBatchListFilesParams.Filter>
filter()
Filter by file status. final Optional<Long>
limit()
A limit on the number of objects to be returned. final Optional<BetaVectorStoreFileBatchListFilesParams.Order>
order()
Sort order by the created_at
timestamp of the objects.final Headers
_additionalHeaders()
final QueryParams
_additionalQueryParams()
Headers
_headers()
The full set of headers in the parameters, including both fixed and additional headers. QueryParams
_queryParams()
The full set of query params in the parameters, including both fixed and additional query params. final String
getPathParam(Integer index)
final BetaVectorStoreFileBatchListFilesParams.Builder
toBuilder()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static BetaVectorStoreFileBatchListFilesParams.Builder
builder()
Returns a mutable builder for constructing an instance of BetaVectorStoreFileBatchListFilesParams. -
-
Method Detail
-
vectorStoreId
final String vectorStoreId()
-
after
final Optional<String> after()
A cursor for use in pagination.
after
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.
-
before
final Optional<String> before()
A cursor for use in pagination.
before
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.
-
filter
final Optional<BetaVectorStoreFileBatchListFilesParams.Filter> filter()
Filter by file status. One of
in_progress
,completed
,failed
,cancelled
.
-
limit
final Optional<Long> limit()
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
-
order
final Optional<BetaVectorStoreFileBatchListFilesParams.Order> order()
Sort order by the
created_at
timestamp of the objects.asc
for ascending order anddesc
for descending order.
-
_additionalHeaders
final Headers _additionalHeaders()
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
-
_headers
Headers _headers()
The full set of headers in the parameters, including both fixed and additional headers.
-
_queryParams
QueryParams _queryParams()
The full set of query params in the parameters, including both fixed and additional query params.
-
getPathParam
final String getPathParam(Integer index)
-
toBuilder
final BetaVectorStoreFileBatchListFilesParams.Builder toBuilder()
-
builder
final static BetaVectorStoreFileBatchListFilesParams.Builder builder()
Returns a mutable builder for constructing an instance of BetaVectorStoreFileBatchListFilesParams.
The following fields are required:
.vectorStoreId() .batchId()
-
-
-
-