ISemanticSearchResult
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Semantic search result payload.
export interface ISemanticSearchResult
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(BETA) (Optional) Error details if the search operation failed. | |||
string | (BETA) (Optional) Assistant reasoning describing the search outcome. | ||
(BETA) Relationships tying the found objects together. | |||
(BETA) List of found objects. |
Property details
ISemanticSearchResult.errorpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Error details if the search operation failed.
error?: ISemanticSearchError;
ISemanticSearchResult.reasoningpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Assistant reasoning describing the search outcome.
reasoning?: string;
ISemanticSearchResult.relationshipspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Relationships tying the found objects together.
relationships: ISemanticSearchRelationship[];
ISemanticSearchResult.resultspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
List of found objects.
results: ISemanticSearchResultItem[];