1
# ! pip install -U cohere
2
3
import cohere
4
5
# instantiating the old client
6
co_v1 = cohere.Client(api_key="<YOUR API KEY>")
7
8
# instantiating the new client
9
co_v2 = cohere.ClientV2(api_key="<YOUR API KEY>")

1
res = co_v1.chat(
2
	    model="command-r-plus-08-2024",
3
	    preamble="You respond in concise sentences.",
4
	    chat_history=[
5
	        {
6
	            "role": "user",
7
	            "message": "Hello"
8
	        },
9
	        {
10
	            "role": "chatbot",
11
	            "message": "Hi, how can I help you today?"
12
	        }
13
	    ],
14
	    message="I'm joining a new startup called Co1t today. Could you help me write a one-sentence introduction message to my teammates?")
15
16
print(res.text)

1
res = co_v2.chat(
2
    model="command-r-plus-08-2024",
3
    messages=[
4
        {
5
            "role": "system",
6
            "content": "You respond in concise sentences."
7
        },
8
        {
9
            "role": "user",
10
            "content": "Hello"
11
        },
12
        {
13
            "role": "assistant",
14
            "content": "Hi, how can I help you today?"
15
        },
16
        {
17
            "role": "user",
18
            "content": "I'm joining a new startup called Co1t today. Could you help me write a one-sentence introduction message to my teammates."
19
        }
20
    ])
21
22
print(res.message.content[0].text)

1
res = co_v1.chat(model="command-r-plus-08-2024",
2
                 message="What is 2 + 2")
3
4
print(res.text)

1
res = co_v2.chat(model="command-r-plus-08-2024",
2
                 messages=[
3
                     {
4
                         "role": "user",
5
                         "content": "What is 2 + 2"
6
                     }
7
                 ])
8
9
print(res.message.content[0].text)

1
message = "I'm joining a new startup called Co1t today. Could you help me write a one-sentence introduction message to my teammates."
2
3
res = co_v1.chat_stream(model="command-r-plus-08-2024",
4
                        message=message)
5
6
for chunk in res:
7
    if chunk.event_type == "text-generation":
8
        print(chunk.text, end="")

1
message = "I'm joining a new startup called Co1t today. Could you help me write a one-sentence introduction message to my teammates."
2
3
res = co_v2.chat_stream(model="command-r-plus-08-2024",
4
                        messages=[{"role": "user", "content": message}])
5
6
for chunk in res: 
7
    if chunk:
8
        if chunk.type == "content-delta":
9
            print(chunk.delta.message.content.text, end="")

1
# Define the documents
2
documents_v1 = [
3
    {"text": "Reimbursing Travel Expenses: Easily manage your travel expenses by submitting them through our finance tool. Approvals are prompt and straightforward."},
4
    {"text": "Health and Wellness Benefits: We care about your well-being and offer gym memberships, on-site yoga classes, and comprehensive health insurance."}
5
]
6
7
# The user query
8
message = "Are there fitness-related benefits?"
9
10
# Generate the response
11
res_v1 = co_v1.chat(model="command-r-plus-08-2024",
12
                    message=message,
13
                    documents=documents_v1)
14
15
print(res_v1.text)

1
# Define the documents
2
documents_v2 = [
3
  {
4
    "data": {
5
      "text": "Reimbursing Travel Expenses: Easily manage your travel expenses by submitting them through our finance tool. Approvals are prompt and straightforward."
6
    }
7
  },
8
  {
9
    "data": {
10
      "text": "Health and Wellness Benefits: We care about your well-being and offer gym memberships, on-site yoga classes, and comprehensive health insurance."
11
    }
12
  }
13
]
14
15
# The user query
16
message = "Are there fitness-related benefits?"
17
18
# Generate the response
19
res_v2 = co_v2.chat(model="command-r-plus-08-2024",
20
                    messages=[{"role": "user", "content": message}],
21
                    documents=documents_v2)
22
23
print(res_v2.message.content[0].text)

1
documents_v2 = [
2
# List of objects with data string
3
{
4
	"id": "123"
5
	"data": "I love penguins. they are fluffy",
6
},
7
# List of objects with data object
8
{"id": "456", "data": {
9
	"text": "I love penguins. they are fluffy",
10
	"author": "Abdullah",
11
	"create_date": "09021989"
12
	}
13
},
14
# List of strings
15
"just a string"
16
]

1
# Yes, there are fitness-related benefits. We offer gym memberships, on-site yoga classes, and comprehensive health insurance.
2
3
print(res_v1.citations)
4
print(res_v1.documents)

1
# Yes, we offer gym memberships, on-site yoga classes, and comprehensive health insurance.
2
3
print(res_v2.message.citations)

1
res_v1 = co_v1.chat(
2
	message="who won euro 2024",
3
	connectors=[{"id": "web-search"}],
4
)
5
6
print(res_v1.text)

