| Field | Type | Required | Description |
|---|---|---|---|
namespace_id |
str | ✔️ | The ID of the namespace this hosting belongs to. |
title |
Nullable[str] | ✔️ | The title displayed on the hosted interface. |
slug |
Nullable[str] | ✔️ | The unique slug for accessing the hosted interface. |
logo |
Nullable[str] | ✔️ | The URL or base64 encoded image of the logo. |
og_title |
Nullable[str] | ✔️ | Custom Open Graph title for social media sharing. |
og_description |
Nullable[str] | ✔️ | Custom Open Graph description for social media sharing. |
og_image |
Nullable[str] | ✔️ | Custom Open Graph image URL for social media sharing. |
system_prompt |
Nullable[str] | ✔️ | The system prompt used for the chat interface. |
example_questions |
List[str] | ✔️ | Example questions to display to users in the chat interface. |
example_search_queries |
List[str] | ✔️ | Example search queries to display to users in the search interface. |
welcome_message |
Nullable[str] | ✔️ | Welcome message displayed to users. |
citation_metadata_path |
Nullable[str] | ✔️ | Path to metadata field used for citations. |
search_enabled |
Optional[bool] | ➖ | Whether search functionality is enabled. |
rerank_config |
Any | ✔️ | Configuration for the reranking model. |
llm_config |
Any | ✔️ | Configuration for the LLM model. |
top_k |
Optional[int] | ➖ | Number of documents to retrieve from vector store. |
protected |
Optional[bool] | ➖ | Whether the hosted interface is protected by authentication. |
allowed_emails |
List[str] | ✔️ | List of allowed email addresses (when protected is true). |
allowed_email_domains |
List[str] | ✔️ | List of allowed email domains (when protected is true). |
created_at |
str | ✔️ | The date and time the hosting was created. |
updated_at |
str | ✔️ | The date and time the hosting was last updated. |