CatalogResultItem

pydantic model openapi_client.models.catalog_result_item.CatalogResultItem

A single catalog asset returned by POST /catalog/search. Attributes are projected from the search index, so any attribute that is not populated on the indexed document is simply absent rather than null. The last five properties are returned only by semantic search (search_type=semantic).

Fields:

• access_type (str | None)

• asset_id (str | None)

• asset_name (str | None)

• asset_type (str | None)

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

• data_category (str | None)

• data_classification (str | None)

• datasource_id (str | None)

• datasource_name (str | None)

• datasource_type (str | None)

• description (str | None)

• display_name (str | None)

• domain (str | None)

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

• ingestion_type (str | None)

• keywords (List[str] | None)

• last_modified_time (str | None)

• match_score (float | int | None)

• resource_type (str | None)

• tags (List[Dict[str, Any]] | None)

• target_location (str | None)

field asset_id: Optional[StrictStr] = None (alias 'AssetId')

Unique identifier of the asset.

field asset_name: Optional[StrictStr] = None (alias 'AssetName')

Name of the asset.

field display_name: Optional[StrictStr] = None (alias 'DisplayName')

Human-readable name. Always present, and an empty string when the asset has no display name set.

field asset_type: Optional[StrictStr] = None (alias 'AssetType')

Kind of catalog asset.

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

Description of the asset.

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

The caller’s level of access to this asset. Note that the value for “no access” is the literal string “None”, not a JSON null.

field datasource_id: Optional[StrictStr] = None (alias 'DatasourceId')

Identifier of the datasource the asset belongs to.

field datasource_name: Optional[StrictStr] = None (alias 'DatasourceName')

Name of the datasource the asset belongs to.

field datasource_type: Optional[StrictStr] = None (alias 'DatasourceType')

Type of the datasource the asset belongs to.

field domain: Optional[StrictStr] = None (alias 'Domain')

Domain the asset is registered under.

field target_location: Optional[StrictStr] = None (alias 'TargetLocation')

Storage or query backend the asset resides in.

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

Search keywords attached to the asset.

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

Amorphic resource type of the asset.

field ingestion_type: Optional[StrictStr] = None (alias 'IngestionType')

How data reaches the asset.

field data_category: Optional[StrictStr] = None (alias 'DataCategory')

Data category assigned to the asset.

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

Timestamp of the most recent change to the asset.

field match_score: Optional[Union[StrictFloat, StrictInt]] = None (alias 'MatchScore')

Semantic relevance score. Returned only when search_type=semantic and include_match_score is “true”. Results scoring below the backend threshold are dropped from the response entirely.

field data_classification: Optional[StrictStr] = None (alias 'DataClassification')

Data classification assigned to the asset. Returned by semantic search only.

field tags: Optional[List[Dict[str, Any]]] = None (alias 'Tags')

Tags attached to the asset. Returned by semantic search only. Passed through from the search index without reshaping.

field glossary_details: Optional[Dict[str, Any]] = None (alias 'GlossaryDetails')

Business-glossary terms linked to the asset. Returned by semantic search only. Passed through from the search index without reshaping, so no element structure is defined here.

field custom_metadata: Optional[Dict[str, Any]] = None (alias 'CustomMetadata')

Custom metadata attached to the asset. Returned by semantic search only. Passed through from the search index without reshaping.

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

Return type:

Optional[Self]