copyleaks

type AIGeneratedText struct {
	// Detect detects whether the text was written by AI.
	Detect bool `json:"detect"`
	// Sensitivity is 1 to 3; see AITextDetectionRequest.Sensitivity. Zero keeps the default.
	Sensitivity int `json:"sensitivity,omitempty"`
	// Explain adds AI Logic, an explanation of the detection, for the languages that support it.
	Explain *AIGeneratedTextExplain `json:"explain,omitempty"`
}

type AIGeneratedTextExplain struct {
	// Enable turns AI Logic on.
	Enable bool `json:"enable"`
}

type AIImageAsyncSubmission struct {
	// URL is the public address of the image to check (required).
	URL string `json:"url"`
	// FileName is the image name (required), up to 254 characters; see AIImageDetectionRequest.Filename.
	FileName string `json:"fileName"`
	// Model is the detection model, such as AIImageModel1Ultra (required).
	Model string `json:"model"`
	// MaskType is AIImageMaskBinary (default) or AIImageMaskHeatmap.
	MaskType string `json:"maskType,omitempty"`
	// ObjectDetection lists up to 3 objects to locate; see AIImageDetectionRequest.ObjectDetection.
	ObjectDetection []AIImageObject `json:"objectDetection,omitempty"`
	// Headers are the headers that Copyleaks sends to fetch URL, as [name, value] pairs.
	Headers [][]string `json:"headers,omitempty"`
	// Webhooks is where Copyleaks sends the result (required); see ParseAIImageWebhook.
	Webhooks ResultWebhook `json:"webhooks"`
	// Sandbox runs a free test check that returns mock results.
	Sandbox bool `json:"sandbox,omitempty"`
	// DeveloperPayload is sent back with the result; up to 511 characters.
	DeveloperPayload string `json:"developerPayload,omitempty"`
}

type AIImageDetectedObject struct {
	// Object is the name of the object, as in the request.
	Object string `json:"object"`
	// Mask is the run-length encoded mask of the object, over the pixels flattened row by row.
	Mask *AIImageDetectionResult `json:"mask"`
}

type AIImageDetectionRequest struct {
	// Base64 is the image, base64-encoded (required): 512x512 pixels to 27 megapixels, under 32 MB.
	Base64 string `json:"base64"`
	// Filename is the image name (required), 5 to 254 characters, ending with .png, .bmp, .jpg, .jpeg, .webp,
	// .heic, .heif or .avif.
	Filename string `json:"filename"`
	// Model is the detection model, such as AIImageModel1Ultra (required).
	Model string `json:"model"`
	// Sandbox runs a free test check that returns mock results.
	Sandbox bool `json:"sandbox,omitempty"`
	// MaskType is AIImageMaskBinary (default), AIImageMaskHeatmap or AIImageMaskNone.
	MaskType string `json:"maskType,omitempty"`
	// ObjectDetection lists up to 3 objects to locate, such as "face", at no extra cost; see
	// AIImageDetectionResponse.DetectedObjects. It is a pointer, so that AIImageDetectionRequest stays comparable.
	ObjectDetection *[]AIImageObject `json:"objectDetection,omitempty"`
}

type AIImageDetectionResponse struct {
	// Model is the detection model that was used.
	Model string `json:"model"`
	// Result is the run-length encoded mask of the AI-generated regions, over the pixels flattened row by row.
	Result *AIImageDetectionResult `json:"result"`
	// Summary is the share of pixels detected as human-made and as AI-generated.
	Summary *AIImageDetectionSummary `json:"summary"`
	// IsAIDetected reports whether AI-generated content was detected in the image.
	IsAIDetected bool `json:"isAiDetected"`
	// ImageInfo is information about the image.
	ImageInfo *AIImageInfo `json:"imageInfo"`
	// ScannedDocument is general information about the check; TotalWords and TotalExcluded are not used.
	ScannedDocument *ScannedDocument `json:"scannedDocument"`
	// DetectedObjects are the requested objects that were found, each with its mask; look them up by Object.
	// Nil without ObjectDetection. It is a pointer, so that AIImageDetectionResponse stays comparable.
	DetectedObjects *[]AIImageDetectedObject `json:"detectedObjects"`
	// DeveloperPayload is the DeveloperPayload of an AIImageAsyncSubmission, when the webhook carries it.
	DeveloperPayload string `json:"developerPayload,omitempty"`
	// Error tells why a SubmitAIImageAsync check failed; when it is set, only Error and DeveloperPayload are
	// filled. DetectAIImage and DetectAIImageUpload return an *APIError instead.
	Error *WebhookError `json:"error,omitempty"`
}

type AIImageDetectionResult struct {
	// Starts are the start positions of the AI-generated runs.
	Starts []int `json:"starts"`
	// Lengths are the lengths of the AI-generated runs, one per start position.
	Lengths []int `json:"lengths"`
	// Labels are the confidence bands of the runs, 0 (lowest) to 4 (highest); only for AIImageMaskHeatmap.
	Labels []int `json:"labels,omitempty"`
}

type AIImageDetectionSummary struct {
	// Human is the share of human-made pixels.
	Human float64 `json:"human"`
	// AI is the share of AI-generated pixels.
	AI float64 `json:"ai"`
}

type AIImageInfo struct {
	// Shape is the size of the image.
	Shape *AIImageShape `json:"shape"`
	// Metadata is metadata read from the image, when it has any.
	Metadata *AIImageMetadata `json:"metadata"`
}

type AIImageMetadata struct {
	// IssuedTime is when the image was created.
	IssuedTime string `json:"issuedTime"`
	// IssuedBy is the AI service or tool that created the image.
	IssuedBy string `json:"issuedBy"`
	// AppOrDeviceUsed is the application or device that created the image.
	AppOrDeviceUsed string `json:"appOrDeviceUsed"`
	// ContentSummary describes how the content was created.
	ContentSummary string `json:"contentSummary"`
}

type AIImageObject struct {
	// Object names the object, 1 to 32 characters.
	Object string `json:"object"`
}

type AIImageShape struct {
	// Height is the height of the image.
	Height int `json:"height"`
	// Width is the width of the image.
	Width int `json:"width"`
}

type AIImageUploadRequest struct {
	// Image is the image file (required), with the limits of AIImageDetectionRequest.Base64.
	Image []byte
	// Filename is the image name (required); see AIImageDetectionRequest.Filename.
	Filename string
	// Model is the detection model, such as AIImageModel1Ultra (required).
	Model string
	// Sandbox runs a free test check that returns mock results.
	Sandbox bool
	// MaskType is the kind of mask; see AIImageDetectionRequest.MaskType.
	MaskType string
	// ObjectDetection lists up to 3 objects to locate; see AIImageDetectionRequest.ObjectDetection.
	ObjectDetection []AIImageObject
}

type AISourceMatch struct {
	// Enable turns AI Source Match on. The server default is false.
	Enable bool `json:"enable"`
}

type AITextCreditsBalance struct {
	// Credits is the number of remaining credits.
	Credits int `json:"credits"`
}

type AITextDetectionExplain struct {
	// Patterns are the AI patterns found in the text.
	Patterns *AITextDetectionPatterns `json:"patterns"`
}

type AITextDetectionMatch struct {
	// Text locates the section in the plain text.
	Text *AITextLocation `json:"text"`
	// HTML locates the section in the HTML source, for HTML submissions.
	HTML *AITextLocation `json:"html"`
}

type AITextDetectionPatterns struct {
	// Statistics are statistics of each pattern.
	Statistics *AITextPatternStatistics `json:"statistics"`
	// Text locates the patterns in the plain text.
	Text *AITextLocation `json:"text"`
	// HTML locates the patterns in the HTML source, for HTML submissions.
	HTML *AITextLocation `json:"html"`
}

type AITextDetectionRequest struct {
	// Text is the text to check, 255 to 100,000 characters (required).
	Text string `json:"text"`
	// Sandbox runs a free test check that returns mock results.
	Sandbox bool `json:"sandbox,omitempty"`
	// Language is the ISO 639-1 code of the text, such as "en"; empty lets the server detect it.
	Language string `json:"language,omitempty"`
	// Explain asks for AI Logic, an explanation of the detection, for the languages that support it.
	Explain bool `json:"explain,omitempty"`
	// Sensitivity is 1 to 3; higher also catches more heavily edited AI text. Nil keeps 2. Set it with Ptr.
	Sensitivity *int `json:"sensitivity,omitempty"`
}

