SourceDetail

pydantic model openapi_client.models.source_detail.SourceDetail

Details of a data source linked to a knowledge base.

Fields:

• chunking_configuration (Dict[str, Any] | None)

• description (str | None)

• last_modified_by (str | None)

• last_modified_time (str | None)

• parsing_strategy (str | None)

• resource_key (str | None)

• resource_name (str | None)

• resource_type (str | None)

• source_id (str | None)

• source_name (str | None)

• source_status (str | None)

field source_name: Optional[StrictStr] = None (alias 'SourceName')

Name of the data source.

field source_id: Optional[StrictStr] = None (alias 'SourceId')

Unique identifier of the data source. For some structured sources this may equal ResourceKey.

field source_status: Optional[StrictStr] = None (alias 'SourceStatus')

Current status of the data source.

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

Description of the data source.

field chunking_configuration: Optional[Dict[str, Any]] = None (alias 'ChunkingConfiguration')

Chunking config for unstructured sources (ChunkingStrategy NONE, FIXED_SIZE, HIERARCHICAL, or SEMANTIC). Empty or unused for structured sources.

field parsing_strategy: Optional[StrictStr] = None (alias 'ParsingStrategy')

Parsing strategy for unstructured sources.

field resource_type: Optional[StrictStr] = None (alias 'ResourceType')

Attached resource type.

field resource_name: Optional[StrictStr] = None (alias 'ResourceName')

Name of the attached dataset or domain.

field resource_key: Optional[StrictStr] = None (alias 'ResourceKey')

Dataset ID (ResourceType=Dataset) or domain name (ResourceType=Domain).

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

Timestamp when the data source was last modified.

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

User ID of the last modifier.

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

Return type:

Optional[Self]