KnowledgeBaseCreateRequest

class openapi_client.models.knowledge_base_create_request.KnowledgeBaseCreateRequest(**data)

Bases: BaseModel

knowledgebase_name: StrictStr

description: Optional[StrictStr]

embedding_model: Optional[StrictStr]

guard_rails: Optional[List[Guardrail]]

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()

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 KnowledgeBaseCreateRequest 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 KnowledgeBaseCreateRequest from a dict

Return type:

Optional[Self]

model_fields: ClassVar[dict[str, FieldInfo]] = {'description': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='Description', alias_priority=2, description='A brief description of the knowledge base.'), 'embedding_model': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='EmbeddingModel', alias_priority=2, description="The embedding model to use for the knowledge base (e.g., 'amazon.titan-embed-text-v1')."), 'guard_rails': FieldInfo(annotation=Union[List[Guardrail], NoneType], required=False, alias='GuardRails', alias_priority=2, description='List of guard rails to apply to the knowledge base.'), 'knowledgebase_name': FieldInfo(annotation=str, required=True, alias='KnowledgebaseName', alias_priority=2, description='The name of the knowledge base to be created.', 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