permissions.js 2.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465
  1. "use strict";
  2. // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
  3. Object.defineProperty(exports, "__esModule", { value: true });
  4. exports.PermissionCreateResponsesPage = exports.Permissions = void 0;
  5. const resource_1 = require("../../../resource.js");
  6. const core_1 = require("../../../core.js");
  7. const pagination_1 = require("../../../pagination.js");
  8. class Permissions extends resource_1.APIResource {
  9. /**
  10. * **NOTE:** Calling this endpoint requires an [admin API key](../admin-api-keys).
  11. *
  12. * This enables organization owners to share fine-tuned models with other projects
  13. * in their organization.
  14. *
  15. * @example
  16. * ```ts
  17. * // Automatically fetches more pages as needed.
  18. * for await (const permissionCreateResponse of client.fineTuning.checkpoints.permissions.create(
  19. * 'ft:gpt-4o-mini-2024-07-18:org:weather:B7R9VjQd',
  20. * { project_ids: ['string'] },
  21. * )) {
  22. * // ...
  23. * }
  24. * ```
  25. */
  26. create(fineTunedModelCheckpoint, body, options) {
  27. return this._client.getAPIList(`/fine_tuning/checkpoints/${fineTunedModelCheckpoint}/permissions`, PermissionCreateResponsesPage, { body, method: 'post', ...options });
  28. }
  29. retrieve(fineTunedModelCheckpoint, query = {}, options) {
  30. if ((0, core_1.isRequestOptions)(query)) {
  31. return this.retrieve(fineTunedModelCheckpoint, {}, query);
  32. }
  33. return this._client.get(`/fine_tuning/checkpoints/${fineTunedModelCheckpoint}/permissions`, {
  34. query,
  35. ...options,
  36. });
  37. }
  38. /**
  39. * **NOTE:** This endpoint requires an [admin API key](../admin-api-keys).
  40. *
  41. * Organization owners can use this endpoint to delete a permission for a
  42. * fine-tuned model checkpoint.
  43. *
  44. * @example
  45. * ```ts
  46. * const permission =
  47. * await client.fineTuning.checkpoints.permissions.del(
  48. * 'ft:gpt-4o-mini-2024-07-18:org:weather:B7R9VjQd',
  49. * 'cp_zc4Q7MP6XxulcVzj4MZdwsAB',
  50. * );
  51. * ```
  52. */
  53. del(fineTunedModelCheckpoint, permissionId, options) {
  54. return this._client.delete(`/fine_tuning/checkpoints/${fineTunedModelCheckpoint}/permissions/${permissionId}`, options);
  55. }
  56. }
  57. exports.Permissions = Permissions;
  58. /**
  59. * Note: no pagination actually occurs yet, this is for forwards-compatibility.
  60. */
  61. class PermissionCreateResponsesPage extends pagination_1.Page {
  62. }
  63. exports.PermissionCreateResponsesPage = PermissionCreateResponsesPage;
  64. Permissions.PermissionCreateResponsesPage = PermissionCreateResponsesPage;
  65. //# sourceMappingURL=permissions.js.map