forked from replicate/replicate-javascript
-
Notifications
You must be signed in to change notification settings - Fork 5
Expand file tree
/
Copy pathindex.js
More file actions
203 lines (181 loc) · 6.4 KB
/
index.js
File metadata and controls
203 lines (181 loc) · 6.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
const axios = require('axios');
const collections = require('./lib/collections');
const models = require('./lib/models');
const predictions = require('./lib/predictions');
const packageJSON = require('./package.json');
/**
* Replicate API client library
*
* @see https://replicate.com/docs/reference/http
* @example
* // Create a new Replicate API client instance
* const Replicate = require("replicate");
* const replicate = new Replicate({
* // get your token from https://replicate.com/account
* auth: process.env.REPLICATE_API_TOKEN,
* userAgent: "my-app/1.2.3"
* });
*
* // Run a model and await the result:
* const model = 'owner/model:version-id'
* const input = {text: 'Hello, world!'}
* const output = await replicate.run(model, { input });
*/
class Replicate {
/**
* Create a new Replicate API client instance.
*
* @param {object} options - Configuration options for the client
* @param {string} options.auth - Required. API access token
* @param {string} options.userAgent - Identifier of your app
* @param {string} [options.baseUrl] - Defaults to https://api.replicate.com/v1
*/
constructor(options) {
this.auth = options.auth;
this.userAgent =
options.userAgent || `replicate-javascript/${packageJSON.version}`;
this.baseUrl = options.baseUrl || 'https://api.replicate.com/v1';
this.instance = axios.create({
baseURL: this.baseUrl,
headers: {
Authorization: `Token ${this.auth}`,
'User-Agent': this.userAgent,
'Content-Type': 'application/json',
},
});
this.collections = {
get: collections.get.bind(this),
};
this.models = {
get: models.get.bind(this),
versions: {
list: models.versions.list.bind(this),
get: models.versions.get.bind(this),
},
};
this.predictions = {
create: predictions.create.bind(this),
get: predictions.get.bind(this),
list: predictions.list.bind(this),
};
}
/**
* Run a model and wait for its output.
*
* @param {string} identifier - Required. The model version identifier in the format "{owner}/{name}:{version}"
* @param {object} options
* @param {object} options.input - Required. An object with the model inputs
* @param {boolean|object} [options.wait] - Whether to wait for the prediction to finish. Defaults to false
* @param {number} [options.wait.interval] - Polling interval in milliseconds. Defaults to 250
* @param {number} [options.wait.maxAttempts] - Maximum number of polling attempts. Defaults to no limit
* @param {string} [options.webhook_completed] - A URL which will receive a POST request upon completion of the prediction
* @throws {Error} If the prediction failed
* @returns {Promise<object>} - Resolves with the output of running the model
*/
async run(identifier, options) {
const pattern =
/^(?<owner>[a-zA-Z0-9-]+?)\/(?<name>[a-zA-Z0-9-]+?):(?<version>[0-9a-fA-F]+)$/;
const match = identifier.match(pattern);
if (!match) {
throw new Error(
'Invalid version. It must be in the format "owner/name:version"'
);
}
const { version } = match.groups;
const prediction = await this.predictions.create({
wait: true,
...options,
version,
});
if (prediction.status === 'failed') {
throw new Error(`Prediction failed: ${prediction.error}`);
}
return prediction.output;
}
/**
* Make a request to the Replicate API.
*
* @param {string} route - REST API endpoint path
* @param {object} parameters - URL, query, and request body parameters for the given route
* @returns {Promise<object>} - Resolves with the API response data
*/
async request(route, parameters) {
const response = await this.instance(route, parameters);
return response.data;
}
/**
* Paginate through a list of results.
*
* @generator
* @example
* for await (const page of replicate.paginate(replicate.predictions.list) {
* console.log(page);
* }
* @param {Function} endpoint - Function that returns a promise for the next page of results
* @yields {object[]} Each page of results
*/
async *paginate(endpoint) {
const response = await endpoint();
yield response.results;
if (response.next) {
const nextPage = () => this.request(response.next, { method: 'GET' });
yield* this.paginate(nextPage);
}
}
/**
* Wait for a prediction to finish.
*
* If the prediction has already finished,
* this function returns immediately.
* Otherwise, it polls the API until the prediction finishes.
*
* @async
* @param {object} prediction - Prediction object
* @param {object} options - Options
* @param {number} [options.interval] - Polling interval in milliseconds. Defaults to 250
* @param {number} [options.maxAttempts] - Maximum number of polling attempts. Defaults to no limit
* @throws {Error} If the prediction doesn't complete within the maximum number of attempts
* @throws {Error} If the prediction failed
* @returns {Promise<object>} Resolves with the completed prediction object
*/
async wait(prediction, options) {
const { id } = prediction;
if (!id) {
throw new Error('Invalid prediction');
}
if (
prediction.status === 'succeeded' ||
prediction.status === 'failed' ||
prediction.status === 'canceled'
) {
return prediction;
}
let updatedPrediction = await this.predictions.get(id);
// eslint-disable-next-line no-promise-executor-return
const sleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
let attempts = 0;
const interval = options.interval || 250;
const maxAttempts = options.maxAttempts || null;
while (
updatedPrediction.status !== 'succeeded' &&
updatedPrediction.status !== 'failed' &&
updatedPrediction.status !== 'canceled'
) {
attempts += 1;
if (maxAttempts && attempts > maxAttempts) {
throw new Error(
`Prediction ${id} did not finish after ${maxAttempts} attempts`
);
}
/* eslint-disable no-await-in-loop */
await sleep(interval);
updatedPrediction = await this.predictions.get(prediction.id);
/* eslint-enable no-await-in-loop */
}
if (updatedPrediction.status === 'failed') {
throw new Error(`Prediction failed: ${updatedPrediction.error}`);
}
return updatedPrediction;
}
}
module.exports = Replicate;