ListQuery

api_openai::exposed::components::query

Struct ListQuery 

Source 
pub struct ListQuery {
    pub limit: Option<u32>,
    pub order: Option<String>,
    pub after: Option<String>,
    pub before: Option<String>,
}
Expand description

Represents common query parameters for list endpoints supporting pagination and ordering.

Fields correspond to standard parameters like limit, order, after, and before. Use the Former derive to construct instances easily.

§Used By (as query parameter)

  • /assistants (GET)
  • /threads/{thread_id}/messages (GET)
  • /threads/{thread_id}/runs (GET)
  • /threads/{thread_id}/runs/{run_id}/steps (GET)
  • /vector_stores (GET)
  • /vector_stores/{vector_store_id}/files (GET)
  • /vector_stores/{vector_store_id}/file_batches/{batch_id}/files (GET)
  • /files (GET)
  • /batches (GET)
  • /chat/completions (GET)
  • /fine_tuning/jobs (GET)
  • /fine_tuning/jobs/{fine_tuning_job_id}/events (GET)
  • /fine_tuning/jobs/{fine_tuning_job_id}/checkpoints (GET)
  • /fine_tuning/checkpoints/{permission_id}/permissions (GET)
  • /organization/admin_api_keys (GET)
  • /organization/audit_logs (GET)
  • /organization/invites (GET)
  • /organization/projects (GET)
  • /organization/projects/{project_id}/api_keys (GET)
  • /organization/projects/{project_id}/rate_limits (GET)
  • /organization/projects/{project_id}/service_accounts (GET)
  • /organization/projects/{project_id}/users (GET)
  • /organization/users (GET)
  • /responses/{response_id}/input_items (GET) // Added this endpoint

Fields§

§limit: Option<u32>

A limit on the number of objects to be returned. Limit can range between 1 and 100, with a default depending on the endpoint (often 20).

§order: Option<String>

Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. Default varies by endpoint (often desc).

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

Implementations§

Source§

impl ListQuery

Source

pub fn former() -> ListQueryFormer<ListQueryFormerDefinition<(), ListQuery, ReturnPreformed>>

Provides a mechanism to initiate the formation process with a default completion behavior.

Trait Implementations§

Source§

impl Clone for ListQuery

Source§

fn clone(&self) -> ListQuery

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for ListQuery

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<__Context, __Formed, __End> EntityToDefinition<__Context, __Formed, __End> for ListQuery
where __End: FormingEnd<ListQueryFormerDefinitionTypes<__Context, __Formed>>,

Source§

type Definition = ListQueryFormerDefinition<__Context, __Formed, __End>

The specific FormerDefinition associated with this entity. Read more
Source§

type Types = ListQueryFormerDefinitionTypes<__Context, __Formed>

The specific FormerDefinitionTypes associated with this entity. Read more
Source§

impl<__Context, __Formed> EntityToDefinitionTypes<__Context, __Formed> for ListQuery

Source§

type Types = ListQueryFormerDefinitionTypes<__Context, __Formed>

Specifies the FormerDefinitionTypes that define the storage, formed entity, and context types used during formation. Read more
Source§

impl<Definition> EntityToFormer<Definition> for ListQuery
where Definition: FormerDefinition<Storage = ListQueryFormerStorage>,

Source§

type Former = ListQueryFormer<Definition>

The type of the former (builder) used for constructing the entity. Read more
Source§

fn __f(_: &Definition)

A placeholder function to reference the definition without operational logic. Read more
Source§

impl EntityToStorage for ListQuery

Source§

type Storage = ListQueryFormerStorage

The storage type used for forming the entity.
Source§

impl PartialEq for ListQuery

Source§

fn eq(&self, other: &ListQuery) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for ListQuery

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for ListQuery

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneDyn for T
where T: Clone,

Source§

fn __clone_dyn(&self, _: DontCallMe) -> *mut ()

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<C, E> EntryToVal<C> for E
where C: Collection<Entry = E>,

Source§

type Val = <C as Collection>::Val

The type of values stored in the collection. This might be distinct from Entry in complex collections. For example, in a HashMap, while Entry might be a ( key, value ) tuple, Val might only be the value part.
Source§

fn entry_to_val(self) -> <E as EntryToVal<C>>::Val

Converts an entry into a value representation specific to the type of collection. This conversion is crucial for handling operations on entries, especially when they need to be treated or accessed as individual values, such as retrieving the value part from a key-value pair in a hash map.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoResult<T> for T

Source§

type Err = Infallible

Source§

fn into_result(self) -> Result<T, <T as IntoResult<T>>::Err>

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<C, Val> ValToEntry<C> for Val
where C: CollectionValToEntry<Val>,

Source§

fn val_to_entry(self) -> <C as CollectionValToEntry<Val>>::Entry

Invokes the val_to_entry function of the CollectionValToEntry trait to convert the value to an entry.

Source§

type Entry = <C as CollectionValToEntry<Val>>::Entry

Represents the type of entry that corresponds to the value within the collection. Type Entry is defined by the Collection trait.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more