CreateProjectRequestBody

class openapi_client.models.create_project_request_body.CreateProjectRequestBody(**data)[source]

Bases: BaseModel

Request body for creating a project

project_name: StrictStr
description: Optional[StrictStr]
keywords: Optional[List[StrictStr]]
category: Optional[StrictStr]
enforce_resource_acls: Optional[StrictBool]
chatbot_name: Optional[StrictStr]
instructions: Optional[StrictStr]
greeting: Optional[StrictStr]
chat_suggestions: Optional[List[StrictStr]]
enable_smart_orchestration: Optional[StrictBool]
model: Optional[StrictStr]
guard_rail: Optional[StrictStr]
knowledgebases: Optional[List[StrictStr]]
agents: Optional[List[StrictStr]]
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_str()[source]

Returns the string representation of the model using alias

Return type:

str

to_json()[source]

Returns the JSON representation of the model using alias

Return type:

str

classmethod from_json(json_str)[source]

Create an instance of CreateProjectRequestBody from a JSON string

Return type:

Optional[Self]

to_dict()[source]

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)[source]

Create an instance of CreateProjectRequestBody from a dict

Return type:

Optional[Self]

model_fields: ClassVar[dict[str, FieldInfo]] = {'agents': FieldInfo(annotation=Union[List[Annotated[str, Strict(strict=True)]], NoneType], required=False, alias='Agents', alias_priority=2, description='List of agent IDs'), 'category': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='Category', alias_priority=2, description='Category for the project'), 'chat_suggestions': FieldInfo(annotation=Union[List[Annotated[str, Strict(strict=True)]], NoneType], required=False, alias='ChatSuggestions', alias_priority=2, description='List of chat suggestions'), 'chatbot_name': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='ChatbotName', alias_priority=2, description='Name of the chatbot/project agent'), 'description': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='Description', alias_priority=2, description='Description of the project'), 'enable_smart_orchestration': FieldInfo(annotation=Union[Annotated[bool, Strict(strict=True)], NoneType], required=False, alias='EnableSmartOrchestration', alias_priority=2, description='Whether to enable smart orchestration'), 'enforce_resource_acls': FieldInfo(annotation=Union[Annotated[bool, Strict(strict=True)], NoneType], required=False, alias='EnforceResourceACLs', alias_priority=2, description='Whether to enforce resource ACLs'), 'greeting': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='Greeting', alias_priority=2, description='Greeting message for the project agent'), 'guard_rail': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='GuardRail', alias_priority=2, description='ID of the guard rail to use'), 'instructions': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='Instructions', alias_priority=2, description='Instructions for the project agent'), 'keywords': FieldInfo(annotation=Union[List[Annotated[str, Strict(strict=True)]], NoneType], required=False, alias='Keywords', alias_priority=2, description='List of keywords associated with the project'), 'knowledgebases': FieldInfo(annotation=Union[List[Annotated[str, Strict(strict=True)]], NoneType], required=False, alias='Knowledgebases', alias_priority=2, description='List of knowledge base IDs'), 'model': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='Model', alias_priority=2, description='ID of the AI model to use'), 'project_name': FieldInfo(annotation=str, required=True, alias='ProjectName', alias_priority=2, description='Name of the project (required)', metadata=[Strict(strict=True)])}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

model_post_init(__context)

This function is meant to behave like a BaseModel method to initialise private attributes.

It takes context as an argument since that’s what pydantic-core passes when calling it.

Parameters:
  • self (BaseModel) – The BaseModel instance.

  • __context (Any) – The context.

Return type:

None