Method cancel

integrations/openai/src/threads.ts:445–474

* Cancels a run that is `in_progress`.

(
    key: IntegrationTaskKey,
    threadId: string,
    runId: string,
    options: OpenAIRequestOptions = {}
  )

   * Cancels a run that is `in_progress`.
   */
  async cancel(
    key: IntegrationTaskKey,
    threadId: string,
    runId: string,
    options: OpenAIRequestOptions = {}
  ): Promise<OpenAI.Beta.Threads.Run> {
    return this.runTask(
      key,
      async (client, task, io) => {
        const { data, response } = await client.beta.threads.runs
          .cancel(threadId, runId, {
            idempotencyKey: task.idempotencyKey,
            ...options,
          })
          .withResponse();

        task.outputProperties = createTaskOutputProperties(undefined, response.headers);

        return data;
      },
      {
        name: "Cancel Run",
        properties: [
          { label: "threadId", text: threadId },
          { label: "runId", text: runId },
        ],
      },
      handleOpenAIError
    );
  }

  /**
   * When a run has the `status: "requires_action"` and `required_action.type` is