CreateAiProjectBody¶
- pydantic model openapi_client.models.create_ai_project_body.CreateAiProjectBody¶
Body for creating an AI project, sent when action is omitted. ProjectName is the only required field; every other field is optional and falls back to the default noted on it.
- Fields:
- field project_name: StrictStr [Required] (alias 'ProjectName')¶
Display name for the new project. Required when creating. Names are not unique. If you omit ChatbotName, it defaults to this name plus “ Assistant”.
- Constraints:
strict = True
- field description: Optional[StrictStr] = None (alias 'Description')¶
Free-text description. Defaults to an empty string.
- field keywords: Optional[List[StrictStr]] = None (alias 'Keywords')¶
Search keywords. Defaults to an empty list.
- field category: Optional[StrictStr] = None (alias 'Category')¶
Category to file the project under. Extra spaces are removed and the first letter is capitalized, so finance, FINANCE, and “ finance “ all become Finance. Do not send Default; omit this field to use that value. A new category is created the first time it is used.
- field enforce_resource_acls: Optional[StrictBool] = False (alias 'EnforceResourceACLs')¶
When true, each user only sees the linked knowledge bases and agents they have access to. Defaults to false.
- field chatbot_name: Optional[StrictStr] = None (alias 'ChatbotName')¶
Display name of the project assistant. Defaults to “<ProjectName> Assistant”.
- field instructions: Optional[Annotated[str, Field(strict=True, max_length=15000)]] = None (alias 'Instructions')¶
Instructions for the project assistant. Defaults to empty. Must be 15000 characters or fewer.
- field greeting: Optional[StrictStr] = None (alias 'Greeting')¶
Welcome message shown in chat. Defaults to “Hello, how can I help you?”.
- field chat_suggestions: Optional[List[StrictStr]] = None (alias 'ChatSuggestions')¶
Suggested prompts shown in chat. Defaults to an empty list.
- field model: Optional[StrictStr] = None (alias 'Model')¶
ID of the model to use. Must be enabled for chats. If omitted, the first model enabled for chats is used. Responses return this as an object with ModelId and ModelName, not as the string you sent.
- field guard_rail: Optional[StrictStr] = None (alias 'GuardRail')¶
ID of the guard rail to apply. The DRAFT version is used. If omitted, the default chat guard rail is applied, or none if chats has no allowed guard rails. Responses return this as an object, not as the string you sent.
- field knowledgebases: Optional[List[StrictStr]] = None (alias 'Knowledgebases')¶
Knowledge bases to link (up to 5). Linking continues in the background after the project is created. Missing or inaccessible entries are skipped and reported on the project; this request still succeeds.
- field agents: Optional[List[StrictStr]] = None (alias 'Agents')¶
Agents to link (up to 10). Linking continues in the background, the same way as knowledge bases. Platform system agents are always allowed.
- field smart_chunking: Optional[StrictBool] = False (alias 'SmartChunking')¶
When true, adds context enrichment to chunks during indexing. Defaults to false.
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- classmethod from_json(json_str)¶
Create an instance of CreateAiProjectBody from a JSON string
- Return type:
Optional[Self]
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True):
None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- Return type:
Dict[str,Any]
- classmethod from_dict(obj)¶
Create an instance of CreateAiProjectBody from a dict
- Return type:
Optional[Self]