import * as z from "zod/v3"; import { Result as SafeParseResult } from "../../types/fp.js"; import { SDKValidationError } from "../errors/sdkvalidationerror.js"; import { ClusterGroup, ClusterGroup$Outbound } from "./clustergroup.js"; import { ClusterTypeEnum } from "./clustertypeenum.js"; import { Document, Document$Outbound } from "./document.js"; import { PinDocument, PinDocument$Outbound } from "./pindocument.js"; import { QuerySuggestion, QuerySuggestion$Outbound } from "./querysuggestion.js"; import { QuerySuggestionList, QuerySuggestionList$Outbound } from "./querysuggestionlist.js"; import { RelatedDocuments, RelatedDocuments$Outbound } from "./relateddocuments.js"; import { SearchResultProminenceEnum } from "./searchresultprominenceenum.js"; import { SearchResultSnippet, SearchResultSnippet$Outbound } from "./searchresultsnippet.js"; import { StructuredResult, StructuredResult$Outbound } from "./structuredresult.js"; export type SearchResult = { /** * An array of entities in the work graph retrieved via a data request. */ structuredResults?: Array | undefined; /** * An opaque token that represents this particular result in this particular query. To be used for /feedback reporting. */ trackingToken?: string | undefined; document?: Document | undefined; title?: string | undefined; url: string; /** * A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...). */ nativeAppUrl?: string | undefined; /** * Text content from the result document which contains search query terms, if available. */ snippets?: Array | undefined; /** * The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack). */ fullText?: string | undefined; /** * The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack). */ fullTextList?: Array | undefined; /** * A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP. */ relatedResults?: Array | undefined; /** * A list of results that should be displayed as associated with this result. */ clusteredResults?: Array | undefined; /** * A list of results that should be displayed as associated with this result. */ allClusteredResults?: Array | undefined; /** * The total number of attachments. */ attachmentCount?: number | undefined; /** * A (potentially partial) list of results representing documents attached to the main result document. */ attachments?: Array | undefined; /** * A list of results that should be displayed as backlinks of this result in reverse chronological order. */ backlinkResults?: Array | undefined; /** * The reason for inclusion of clusteredResults. */ clusterType?: ClusterTypeEnum | undefined; mustIncludeSuggestions?: QuerySuggestionList | undefined; querySuggestion?: QuerySuggestion | undefined; /** * The level of visual distinction that should be given to a result. * * @remarks */ prominence?: SearchResultProminenceEnum | undefined; /** * Additional context for the relationship between the result and the document it's attached to. */ attachmentContext?: string | undefined; /** * A list of pins associated with this search result. */ pins?: Array | undefined; }; /** @internal */ export declare const SearchResult$inboundSchema: z.ZodType; /** @internal */ export type SearchResult$Outbound = { structuredResults?: Array | undefined; trackingToken?: string | undefined; document?: Document$Outbound | undefined; title?: string | undefined; url: string; nativeAppUrl?: string | undefined; snippets?: Array | undefined; fullText?: string | undefined; fullTextList?: Array | undefined; relatedResults?: Array | undefined; clusteredResults?: Array | undefined; allClusteredResults?: Array | undefined; attachmentCount?: number | undefined; attachments?: Array | undefined; backlinkResults?: Array | undefined; clusterType?: string | undefined; mustIncludeSuggestions?: QuerySuggestionList$Outbound | undefined; querySuggestion?: QuerySuggestion$Outbound | undefined; prominence?: string | undefined; attachmentContext?: string | undefined; pins?: Array | undefined; }; /** @internal */ export declare const SearchResult$outboundSchema: z.ZodType; export declare function searchResultToJSON(searchResult: SearchResult): string; export declare function searchResultFromJSON(jsonString: string): SafeParseResult; //# sourceMappingURL=searchresult.d.ts.map