Class Steps

Hierarchy

APIResource
- Steps

Index

Constructors

Properties

Methods

Constructors

constructor

new Steps(client): Steps
Parameters
- client: OpenAI
Returns Steps
Inherited from APIResource.constructor
- Defined in node_modules/openai/resource.d.ts:4

Properties

`Protected`_client

_client: OpenAI

Methods

list

list(threadId, runId, query?, options?): PagePromise<RunStepsPage, RunStep>
Returns a list of run steps belonging to a run.
Parameters
- threadId: string
- runId: string
- Optionalquery: StepListParams
- Optionaloptions: RequestOptions<unknown>
Returns PagePromise<RunStepsPage, RunStep>
- Defined in node_modules/openai/resources/beta/threads/runs/steps.d.ts:14
list(threadId, runId, options?): PagePromise<RunStepsPage, RunStep>
Parameters
- threadId: string
- runId: string
- Optionaloptions: RequestOptions<unknown>
Returns PagePromise<RunStepsPage, RunStep>
- Defined in node_modules/openai/resources/beta/threads/runs/steps.d.ts:15

retrieve

retrieve(threadId, runId, stepId, query?, options?): APIPromise<RunStep>
Retrieves a run step.
Parameters
- threadId: string
- runId: string
- stepId: string
- Optionalquery: StepRetrieveParams
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<RunStep>
- Defined in node_modules/openai/resources/beta/threads/runs/steps.d.ts:9
retrieve(threadId, runId, stepId, options?): APIPromise<RunStep>
Parameters
- threadId: string
- runId: string
- stepId: string
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<RunStep>
- Defined in node_modules/openai/resources/beta/threads/runs/steps.d.ts:10