type AITextDetectionResponse struct {
	// ModelVersion is the version of the detection model.
	ModelVersion string `json:"modelVersion"`
	// Results are the classified sections of the text.
	Results []AITextDetectionResult `json:"results"`
	// Summary is the share of the text classified as human-written and as AI-generated.
	Summary *AITextDetectionSummary `json:"summary"`
	// TranslationProvider is the machine translation provider used before the detection; 0 if not translated.
	TranslationProvider int `json:"translationProvider"`
	// Translation is the machine-translated English text, when the text was translated.
	Translation string `json:"translation"`
	// Explain is AI Logic, when AITextDetectionRequest.Explain was set.
	Explain *AITextDetectionExplain `json:"explain"`
	// ScannedDocument is general information about the check.
	ScannedDocument *ScannedDocument `json:"scannedDocument"`
	// ScanType is "sandbox" for sandbox checks and empty otherwise.
	ScanType string `json:"scanType"`
}

type AITextDetectionResult struct {
	// Classification is 1 for human-written text and 2 for AI-generated text.
	Classification int `json:"classification"`
	// Probability is the confidence of the classification, or 0 when the server leaves it out.
	//
	// Deprecated: The API reference deprecates it. Use Classification and AITextDetectionResponse.Summary.
	Probability float64 `json:"probability"`
	// Matches are the locations of the section in the text.
	Matches []AITextDetectionMatch `json:"matches"`
}

type AITextDetectionSummary struct {
	// Human is the share of human-written text.
	Human float64 `json:"human"`
	// AI is the share of AI-generated text.
	AI float64 `json:"ai"`
}

type AITextLocation struct {
	// Chars are character positions.
	Chars *AITextPositions `json:"chars"`
	// Words are word positions.
	Words *AITextPositions `json:"words"`
}

type AITextPatternStatistics struct {
	// AICount is how often each pattern appears in AI-generated text.
	AICount []float64 `json:"aiCount"`
	// HumanCount is how often each pattern appears in human-written text.
	HumanCount []float64 `json:"humanCount"`
	// Proportion is the ratio between the AI and the human frequency of each pattern.
	Proportion []float64 `json:"proportion"`
	// Source is the source of each pattern: 1 for AI, 2 for a humanizer.
	Source []int `json:"source"`
}

type AITextPositions struct {
	// Starts are the start positions of the segments.
	Starts []int `json:"starts"`
	// Lengths are the lengths of the segments, one per start position.
	Lengths []int `json:"lengths"`
	// GroupIDs are the HTML group IDs of the segments, for HTML positions.
	GroupIDs []int `json:"groupIds,omitempty"`
}

type AIVideoDetectionResponse struct {
	// Model is the detection model that was used.
	Model string `json:"model"`
	// AudioResult are the AI-generated segments of the audio track.
	AudioResult *AIVideoTrackResult `json:"audioResult"`
	// VisualResult are the AI-generated segments of the visual track.
	VisualResult *AIVideoTrackResult `json:"visualResult"`
	// Summary is the share of the video detected as AI-generated.
	Summary *AIVideoDetectionSummary `json:"summary"`
	// IsAIDetected reports whether the video contains AI-generated content; prefer it to the Summary ratios.
	IsAIDetected bool `json:"isAiDetected"`
	// VideoInfo is information about the video.
	VideoInfo *AIVideoInfo `json:"videoInfo"`
	// ScannedVideo is general information about the check.
	ScannedVideo *ScannedVideo `json:"scannedVideo"`
	// DeveloperPayload is the DeveloperPayload of the submit, when the webhook carries it.
	DeveloperPayload string `json:"developerPayload,omitempty"`
	// Error tells why the check failed; when it is set, only Error and DeveloperPayload are filled.
	Error *WebhookError `json:"error,omitempty"`
}

type AIVideoDetectionSummary struct {
	// AudioAIRatio is the share of the audible duration detected as AI-generated.
	AudioAIRatio float64 `json:"audioAIRatio"`
	// VisualAIRatio is the share of the visible duration detected as AI-generated.
	VisualAIRatio float64 `json:"visualAIRatio"`
	// OverallAIRatio is the share of the whole video detected as AI-generated, over both tracks.
	OverallAIRatio float64 `json:"overallAIRatio"`
}

type AIVideoInfo struct {
	// Duration is the duration of the video, in seconds.
	Duration float64 `json:"duration"`
	// Metadata is metadata read from the video, such as C2PA provenance data, when it has any.
	Metadata *AIVideoMetadata `json:"metadata"`
}

type AIVideoMetadata struct {
	// IssuedTime is when the video was created.
	IssuedTime string `json:"issuedTime"`
	// IssuedBy is the AI service or tool that created the video.
	IssuedBy string `json:"issuedBy"`
	// AppOrDeviceUsed is the application or device that created the video.
	AppOrDeviceUsed string `json:"appOrDeviceUsed"`
	// ContentSummary describes how the video was created.
	ContentSummary string `json:"contentSummary"`
}

type AIVideoRanges struct {
	// Starts are the start positions of the segments.
	Starts []int `json:"starts"`
	// Lengths are the durations of the segments, one per start position.
	Lengths []int `json:"lengths"`
}

type AIVideoSubmission struct {
	// URL is the public address of the video to check (required).
	URL string `json:"url"`
	// Headers are the headers that Copyleaks sends to fetch URL, as [name, value] pairs.
	Headers [][]string `json:"headers,omitempty"`
	// Verb is the HTTP method used to fetch URL: "GET" (default), "POST" or "PUT".
	Verb string `json:"verb,omitempty"`
	// Filename is the video name (required), up to 254 characters, ending with .mp4, .avi, .mov, .mkv, .webm,
	// .flv, .wmv, .mpg, .m4v, .3gp or .mxf.
	Filename string `json:"filename"`
	// Model is the detection model, such as AIVideoModel1Pro (required).
	Model string `json:"model"`
	// Webhooks is where Copyleaks sends the result (required); see ParseAIVideoWebhook.
	Webhooks ResultWebhook `json:"webhooks"`
	// Sandbox runs a free test check that returns mock results.
	Sandbox bool `json:"sandbox,omitempty"`
	// DeveloperPayload is sent back with the result; up to 511 characters.
	DeveloperPayload string `json:"developerPayload,omitempty"`
}

type AIVideoTrackResult struct {
	// Starts are the start positions of the AI-generated segments.
	Starts []int `json:"starts"`
	// Lengths are the durations of the AI-generated segments, one per start position.
	Lengths []int `json:"lengths"`
	// Exclude are the segments that were not scored, and do not count in the ratios.
	Exclude *AIVideoRanges `json:"exclude"`
}

type APIError struct {
	// StatusCode is the HTTP status code of the response.
	StatusCode int
	// Method is the HTTP method of the request.
	Method string
	// Endpoint is the URL path of the request, such as "/v3/scans/submit/file/my-scan".
	Endpoint string
	// Body is the response body, up to 1 MiB. The server usually explains the error here.
	Body []byte
	// RetryAfter is the Retry-After delay of the response, or 0 without one; mostly set on HTTP 429 and 503.
	RetryAfter time.Duration
}

type Alert struct {
	// Category is the alert category; 2 is AI Text Detection.
	Category int `json:"category"`
	// Code identifies the alert, such as AlertCodeSuspectedAIText.
	Code string `json:"code"`
	// Title is a human-readable title.
	Title string `json:"title"`
	// Message is a human-readable description.
	Message string `json:"message"`
	// HelpLink links to a description of the alert. Not every alert has one.
	HelpLink string `json:"helpLink"`
	// Severity is the importance of the alert, from 0 (very low) to 4 (very high).
	Severity int `json:"severity"`
	// AdditionalData is extra data as a JSON string; decode a suspected-ai-text alert's with AIDetectionResult.
	AdditionalData string `json:"additionalData"`
}

type AllowedCrossLanguages struct {
	// DocumentLanguages are the languages that a scanned document can be in.
	DocumentLanguages LanguageCodes `json:"documentLanguages"`
	// ResultLanguages are the languages that the document can be compared against.
	ResultLanguages LanguageCodes `json:"resultLanguages"`
}

type Assignment struct {
	// ID is a unique identifier of the assignment.
	ID string `json:"id,omitempty"`
}

type AuthToken struct {
	// AccessToken is the bearer token sent in the Authorization header.
	AccessToken string `json:"access_token"`
	// Issued is when the token was issued.
	Issued time.Time `json:".issued"`
	// Expires is when the token expires.
	Expires time.Time `json:".expires"`
}

type Author struct {
	// ID is a unique identifier of the author.
	ID string `json:"id,omitempty"`
}

type Client struct {
	// contains filtered or unexported fields
}

type ComparisonLocation struct {
	// Chars are the character positions of the matches.
	Chars *TextRanges `json:"chars"`
	// Words are the word positions of the matches.
	Words *TextRanges `json:"words"`
}

type ComparisonMatches struct {
	// GroupID are the HTML group IDs of the matches, in the HTML comparison only.
	GroupID []int `json:"groupId,omitempty"`
	// Source locates the matches in the result source.
	Source *ComparisonLocation `json:"source"`
	// Suspected locates the matches in the scanned document.
	Suspected *ComparisonLocation `json:"suspected"`
}

