https://github.com/cohere-ai/cohere-java

Cohere's Java SDK
https://github.com/cohere-ai/cohere-java

Last synced: about 1 month ago
JSON representation

Cohere's Java SDK

• Host: GitHub
• URL: https://github.com/cohere-ai/cohere-java
• Owner: cohere-ai
• License: mit
• Created: 2023-11-06T17:02:58.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-05-22T15:24:59.000Z (6 months ago)
• Last Synced: 2024-05-22T15:52:39.223Z (6 months ago)
• Language: Java
• Size: 1.94 MB
• Stars: 4
• Watchers: 6
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        
# Cohere Java Library

![](banner.png)

[![Maven Central](https://img.shields.io/maven-central/v/com.cohere/cohere-java)](https://central.sonatype.com/artifact/com.cohere/cohere-java)

[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern)

## ✨🪩✨ Announcing Cohere's new Java SDK ✨🪩✨

We are very excited to publish this brand new Java SDK. We now officially support Java and will continuously update this library with all of the latest features in our API. Please create issues where you have feedback so that we can continue to improve the developer experience!

## 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:+'

}

```

### Maven

Add the dependency in your `pom.xml`:

```xml

    com.cohere

    cohere-java

    1.x.x

```

## Usage

```java

import com.cohere.api.Cohere;

import com.cohere.api.requests.ChatRequest;

import com.cohere.api.types.ChatMessage;

import com.cohere.api.types.Message;

import com.cohere.api.types.NonStreamedChatResponse;

import java.util.List;

public class ChatPost {

    public static void main(String[] args) {

        Cohere cohere = Cohere.builder().token("<>").clientName("snippet").build();

        NonStreamedChatResponse response = cohere.chat(

                ChatRequest.builder()

                        .message("What year was he born?")

                        .chatHistory(

                                List.of(Message.user(ChatMessage.builder().message("Who discovered gravity?").build()),

                                        Message.chatbot(ChatMessage.builder().message("The man who is widely credited with discovering gravity is Sir Isaac Newton").build()))).build());

        System.out.println(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!