Add conversational search

src/Client.php

@@ -5,7 +5,9 @@
 namespace Meilisearch;
 
 use Meilisearch\Endpoints\Batches;
+use Meilisearch\Endpoints\ChatWorkspaces;
 use Meilisearch\Endpoints\Delegates\HandlesBatches;
+use Meilisearch\Endpoints\Delegates\HandlesChatWorkspaces;
 use Meilisearch\Endpoints\Delegates\HandlesDumps;
 use Meilisearch\Endpoints\Delegates\HandlesIndex;
 use Meilisearch\Endpoints\Delegates\HandlesKeys;
@@ -31,6 +33,7 @@
 
 class Client
 {
+    use HandlesChatWorkspaces;
     use HandlesDumps;
     use HandlesIndex;
     use HandlesTasks;
@@ -53,6 +56,7 @@ public function __construct(
         ?StreamFactoryInterface $streamFactory = null
     ) {
         $this->http = new MeilisearchClientAdapter($url, $apiKey, $httpClient, $requestFactory, $clientAgents, $streamFactory);
+        $this->chats = new ChatWorkspaces($this->http);
         $this->index = new Indexes($this->http);
         $this->health = new Health($this->http);
         $this->version = new Version($this->http);

src/Contracts/ChatWorkspacePromptsSettings.php

@@ -0,0 +1,79 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Meilisearch\Contracts;
+
+/**
+ * @phpstan-type ChatWorkspacePromptsArray array{
+ *     system: string,
+ *     searchDescription: string,
+ *     searchQParam: non-empty-string,
+ *     searchIndexUidParam: non-empty-string
+ * }
+ */
+class ChatWorkspacePromptsSettings extends Data
+{
+    private string $system;
+    private string $searchDescription;
+    /**
+     * @var non-empty-string
+     */
+    private string $searchQParam;
+    /**
+     * @var non-empty-string
+     */
+    private string $searchIndexUidParam;
+
+    /**
+     * @param ChatWorkspacePromptsArray $params
+     */
+    public function __construct(array $params)
+    {
+        parent::__construct($params);
+
+        $this->system = $params['system'];
+        $this->searchDescription = $params['searchDescription'];
+        $this->searchQParam = $params['searchQParam'];
+        $this->searchIndexUidParam = $params['searchIndexUidParam'];
+    }
+
+    public function getSystem(): string
+    {
+        return $this->system;
+    }
+
+    public function getSearchDescription(): string
+    {
+        return $this->searchDescription;
+    }
+
+    /**
+     * @return non-empty-string
+     */
+    public function getSearchQParam(): string
+    {
+        return $this->searchQParam;
+    }
+
+    /**
+     * @return non-empty-string
+     */
+    public function getSearchIndexUidParam(): string
+    {
+        return $this->searchIndexUidParam;
+    }
+
+    /**
+     * @return ChatWorkspacePromptsArray
+     */
+    public function toArray(): array
+    {
+        return [
+            'system' => $this->system,
+            'searchDescription' => $this->searchDescription,
+            'searchQParam' => $this->searchQParam,
+            'searchIndexUidParam' => $this->searchIndexUidParam,
+        ];
+    }
+}

src/Contracts/ChatWorkspaceSettings.php

@@ -0,0 +1,161 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Meilisearch\Contracts;
+
+/**
+ * @phpstan-type ChatWorkspaceSource 'openAi'|'azureOpenAi'|'mistral'|'gemini'|'vLlm'
+ */
+class ChatWorkspaceSettings extends Data
+{
+    /**
+     * @var ChatWorkspaceSource
+     */
+    private string $source;
+    /**
+     * @var non-empty-string|null
+     */
+    private ?string $orgId;
+    /**
+     * @var non-empty-string|null
+     */
+    private ?string $projectId;
+    /**
+     * @var non-empty-string|null
+     */
+    private ?string $apiVersion;
+    /**
+     * @var non-empty-string|null
+     */
+    private ?string $deploymentId;
+    /**
+     * @var non-empty-string|null
+     */
+    private ?string $baseUrl;
+    private ?string $apiKey;
+    private ChatWorkspacePromptsSettings $prompts;
+
+    /**
+     * @param array{
+     *     source: ChatWorkspaceSource,
+     *     orgId?: non-empty-string,
+     *     projectId?: non-empty-string,
+     *     apiVersion?: non-empty-string,
+     *     deploymentId?: non-empty-string,
+     *     baseUrl?: non-empty-string,
+     *     apiKey?: string,
+     *     prompts: array{
+     *         system: string,
+     *         searchDescription: string,
+     *         searchQParam: non-empty-string,
+     *         searchIndexUidParam: non-empty-string
+     *     }
+     * } $params
+     */
+    public function __construct(array $params)
+    {
+        parent::__construct($params);
+
+        $this->source = $params['source'];
+        $this->orgId = $params['orgId'] ?? null;
+        $this->projectId = $params['projectId'] ?? null;
+        $this->apiVersion = $params['apiVersion'] ?? null;
+        $this->deploymentId = $params['deploymentId'] ?? null;
+        $this->baseUrl = $params['baseUrl'] ?? null;
+        $this->apiKey = $params['apiKey'] ?? null;
+        $this->prompts = new ChatWorkspacePromptsSettings($params['prompts']);
+    }
+
+    /**
+     * @return ChatWorkspaceSource
+     */
+    public function getSource(): string
+    {
+        return $this->source;
+    }
+
+    /**
+     * @return non-empty-string|null
+     */
+    public function getOrgId(): ?string
+    {
+        return $this->orgId;
+    }
+
+    /**
+     * @return non-empty-string|null
+     */
+    public function getProjectId(): ?string
+    {
+        return $this->projectId;
+    }
+
+    /**
+     * @return non-empty-string|null
+     */
+    public function getApiVersion(): ?string
+    {
+        return $this->apiVersion;
+    }
+
+    /**
+     * @return non-empty-string|null
+     */
+    public function getDeploymentId(): ?string
+    {
+        return $this->deploymentId;
+    }
+
+    /**
+     * @return non-empty-string|null
+     */
+    public function getBaseUrl(): ?string
+    {
+        return $this->baseUrl;
+    }
+
+    /**
+     * @return non-empty-string|null
+     */
+    public function getApiKey(): ?string
+    {
+        return $this->apiKey;
+    }
+
+    public function getPrompts(): ChatWorkspacePromptsSettings
+    {
+        return $this->prompts;
+    }
+
+    /**
+     * @return array{
+     *     source: ChatWorkspaceSource,
+     *     orgId?: non-empty-string,
+     *     projectId?: non-empty-string,
+     *     apiVersion?: non-empty-string,
+     *     deploymentId?: non-empty-string,
+     *     baseUrl?: non-empty-string,
+     *     apiKey?: string,
+     *     prompts: array{
+     *         system: string,
+     *         searchDescription: string,
+     *         searchQParam: non-empty-string,
+     *         searchIndexUidParam: non-empty-string
+     *     }
+     * }
+     */
+    public function toArray(): array
+    {
+        return [
+            'source' => $this->source,
+            'orgId' => $this->orgId,
+            'projectId' => $this->projectId,
+            'apiVersion' => $this->apiVersion,
+            'deploymentId' => $this->deploymentId,
+            'baseUrl' => $this->baseUrl,
+            'apiKey' => $this->apiKey,
+            'prompts' => $this->prompts->toArray(),
+        ];
+    }
+}

src/Contracts/ChatWorkspacesResults.php

@@ -0,0 +1,90 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Meilisearch\Contracts;
+
+class ChatWorkspacesResults extends Data
+{
+    /**
+     * @var non-negative-int
+     */
+    private int $offset;
+
+    /**
+     * @var non-negative-int
+     */
+    private int $limit;
+
+    /**
+     * @var non-negative-int
+     */
+    private int $total;
+
+    public function __construct(array $params)
+    {
+        parent::__construct($params['results']);
+
+        $this->offset = $params['offset'];
+        $this->limit = $params['limit'];
+        $this->total = $params['total'];
+    }
+
+    /**
+     * @return array<int, array{uid: string}>
+     */
+    public function getResults(): array
+    {
+        return $this->data;
+    }
+
+    /**
+     * @return non-negative-int
+     */
+    public function getOffset(): int
+    {
+        return $this->offset;
+    }
+
+    /**
+     * @return non-negative-int
+     */
+    public function getLimit(): int
+    {
+        return $this->limit;
+    }
+
+    /**
+     * @return non-negative-int
+     */
+    public function getTotal(): int
+    {
+        return $this->total;
+    }
+
+    /**
+     * @return array{
+     *     results: array,
+     *     offset: non-negative-int,
+     *     limit: non-negative-int,
+     *     total: non-negative-int
+     * }
+     */
+    public function toArray(): array
+    {
+        return [
+            'results' => $this->data,
+            'offset' => $this->offset,
+            'limit' => $this->limit,
+            'total' => $this->total,
+        ];
+    }
+
+    /**
+     * @return non-negative-int
+     */
+    public function count(): int
+    {
+        return \count($this->data);
+    }
+}

src/Contracts/Http.php

@@ -7,6 +7,7 @@
 use Meilisearch\Exceptions\ApiException;
 use Meilisearch\Exceptions\JsonDecodingException;
 use Meilisearch\Exceptions\JsonEncodingException;
+use Psr\Http\Message\StreamInterface;
 
 interface Http
 {
@@ -46,4 +47,10 @@ public function patch(string $path, $body = null, array $query = []);
      * @throws JsonDecodingException
      */
     public function delete(string $path, array $query = []);
+
+    /**
+     * @throws ApiException
+     * @throws JsonEncodingException
+     */
+    public function postStream(string $path, $body = null, array $query = []): StreamInterface;
 }