Meilisearch PHP | Documentation

HandlesChatWorkspaceSettings

Table of Contents

Methods

getSettings()  : ChatWorkspaceSettings
Get the current settings for this chat workspace.
resetSettings()  : ChatWorkspaceSettings
Reset the settings for this chat workspace to default values.
streamCompletion()  : StreamInterface
Create a streaming chat completion using OpenAI-compatible API.
updateSettings()  : ChatWorkspaceSettings
Update the settings for this chat workspace.

Methods

streamCompletion()

Create a streaming chat completion using OpenAI-compatible API.

public streamCompletion(array{model: string, messages: array{role: string, content: string}[], stream: bool} $options) : StreamInterface
Parameters
$options : array{model: string, messages: array{role: string, content: string}[], stream: bool}

The request body for the chat completion

Return values
StreamInterface

updateSettings()

Update the settings for this chat workspace.

public updateSettings(array{source?: "openAi"|"azureOpenAi"|"mistral"|"gemini"|"vLlm", orgId?: string, projectId?: string, apiVersion?: string, deploymentId?: string, baseUrl?: string, apiKey?: string, prompts?: array$settings) : ChatWorkspaceSettings
Parameters
$settings : array{source?: "openAi"|"azureOpenAi"|"mistral"|"gemini"|"vLlm", orgId?: string, projectId?: string, apiVersion?: string, deploymentId?: string, baseUrl?: string, apiKey?: string, prompts?: array}
Return values
ChatWorkspaceSettings

        
On this page

Search results