type CompletedWebhook struct {
	// Status is the scan status: 0 for success.
	Status int `json:"status"`
	// DeveloperPayload is the ScanProperties.DeveloperPayload of the scan.
	DeveloperPayload string `json:"developerPayload"`
	// ScannedDocument is general information about the scanned document.
	ScannedDocument *WebhookScannedDocument `json:"scannedDocument"`
	// Results are the results that were found, by source, and the aggregated score.
	Results *Results `json:"results"`
	// Notifications are the scan alerts.
	Notifications *Notifications `json:"notifications"`
	// ReferencesValidation is the Citation Checker summary; per-reference results are in
	// ExportedCrawledVersion.ReferencesValidation.
	ReferencesValidation *ReferencesValidation `json:"referencesValidation"`
	// WritingFeedback is the Grammar Checker summary; export the full report with ExportRequest.WritingFeedback.
	WritingFeedback *WebhookWritingFeedback `json:"writingFeedback"`
}

type CopyleaksDB struct {
	// IncludeMySubmissions compares against content that you added to the Shared Data Hub.
	IncludeMySubmissions bool `json:"includeMySubmissions,omitempty"`
	// IncludeOthersSubmissions compares against content that other users added to the Shared Data Hub.
	IncludeOthersSubmissions bool `json:"includeOthersSubmissions,omitempty"`
}

type CorrectionType struct {
	// ID is the correction type ID, as used in GrammarCorrectionRanges.Types.
	ID int `json:"id"`
	// Category is the ID of the correction category.
	Category int `json:"category"`
	// Title is the name of the correction type.
	Title string `json:"title"`
	// Message is a short message about the correction.
	Message string `json:"message"`
	// Description describes the correction type.
	Description string `json:"description"`
}

type CorrectionTypes struct {
	// CorrectionTypes are the correction types.
	CorrectionTypes []CorrectionType `json:"correctionTypes"`
}

type Course struct {
	// ID is a unique identifier of the course.
	ID string `json:"id,omitempty"`
}

type CrawledVersionHTML struct {
	// Value is the HTML.
	Value string `json:"value"`
	// Exclude are the parts of the HTML that were not scanned.
	Exclude *ExcludedRanges `json:"exclude"`
}

type CrawledVersionMetadata struct {
	// Words is the number of words.
	Words int `json:"words"`
	// Excluded is the number of excluded words.
	Excluded int `json:"excluded"`
}

type CrawledVersionText struct {
	// Value is the text.
	Value string `json:"value"`
	// Exclude are the parts of the text that were not scanned.
	Exclude *ExcludedRanges `json:"exclude"`
	// Pages are the pages of the text.
	Pages *TextPages `json:"pages"`
}

type CreditsBalance struct {
	// Amount is the number of remaining credits. A credit covers up to 250 words.
	Amount int `json:"Amount"`
}

type CreditsCheckedWebhook struct {
	// Status is the scan status: 2 for credits checked.
	Status int `json:"status"`
	// DeveloperPayload is the ScanProperties.DeveloperPayload of the scan.
	DeveloperPayload string `json:"developerPayload"`
	// Credits is the cost of the scan, if you start it with Client.Start.
	Credits int `json:"credits"`
	// ScannedDocument is general information about the scanned document.
	ScannedDocument *WebhookScannedDocument `json:"scannedDocument"`
}

type CrossLanguage struct {
	// Code is the language code, such as "fr".
	Code string `json:"code"`
}

type CrossLanguages struct {
	// Languages are the languages to compare the content against, besides its own.
	Languages []CrossLanguage `json:"languages"`
}

type CustomMetadata struct {
	// Key is the name of the property.
	Key string `json:"key"`
	// Value is the value of the property.
	Value string `json:"value"`
}

type DatabaseResult struct {
	// ID is the result ID, used by Client.Export.
	ID string `json:"id"`
	// Title is the title of the source.
	Title string `json:"title"`
	// Introduction is a short introduction of the source.
	Introduction string `json:"introduction"`
	// MatchedWords is the number of words that match the scanned document.
	MatchedWords int `json:"matchedWords"`
	// ScanID is the scan ID of the source, when you submitted it.
	ScanID string `json:"scanId"`
	// Metadata is metadata of the source.
	Metadata *ResultMetadata `json:"metadata"`
	// Tags are the tags of the result.
	Tags []ResultTag `json:"tags"`
}

type DeleteRequest struct {
	// Scans are the completed scans to delete, up to 10,000 (required).
	Scans []DeleteScan `json:"scans"`
	// Purge also removes the scans from the Shared Data Hub and Private Cloud Hubs, so they never match again.
	Purge bool `json:"purge,omitempty"`
	// CompletionWebhook is called with a POST request, without a body, when the deletion is done.
	CompletionWebhook string `json:"completionWebhook,omitempty"`
	// Headers are extra headers of the CompletionWebhook request, as [name, value] pairs.
	Headers [][]string `json:"headers,omitempty"`
}

type DeleteScan struct {
	// ID is the scan ID.
	ID string `json:"id"`
}

type DomainsMode int

type ErrorWebhook struct {
	// Status is the scan status: 1 for error.
	Status int `json:"status"`
	// DeveloperPayload is the ScanProperties.DeveloperPayload of the scan.
	DeveloperPayload string `json:"developerPayload"`
	// Error describes the error.
	Error *WebhookError `json:"error"`
}

type Exclude struct {
	// Quotes excludes quoted text.
	Quotes bool `json:"quotes,omitempty"`
	// Citations excludes citations.
	Citations bool `json:"citations,omitempty"`
	// References excludes referenced text.
	References bool `json:"references,omitempty"`
	// TableOfContents excludes the table of contents.
	TableOfContents bool `json:"tableOfContents,omitempty"`
	// Titles excludes the titles of an HTML document.
	Titles bool `json:"titles,omitempty"`
	// HTMLTemplate excludes text that repeats across the pages of a site, such as the header and the footer.
	HTMLTemplate bool `json:"htmlTemplate,omitempty"`
	// DocumentTemplateIDs excludes the template text found in up to three other scans.
	DocumentTemplateIDs []string `json:"documentTemplateIds,omitempty"`
	// Code sets what is excluded from source code files.
	Code *ExcludeCode `json:"code,omitempty"`
}

type ExcludeCode struct {
	// Comments excludes code comments.
	Comments bool `json:"comments,omitempty"`
}

type ExcludedRanges struct {
	// Starts are the start positions of the parts.
	Starts []int `json:"starts"`
	// Lengths are the lengths of the parts, in characters.
	Lengths []int `json:"lengths"`
	// Reasons are the reasons why the parts were excluded.
	Reasons []int `json:"reasons"`
	// GroupIDs are the HTML group IDs of the parts, in the HTML version only.
	GroupIDs []int `json:"groupIds,omitempty"`
}

type ExportCompletedWebhook struct {
	// Completed reports whether the export finished without internal errors.
	Completed bool `json:"completed"`
	// DeveloperPayload is the ExportRequest.DeveloperPayload of the export.
	DeveloperPayload string `json:"developerPayload"`
	// Tasks are the uploads of the export.
	Tasks []ExportTask `json:"tasks"`
}

type ExportRequest struct {
	// CompletionWebhook is called when the export is done (required); see ParseExportCompletedWebhook.
	CompletionWebhook string `json:"completionWebhook"`
	// CompletionWebhookHeaders are extra headers of the CompletionWebhook request, as [name, value] pairs.
	CompletionWebhookHeaders [][]string `json:"completionWebhookHeaders,omitempty"`
	// MaxRetries is how many times each upload is retried, 1 to 12 (default 3).
	MaxRetries int `json:"maxRetries,omitempty"`
	// DeveloperPayload is sent back in the export-completed webhook.
	DeveloperPayload string `json:"developerPayload,omitempty"`
	// Results are the results to export, by result ID from the completed webhook; see ParseExportedResult.
	Results []ExportResult `json:"results,omitempty"`
	// PDFReport exports the PDF report. It requires ScanProperties.PDF.Create on submit.
	PDFReport *ExportTarget `json:"pdfReport,omitempty"`
	// CrawledVersion exports the crawled version of the submitted content; see ParseExportedCrawledVersion.
	CrawledVersion *ExportTarget `json:"crawledVersion,omitempty"`
	// AIDetection exports the AI Text Detection report, with AI Logic when it was on. It requires
	// ScanProperties.AIGeneratedText.Detect on submit. See ParseExportedAIDetection.
	AIDetection *ExportTarget `json:"aiDetection,omitempty"`
	// WritingFeedback exports the Grammar Checker report; it requires ScanProperties.WritingFeedback.Enable.
	// See ParseExportedWritingFeedback.
	WritingFeedback *ExportTarget `json:"writingFeedback,omitempty"`
	// Overview exports the Gen-AI Overview. It requires ScanProperties.Overview.Enable on submit.
	// See ParseExportedOverview.
	Overview *ExportTarget `json:"overview,omitempty"`
}