1
# Any search engine can be used. This example uses the Tavily API.
2
from tavily import TavilyClient
3
4
tavily_client = TavilyClient(api_key=os.environ["TAVILY_API_KEY"])
5
6
7
# Create a web search function
8
def web_search(queries: list[str]) -> list[dict]:
9
10
    documents = []
11
12
    for query in queries:
13
        response = tavily_client.search(query, max_results=2)
14
15
        results = [
16
            {"title": r["title"], "content": r["content"], "url": r["url"]}
17
            for r in response["results"]
18
        ]
19
20
        for idx, result in enumerate(results):
21
            document = {"id": str(idx), "data": result}
22
            documents.append(document)
23
24
    return documents
25
26
27
# Define the web search tool
28
web_search_tool = [
29
    {
30
        "type": "function",
31
        "function": {
32
            "name": "web_search",
33
            "description": "Returns a list of relevant document snippets for a textual query retrieved from the internet",
34
            "parameters": {
35
                "type": "object",
36
                "properties": {
37
                    "queries": {
38
                        "type": "array",
39
                        "items": {"type": "string"},
40
                        "description": "a list of queries to search the internet with.",
41
                    }
42
                },
43
                "required": ["queries"],
44
            },
45
        },
46
    }
47
]
48
49
# The user query
50
query = "who won euro 2024"
51
52
# Define a preamble to optimize search query generation
53
instructions = "Write a search query that will find helpful information for answering the user's question accurately. If you need more than one search query, write a list of search queries. If you decide that a search is very unlikely to find information that would be useful in constructing a response to the user, you should instead directly answer."
54
55
messages = [
56
    {"role": "system", "content": instructions},
57
    {"role": "user", "content": query},
58
]
59
60
model = "command-r-plus-08-2024"
61
62
# Generate search queries (if any)
63
response = co_v2.chat(model=model, messages=messages, tools=web_search_tool)
64
65
search_queries = []
66
67
while response.message.tool_calls:
68
69
    print("Tool plan:")
70
    print(response.message.tool_plan, "\n")
71
    print("Tool calls:")
72
    for tc in response.message.tool_calls:
73
        print(f"Tool name: {tc.function.name} | Parameters: {tc.function.arguments}")
74
    print("=" * 50)
75
76
    messages.append(
77
        {
78
            "role": "assistant",
79
            "tool_calls": response.message.tool_calls,
80
            "tool_plan": response.message.tool_plan,
81
        }
82
    )
83
84
    # Step 3: Get tool results
85
    for idx, tc in enumerate(response.message.tool_calls):
86
        tool_result = web_search(**json.loads(tc.function.arguments))
87
        tool_content = []
88
        for data in tool_result:
89
            tool_content.append({"type": "document", "document": {"data": json.dumps(data)}})
90
            # Optional: add an "id" field in the "document" object, otherwise IDs are auto-generated
91
        messages.append(
92
            {"role": "tool", "tool_call_id": tc.id, "content": tool_content}
93
        )
94
95
    # Step 4: Generate response and citations
96
    response = co_v2.chat(model=model, messages=messages, tools=web_search_tool)
97
98
print(response.message.content[0].text)

1
message = "Are there fitness-related benefits?"
2
3
res_v1 = co_v1.chat_stream(model="command-r-plus-08-2024",
4
                           message=message,
5
                           documents=documents_v1)
6
7
for chunk in res_v1:
8
    if chunk.event_type == "text-generation":
9
        print(chunk.text, end="")
10
    if chunk.event_type == "citation-generation":
11
        print(f"\n{chunk.citations}")

1
message = "Are there fitness-related benefits?"
2
3
messages = [{"role": "user", "content": message}]
4
5
res_v2 = co_v2.chat_stream(
6
    model="command-r-plus-08-2024", messages=messages, documents=documents_v2
7
)
8
9
for chunk in res_v2:
10
    if chunk:
11
        if chunk.type == "content-delta":
12
            print(chunk.delta.message.content.text, end="")
13
        if chunk.type == "citation-start":
14
            print(f"\n{chunk.delta.message.citations}")

1
def get_weather(location):
2
    return {"temperature": "20C"}
3
  
4
functions_map = {"get_weather": get_weather}
5
6
tools_v1 = [
7
    {
8
      "name": "get_weather",
9
      "description": "Gets the weather of a given location",
10
      "parameter_definitions": {
11
        "location": {
12
          "description": "The location to get weather, example: San Francisco, CA",
13
          "type": "str",
14
          "required": True
15
        }
16
      }
17
    },
18
]

1
def get_weather(location):
2
    return [{"temperature": "20C"}]
3
    # You can return a list of objects e.g. [{"url": "abc.com", "text": "..."}, {"url": "xyz.com", "text": "..."}]
