ChatGPT-Java-API/com.cjcrafter.openai/AbstractListRequestBuilder

AbstractListRequestBuilder

abstract class AbstractListRequestBuilder<T>

An abstract builder type for list requests. Many objects stored by the OpenAI API are stored in lists. This abstract request stores the data that each request has in common.

Inheritors

Builder

Constructors

AbstractListRequestBuilder

constructor()

Functions

after

fun after(after: Assistant): AbstractListRequestBuilder<T>

fun after(after: String?): AbstractListRequestBuilder<T>

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.

ascending

fun ascending(): AbstractListRequestBuilder<T>

Sets the order to ListOrder.ASCENDING.

before

fun before(before: Assistant): AbstractListRequestBuilder<T>

fun before(before: String?): AbstractListRequestBuilder<T>

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, ending with "obj_foo", your subsequent call can include before="obj_foo" in order to fetch the previous page of the list.

build

abstract fun build(): T

descending

fun descending(): AbstractListRequestBuilder<T>

Sets the order to ListOrder.DESCENDING.

limit

fun limit(limit: Int?): AbstractListRequestBuilder<T>

The maximum number of results to return. This value must be between 1 and 100 (inclusive).

order

fun order(order: ListOrder?): AbstractListRequestBuilder<T>

How the returned list should be ordered. If not specified, the default value is ListOrder.DESCENDING. Use the ascending and descending methods.