responses.mjs 2.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677
  1. // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
  2. import { parseResponse, addOutputText, } from "../../lib/ResponsesParser.mjs";
  3. import { APIResource } from "../../resource.mjs";
  4. import * as InputItemsAPI from "./input-items.mjs";
  5. import { InputItems } from "./input-items.mjs";
  6. import { ResponseStream } from "../../lib/responses/ResponseStream.mjs";
  7. import { CursorPage } from "../../pagination.mjs";
  8. export class Responses extends APIResource {
  9. constructor() {
  10. super(...arguments);
  11. this.inputItems = new InputItemsAPI.InputItems(this._client);
  12. }
  13. create(body, options) {
  14. return this._client.post('/responses', { body, ...options, stream: body.stream ?? false })._thenUnwrap((rsp) => {
  15. if ('object' in rsp && rsp.object === 'response') {
  16. addOutputText(rsp);
  17. }
  18. return rsp;
  19. });
  20. }
  21. retrieve(responseId, query = {}, options) {
  22. return this._client.get(`/responses/${responseId}`, {
  23. query,
  24. ...options,
  25. stream: query?.stream ?? false,
  26. });
  27. }
  28. /**
  29. * Deletes a model response with the given ID.
  30. *
  31. * @example
  32. * ```ts
  33. * await client.responses.del(
  34. * 'resp_677efb5139a88190b512bc3fef8e535d',
  35. * );
  36. * ```
  37. */
  38. del(responseId, options) {
  39. return this._client.delete(`/responses/${responseId}`, {
  40. ...options,
  41. headers: { Accept: '*/*', ...options?.headers },
  42. });
  43. }
  44. parse(body, options) {
  45. return this._client.responses
  46. .create(body, options)
  47. ._thenUnwrap((response) => parseResponse(response, body));
  48. }
  49. /**
  50. * Creates a model response stream
  51. */
  52. stream(body, options) {
  53. return ResponseStream.createResponse(this._client, body, options);
  54. }
  55. /**
  56. * Cancels a model response with the given ID. Only responses created with the
  57. * `background` parameter set to `true` can be cancelled.
  58. * [Learn more](https://platform.openai.com/docs/guides/background).
  59. *
  60. * @example
  61. * ```ts
  62. * await client.responses.cancel(
  63. * 'resp_677efb5139a88190b512bc3fef8e535d',
  64. * );
  65. * ```
  66. */
  67. cancel(responseId, options) {
  68. return this._client.post(`/responses/${responseId}/cancel`, {
  69. ...options,
  70. headers: { Accept: '*/*', ...options?.headers },
  71. });
  72. }
  73. }
  74. export class ResponseItemsPage extends CursorPage {
  75. }
  76. Responses.InputItems = InputItems;
  77. //# sourceMappingURL=responses.mjs.map