Skip to content

Commit 7fa464f

Browse files
fern-supportclaude
andcommitted
docs: Fix OCI README to use OciClientV2 and correct model names
All code examples referenced non-existent OciClient class instead of OciClientV2, and embed model name was incorrect (embed-light-v3.0 → embed-english-light-v3.0). Also removed false V1/V2 claim and redundant emoji markers. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 5ae9e08 commit 7fa464f

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -66,13 +66,13 @@ The SDK supports Oracle Cloud Infrastructure (OCI) Generative AI service. First,
6666
pip install 'cohere[oci]'
6767
```
6868

69-
Then use the `OciClient` or `OciClientV2`:
69+
Then use `OciClientV2`:
7070

7171
```Python
7272
import cohere
7373

7474
# Using OCI config file authentication (default: ~/.oci/config)
75-
co = cohere.OciClient(
75+
co = cohere.OciClientV2(
7676
oci_region="us-chicago-1",
7777
oci_compartment_id="ocid1.compartment.oc1...",
7878
)
@@ -90,7 +90,7 @@ print(response.embeddings)
9090

9191
**1. Config File (Default)**
9292
```Python
93-
co = cohere.OciClient(
93+
co = cohere.OciClientV2(
9494
oci_region="us-chicago-1",
9595
oci_compartment_id="ocid1.compartment.oc1...",
9696
# Uses ~/.oci/config with DEFAULT profile
@@ -99,7 +99,7 @@ co = cohere.OciClient(
9999

100100
**2. Custom Profile**
101101
```Python
102-
co = cohere.OciClient(
102+
co = cohere.OciClientV2(
103103
oci_profile="MY_PROFILE",
104104
oci_region="us-chicago-1",
105105
oci_compartment_id="ocid1.compartment.oc1...",
@@ -109,7 +109,7 @@ co = cohere.OciClient(
109109
**3. Session-based Authentication (Security Token)**
110110
```Python
111111
# Works with OCI CLI session tokens
112-
co = cohere.OciClient(
112+
co = cohere.OciClientV2(
113113
oci_profile="MY_SESSION_PROFILE", # Profile with security_token_file
114114
oci_region="us-chicago-1",
115115
oci_compartment_id="ocid1.compartment.oc1...",
@@ -118,7 +118,7 @@ co = cohere.OciClient(
118118

119119
**4. Direct Credentials**
120120
```Python
121-
co = cohere.OciClient(
121+
co = cohere.OciClientV2(
122122
oci_user_id="ocid1.user.oc1...",
123123
oci_fingerprint="xx:xx:xx:...",
124124
oci_tenancy_id="ocid1.tenancy.oc1...",
@@ -130,7 +130,7 @@ co = cohere.OciClient(
130130

131131
**5. Instance Principal (for OCI Compute instances)**
132132
```Python
133-
co = cohere.OciClient(
133+
co = cohere.OciClientV2(
134134
auth_type="instance_principal",
135135
oci_region="us-chicago-1",
136136
oci_compartment_id="ocid1.compartment.oc1...",
@@ -140,21 +140,21 @@ co = cohere.OciClient(
140140
### Supported OCI APIs
141141

142142
The OCI client supports the following Cohere APIs:
143-
- **Embed**: Full support for all embedding models (embed-english-v3.0, embed-light-v3.0, embed-multilingual-v3.0)
144-
- **Chat**: Full support with both V1 (`OciClient`) and V2 (`OciClientV2`) APIs
143+
- **Embed**: Full support for all embedding models (embed-english-v3.0, embed-english-light-v3.0, embed-multilingual-v3.0)
144+
- **Chat**: Full support with `OciClientV2`
145145
- Streaming available via `chat_stream()`
146146
- Supports Command-R and Command-A model families
147147

148148
### OCI Model Availability and Limitations
149149

150150
**Available on OCI On-Demand Inference:**
151-
- **Embed models**: embed-english-v3.0, embed-light-v3.0, embed-multilingual-v3.0
152-
- **Chat models**: command-r-08-2024, command-r-plus, command-a-03-2025
151+
- **Embed models**: embed-english-v3.0, embed-english-light-v3.0, embed-multilingual-v3.0
152+
- **Chat models**: command-r-08-2024, command-r-plus, command-a-03-2025
153153

154154
**Not Available on OCI On-Demand Inference:**
155-
- **Generate API**: OCI TEXT_GENERATION models are base models that require fine-tuning before deployment
156-
- **Rerank API**: OCI TEXT_RERANK models are base models that require fine-tuning before deployment
157-
- **Multiple Embedding Types**: OCI on-demand models only support single embedding type per request (cannot request both `float` and `int8` simultaneously)
155+
- **Generate API**: OCI TEXT_GENERATION models are base models that require fine-tuning before deployment
156+
- **Rerank API**: OCI TEXT_RERANK models are base models that require fine-tuning before deployment
157+
- **Multiple Embedding Types**: OCI on-demand models only support single embedding type per request (cannot request both `float` and `int8` simultaneously)
158158

159159
**Note**: To use Generate or Rerank models on OCI, you need to:
160160
1. Fine-tune the base model using OCI's fine-tuning service

0 commit comments

Comments
 (0)