type ExportResult struct {
	// ID is the result ID, from the completed webhook (required).
	ID string `json:"id"`
	// Endpoint is the URL to upload the result to (required).
	Endpoint string `json:"endpoint"`
	// Verb is the HTTP method of the upload, such as "POST" (required).
	Verb string `json:"verb"`
	// Headers are extra headers of the upload, as [name, value] pairs.
	Headers [][]string `json:"headers,omitempty"`
}

type ExportTarget struct {
	// Endpoint is the URL to upload the artifact to (required).
	Endpoint string `json:"endpoint"`
	// Verb is the HTTP method of the upload, such as "POST" (required).
	Verb string `json:"verb"`
	// Headers are extra headers of the upload, as [name, value] pairs.
	Headers [][]string `json:"headers,omitempty"`
}

type ExportTask struct {
	// Endpoint is the URL that the artifact was uploaded to.
	Endpoint string `json:"endpoint"`
	// IsHealthy reports whether the upload succeeded.
	IsHealthy bool `json:"isHealthy"`
	// HTTPStatusCode is the status code that your server answered with.
	HTTPStatusCode int `json:"httpStatusCode"`
}

type ExportedCrawledVersion struct {
	// Metadata counts the words of the document.
	Metadata *CrawledVersionMetadata `json:"metadata"`
	// Text is the document as plain text.
	Text *CrawledVersionText `json:"text"`
	// HTML is the document as HTML, when the scan set ScanProperties.IncludeHTML.
	HTML *CrawledVersionHTML `json:"html"`
	// ReferencesValidation is the Citation Checker result, when the scan set ScanProperties.References.Validate.
	ReferencesValidation *ReferencesValidation `json:"referencesValidation"`
}

type ExportedOverview struct {
	// Overview is the overview of the scan, in Markdown.
	Overview string `json:"overview"`
	// ModelVersion is the version of the model that wrote the overview.
	ModelVersion string `json:"modelVersion"`
}

type ExportedResult struct {
	// Statistics count the matching words, by kind of match.
	Statistics *ExportedResultStatistics `json:"statistics"`
	// Text is the source as plain text, with the matches.
	Text *ExportedResultText `json:"text"`
	// HTML is the source as HTML, with the matches, when the scan set ScanProperties.IncludeHTML.
	HTML *ExportedResultHTML `json:"html"`
}

type ExportedResultHTML struct {
	// Value is the HTML of the source.
	Value string `json:"value"`
	// Comparison locates the matches, by kind of match.
	Comparison *ResultComparison `json:"comparison"`
}

type ExportedResultStatistics struct {
	// Identical is the number of identical words.
	Identical int `json:"identical"`
	// MinorChanges is the number of nearly identical words, such as slow and slowly.
	MinorChanges int `json:"minorChanges"`
	// RelatedMeaning is the number of paraphrased words.
	RelatedMeaning int `json:"relatedMeaning"`
}

type ExportedResultText struct {
	// Value is the text of the source.
	Value string `json:"value"`
	// Pages are the pages of the text.
	Pages *TextPages `json:"pages"`
	// Comparison locates the matches, by kind of match.
	Comparison *ResultComparison `json:"comparison"`
}

type FileSubmission struct {
	// Base64 is the file, base64-encoded; set it or Content. To scan plain text, encode the text.
	Base64 string `json:"base64"`
	// Filename is the name of the file with its extension, up to 255 characters (required).
	Filename string `json:"filename"`
	// Properties configures the scan (required).
	Properties ScanProperties `json:"properties"`
	// Content is the raw file; set it or Base64. The SDK encodes it while building the request, which needs less
	// memory (about 1.4 times the file size) than encoding it into Base64 yourself.
	Content []byte `json:"-"`
}

type Filters struct {
	// IdenticalEnabled matches exact words. The server default is true.
	IdenticalEnabled *bool `json:"identicalEnabled,omitempty"`
	// MinorChangesEnabled matches nearly identical words, such as slow and slowly. The server default is true.
	MinorChangesEnabled *bool `json:"minorChangesEnabled,omitempty"`
	// RelatedMeaningEnabled matches paraphrased content. The server default is true.
	RelatedMeaningEnabled *bool `json:"relatedMeaningEnabled,omitempty"`
	// MinCopiedWords only keeps results with at least this many copied words.
	MinCopiedWords int `json:"minCopiedWords,omitempty"`
	// SafeSearch blocks explicit adult content from the results.
	SafeSearch bool `json:"safeSearch,omitempty"`
	// Domains are domains to include in or exclude from the results; see DomainsMode.
	Domains []string `json:"domains,omitempty"`
	// DomainsMode sets whether Domains are included or excluded.
	DomainsMode *DomainsMode `json:"domainsMode,omitempty"`
	// AllowSameDomain allows results from the domain of the submitted URL.
	AllowSameDomain bool `json:"allowSameDomain,omitempty"`
}

type GrammarCheckRequest struct {
	// Text is the text to check, up to 25,000 characters (required).
	Text string `json:"text"`
	// Sandbox runs a free test check that returns mock results.
	Sandbox bool `json:"sandbox,omitempty"`
	// Language is the language code of the text, such as "en"; empty lets the server detect it.
	Language string `json:"language,omitempty"`
	// Score sets the weight of each correction category in the overall score.
	Score *GrammarScoreWeights `json:"score,omitempty"`
}

type GrammarCheckResponse struct {
	// Score holds the writing scores, the readability and statistics of the text.
	Score *GrammarScore `json:"score"`
	// Corrections are the suggested corrections.
	Corrections *GrammarCorrections `json:"corrections"`
	// ScannedDocument is general information about the check.
	ScannedDocument *ScannedDocument `json:"scannedDocument"`
	// ScanType is "sandbox" for sandbox checks and empty otherwise.
	ScanType string `json:"scanType"`
}

type GrammarCorrectionRanges struct {
	// Types are the correction type IDs; see Client.GrammarCorrectionTypes.
	Types []int `json:"types"`
	// Starts are the start positions of the corrected segments.
	Starts []int `json:"starts"`
	// Lengths are the lengths of the corrected segments.
	Lengths []int `json:"lengths"`
	// OperationTexts are the suggested replacement texts.
	OperationTexts []string `json:"operationTexts"`
}

type GrammarCorrections struct {
	// Text holds the corrections of the plain text.
	Text *GrammarCorrectionsText `json:"text"`
}

type GrammarCorrectionsText struct {
	// Chars are the corrections, by character position.
	Chars *GrammarCorrectionRanges `json:"chars"`
}

type GrammarReadability struct {
	// Score is the readability score.
	Score int `json:"score"`
	// ReadabilityLevel is the readability level.
	ReadabilityLevel int `json:"readabilityLevel"`
	// ReadabilityLevelText is the readability level as text, such as "10th to 12th Grader".
	ReadabilityLevelText string `json:"readabilityLevelText"`
	// ReadabilityLevelDescription describes the readability level, such as "Fairly difficult to read".
	ReadabilityLevelDescription string `json:"readabilityLevelDescription"`
}

type GrammarScore struct {
	// Corrections are the correction counts and scores of each category, and the overall score.
	Corrections *GrammarScoreCorrections `json:"corrections"`
	// Readability is the readability of the text.
	Readability *GrammarReadability `json:"readability"`
	// Statistics are statistics of the text.
	Statistics *GrammarStatistics `json:"statistics"`
}

type GrammarScoreCorrections struct {
	// GrammarCorrectionsCount is the number of grammar corrections.
	GrammarCorrectionsCount int `json:"grammarCorrectionsCount"`
	// GrammarCorrectionsScore is the grammar score.
	GrammarCorrectionsScore int `json:"grammarCorrectionsScore"`
	// GrammarScoreWeight is the weight of the grammar score in the overall score.
	GrammarScoreWeight float64 `json:"grammarScoreWeight"`
	// MechanicsCorrectionsCount is the number of mechanics corrections.
	MechanicsCorrectionsCount int `json:"mechanicsCorrectionsCount"`
	// MechanicsCorrectionsScore is the mechanics score.
	MechanicsCorrectionsScore int `json:"mechanicsCorrectionsScore"`
	// MechanicsScoreWeight is the weight of the mechanics score in the overall score.
	MechanicsScoreWeight float64 `json:"mechanicsScoreWeight"`
	// SentenceStructureCorrectionsCount is the number of sentence structure corrections.
	SentenceStructureCorrectionsCount int `json:"sentenceStructureCorrectionsCount"`
	// SentenceStructureCorrectionsScore is the sentence structure score.
	SentenceStructureCorrectionsScore int `json:"sentenceStructureCorrectionsScore"`
	// SentenceStructureScoreWeight is the weight of the sentence structure score in the overall score.
	SentenceStructureScoreWeight float64 `json:"sentenceStructureScoreWeight"`
	// WordChoiceCorrectionsCount is the number of word choice corrections.
	WordChoiceCorrectionsCount int `json:"wordChoiceCorrectionsCount"`
	// WordChoiceCorrectionsScore is the word choice score.
	WordChoiceCorrectionsScore int `json:"wordChoiceCorrectionsScore"`
	// WordChoiceScoreWeight is the weight of the word choice score in the overall score.
	WordChoiceScoreWeight float64 `json:"wordChoiceScoreWeight"`
	// OverallScore is the overall writing score.
	OverallScore int `json:"overallScore"`
}

