ISemanticSearchResultItem
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
A single search result returned by semantic search.
export interface ISemanticSearchResultItem
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(BETA) (Optional) Certification status and optional message for the found metadata object. | |||
string | (BETA) (Optional) The creation date of the found metadata object | ||
string | (BETA) (Optional) The description of the found metadata object | ||
string | (BETA) The identifier of the found metadata object | ||
string | (BETA) (Optional) The last modification date of the found metadata object | ||
number | (BETA) (Optional) Overall similarity score of the found item. Larger is more similar. | ||
number | (BETA) (Optional) Description score of the found item. | ||
number | (BETA) (Optional) 1000 if the found item is an exact match, 0 otherwise. | ||
number | (BETA) (Optional) Title score of the found item. | ||
string[] | (BETA) (Optional) The tags of the found metadata object | ||
string | (BETA) The title of the found metadata object | ||
(BETA) The type of the found metadata object | |||
string | (BETA) (Optional) Represents the type of chart for visualization objects | ||
string | (BETA) The identifier of the workspace where the found metadata object is located |
Property details
ISemanticSearchResultItem.certificationpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Certification status and optional message for the found metadata object.
certification?: ISemanticSearchCertification;
ISemanticSearchResultItem.createdAtpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
The creation date of the found metadata object
createdAt?: string;
ISemanticSearchResultItem.descriptionpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
The description of the found metadata object
description?: string;
ISemanticSearchResultItem.idpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
The identifier of the found metadata object
id: string;
ISemanticSearchResultItem.modifiedAtpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
The last modification date of the found metadata object
modifiedAt?: string;
ISemanticSearchResultItem.scorepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Overall similarity score of the found item. Larger is more similar.
score?: number;
ISemanticSearchResultItem.scoreDescriptorpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Description score of the found item.
scoreDescriptor?: number;
ISemanticSearchResultItem.scoreExactMatchpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
1000 if the found item is an exact match, 0 otherwise.
scoreExactMatch?: number;
ISemanticSearchResultItem.scoreTitlepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Title score of the found item.
scoreTitle?: number;
ISemanticSearchResultItem.tagspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
The tags of the found metadata object
tags?: string[];
ISemanticSearchResultItem.titlepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
The title of the found metadata object
title: string;
ISemanticSearchResultItem.typepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
The type of the found metadata object
type: GenAIObjectType;
ISemanticSearchResultItem.visualizationUrlpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Represents the type of chart for visualization objects
visualizationUrl?: string;
ISemanticSearchResultItem.workspaceIdpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
The identifier of the workspace where the found metadata object is located
workspaceId: string;