Skip to content

Commit 790e9b7

Browse files
trevoruptainniloysikdar
authored andcommitted
docs(readme): remove references to datetime
1 parent c56d0ca commit 790e9b7

File tree

1 file changed

+5
-21
lines changed

1 file changed

+5
-21
lines changed

README.md

Lines changed: 5 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Hypercode
22

3-
`Hypercode` is a npm package for Node.js that allows you to consume the [Hyper APIs](https://docs.gethyper.ai) easily in your JavaScript or TypeScript projects with complete **type-safety**. `Hypercode` handles the complexity of context management and response formatting, allowing you to focus on creating dynamic and intelligent features that enhance the user experience. It is a friendly npm package that makes it easy to get live, structured LLM responses with custom contexts in useful formats like integers, booleans, strings, dates, and lots more.
3+
`Hypercode` is a npm package for Node.js that allows you to consume the [Hyper APIs](https://docs.gethyper.ai) easily in your JavaScript or TypeScript projects with complete **type-safety**. `Hypercode` handles the complexity of context management and response formatting, allowing you to focus on creating dynamic and intelligent features that enhance the user experience. It is a friendly npm package that makes it easy to get live, structured LLM responses with custom contexts in useful formats like integers, booleans, strings, and more.
44

5-
Create a free account today on [Hyper](https://app.gethyper.ai) to start building your own custom contexts, integrating them into your applications, generating API keys, and using them in your projects with `Hypercode`!
5+
Create a free account today on [Hyper](https://app.gethyper.ai) to start building your own custom contexts, integrating them into your applications, generating API keys, and using them in your projects with `Hypercode`.
66

77
Find the npm package [here](https://www.npmjs.com/package/hypercode)
88

@@ -25,14 +25,14 @@ console.log(isEarthFlat); // false
2525
You can also pass the information along with your queries in the form of `context`. Context represents bundles of live data with relevance to the query, ensuring the LLM is given all the information necessary to produce an accurate response. You can build context objects in the [Hyper app](https://app.gethyper.ai), then use them in Hypercode:
2626

2727
```javascript
28-
const { data: productLaunchDate } = await hyper.types.datetime(
28+
const { data: productLaunch } = await hyper.types.string(
2929
'When is the product launch?',
3030
{
3131
contextId: 'product-roadmap-context-id',
3232
},
3333
);
3434

35-
console.log(productLaunchDate); // "2024-07-31T0:00:00Z"
35+
console.log(productLaunch); // "The product launch is on December 11, 2023"
3636
```
3737

3838
> **_NOTE:_** A context object is a collection of resources made up of files, web pages, and data from integrations like Google Drive, Slack, and GitHub. When you link a resource to a Context in Hyper, we generate embeddings that stay automatically synced with changes to your data.
@@ -193,19 +193,9 @@ You can pass the `contextId` as an optional parameter to all the `types` methods
193193
console.log(canCatsSeeInTheDark); // true
194194
```
195195

196-
- **datetime**: Get a date and time as the answer.
197-
198-
```javascript
199-
const { data: moonLandingDate, error } = await hyper.types.datetime(
200-
'What is the date of the Apollo 11 moon landing?',
201-
);
202-
203-
console.log(moonLandingDate); // "1969-07-20T20:17:00Z"
204-
```
205-
206196
**You can also get the result as an array of the above types. Here are the methods for that:**
207197

208-
- `stringArray`, `integerArray`, `floatArray`, `booleanArray`, `datetimeArray` methods: Get an array of the respective type as the answer.
198+
- `stringArray`, `integerArray`, `floatArray`, `booleanArray` methods: Get an array of the respective type as the answer.
209199

210200
```javascript
211201
// Get an array of strings as the answer
@@ -232,12 +222,6 @@ You can pass the `contextId` as an optional parameter to all the `types` methods
232222
'Are services meeting performance targets?',
233223
{ contextId: 'performance-reviews-context-id' },
234224
);
235-
236-
// Get an array of datetimes as the answer
237-
const { data } = await hyper.types.datetimeArray(
238-
'What are the upcoming project deadlines?',
239-
{ contextId: 'project-management-context-id' },
240-
);
241225
```
242226

243227
## Embeddings Search

0 commit comments

Comments
 (0)