type GrammarScoreWeights struct {
	// GrammarScoreWeight is the weight of grammar corrections.
	GrammarScoreWeight *float64 `json:"grammarScoreWeight,omitempty"`
	// MechanicsScoreWeight is the weight of mechanics corrections.
	MechanicsScoreWeight *float64 `json:"mechanicsScoreWeight,omitempty"`
	// SentenceStructureScoreWeight is the weight of sentence structure corrections.
	SentenceStructureScoreWeight *float64 `json:"sentenceStructureScoreWeight,omitempty"`
	// WordChoiceScoreWeight is the weight of word choice corrections.
	WordChoiceScoreWeight *float64 `json:"wordChoiceScoreWeight,omitempty"`
}

type GrammarStatistics struct {
	// SentenceCount is the number of sentences.
	SentenceCount int `json:"sentenceCount"`
	// AverageSentenceLength is the average sentence length, in words.
	AverageSentenceLength float64 `json:"averageSentenceLength"`
	// AverageWordLength is the average word length, in characters.
	AverageWordLength float64 `json:"averageWordLength"`
	// ReadingTimeSeconds is the estimated reading time, in seconds.
	ReadingTimeSeconds float64 `json:"readingTimeSeconds"`
	// SpeakingTimeSeconds is the estimated speaking time, in seconds.
	SpeakingTimeSeconds float64 `json:"speakingTimeSeconds"`
}

type HTMLRanges struct {
	// Starts are the start positions of the ranges.
	Starts []int `json:"starts"`
	// Lengths are the lengths of the ranges, in characters.
	Lengths []int `json:"lengths"`
	// GroupIDs group the ranges of one reference.
	GroupIDs []int `json:"groupIds"`
}

type ImagePlagiarismMatch struct {
	// URL is the address of the matching image.
	URL string `json:"url"`
	// MatchType is ImageMatchFull or ImageMatchPartial.
	MatchType int `json:"matchType"`
	// WebPages are the pages that show the image. It is empty when no page was found.
	WebPages []ImagePlagiarismWebPage `json:"webPages"`
}

type ImagePlagiarismMatches struct {
	// Internet are the matching images, full matches first, each URL once. Empty means no copy was found.
	Internet []ImagePlagiarismMatch `json:"internet"`
	// Score counts the matches.
	Score *ImagePlagiarismScore `json:"score"`
}

type ImagePlagiarismRequest struct {
	// Image is the image file (required), under 20 MB and at most 75 megapixels.
	Image []byte
	// Filename is the image name (required), up to 255 characters: .jpg, .jpeg, .png, .gif, .bmp, .webp or .ico.
	Filename string
	// Sandbox runs a free test check that returns mock results.
	Sandbox bool
	// DeveloperPayload is sent back as it is in ImagePlagiarismResponse.DeveloperPayload.
	DeveloperPayload string
}

type ImagePlagiarismResponse struct {
	// DeveloperPayload is the DeveloperPayload of the request.
	DeveloperPayload string `json:"developerPayload"`
	// ScannedImage is information about the image and the check.
	ScannedImage *ScannedImage `json:"scannedImage"`
	// Matches are the copies of the image found on the web.
	Matches *ImagePlagiarismMatches `json:"matches"`
}

type ImagePlagiarismScore struct {
	// TotalMatches is the number of matching images.
	TotalMatches int `json:"totalMatches"`
	// FullMatches is the number of full matches.
	FullMatches int `json:"fullMatches"`
	// PartialMatches is the number of partial matches.
	PartialMatches int `json:"partialMatches"`
}

type ImagePlagiarismWebPage struct {
	// URL is the address of the page.
	URL string `json:"url"`
}

type IndexedWebhook struct {
	// Status is the scan status: 3 for indexed.
	Status int `json:"status"`
	// DeveloperPayload is the ScanProperties.DeveloperPayload of the scan.
	DeveloperPayload string `json:"developerPayload"`
}

type Indexing struct {
	// Repositories are the Private Cloud Hubs to index the content in.
	Repositories []IndexingRepository `json:"repositories,omitempty"`
	// CopyleaksDB adds the content to the Shared Data Hub. Nil keeps the default: added when Scanning.CopyleaksDB
	// compares it against any submissions.
	CopyleaksDB *bool `json:"copyleaksDb,omitempty"`
}

type IndexingRepository struct {
	// ID is the repository ID of the Private Cloud Hub.
	ID string `json:"id"`
	// MaskingPolicy sets who sees the content of this document in their results.
	MaskingPolicy *MaskingPolicy `json:"maskingPolicy,omitempty"`
}

type Institution struct {
	// ID is a unique identifier of the institution.
	ID string `json:"id,omitempty"`
}

type InternalAIResult struct {
	// ID is the result ID.
	ID string `json:"id"`
	// Title is the title of the matching entry.
	Title string `json:"title"`
	// Introduction is an excerpt of the matching content.
	Introduction string `json:"introduction"`
	// MatchedWords is the number of words that match the scanned document.
	MatchedWords int `json:"matchedWords"`
	// IdenticalWords is the number of identical words.
	IdenticalWords int `json:"identicalWords"`
	// SimilarWords is the number of similar, but not identical, words.
	SimilarWords int `json:"similarWords"`
	// ParaphrasedWords is the number of paraphrased words.
	ParaphrasedWords int `json:"paraphrasedWords"`
	// TotalWords is the number of words in the matching entry.
	TotalWords int `json:"totalWords"`
	// Tags are the tags of the result.
	Tags []ResultTag `json:"tags"`
}

type InternalAISourceMatch struct {
	// Enable turns Internal AI Source Match on. The server default is false.
	Enable bool `json:"enable"`
}

type InternetResult struct {
	// ID is the result ID, used by Client.Export.
	ID string `json:"id"`
	// Title is the title of the source.
	Title string `json:"title"`
	// Introduction is a short introduction of the source.
	Introduction string `json:"introduction"`
	// MatchedWords is the number of words that match the scanned document.
	MatchedWords int `json:"matchedWords"`
	// URL is the public URL of the source.
	URL string `json:"url"`
	// Metadata is metadata of the source.
	Metadata *ResultMetadata `json:"metadata"`
	// Tags are the tags of the result.
	Tags []ResultTag `json:"tags"`
}

type LanguageCodes map[string]string

type MaskingPolicy int

type NewResultWebhook struct {
	// DeveloperPayload is the ScanProperties.DeveloperPayload of the scan.
	DeveloperPayload string `json:"developerPayload"`
	// Score is the score of the scan so far.
	Score *ResultsScore `json:"score"`
	// Internet are the new results from the internet.
	Internet []InternetResult `json:"internet"`
	// Database are the new results from the Shared Data Hub.
	Database []DatabaseResult `json:"database"`
	// Batch are the new results from the same batch of scans.
	Batch []DatabaseResult `json:"batch"`
	// Repositories are the new results from Private Cloud Hubs.
	Repositories []RepositoryResult `json:"repositories"`
	// InternalAIData are the new results from the Copyleaks internal AI database.
	InternalAIData []InternalAIResult `json:"internalAIData"`
}

type Notifications struct {
	// Alerts are the scan alerts.
	Alerts []Alert `json:"alerts"`
}

type OCRSubmission struct {
	// Base64 is the image, base64-encoded; set it or Content.
	Base64 string `json:"base64"`
	// Filename is the name of the image with its extension, up to 255 characters (required).
	Filename string `json:"filename"`
	// LangCode is the language of the text in the image (required); see Client.OCRSupportedLanguages.
	LangCode string `json:"langCode"`
	// Properties configures the scan (required).
	Properties ScanProperties `json:"properties"`
	// Content is the raw image; set it or Base64. See FileSubmission.Content.
	Content []byte `json:"-"`
}

type Option func(*Client) error

type PDF struct {
	// Create generates a PDF report.
	Create bool `json:"create,omitempty"`
	// Title is the title of the report, up to 256 characters.
	Title string `json:"title,omitempty"`
	// LargeLogo is a base64-encoded PNG logo of up to 100 KB.
	LargeLogo string `json:"largeLogo,omitempty"`
	// RTL aligns the text of the report from right to left.
	RTL bool `json:"rtl,omitempty"`
	// Version is the version of the report layout. ReportVersion overrides it.
	//
	// Deprecated: The API reference deprecates pdf.version. Use ReportVersion.
	Version PDFVersion `json:"version,omitempty"`
	// ReportVersion is a PDFReportVersion constant (case-sensitive) and overrides Version. When neither is set,
	// accounts created before 2025-05-15 get v1 and newer accounts get the latest.
	ReportVersion string `json:"reportVersion,omitempty"`
	// Colors customizes the colors of the report.
	Colors *PDFColors `json:"colors,omitempty"`
}

