KnowledgeBaseDetail

pydantic model openapi_client.models.knowledge_base_detail.KnowledgeBaseDetail

Detailed information about a knowledge base, including its associated data sources.

Fields:

• access_type (str | None)

• agents_attached (List[openapi_client.models.knowledge_base_detail_agents_attached_inner.KnowledgeBaseDetailAgentsAttachedInner] | None)

• created_by (str | None)

• creation_time (str | None)

• data_store_status (str | None)

• data_store_type (str | None)

• description (str | None)

• embedding_model (str | None)

• glue_database_name (str | None)

• guard_rails (List[openapi_client.models.guardrail.Guardrail] | None)

• keywords (List[str] | None)

• knowledgebase_id (str | None)

• knowledgebase_name (str | None)

• knowledgebase_role_arn (str | None)

• knowledgebase_status (str | None)

• knowledgebase_type (str | None)

• last_modified_by (str | None)

• last_modified_time (str | None)

• last_synced_status (str | None)

• last_synced_time (str | None)

• message (str | None)

• metrics (openapi_client.models.knowledge_base_detail_metrics.KnowledgeBaseDetailMetrics | None)

• query_engine_id (str | None)

• smart_chunking (bool | None)

• sort_key (str | None)

• source_details (List[openapi_client.models.source_detail.SourceDetail] | None)

• tenant_name (str | None)

field knowledgebase_id: Optional[StrictStr] = None (alias 'KnowledgebaseId')

Unique identifier of the knowledge base.

field knowledgebase_name: Optional[StrictStr] = None (alias 'KnowledgebaseName')

Name of the knowledge base.

field knowledgebase_type: Optional[StrictStr] = None (alias 'KnowledgebaseType')

Type of the knowledge base. Older items without this field are treated as unstructured.

field data_store_type: Optional[StrictStr] = None (alias 'DataStoreType')

Structured datastore type. Present only on structured knowledge bases.

field tenant_name: Optional[StrictStr] = None (alias 'TenantName')

Tenant database name. Present on redshift structured knowledge bases.

field embedding_model: Optional[StrictStr] = None (alias 'EmbeddingModel')

Embedding model used for unstructured knowledge bases. Omitted for structured items.

field description: Optional[StrictStr] = None (alias 'Description')

Description of the knowledge base.

field knowledgebase_status: Optional[StrictStr] = None (alias 'KnowledgebaseStatus')

Current knowledge base status, refreshed from Bedrock when CREATING or UPDATING.

field creation_time: Optional[StrictStr] = None (alias 'CreationTime')

Timestamp when the knowledge base was created.

field created_by: Optional[StrictStr] = None (alias 'CreatedBy')

User ID of the creator.

field last_modified_time: Optional[StrictStr] = None (alias 'LastModifiedTime')

Timestamp when the knowledge base was last modified.

field last_modified_by: Optional[StrictStr] = None (alias 'LastModifiedBy')

User ID of the last modifier.

field last_synced_time: Optional[StrictStr] = None (alias 'LastSyncedTime')

Timestamp of the last sync. “N/A” if never synced.

field last_synced_status: Optional[StrictStr] = None (alias 'LastSyncedStatus')

Status of the last sync. “N/A” if never synced.

field keywords: Optional[List[StrictStr]] = None (alias 'Keywords')

Keywords associated with the knowledge base.

field guard_rails: Optional[List[Guardrail]] = None (alias 'GuardRails')

Guard rails linked to the knowledge base.

field message: Optional[StrictStr] = None (alias 'Message')

Failure reason when KnowledgebaseStatus is FAILED.

field knowledgebase_role_arn: Optional[StrictStr] = None (alias 'KnowledgebaseRoleArn')

IAM role ARN for structured knowledge bases.

field query_engine_id: Optional[StrictStr] = None (alias 'QueryEngineId')

Bedrock query engine / data source ID for structured knowledge bases.

field data_store_status: Optional[StrictStr] = None (alias 'DataStoreStatus')

Datastore setup status for structured knowledge bases.

field glue_database_name: Optional[StrictStr] = None (alias 'GlueDatabaseName')

Glue database name for s3athena structured knowledge bases.

field agents_attached: Optional[List[KnowledgeBaseDetailAgentsAttachedInner]] = None (alias 'AgentsAttached')

Agents currently attached to this knowledge base.

field sort_key: Optional[StrictStr] = None (alias 'SortKey')

DynamoDB sort key for the metadata item. Always Metadata.

field access_type: Optional[StrictStr] = None (alias 'AccessType')

Caller’s permission on the knowledge base.

field metrics: Optional[KnowledgeBaseDetailMetrics] = None (alias 'Metrics')

field smart_chunking: Optional[StrictBool] = None (alias 'SmartChunking')

LLM-assisted contextual chunking flag. Present only on unstructured items.

field source_details: Optional[List[SourceDetail]] = None (alias 'SourceDetails')

Data sources attached to this knowledge base. Omitted when none are attached.

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

Return type:

Optional[Self]