Skip to content

Commit

Permalink
Fix up readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
billytrend-cohere committed Dec 13, 2023
1 parent 1be28bf commit 584fc4c
Show file tree
Hide file tree
Showing 3 changed files with 84 additions and 1 deletion.
3 changes: 2 additions & 1 deletion .fernignore
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
# Specify files that shouldn't be modified by Fern
README.md
banner.png
82 changes: 82 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
# Cohere Java Library

![](banner.png)

[![Maven Central](https://img.shields.io/maven-central/v/com.cohere.cohere-java/cohere)](https://central.sonatype.com/artifact/com.cohere.cohere-java/cohere)
[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern)

## Documentation

API reference documentation is available [here](https://docs.cohere.com/docs).

## Installation

### Gradle

Add the dependency in your `build.gradle`:

```groovy
dependencies {
implementation 'com.cohere.cohere-java:cohere:1.x.x'
}
```

### Maven

Add the dependency in your `pom.xml`:

```xml
<dependency>
<groupId>com.cohere.cohere-java</groupId>
<artifactId>cohere</artifactId>
<version>1.x.x</version>
</dependency>
```

## Usage
```java
import com.cohere.api.Cohere;

Cohere cohere = Cohere.builder()
.apiKey("YOUR_API_KEY")
.build();

GenerateResponse response = cohere.generate(GenerateRequest.builder()
.prompt("Summarize the blog post...")
.build());

System.out.printlin("Received response!" + response);
```

### Handling Errors
When the API returns a non-success status code (4xx or 5xx response),
a subclass of [ApiError](src/main/java/com/Cohere/api/core/ApiError.java)
will be thrown:

```ts
import com.cohere.api.core.ApiError;

try {
cohere.generate(/* ... */);
} catch (ApiError error) {
System.out.println(error.getBody());
System.out.println(error.getStatusCode());
}
```
## Beta status
This SDK is in beta, and there may be breaking changes between versions
without a major version update. Therefore, we recommend pinning the package
version to a specific version in your build.gradle file. This way, you can
install the same version each time without breaking changes unless you are
intentionally looking for the latest version.
## Contributing
While we value open-source contributions to this SDK, this library
is generated programmatically. Additions made directly to this library
would have to be moved over to our generation code, otherwise they would
be overwritten upon the next generated release. Feel free to open a PR as a
proof of concept, but know that we will not be able to merge it as-is.
We suggest opening an issue first to discuss with us!
On the other hand, contributions to the README are always very welcome!
Binary file added banner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 584fc4c

Please sign in to comment.