type PDFColors struct {
	// MainStrip is the color of the main strip.
	MainStrip string `json:"mainStrip,omitempty"`
	// Titles is the color of the titles.
	Titles string `json:"titles,omitempty"`
	// Identical is the highlight color of identical matches.
	Identical string `json:"identical,omitempty"`
	// MinorChanges is the highlight color of minor changes.
	MinorChanges string `json:"minorChanges,omitempty"`
	// RelatedMeaning is the highlight color of paraphrased matches.
	RelatedMeaning string `json:"relatedMeaning,omitempty"`
	// AIDetection is the highlight color of AI-generated text.
	AIDetection string `json:"aiDetection,omitempty"`
	// WritingFeedback is the highlight color of Grammar Checker corrections.
	WritingFeedback string `json:"writingFeedback,omitempty"`
}

type ParsedReference struct {
	// Title is the cited title.
	Title string `json:"title"`
	// Authors are the cited authors.
	Authors []string `json:"authors"`
	// Year is the cited year.
	Year int `json:"year"`
	// Journal is the cited journal or publication. It may be empty.
	Journal string `json:"journal"`
	// URL is the cited link, for non-academic references.
	URL string `json:"url"`
}

type ReferenceSignals struct {
	// Title reports whether the title matches.
	Title *bool `json:"title"`
	// Year reports whether the cited year is the published or the modified year of the source.
	Year *bool `json:"year"`
	// Authors reports whether the authors match.
	Authors *bool `json:"authors"`
}

type ReferenceSuggestion struct {
	// URL is the address of the source.
	URL string `json:"url"`
	// DOI is the DOI of the source. It may be empty.
	DOI string `json:"doi"`
	// Title is the title of the source.
	Title string `json:"title"`
	// Authors are the authors of the source.
	Authors []string `json:"authors"`
	// PublishedYear is the year the source was published, or 0 when unknown.
	PublishedYear int `json:"publishedYear"`
	// ModifiedYear is the year the source was last modified, or 0 when unknown.
	ModifiedYear int `json:"modifiedYear"`
	// Journal is the journal or publication of the source. It may be empty.
	Journal string `json:"journal"`
	// Signals report which fields of the reference the source corroborates.
	Signals *ReferenceSignals `json:"signals"`
}

type ReferenceValidation struct {
	// Type is "academic" (checked against an academic citation index) or "nonAcademic" (against the cited page).
	Type string `json:"type"`
	// TextRanges locate the reference in the text.
	TextRanges *TextRanges `json:"textRanges"`
	// HTMLRanges locate the reference in the HTML. They are empty for plain text scans.
	HTMLRanges *HTMLRanges `json:"htmlRanges"`
	// Parsed are the fields that Copyleaks read from the reference.
	Parsed *ParsedReference `json:"parsed"`
	// Suggestions are the sources found for the reference, if any.
	Suggestions []ReferenceSuggestion `json:"suggestions"`
}

type References struct {
	// Validate detects, parses and validates every reference in the text.
	Validate bool `json:"validate"`
}

type ReferencesValidation struct {
	// Summary counts the references that were found and validated.
	Summary *ReferencesValidationSummary `json:"summary"`
	// Results are the validated references; only the crawled version has them, not the completed webhook.
	Results []ReferenceValidation `json:"results,omitempty"`
}

type ReferencesValidationSummary struct {
	// Total is the number of references found.
	Total int `json:"total"`
	// Academic is the number of references found to be academic.
	Academic int `json:"academic"`
	// AcademicValidated is the number of academic references that were fully corroborated.
	AcademicValidated int `json:"academicValidated"`
	// NonAcademicValidated is the number of other references fully corroborated by their cited source.
	NonAcademicValidated int `json:"nonAcademicValidated"`
}

type ReleaseNote struct {
	// MsgType is the kind of change, such as "NEW".
	MsgType string `json:"msgType"`
	// Date is when the change was released, in ISO 8601 format.
	Date string `json:"date"`
	// HTMLDescription describes the change, as HTML.
	HTMLDescription string `json:"htmlDescription"`
}

type ReleaseNotes struct {
	// Updates are the release notes, newest first.
	Updates []ReleaseNote `json:"updates"`
}

type RepositoryInfo struct {
	// ID is the repository ID.
	ID string `json:"id"`
	// Name is the name of the hub.
	Name string `json:"name"`
	// Description is the description of the hub.
	Description string `json:"description"`
	// Permission is the role of the caller in the hub.
	Permission RepositoryRole `json:"permission"`
	// Status is the state of the hub.
	Status RepositoryStatus `json:"status"`
	// MaxCredits is the credit limit of the hub.
	MaxCredits int `json:"maxCredits"`
	// CurrentCredits is the number of credits that the hub has.
	CurrentCredits int `json:"currentCredits"`
	// MaskingPolicy sets who sees the content of the hub's documents in their results.
	MaskingPolicy MaskingPolicy `json:"maskingPolicy"`
	// CreationTime is when the hub was created, in ISO 8601 format.
	CreationTime string `json:"creationTime"`
}

type RepositoryResult struct {
	// ID is the result ID, used by Client.Export.
	ID string `json:"id"`
	// Title is the title of the source.
	Title string `json:"title"`
	// Introduction is a short introduction of the source.
	Introduction string `json:"introduction"`
	// MatchedWords is the number of words that match the scanned document.
	MatchedWords int `json:"matchedWords"`
	// RepositoryID is the ID of the Private Cloud Hub.
	RepositoryID string `json:"repositoryId"`
	// ScanID is the scan ID of the source in the Private Cloud Hub.
	ScanID string `json:"scanId"`
	// Metadata is metadata of the source.
	Metadata *ResultMetadata `json:"metadata"`
	// Tags are the tags of the result.
	Tags []ResultTag `json:"tags"`
}

type RepositoryRole int

type RepositoryStatus int

type ResultComparison struct {
	// Identical are the identical matches.
	Identical *ComparisonMatches `json:"identical"`
	// MinorChanges are the nearly identical matches.
	MinorChanges *ComparisonMatches `json:"minorChanges"`
	// RelatedMeaning are the paraphrased matches.
	RelatedMeaning *ComparisonMatches `json:"relatedMeaning"`
}

type ResultMetadata struct {
	// FinalURL is the URL after all HTTP redirects.
	FinalURL string `json:"finalUrl"`
	// CanonicalURL is the canonical URL of the page.
	CanonicalURL string `json:"canonicalUrl"`
	// PublishDate is the publication date.
	PublishDate string `json:"publishDate"`
	// CreationDate is the creation date.
	CreationDate string `json:"creationDate"`
	// LastModificationDate is the last modification date.
	LastModificationDate string `json:"lastModificationDate"`
	// Author is the author.
	Author string `json:"author"`
	// Organization is the organization.
	Organization string `json:"organization"`
	// Filename is the file name.
	Filename string `json:"filename"`
	// SubmittedBy is the email of the user who added the document; only Private Cloud Hub results have it.
	SubmittedBy string `json:"submittedBy"`
}

type ResultTag struct {
	// Code identifies the kind of tag.
	Code string `json:"code"`
	// Title is a short name of the tag.
	Title string `json:"title"`
	// Description describes the tag.
	Description string `json:"description"`
}

type ResultWebhook struct {
	// URL is called with a POST request that carries the result (required).
	URL string `json:"url"`
	// Headers are extra headers of the webhook request, as [name, value] pairs.
	Headers [][]string `json:"headers,omitempty"`
}

type Results struct {
	// Internet are the results from the internet.
	Internet []InternetResult `json:"internet"`
	// Database are the results from the Shared Data Hub.
	Database []DatabaseResult `json:"database"`
	// Batch are the results from the same batch of scans.
	Batch []DatabaseResult `json:"batch"`
	// Repositories are the results from Private Cloud Hubs.
	Repositories []RepositoryResult `json:"repositories"`
	// Score is the aggregated score of all results.
	Score *ResultsScore `json:"score"`
	// InternalAIData are the results from the Copyleaks internal AI database.
	InternalAIData []InternalAIResult `json:"internalAIData"`
}

type ResultsScore struct {
	// IdenticalWords is the number of words that match exactly.
	IdenticalWords int `json:"identicalWords"`
	// MinorChangedWords is the number of nearly identical words, such as slow and slowly.
	MinorChangedWords int `json:"minorChangedWords"`
	// RelatedMeaningWords is the number of paraphrased words.
	RelatedMeaningWords int `json:"relatedMeaningWords"`
	// AggregatedScore is the percentage of similar words from all results.
	AggregatedScore float64 `json:"aggregatedScore"`
}

