Class ListQuery

Namespace

OpenAI

Assembly

OpenAI-DotNet.dll

public sealed class ListQuery

Inheritance

object

ListQuery

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ListQuery(int?, SortOrder, string, string)

[Obsolete("use new .ctr overload")]
public ListQuery(int? limit, SortOrder order, string after, string before)

Parameters

limit int?

order SortOrder

after string

before string

ListQuery(string, string, IEnumerable<string>, int?, SortOrder)

List Query.

public ListQuery(string after = null, string before = null, IEnumerable<string> include = null, int? limit = null, SortOrder order = SortOrder.Descending)

Parameters

after string

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 string

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.

include IEnumerable<string>

Additional fields to include in the response.

limit int?

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

order SortOrder

Sort order by the 'created_at' timestamp of the objects.

Properties

After

An item ID to list items after, used in pagination.

public string After { get; set; }

Property Value

string

Before

An item ID to list items before, used in pagination.

public string Before { get; set; }

Property Value

string

Include

Additional fields to include in the response.

public IEnumerable<string> Include { get; set; }

Property Value

IEnumerable<string>

Limit

Additional fields to include in the response.

public int? Limit { get; set; }

Property Value

int?

Order

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

public SortOrder Order { get; set; }

Property Value

SortOrder

Operators

implicit operator Dictionary<string, string>(ListQuery)

public static implicit operator Dictionary<string, string>(ListQuery query)

Parameters

query ListQuery

Returns

Dictionary<string, string>