4
5
functions_map = {"get_weather": get_weather}
6
7
tools_v2 = [
8
    {
9
    "type": "function",
10
    "function": {
11
            "name": "get_weather",
12
            "description" : "gets the weather of a given location",
13
            "parameters": {
14
                "type": "object",
15
                "properties": {
16
                "location": {
17
                    "type" : "str",
18
                    "description": "the location to get weather, example: San Fransisco, CA"
19
                }
20
                },
21
                "required": ["location"]
22
            }
23
            }
24
    },
25
]

1
message = "What's the weather in Toronto?"
2
3
res_v1 = co_v1.chat(model="command-r-plus-08-2024",
4
                    message=message,
5
                    tools=tools_v1)
6
7
print(res_v1.tool_calls)

1
messages = [{"role": "user", "content": "What's the weather in Toronto?"}]
2
3
res_v2 = co_v2.chat(model="command-r-plus-08-2024", messages=messages, tools=tools_v2)
4
5
if res_v2.message.tool_calls:
6
    messages.append(
7
        {
8
            "role": "assistant",
9
            "tool_calls": res_v2.message.tool_calls,
10
            "tool_plan": res_v2.message.tool_plan,
11
        }
12
    )
13
14
    print(res_v2.message.tool_calls)

1
tool_results = [
2
  {
3
    "call": {
4
      "name": "<tool name>",
5
      "parameters": {
6
        "<param name>": "<param value>"
7
      }
8
    },
9
    "outputs": [{
10
      "<key>": "<value>"
11
    }]
12
  },
13
]

1
messages = [
2
  {
3
    "role": "tool", 
4
    "tool_call_id": "123", 
5
    "content": [
6
      {
7
        "type": "document", 
8
        "document": {
9
          "id": "123", 
10
          "data": {
11
            "<key>": "<value>"
12
          }
13
        }
14
      }
15
    ]
16
  }
17
]

1
tool_content_v1 = []
2
if res_v1.tool_calls:
3
    for tc in res_v1.tool_calls:
4
        tool_call = {"name": tc.name, "parameters": tc.parameters}
5
        tool_result = functions_map[tc.name](**tc.parameters)
6
        tool_content_v1.append({"call": tool_call, "outputs": [tool_result]})
7
        
8
res_v1 = co_v1.chat(
9
    model="command-r-plus-08-2024",
10
    message="",
11
    tools=tools_v1,
12
    tool_results=tool_content_v1,   
13
    chat_history=res_v1.chat_history
14
)
15
16
print(res_v1.text)

1
if res_v2.message.tool_calls:
2
    for tc in res_v2.message.tool_calls:
3
        tool_result = functions_map[tc.function.name](
4
            **json.loads(tc.function.arguments)
5
        )
6
        tool_content_v2 = []
7
        for data in tool_result:
8
            tool_content_v2.append({"type": "document", "document": {"data": json.dumps(data)}})
9
            # Optional: add an "id" field in the "document" object, otherwise IDs are auto-generated
10
        messages.append(
11
            {"role": "tool", "tool_call_id": tc.id, "content": tool_content_v2}
12
        )
13
14
res_v2 = co_v2.chat(
15
    model="command-r-plus-08-2024",
16
    messages=messages,
17
    tools=tools_v2
18
)
19
20
print(res_v2.message.content[0].text)

1
print(res_v1.citations)
2
print(res_v1.documents)

1
print(res_v2.message.citations)

1
tool_content_v1 = []
2
if res_v1.tool_calls:
3
    for tc in res_v1.tool_calls:
4
        tool_call = {"name": tc.name, "parameters": tc.parameters}
5
        tool_result = functions_map[tc.name](**tc.parameters)
6
        tool_content_v1.append({"call": tool_call, "outputs": [tool_result]})
7
8
res_v1 = co_v1.chat_stream(
9
    message="",
10
    tools=tools_v1,
11
    tool_results=tool_content_v1,
12
    chat_history=res_v1.chat_history
13
)
14
15
for chunk in res_v1:
16
    if chunk.event_type == "text-generation":
17
        print(chunk.text, end="")
18
    if chunk.event_type == "citation-generation":
19
        print(f"\n{chunk.citations}")

1
if res_v2.message.tool_calls:
2
    for tc in res_v2.message.tool_calls:
3
        tool_result = functions_map[tc.function.name](
4
            **json.loads(tc.function.arguments)
5
        )
6
        tool_content_v2 = []
7
        for data in tool_result:
8
            tool_content_v2.append({"type": "document", "document": {"data": json.dumps(data)}})
9
            # Optional: add an "id" field in the "document" object, otherwise IDs are auto-generated
10
        messages.append(
11
            {"role": "tool", "tool_call_id": tc.id, "content": tool_content_v2}
12
        )
13
14
res_v2 = co_v2.chat_stream(
15
    model="command-r-plus-08-2024",
16
    messages=messages,
17
    tools=tools_v2
18
)
19
20
for chunk in res_v2:
21
    if chunk:
22
        if chunk.type == "content-delta":
23
            print(chunk.delta.message.content.text, end="")
24
        elif chunk.type == "citation-start":
25
            print(f"\n{chunk.delta.message.citations}")