type RetryPolicy struct {
	// MaxAttempts counts the attempts of each call, the first included; below 2 turns retries off.
	MaxAttempts int
	// BaseDelay is the delay before the first retry, before jitter (default one second).
	BaseDelay time.Duration
	// MaxDelay caps each delay (default 30 seconds); a longer Retry-After ends the call with its error.
	MaxDelay time.Duration
}

type ScanEnabledFeatures struct {
	// PlagiarismDetection reports the Plagiarism Checker.
	PlagiarismDetection bool `json:"plagiarismDetection"`
	// AIDetection reports AI Text Detection.
	AIDetection bool `json:"aiDetection"`
	// ExplainableAI reports AI Logic.
	ExplainableAI bool `json:"explainableAi"`
	// WritingFeedback reports the Grammar Checker.
	WritingFeedback bool `json:"writingFeedback"`
	// PDFReport reports the PDF report.
	PDFReport bool `json:"pdfReport"`
	// CheatDetection reports cheat detection.
	CheatDetection bool `json:"cheatDetection"`
	// Overview reports the Gen-AI Overview.
	Overview bool `json:"overview"`
	// ReferencesValidation reports the Citation Checker.
	ReferencesValidation bool `json:"referencesValidation"`
	// AISourceMatch reports AI Source Match.
	AISourceMatch bool `json:"aiSourceMatch"`
	// InternalAISourceMatch reports Internal AI Source Match.
	InternalAISourceMatch bool `json:"internalAiSourceMatch"`
}

type ScanMethodAlgorithm int

type ScanOverview struct {
	// Enable turns the overview on.
	Enable bool `json:"enable"`
	// IgnoreAIDetection leaves the AI Text Detection results out of the overview.
	IgnoreAIDetection bool `json:"ignoreAIDetection,omitempty"`
	// IgnorePlagiarismDetection leaves the plagiarism results out of the overview.
	IgnorePlagiarismDetection bool `json:"ignorePlagiarismDetection,omitempty"`
	// IgnoreWritingFeedback leaves the Grammar Checker results out of the overview.
	IgnoreWritingFeedback bool `json:"ignoreWritingFeedback,omitempty"`
	// IgnoreAuthorData leaves the author's earlier scans out of the overview.
	IgnoreAuthorData bool `json:"ignoreAuthorData,omitempty"`
}

type ScanProperties struct {
	// Webhooks sets the URLs that Copyleaks calls with the scan status (required).
	Webhooks SubmitWebhooks `json:"webhooks"`
	// Sandbox submits a free test scan that returns mock results.
	Sandbox bool `json:"sandbox,omitempty"`
	// Action is what the submit does. The default, SubmitActionScan, starts the scan.
	Action SubmitAction `json:"action,omitempty"`
	// IncludeHTML also generates the report in HTML format, when possible.
	IncludeHTML bool `json:"includeHtml,omitempty"`
	// DeveloperPayload is sent back in the webhooks of the scan. Up to 512 characters.
	DeveloperPayload string `json:"developerPayload,omitempty"`
	// Expiration is how many hours the scan is kept after it completes, 1 to 2880 (default 2880).
	Expiration int `json:"expiration,omitempty"`
	// Author identifies the author of the content.
	Author *Author `json:"author,omitempty"`
	// Filters fine-tunes which results are included.
	Filters *Filters `json:"filters,omitempty"`
	// Scanning sets the sources that the content is compared against.
	Scanning *Scanning `json:"scanning,omitempty"`
	// Indexing sets the Private Cloud Hubs that the content is indexed in.
	Indexing *Indexing `json:"indexing,omitempty"`
	// Exclude sets the parts of the content that are not scanned.
	Exclude *Exclude `json:"exclude,omitempty"`
	// PDF requests and customizes a PDF report.
	PDF *PDF `json:"pdf,omitempty"`
	// DisplayLanguage is the PDF report language: "en" (default), "es", "pt", "fr", "de" or "it", lowercase.
	// It is stored with the scan, so it also applies to a PDF report requested later.
	DisplayLanguage string `json:"displayLanguage,omitempty"`
	// SensitivityLevel trades speed for coverage, 1 (fastest) to 5 (most thorough); default 3.
	SensitivityLevel int `json:"sensitivityLevel,omitempty"`
	// CheatDetection reports text manipulation as scan alerts in the completed webhook.
	CheatDetection bool `json:"cheatDetection,omitempty"`
	// ScanMethodAlgorithm chooses between maximum coverage (the default) and maximum results.
	ScanMethodAlgorithm ScanMethodAlgorithm `json:"scanMethodAlgorithm,omitempty"`
	// AIGeneratedText adds AI Text Detection to the scan; see CompletedWebhook.AIDetectionResult.
	AIGeneratedText *AIGeneratedText `json:"aiGeneratedText,omitempty"`
	// AISourceMatch finds online sources suspected of containing AI-generated text (English documents only).
	AISourceMatch *AISourceMatch `json:"aiSourceMatch,omitempty"`
	// CustomMetadata is attached to the document in a Private Cloud Hub and to the results that match it.
	CustomMetadata []CustomMetadata `json:"customMetadata,omitempty"`
	// ScanTimeZone is the IANA time zone of the PDF report's scan time, such as "America/New_York".
	// It is case-sensitive; the default is the time zone of the account's country, or UTC.
	ScanTimeZone string `json:"scanTimeZone,omitempty"`
	// Course identifies the course of the content, for analytics.
	Course *Course `json:"course,omitempty"`
	// Assignment identifies the assignment of the content, for analytics.
	Assignment *Assignment `json:"assignment,omitempty"`
	// Institution identifies the institution of the content, for analytics.
	Institution *Institution `json:"institution,omitempty"`
	// SensitiveDataProtection masks sensitive data with # characters (plans of 2,500 pages or more).
	SensitiveDataProtection *SensitiveDataProtection `json:"sensitiveDataProtection,omitempty"`
	// WritingFeedback adds the Grammar Checker to the scan.
	WritingFeedback *ScanWritingFeedback `json:"writingFeedback,omitempty"`
	// Overview adds a Gen-AI Overview of the scan results; export it with ExportRequest.Overview.
	Overview *ScanOverview `json:"overview,omitempty"`
	// InternalAISourceMatch finds sources in the Copyleaks internal AI database; see Results.InternalAIData.
	InternalAISourceMatch *InternalAISourceMatch `json:"internalAiSourceMatch,omitempty"`
	// References turns on the Citation Checker; see CompletedWebhook.ReferencesValidation.
	References *References `json:"references,omitempty"`
}

type ScanWritingFeedback struct {
	// Enable turns the Grammar Checker on.
	Enable bool `json:"enable"`
	// Score sets the weight of each correction category in the overall writing score.
	Score *GrammarScoreWeights `json:"score,omitempty"`
}

type ScannedDocument struct {
	// ScanID is the scan ID given by you.
	ScanID string `json:"scanId"`
	// TotalWords is the number of words in the text.
	TotalWords int `json:"totalWords"`
	// TotalExcluded is the number of excluded words.
	TotalExcluded int `json:"totalExcluded"`
	// ActualCredits is the number of credits that the check used.
	ActualCredits int `json:"actualCredits"`
	// ExpectedCredits is the number of credits that the check was expected to use.
	ExpectedCredits int `json:"expectedCredits"`
	// CreationTime is when the check was created, in ISO 8601 format (UTC).
	CreationTime string `json:"creationTime"`
}

type ScannedImage struct {
	// ScanID is the scan ID given by you.
	ScanID string `json:"scanId"`
	// ExpectedCredits is the number of credits that the check was expected to use.
	ExpectedCredits int `json:"expectedCredits"`
	// ActualCredits is the number of credits that the check used.
	ActualCredits int `json:"actualCredits"`
	// CreationTime is when the check was created, in ISO 8601 format (UTC).
	CreationTime string `json:"creationTime"`
	// Width is the width of the image, in pixels.
	Width int `json:"width"`
	// Height is the height of the image, in pixels.
	Height int `json:"height"`
	// Filename is the Filename of the request.
	Filename string `json:"filename"`
}

type ScannedVideo struct {
	// ScanID is the scan ID given by you.
	ScanID string `json:"scanId"`
	// ActualCredits is the number of credits that the check used.
	ActualCredits int `json:"actualCredits"`
	// ExpectedCredits is the number of credits that the check was expected to use.
	ExpectedCredits int `json:"expectedCredits"`
	// CreationTime is when the check was created, in ISO 8601 format (UTC).
	CreationTime string `json:"creationTime"`
}

type Scanning struct {
	// Internet compares the content with online sources. The server default is true.
	Internet *bool `json:"internet,omitempty"`
	// Exclude leaves matching submissions out of the results.
	Exclude *ScanningExclude `json:"exclude,omitempty"`
	// Include keeps only matching submissions in the results.
	Include *ScanningInclude `json:"include,omitempty"`
	// Repositories are the Private Cloud Hubs to compare the content against.
	Repositories []ScanningRepository `json:"repositories,omitempty"`
	// CopyleaksDB compares the content against the Shared Data Hub.
	CopyleaksDB *CopyleaksDB `json:"copyleaksDb,omitempty"`
	// CrossLanguages also compares the content against sources in other languages.
	CrossLanguages *CrossLanguages `json:"crossLanguages,omitempty"`
}

