Fixes+additions in docs

ddebowczyk · ddebowczyk · commit 6d30cc517ff0 · 2024-06-05T17:37:41.000+02:00
diff --git a/docs/hub/advanced/function_arguments.md b/docs/hub/advanced/function_arguments.md
@@ -1,7 +1,10 @@
 # Extracting arguments of function or method
 
-Instructor offers Call class to extract arguments of a function or method from content.
-This is useful when you want to build tool usage capability, e.g. for AI chatbots or agents.
+Instructor offers FunctionCall class to extract arguments of a function
+or method from content.
+
+This is useful when you want to build tool use capability, e.g. for AI
+chatbots or agents.
 
 ```php
 <?php
@@ -11,20 +14,23 @@ $loader->add('Cognesy\\Instructor\\', __DIR__ . '../../src/');
 use Cognesy\Instructor\Extras\FunctionCall\FunctionCall;
 use Cognesy\Instructor\Instructor;
 
-/** Save user data to storage */
-function saveUser(string $name, int $age, string $country) {
-    // Save user to database
-    echo "Saving user ... saveUser('$name', $age, '$country')\n";
+class DataStore
+{
+    /** Save user data to storage */
+    public function saveUser(string $name, int $age, string $country) : void {
+        // Save user to database
+        echo "Saving user ... saveUser('$name', $age, '$country')\n";
+    }
 }
 
 $text = "His name is Jason, he is 28 years old and he lives in Germany.";
 $args = (new Instructor)->respond(
     messages: $text,
-    responseModel: FunctionCall::fromCallable(saveUser(...)),
+    responseModel: FunctionCall::fromMethodName(DataStore::class, 'saveUser'),
 );
 
 echo "\nCalling the function with the extracted arguments:\n";
-saveUser(...$args);
+(new DataStore)->saveUser(...$args);
 
 echo "\nExtracted arguments:\n";
 dump($args);
diff --git a/docs/hub/advanced/language_programs.md b/docs/hub/advanced/language_programs.md
@@ -172,4 +172,7 @@ $getStats = new GetStats($instructor, $directoryContents);
 $emailStats = $getStats->with(EmailStats::for('inbox'));
 
 echo "Results:\n";
-dump($emailStats->get());
+dump($emailStats->get());
+?>
+```
+
diff --git a/docs/hub/api_support/llm_support_anthropic.md b/docs/hub/api_support/llm_support_anthropic.md
@@ -45,7 +45,7 @@ $user = $instructor->respond(
     messages: "Jason (@jxnlco) is 25 years old and is the admin of this project. He likes playing football and reading books.",
     responseModel: User::class,
     model: 'claude-3-haiku-20240307',
-    mode: Mode::Json,
+    mode: Mode::Tools,
     //options: ['stream' => true ]
 );
 
diff --git a/docs/hub/api_support/llm_support_cohere.md b/docs/hub/api_support/llm_support_cohere.md
@@ -0,0 +1,63 @@
+# Support for Cohere API
+
+Instructor supports Cohere API - you can find the details on how to configure
+the client in the example below.
+
+Mode compatibility:
+ - Mode::MdJson - supported, recommended
+ - Mode::Json - not supported by Cohere
+ - Mode::Tools - partially supported, not recommended
+
+Reasons Mode::Tools is not recommended:
+
+ - Cohere does not support JSON Schema, which only allows to extract very simple data schemas.
+ - Performance of the currently available versions of Cohere models in tools mode for Instructor use case (data extraction) is extremely poor.
+
+```php
+<?php
+$loader = require 'vendor/autoload.php';
+$loader->add('Cognesy\\Instructor\\', __DIR__ . '../../src/');
+
+use Cognesy\Instructor\Clients\Cohere\CohereClient;
+use Cognesy\Instructor\Enums\Mode;
+use Cognesy\Instructor\Instructor;
+use Cognesy\Instructor\Utils\Env;
+
+enum UserType : string {
+    case Guest = 'guest';
+    case User = 'user';
+    case Admin = 'admin';
+}
+
+class User {
+    public int $age;
+    public string $name;
+    public string $username;
+    public UserType $role;
+    /** @var string[] */
+    public array $hobbies;
+}
+
+// Create instance of client initialized with custom parameters
+$client = new CohereClient(
+    apiKey: Env::get('COHERE_API_KEY'),
+);
+
+/// Get Instructor with the default client component overridden with your own
+$instructor = (new Instructor)->withClient($client);//->withDebug();
+
+$user = $instructor->respond(
+    messages: "Jason (@jxnlco) is 25 years old and is the admin of this project. He likes playing football and reading books.",
+    responseModel: User::class,
+    model: 'command-r-plus',
+    mode: Mode::MdJson,
+    //options: ['stream' => true ]
+);
+
+print("Completed response model:\n\n");
+dump($user);
+
+assert(isset($user->name));
+assert(isset($user->age));
+?>
+```
