import * as z from "zod/v3"; import { OpenEnum } from "../../types/enums.js"; import { Result as SafeParseResult } from "../../types/fp.js"; import { SDKValidationError } from "../errors/sdkvalidationerror.js"; import { Document, Document$Outbound } from "./document.js"; import { QuerySuggestion, QuerySuggestion$Outbound } from "./querysuggestion.js"; import { SearchResult, SearchResult$Outbound } from "./searchresult.js"; /** * How this document relates to the including entity. */ export declare const Relation: { readonly Attachment: "ATTACHMENT"; /** * Canonical documents for the entity, such as overview docs, architecture docs elastic. */ readonly Canonical: "CANONICAL"; readonly Case: "CASE"; readonly ContactLower: "contact"; readonly ContactUpper: "CONTACT"; readonly ConversationMessages: "CONVERSATION_MESSAGES"; readonly Expert: "EXPERT"; readonly From: "FROM"; readonly Highlight: "HIGHLIGHT"; readonly OpportunityLower: "opportunity"; readonly OpportunityUpper: "OPPORTUNITY"; readonly Recent: "RECENT"; readonly Source: "SOURCE"; readonly Ticket: "TICKET"; readonly Transcript: "TRANSCRIPT"; readonly With: "WITH"; }; /** * How this document relates to the including entity. */ export type Relation = OpenEnum; export type RelatedDocuments = { /** * How this document relates to the including entity. */ relation?: Relation | undefined; /** * Which entity in the response that this entity relates to. Relevant when there are multiple entities associated with the response (such as merged customers) */ associatedEntityId?: string | undefined; querySuggestion?: QuerySuggestion | undefined; /** * A truncated list of documents with this relation. TO BE DEPRECATED. * * @deprecated field: Deprecated on 2026-02-05, removal scheduled for 2026-10-15: Field is deprecated. */ documents?: Array | undefined; /** * A truncated list of documents associated with this relation. To be used in favor of `documents` because it contains a trackingToken. */ results?: Array | undefined; }; /** @internal */ export declare const Relation$inboundSchema: z.ZodType; /** @internal */ export declare const Relation$outboundSchema: z.ZodType; /** @internal */ export declare const RelatedDocuments$inboundSchema: z.ZodType; /** @internal */ export type RelatedDocuments$Outbound = { relation?: string | undefined; associatedEntityId?: string | undefined; querySuggestion?: QuerySuggestion$Outbound | undefined; documents?: Array | undefined; results?: Array | undefined; }; /** @internal */ export declare const RelatedDocuments$outboundSchema: z.ZodType; export declare function relatedDocumentsToJSON(relatedDocuments: RelatedDocuments): string; export declare function relatedDocumentsFromJSON(jsonString: string): SafeParseResult; //# sourceMappingURL=relateddocuments.d.ts.map