> ## Documentation Index
> Fetch the complete documentation index at: https://javaai.pig4cloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

# OCI GenAI Cohere 聊天

[OCI GenAI 服务](https://www.oracle.com/artificial-intelligence/generative-ai/generative-ai-service/) 提供按需模型或专用 AI 集群的生成式 AI 聊天功能。

[OCI 聊天模型页面](https://docs.oracle.com/en-us/iaas/Content/generative-ai/chat-models.htm)和 [OCI 生成式 AI 试验场](https://docs.oracle.com/en-us/iaas/Content/generative-ai/use-playground-embed.htm)提供了有关在 OCI 上使用和托管聊天模型的详细信息。

## 前提条件

你需要一个有效的 [Oracle Cloud Infrastructure (OCI)](https://signup.oraclecloud.com/) 帐户才能使用 OCI GenAI Cohere 聊天客户端。该客户端提供四种不同的连接方式，包括使用用户和私钥的简单身份验证、工作负载身份、实例主体或 OCI 配置文件身份验证。

### 添加仓库和 BOM

Spring AI 的构件发布在 Maven Central 和 Spring Snapshot 仓库中。
请参阅[构件仓库](/spring4ai/getting-started#artifact-repositories)部分，将这些仓库添加到你的构建系统中。

为了帮助进行依赖管理，Spring AI 提供了一个 BOM (bill of materials)，以确保在整个项目中使用一致版本的 Spring AI。请参阅[依赖管理](/spring4ai/getting-started#dependency-management)部分，将 Spring AI BOM 添加到你的构建系统中。

## 自动配置

<Note>
  Spring AI 自动配置、启动器模块的构件名称发生了重大变化。
  有关更多信息，请参阅[升级说明](https://docs.spring.io/spring-ai/reference/upgrade-notes.html)。
</Note>

Spring AI 为 OCI GenAI Cohere 聊天客户端提供 Spring Boot 自动配置。
要启用它，请将以下依赖项添加到项目的构建文件中：

<Tabs>
  <Tab title="Maven">
    ```xml theme={"system"}
    <dependency>
        <groupId>org.springframework.ai</groupId>
        <artifactId>spring-ai-starter-model-oci-genai</artifactId>
    </dependency>
    ```
  </Tab>

  <Tab title="Gradle">
    ```gradle theme={"system"}
    dependencies {
        implementation 'org.springframework.ai:spring-ai-starter-model-oci-genai'
    }
    ```
  </Tab>
</Tabs>

<Tip>
  请参阅[依赖管理](/spring4ai/getting-started#dependency-management)部分，将 Spring AI BOM 添加到你的构建文件中。
</Tip>

### 聊天属性

#### 连接属性

前缀 `spring.ai.oci.genai` 是用于配置与 OCI GenAI 连接的属性前缀。

| 属性                                     | 描述                                                                                     | 默认值               |
| :------------------------------------- | :------------------------------------------------------------------------------------- | :---------------- |
| spring.ai.oci.genai.authenticationType | 向 OCI 进行身份验证时使用的身份验证类型。可以是 `file`、`instance-principal`、`workload-identity` 或 `simple`。 | file              |
| spring.ai.oci.genai.region             | OCI 服务区域。                                                                              | us-chicago-1      |
| spring.ai.oci.genai.tenantId           | OCI 租户 OCID，在使用 `simple` 身份验证时使用。                                                      | -                 |
| spring.ai.oci.genai.userId             | OCI 用户 OCID，在使用 `simple` 身份验证时使用。                                                      | -                 |
| spring.ai.oci.genai.fingerprint        | 私钥指纹，在使用 `simple` 身份验证时使用。                                                             | -                 |
| spring.ai.oci.genai.privateKey         | 私钥内容，在使用 `simple` 身份验证时使用。                                                             | -                 |
| spring.ai.oci.genai.passPhrase         | 可选的私钥密码，在使用 `simple` 身份验证和受密码保护的私钥时使用。                                                 | -                 |
| spring.ai.oci.genai.file               | OCI 配置文件路径。在使用 `file` 身份验证时使用。                                                         | 用户主目录/.oci/config |
| spring.ai.oci.genai.profile            | OCI 配置文件名称。在使用 `file` 身份验证时使用。                                                         | DEFAULT           |
| spring.ai.oci.genai.endpoint           | 可选的 OCI GenAI 端点。                                                                      | -                 |

#### 配置属性

<Note>
  聊天自动配置的启用和禁用现在通过前缀为 `spring.ai.model.chat` 的顶级属性进行配置。
  要启用，`spring.ai.model.chat=oci-genai` (默认启用)
  要禁用，`spring.ai.model.chat=none` (或任何与 oci-genai 不匹配的值)
  此更改是为了允许配置多个模型。
</Note>

前缀 `spring.ai.oci.genai.chat.cohere` 是配置 OCI GenAI Cohere Chat 的 `ChatModel` 实现的属性前缀。

| 属性                                                       | 描述                                        | 默认值       |
| :------------------------------------------------------- | :---------------------------------------- | :-------- |
| spring.ai.model.chat                                     | 启用 OCI GenAI Cohere 聊天模型。                 | oci-genai |
| spring.ai.oci.genai.chat.cohere.enabled (不再有效)           | 启用 OCI GenAI Cohere 聊天模型。                 | true      |
| spring.ai.oci.genai.chat.cohere.options.model            | 模型 OCID 或端点                               | -         |
| spring.ai.oci.genai.chat.cohere.options.compartment      | 模型区间 OCID。                                | -         |
| spring.ai.oci.genai.chat.cohere.options.servingMode      | 要使用的模型服务模式。可以是 `on-demand` 或 `dedicated`。 | on-demand |
| spring.ai.oci.genai.chat.cohere.options.preambleOverride | 覆盖聊天模型的提示前导                               | -         |
| spring.ai.oci.genai.chat.cohere.options.temperature      | 推理温度                                      | -         |
| spring.ai.oci.genai.chat.cohere.options.topP             | Top P 参数                                  | -         |
| spring.ai.oci.genai.chat.cohere.options.topK             | Top K 参数                                  | -         |
| spring.ai.oci.genai.chat.cohere.options.frequencyPenalty | 较高的值会减少重复的标记，输出会更随机。                      | -         |
| spring.ai.oci.genai.chat.cohere.options.presencePenalty  | 较高的值鼓励生成包含尚未使用过的标记的输出。                    | -         |
| spring.ai.oci.genai.chat.cohere.options.stop             | 将结束补全生成的文本序列列表。                           | -         |
| spring.ai.oci.genai.chat.cohere.options.documents        | 聊天上下文中使用的文档列表。                            | -         |

<Tip>
  所有以 `spring.ai.oci.genai.chat.cohere.options` 为前缀的属性都可以在运行时通过向 `Prompt` 调用添加特定于请求的[聊天选项](#runtime-options)来覆盖。
</Tip>

## 运行时选项

[OCICohereChatOptions.java](https://github.com/spring-projects/spring-ai/blob/main/models/spring-ai-oci-genai/src/main/java/org/springframework/ai/oci/cohere/OCICohereChatOptions.java) 提供模型配置，例如要使用的模型、温度、频率惩罚等。

在启动时，可以使用 `OCICohereChatModel(api, options)` 构造函数或 `spring.ai.oci.genai.chat.cohere.options.*` 属性配置默认选项。

在运行时，你可以通过向 `Prompt` 调用添加新的、特定于请求的选项来覆盖默认选项。
例如，要为特定请求覆盖默认模型和温度：

```java theme={"system"}
ChatResponse response = chatModel.call(
    new Prompt(
        "生成 5 个著名海盗的名字。",
        OCICohereChatOptions.builder()
            .model("我的模型ocid")
            .compartment("我的区间ocid")
            .temperature(0.5)
        .build()
    ));
```

## 示例控制器

[创建](https://start.spring.io/)一个新的 Spring Boot 项目，并将 `spring-ai-starter-model-oci-genai` 添加到你的 pom (或 gradle) 依赖项中。

在 `src/main/resources` 目录下添加一个 `application.properties` 文件，以启用和配置 OCI GenAI Cohere 聊天模型：

```properties theme={"system"}
spring.ai.oci.genai.authenticationType=file
spring.ai.oci.genai.file=/path/to/oci/config/file
spring.ai.oci.genai.cohere.chat.options.compartment=我的区间ocid
spring.ai.oci.genai.cohere.chat.options.servingMode=on-demand
spring.ai.oci.genai.cohere.chat.options.model=我的聊天模型ocid
```

<Tip>
  将 `file`、`compartment` 和 `model` 替换为你的 OCI 帐户中的值。
</Tip>

这将创建一个 `OCICohereChatModel` 实现，你可以将其注入到你的类中。
以下是一个简单的 `@Controller` 类的示例，该类使用聊天模型进行文本生成。

```java theme={"system"}
@RestController
public class ChatController {

    private final OCICohereChatModel chatModel;

    @Autowired
    public ChatController(OCICohereChatModel chatModel) {
        this.chatModel = chatModel;
    }

    @GetMapping("/ai/generate")
    public Map generate(@RequestParam(value = "message", defaultValue = "给我讲个笑话") String message) {
        return Map.of("generation", chatModel.call(message));
    }

    @GetMapping("/ai/generateStream")
    public Flux<ChatResponse> generateStream(@RequestParam(value = "message", defaultValue = "给我讲个笑话") String message) {
        var prompt = new Prompt(new UserMessage(message));
        return chatModel.stream(prompt);
    }
}
```

## 手动配置

[OCICohereChatModel](https://github.com/spring-projects/spring-ai/blob/main/models/spring-ai-oci-genai/src/main/java/org/springframework/ai/oci/cohere/OCICohereChatModel.java) 实现了 `ChatModel` 并使用 OCI Java SDK 连接到 OCI GenAI 服务。

将 `spring-ai-oci-genai` 依赖项添加到项目的构建文件中：

<Tabs>
  <Tab title="Maven">
    ```xml theme={"system"}
    <dependency>
        <groupId>org.springframework.ai</groupId>
        <artifactId>spring-ai-oci-genai</artifactId>
    </dependency>
    ```
  </Tab>

  <Tab title="Gradle">
    ```gradle theme={"system"}
    dependencies {
        implementation 'org.springframework.ai:spring-ai-oci-genai'
    }
    ```
  </Tab>
</Tabs>

<Tip>
  请参阅[依赖管理](/spring4ai/getting-started#dependency-management)部分，将 Spring AI BOM 添加到你的构建文件中。
</Tip>

接下来，创建一个 `OCICohereChatModel` 并将其用于文本生成：

```java theme={"system"}
var CONFIG_FILE = Paths.get(System.getProperty("user.home"), ".oci", "config").toString();
var COMPARTMENT_ID = System.getenv("OCI_COMPARTMENT_ID");
var MODEL_ID = System.getenv("OCI_CHAT_MODEL_ID");

ConfigFileAuthenticationDetailsProvider authProvider = new ConfigFileAuthenticationDetailsProvider(
        CONFIG_FILE,
        "DEFAULT"
);
var genAi = GenerativeAiInferenceClient.builder()
        .region(Region.valueOf("us-chicago-1"))
        .build(authProvider);

var chatModel = new OCICohereChatModel(genAi, OCICohereChatOptions.builder()
        .model(MODEL_ID)
        .compartment(COMPARTMENT_ID)
        .servingMode("on-demand")
        .build());

ChatResponse response = chatModel.call(
        new Prompt("生成 5 个著名海盗的名字。"));
```

`OCICohereChatOptions` 为聊天请求提供配置信息。
`OCICohereChatOptions.Builder` 是流畅的选项构建器。

<Card title="文档有误？请协助编辑" icon="pencil" href="https://github.com/javaai-pig4cloud-com/javaai-docs/edit/main/spring-ai/api/chat/oci-genai/cohere-chat.mdx">
  发现文档问题？点击此处直接在 GitHub 上编辑并提交 PR，帮助我们改进文档！
</Card>
