Skip to content

Commit 5ed98b1

Browse files
chore: Namananand/ins 2251 separate queries mutation and actions for SDK and example (#38)
Because - separate queries mutation and actions for SDK and example This commit - separate queries mutation and actions for SDK and example
1 parent 3422f66 commit 5ed98b1

33 files changed

+2515
-1441
lines changed

README.md

Lines changed: 106 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ export default function TypescriptSdkDemo() {
6868
const client = new InstillClient(
6969
"http://localhost:8080",
7070
"v1alpha",
71-
"" // get console API token from `http://localhost:3000/settings`
71+
"<your_api_token>" // get console API token from `http://localhost:3000/settings`
7272
);
7373
7474
useEffect(() => {
@@ -110,7 +110,7 @@ export default function TypescriptSdkDemo() {
110110
const client = new InstillClient(
111111
"https://api.instill.tech",
112112
"v1alpha",
113-
"" // console API token
113+
"<your_api_token>" // console API token
114114
);
115115
116116
useEffect(() => {
@@ -164,6 +164,70 @@ export default function TypescriptSdkDemo() {
164164

165165
### Pipelines
166166

167+
### create Pipeline
168+
169+
```
170+
171+
userName : check your userName: https://console.instill.tech/settings
172+
173+
client.PipelineClient.createUserPipelineMutation("<userName>",
174+
{
175+
"id": "overseas-blue-lobster",
176+
"recipe": {
177+
"version": "v1alpha",
178+
"components": [
179+
{
180+
"id": "start",
181+
"resource_name": "",
182+
"configuration": {
183+
"metadata": {
184+
"text": {
185+
"type": "text",
186+
"title": "text"
187+
}
188+
}
189+
},
190+
"definition_name": "operator-definitions/op-start"
191+
},
192+
{
193+
"id": "end",
194+
"resource_name": "",
195+
"configuration": {
196+
"metadata": {
197+
"output": {
198+
"title": "output"
199+
}
200+
},
201+
"input": {
202+
"output": "{ai_1.output.texts}"
203+
}
204+
},
205+
"definition_name": "operator-definitions/op-end"
206+
},
207+
{
208+
"id": "ai_1",
209+
"resource_name": "users/namananand-instill-ai/connector-resources/ai2",
210+
"configuration": {
211+
"task": "TASK_TEXT_GENERATION",
212+
"input": {
213+
"prompt": "{start.text}",
214+
"model": "gpt-3.5-turbo"
215+
}
216+
},
217+
"definition_name": "connector-definitions/ai-openai"
218+
}
219+
]
220+
}
221+
}
222+
).then((response) => {
223+
console.log(response.data)
224+
})
225+
.catch(error => {
226+
console.log(error)
227+
})
228+
229+
```
230+
167231
| function | params |
168232
| :------------------------------------ | :---------------------------------------------: |
169233
| listPipelinesQuery | pageSize, nextPageToken |
@@ -188,15 +252,37 @@ export default function TypescriptSdkDemo() {
188252

189253
### Connector
190254

255+
### Create new connector
256+
257+
```
258+
userName : check your userName: https://console.instill.tech/settings
259+
260+
query.ConnectorClient.createUserConnectorResourceMutation("<userName>",
261+
{
262+
"id": "open-ai-model-1",
263+
"connector_definition_name": "connector-definitions/ai-openai",
264+
"configuration": {
265+
"organization": "my-org",
266+
"api_key": "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"
267+
}
268+
}
269+
).then((response) => {
270+
console.log(response.data)
271+
})
272+
.catch(error => {
273+
console.log(error)
274+
})
275+
```
276+
191277
| function | params |
192278
| :---------------------------------------- | :---------------------------------------: |
193279
| listConnectorResourcesQuery | userName, pageSize, nextPageToken, filter |
194280
| listUserConnectorResourcesQuery | pageSize, nextPageToken, filter |
195281
| listConnectorDefinitionsQuery | connectorDefinitionName |
196282
| getConnectorDefinitionQuery | connectorDefinitionName |
197283
| getUserConnectorResourceQuery | connectorDefinitionName |
198-
| watchUserConnectorResource | userName, payload |
199-
| createUserConnectorResourceMutation | connectorDefinitionName |
284+
| watchUserConnectorResource | connectorResourceName |
285+
| createUserConnectorResourceMutation | userName, payload |
200286
| deleteUserConnectorResourceMutation | payload |
201287
| updateUserConnectorResourceMutation | payload |
202288
| renameUserConnectorResource | payload |
@@ -212,8 +298,6 @@ export default function TypescriptSdkDemo() {
212298
| listTriggeredPipelineQuery | pageSize, nextPageToken, filter |
213299
| listTriggeredPipelineChartQuery | pageSize, nextPageToken, filter |
214300

215-
modelDefinitionName,
216-
217301
### Model
218302

219303
| function | params |
@@ -240,6 +324,22 @@ modelDefinitionName,
240324

241325
### Mgmt
242326

327+
### create API token
328+
329+
```
330+
331+
client.AuthClient.createApiTokenMutation({
332+
"id": "aa",
333+
"ttl": -1
334+
}).then((response) => {
335+
console.log(response.data)
336+
})
337+
.catch(error => {
338+
console.log(error)
339+
})
340+
341+
```
342+
243343
| function | params |
244344
| :--------------------- | :---------------------: |
245345
| getUserQuery | |

examples/next-app/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
"lint": "next lint"
1010
},
1111
"dependencies": {
12-
"@instill-ai/typescript-sdk": "0.0.8-rc.12",
12+
"@instill-ai/typescript-sdk": "0.0.11-rc.0",
1313
"next": "latest",
1414
"react": "latest",
1515
"react-dom": "latest"

0 commit comments

Comments
 (0)