type ScanningExclude struct {
	// IDPattern excludes submissions whose scan ID matches it, 1 to 36 characters; * matches any number of
	// characters and . exactly one non-whitespace character. ScanningInclude.IDPattern uses the same syntax.
	IDPattern string `json:"idPattern,omitempty"`
	// BacklinksDomains excludes results that link back to up to 10 domains, 1 to 256 characters each.
	BacklinksDomains *[]string `json:"backlinksDomains,omitempty"`
	// Text excludes results that contain up to 5 phrases, 1 to 30 characters each.
	Text *[]string `json:"text,omitempty"`
}

type ScanningInclude struct {
	// IDPattern keeps only Shared Data Hub and Private Cloud Hub results whose scan ID matches it; same syntax
	// as ScanningExclude.IDPattern.
	IDPattern string `json:"idPattern,omitempty"`
}

type ScanningRepository struct {
	// ID is the repository ID of the Private Cloud Hub.
	ID string `json:"id"`
	// IncludeMySubmissions compares against your own submissions in the hub.
	IncludeMySubmissions bool `json:"includeMySubmissions,omitempty"`
	// IncludeOthersSubmissions compares against other users' submissions in the hub.
	IncludeOthersSubmissions bool `json:"includeOthersSubmissions,omitempty"`
}

type SensitiveDataProtection struct {
	// DriversLicense masks driver's license numbers.
	DriversLicense bool `json:"driversLicense,omitempty"`
	// Credentials masks credentials, such as passwords, authentication tokens and cloud keys.
	Credentials bool `json:"credentials,omitempty"`
	// Passport masks passport numbers.
	Passport bool `json:"passport,omitempty"`
	// Network masks network identifiers, such as IP and MAC addresses.
	Network bool `json:"network,omitempty"`
	// URL masks URLs.
	URL bool `json:"url,omitempty"`
	// EmailAddress masks email addresses.
	EmailAddress bool `json:"emailAddress,omitempty"`
	// CreditCard masks credit card numbers.
	CreditCard bool `json:"creditCard,omitempty"`
	// PhoneNumber masks phone numbers.
	PhoneNumber bool `json:"phoneNumber,omitempty"`
}

type StartErrorHandling int

type StartRequest struct {
	// Trigger lists up to 100 scan IDs to start (required).
	Trigger []string `json:"trigger"`
	// ErrorHandling is what happens when some of the scans are in error.
	ErrorHandling StartErrorHandling `json:"errorHandling"`
}

type StartResponse struct {
	// Success are the scans that started.
	Success []StartedScan `json:"success"`
	// Failed are the scans that did not start.
	Failed []StartedScan `json:"failed"`
}

type StartedScan struct {
	// ID is the scan ID.
	ID string `json:"id"`
}

type SubmitAction int

type SubmitWebhooks struct {
	// Status is called when the scan status changes (required); {STATUS} becomes completed, error,
	// creditschecked or indexed.
	Status string `json:"status"`
	// StatusHeaders are extra headers for the status webhook, as [name, value] pairs.
	StatusHeaders [][]string `json:"statusHeaders,omitempty"`
	// NewResult is called each time a result is found while the scan runs.
	NewResult string `json:"newResult,omitempty"`
	// NewResultHeaders are extra headers for the new-result webhook, as [name, value] pairs.
	NewResultHeaders [][]string `json:"newResultHeaders,omitempty"`
}

type SupportedAITextFileTypes struct {
	// FileTypes are the file extensions, such as "pdf" and "docx".
	FileTypes []string `json:"supportedAiFileTypes"`
}

type SupportedFileTypes struct {
	// Textual are the extensions of the text files that SubmitFile accepts.
	Textual []string `json:"textual"`
	// OCR are the extensions of the image files that SubmitOCR accepts.
	OCR []string `json:"ocr"`
}

type TextModerationChars struct {
	// Labels are the label values of the segments; see TextModerationResponse.Legend.
	Labels []int `json:"labels"`
	// Starts are the start positions of the segments.
	Starts []int `json:"starts"`
	// Lengths are the lengths of the segments.
	Lengths []int `json:"lengths"`
}

type TextModerationLabel struct {
	// ID is the label ID.
	ID string `json:"id"`
}

type TextModerationLegend struct {
	// Index is the label value used in TextModerationChars.Labels.
	Index int `json:"index"`
	// ID is the label ID, such as TextModerationLabelToxicV1.
	ID string `json:"id"`
}

type TextModerationRequest struct {
	// Text is the text to moderate, 2 to 25,000 characters (required).
	Text string `json:"text"`
	// Sandbox runs a free test check that returns mock results.
	Sandbox bool `json:"sandbox,omitempty"`
	// Language is the language code: TextModerationLanguageEnglish, or empty to let the server detect it.
	Language string `json:"language,omitempty"`
	// Labels are 1 to 16 categories to check for (required); a flagged segment's label value indexes this list.
	Labels []TextModerationLabel `json:"labels"`
}

type TextModerationResponse struct {
	// ModelVersion is the version of the moderation model.
	ModelVersion string `json:"modelVersion"`
	// Moderations are the flagged segments of the text.
	Moderations *TextModerations `json:"moderations"`
	// Legend maps the label values of Moderations to label IDs.
	Legend []TextModerationLegend `json:"legend"`
	// ScannedDocument is general information about the check.
	ScannedDocument *ScannedDocument `json:"scannedDocument"`
}

type TextModerationText struct {
	// Chars are the flagged segments, by character position.
	Chars *TextModerationChars `json:"chars"`
}

type TextModerations struct {
	// Text holds the flagged segments of the plain text.
	Text *TextModerationText `json:"text"`
}

type TextPages struct {
	// StartPosition are the character positions where the pages start.
	StartPosition []int `json:"startPosition"`
}

type TextRanges struct {
	// Starts are the start positions of the ranges.
	Starts []int `json:"starts"`
	// Lengths are the lengths of the ranges, one per start position.
	Lengths []int `json:"lengths"`
}

type URLSubmission struct {
	// URL is the address of the page to scan (required).
	URL string `json:"url"`
	// Properties configures the scan (required).
	Properties ScanProperties `json:"properties"`
	// Verb is the HTTP method used to fetch URL: "GET" (default), "POST" or "PUT".
	Verb string `json:"verb,omitempty"`
	// Headers are the headers sent to fetch URL, as [name, value] pairs, replacing Copyleaks' own.
	// Use Set-Cookie for cookies.
	Headers [][]string `json:"headers,omitempty"`
}

type WebhookError struct {
	// Type is the error type, such as "invalid_request_error".
	Type string `json:"type"`
	// ID is the machine-readable error ID, such as "insufficient_credits".
	ID string `json:"id"`
	// Code is the numeric error code.
	Code int `json:"code"`
	// Message is a human-readable description of the error.
	Message string `json:"message"`
	// URL links to the documentation of the error.
	URL string `json:"url"`
	// Details describe the request parameters that caused the error.
	Details []WebhookErrorDetail `json:"details"`
}

type WebhookErrorDetail struct {
	// Param is the name of the parameter.
	Param string `json:"param"`
	// Message describes the problem with the parameter.
	Message string `json:"message"`
}

type WebhookScannedDocument struct {
	// ScanID is the scan ID given by you.
	ScanID string `json:"scanId"`
	// TotalWords is the number of words in the document.
	TotalWords int `json:"totalWords"`
	// TotalExcluded is the number of excluded words.
	TotalExcluded int `json:"totalExcluded"`
	// Credits is the number of credits that the scan used.
	Credits int `json:"credits"`
	// CreationTime is when the scan was created, in ISO 8601 format (UTC).
	CreationTime string `json:"creationTime"`
	// Metadata is metadata of the scanned document.
	Metadata *ResultMetadata `json:"metadata"`
	// ExpectedCredits is the number of credits that the scan was expected to use.
	ExpectedCredits int `json:"expectedCredits"`
	// DetectedLanguage is the language code of the document, such as "en", when the server reports it.
	DetectedLanguage string `json:"detectedLanguage"`
	// Enabled reports the features that the scan ran, when the server reports them.
	Enabled *ScanEnabledFeatures `json:"enabled"`
}

type WebhookWritingFeedback struct {
	// TextStatistics are statistics of the text.
	TextStatistics *GrammarStatistics `json:"textStatistics"`
	// Score holds the correction counts and scores of each category, and the overall score.
	Score *GrammarScoreCorrections `json:"score"`
	// Readability is the readability of the text.
	Readability *GrammarReadability `json:"readability"`
}