Skip to content

feat(api): update via SDK Studio #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 18, 2025
Merged

feat(api): update via SDK Studio #9

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 25 additions & 31 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

This library provides convenient access to the Zeroentropy REST API from server-side TypeScript or JavaScript.

The REST API documentation can be found on [docs.zeroentropy.dev](https://docs.zeroentropy.dev). The full API of this library can be found in [api.md](api.md).
The REST API documentation can be found on [docs.zeroentropy.dev](https://docs.zeroentropy.dev/api-reference). The full API of this library can be found in [api.md](api.md).

It is generated with [Stainless](https://www.stainlessapi.com/).

Expand All @@ -27,9 +27,13 @@ const client = new Zeroentropy({
});

async function main() {
const response = await client.documents.getInfo({ collection_name: 'collection_name', path: 'path' });
const response = await client.documents.add({
collection_name: 'example_collection',
content: { type: 'text', text: 'Example Content' },
path: 'my_document.txt',
});

console.log(response.document);
console.log(response.message);
}

main();
Expand All @@ -48,8 +52,7 @@ const client = new Zeroentropy({
});

async function main() {
const params: Zeroentropy.DocumentGetInfoParams = { collection_name: 'collection_name', path: 'path' };
const response: Zeroentropy.DocumentGetInfoResponse = await client.documents.getInfo(params);
const response: Zeroentropy.StatusGetStatusResponse = await client.status.getStatus();
}

main();
Expand All @@ -66,17 +69,15 @@ a subclass of `APIError` will be thrown:
<!-- prettier-ignore -->
```ts
async function main() {
const response = await client.documents
.getInfo({ collection_name: 'collection_name', path: 'path' })
.catch(async (err) => {
if (err instanceof Zeroentropy.APIError) {
console.log(err.status); // 400
console.log(err.name); // BadRequestError
console.log(err.headers); // {server: 'nginx', ...}
} else {
throw err;
}
});
const response = await client.status.getStatus().catch(async (err) => {
if (err instanceof Zeroentropy.APIError) {
console.log(err.status); // 400
console.log(err.name); // BadRequestError
console.log(err.headers); // {server: 'nginx', ...}
} else {
throw err;
}
});
}

main();
Expand Down Expand Up @@ -111,7 +112,7 @@ const client = new Zeroentropy({
});

// Or, configure per-request:
await client.documents.getInfo({ collection_name: 'collection_name', path: 'path' }, {
await client.status.getStatus({
maxRetries: 5,
});
```
Expand All @@ -128,7 +129,7 @@ const client = new Zeroentropy({
});

// Override per-request:
await client.documents.getInfo({ collection_name: 'collection_name', path: 'path' }, {
await client.status.getStatus({
timeout: 5 * 1000,
});
```
Expand Down Expand Up @@ -182,17 +183,13 @@ You can also use the `.withResponse()` method to get the raw `Response` along wi
```ts
const client = new Zeroentropy();

const response = await client.documents
.getInfo({ collection_name: 'collection_name', path: 'path' })
.asResponse();
const response = await client.status.getStatus().asResponse();
console.log(response.headers.get('X-My-Header'));
console.log(response.statusText); // access the underlying Response object

const { data: response, response: raw } = await client.documents
.getInfo({ collection_name: 'collection_name', path: 'path' })
.withResponse();
const { data: response, response: raw } = await client.status.getStatus().withResponse();
console.log(raw.headers.get('X-My-Header'));
console.log(response.document);
console.log(response.num_documents);
```

### Making custom/undocumented requests
Expand Down Expand Up @@ -296,12 +293,9 @@ const client = new Zeroentropy({
});

// Override per-request:
await client.documents.getInfo(
{ collection_name: 'collection_name', path: 'path' },
{
httpAgent: new http.Agent({ keepAlive: false }),
},
);
await client.status.getStatus({
httpAgent: new http.Agent({ keepAlive: false }),
});
```

## Semantic versioning
Expand Down