import { type GenAIObjectType } from "./common.js";
/**
 * Allowed relationship type combination for semantic search.
 * Filters relationships and results to only include direct matches or objects reachable via allowed relationship types.
 * @beta
 */
export interface IAllowedRelationshipType {
    /**
     * Source object type (e.g. 'dashboard', 'visualization', 'metric').
     */
    sourceType: GenAIObjectType;
    /**
     * Target object type (e.g. 'visualization', 'metric', 'attribute').
     */
    targetType: GenAIObjectType;
    /**
     * If true, allows target objects that are not part of any relationship (orphans) to be included in results.
     * If false, orphan target objects will be excluded even if they directly match the search query.
     * Default is true (orphans are allowed).
     */
    allowOrphans?: boolean;
}
/**
 * Semantic search result payload.
 * @beta
 */
export interface ISemanticSearchResult {
    /**
     * List of found objects.
     */
    results: ISemanticSearchResultItem[];
    /**
     * Relationships tying the found objects together.
     */
    relationships: ISemanticSearchRelationship[];
    /**
     * Assistant reasoning describing the search outcome.
     */
    reasoning?: string;
    /**
     * Error details if the search operation failed.
     */
    error?: ISemanticSearchError;
}
/**
 * Represents an error encountered during a semantic search operation.
 * @beta
 */
export interface ISemanticSearchError {
    /**
     * HTTP status code of the error.
     */
    statusCode: number;
    /**
     * Stable code identifying the type of error.
     */
    reason: (string & {}) | "METADATA_SYNC_IN_PROGRESS" | "METADATA_SYNC_REQUEST_ERROR";
}
/**
 * A single search result returned by semantic search.
 * @beta
 */
export interface ISemanticSearchResultItem {
    /**
     * The type of the found metadata object
     */
    type: GenAIObjectType;
    /**
     * The identifier of the found metadata object
     */
    id: string;
    /**
     * The identifier of the workspace where the found metadata object is located
     */
    workspaceId: string;
    /**
     * The title of the found metadata object
     */
    title: string;
    /**
     * The description of the found metadata object
     */
    description?: string;
    /**
     * The tags of the found metadata object
     */
    tags?: string[];
    /**
     * The creation date of the found metadata object
     */
    createdAt?: string;
    /**
     * The last modification date of the found metadata object
     */
    modifiedAt?: string;
    /**
     * Represents the type of chart for visualization objects
     */
    visualizationUrl?: string;
    /**
     * Overall similarity score of the found item.
     * Larger is more similar.
     */
    score?: number;
    /**
     * Title score of the found item.
     */
    scoreTitle?: number;
    /**
     * Description score of the found item.
     */
    scoreDescriptor?: number;
    /**
     * 1000 if the found item is an exact match, 0 otherwise.
     */
    scoreExactMatch?: number;
}
/**
 * Tests whether the provided item is a semantic search result item.
 * @beta
 */
export declare function isSemanticSearchResultItem(item: object): item is ISemanticSearchResultItem;
/**
 * Reference between two metadata objects.
 * @beta
 */
export interface ISemanticSearchRelationship {
    /**
     * Workspace id of the source object
     */
    sourceWorkspaceId: string;
    /**
     * Object id of the source
     */
    sourceObjectId: string;
    /**
     * Type of the source object
     */
    sourceObjectType: GenAIObjectType;
    /**
     * Title of the source object
     */
    sourceObjectTitle: string;
    /**
     * Workspace id of the target object
     */
    targetWorkspaceId: string;
    /**
     * Object id of the target
     */
    targetObjectId: string;
    /**
     * Type of the target object
     */
    targetObjectType: GenAIObjectType;
    /**
     * Title of the target object
     */
    targetObjectTitle: string;
}
/**
 * Tests whether the provided item is a semantic search relationship.
 * @beta
 */
export declare function isSemanticSearchRelationship(item: object): item is ISemanticSearchRelationship;
//# sourceMappingURL=semanticSearch.d.ts.map