@laserfiche/lf-repository-api-client-v2 1.5.0 → 1.6.0--preview-35385635256

package/dist/index.d.ts

@@ -1676,6 +1676,15 @@ export interface IEntriesClient {
     /**
      * - Starts an asynchronous export operation to export an entry.
     - If successful, it returns a taskId which can be used to check the status of the export operation or download the export result, otherwise, it returns an error.
+    - When part=Text, a document whose pages carry no text stream is rejected with 400 rather
+      than started and failed later. Text is extracted asynchronously after an import, so a
+      document may briefly have pages but no text; poll hasText on ListPageInfos and retry once
+      it reports true. A document with no pages at all is not rejected here.
+    - The download link the completed task carries in result.uri is **single-use**. The first
+      GET returns the file; any later GET of the same link answers 404, and that 404 carries no
+      problem details because it comes from the download service rather than from this API.
+      Save the content on the first download, and start a new export if a download has to be
+      retried.
     - Required OAuth scope: repository.Read
      * @param args.repositoryId The requested repository ID.
      * @param args.entryId The ID of entry to export.
@@ -1779,7 +1788,7 @@ export interface IEntriesClient {
      * @param args.culture (optional) An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag. This may be used when setting field values with tokens.
      * @param args.file (optional) Optional. The file to import. If the file extension is not in {txt, tif, tiff, bmp, pcx, jpg, jpeg, gif, png}, or if importAsElectronicDocument=true, it is stored as the electronic document. Otherwise (image extension with importAsElectronicDocument=false), it is imported as image pages. A zero-byte file creates an empty document with no electronic document and no pages.
      * @param args.request (optional)
-     * @param args.imageFiles (optional) Optional. Up to 10 image files (100 MB aggregate) that are appended as image pages. Use PUT /Document/Pages to replace existing pages instead of appending. Set generateImagePagesText=false in the request body to skip OCR for these pages (default: true).
+     * @param args.imageFiles (optional) Optional. Up to 10 image files (100 MB aggregate) that are appended as image pages. Use PUT /Document/Pages to replace existing pages instead of appending.
      * @returns Document was created successfully. Returns created entry.
      */
     importEntry(args: {
@@ -1794,12 +1803,20 @@ export interface IEntriesClient {
     /**
      * - Export an entry.
     - The export may time out if it takes longer than 60 seconds. This value is subject to change at anytime. Use the long operation asynchronous export if you run into this restriction.
+    - When part=Text, a document whose pages carry no text stream is rejected with 400 rather
+      than started and failed later. Text is extracted asynchronously after an import, so a
+      document may briefly have pages but no text; poll hasText on ListPageInfos and retry once
+      it reports true. A document with no pages at all is not rejected here.
+    - The returned download link is **single-use**. The first GET returns the file; any later
+      GET of the same link answers 404, and that 404 carries no problem details because it
+      comes from the download service rather than from this API. Save the content on the first
+      download, and start a new export if a download has to be retried.
     - Required OAuth scope: repository.Read
      * @param args.repositoryId The requested repository ID.
      * @param args.entryId The ID of entry to export.
      * @param args.request The request body.
      * @param args.pageRange (optional) A comma-separated range of pages to include. Ex: 1,3,4 or 1-3,5-7,9. This value is ignored when exporting as Edoc or AlternateEdoc.
-     * @returns Export was successful. Returned a link to download the exported entry.
+     * @returns Export was successful. Returned a single-use link to download the exported entry. A second download of the same link returns 404.
      */
     exportEntry(args: {
         repositoryId: string;
@@ -2038,7 +2055,7 @@ export interface IEntriesClient {
      * @param args.culture (optional) An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag. This may be used when setting field values with tokens.
      * @param args.file (optional) Optional. The electronic document or image file to apply to the existing document. If the file extension is not in {txt, tif, tiff, bmp, pcx, jpg, jpeg, gif, png}, or if importAsElectronicDocument=true, it replaces the existing electronic document. Otherwise (image extension with importAsElectronicDocument=false), it is imported as image pages. A zero-byte file is rejected with 400; use DELETE /Document/Edoc to remove the electronic document.
      * @param args.request (optional)
-     * @param args.imageFiles (optional) Optional. Up to 10 image files (100 MB aggregate) that are appended as image pages. Use PUT /Document/Pages to replace existing pages instead of appending. Set generateImagePagesText=false in the request body to skip OCR for these pages (default: true).
+     * @param args.imageFiles (optional) Optional. Up to 10 image files (100 MB aggregate) that are appended as image pages. Use PUT /Document/Pages to replace existing pages instead of appending.
      * @returns Successfully updated the document. Returned the updated entry.
      */
     updateDocument(args: {
@@ -2103,14 +2120,14 @@ export interface IEntriesClient {
     - The number of pages created is max(imageFiles.Count, textPages.Count). If one array is shorter, pages beyond its length are created without that part.
     - If neither imageFiles nor textPages is provided, one empty page is created.
     - If pageNumber is omitted, pages are appended to the end. If provided, pages are inserted at that 1-based position; existing pages shift down.
-    - generateText triggers OCR when imageFiles are provided. When generateText is true and imageFiles are present, textPages is ignored because OCR-generated text would overwrite any provided text.
+    - generateText requests text extraction from the document's electronic document part; it does not OCR the image pages being written. When generateText is true and imageFiles are present, textPages is ignored because generated text would overwrite any provided text.
     - Required OAuth scope: repository.Write
      * @param args.repositoryId The requested repository ID.
      * @param args.entryId The requested document ID.
      * @param args.pageNumber (optional) Optional 1-based page number. If omitted, pages are appended to the end. If provided, pages are inserted at that position.
-     * @param args.generateText (optional) If true, triggers server-side text generation (OCR) for image pages. Default is false.
+     * @param args.generateText (optional) If true, requests text extraction from the document's electronic document part after the pages are written. This does not OCR the image pages being written. Default is false.
      * @param args.request (optional)
-     * @param args.imageFiles (optional) Optional. Up to 10 image files (100 MB aggregate) that are appended as image pages. Use PUT /Document/Pages to replace existing pages instead of appending. Set generateImagePagesText=false in the request body to skip OCR for these pages (default: true).
+     * @param args.imageFiles (optional) Optional. Up to 10 image files (100 MB aggregate) that are appended as image pages. Use PUT /Document/Pages to replace existing pages instead of appending.
      * @returns Successfully created pages in the specified document. Returned the updated entry.
      */
     createPages(args: {
@@ -2128,9 +2145,9 @@ export interface IEntriesClient {
     - Required OAuth scope: repository.Write
      * @param args.repositoryId The requested repository ID.
      * @param args.entryId The requested document ID.
-     * @param args.generateText (optional) If true, triggers server-side text generation (OCR) after creating pages. Default is false.
+     * @param args.generateText (optional) If true, requests text extraction from the document's electronic document part after the pages are created. This does not OCR the image pages being written. Default is false.
      * @param args.request (optional)
-     * @param args.imageFiles (optional) Optional. Up to 10 image files (100 MB aggregate) that are appended as image pages. Use PUT /Document/Pages to replace existing pages instead of appending. Set generateImagePagesText=false in the request body to skip OCR for these pages (default: true).
+     * @param args.imageFiles (optional) Optional. Up to 10 image files (100 MB aggregate) that are appended as image pages. Use PUT /Document/Pages to replace existing pages instead of appending.
      * @returns Successfully replaced all pages in the specified document. Returned the updated entry.
      */
     replacePages(args: {
@@ -2172,7 +2189,7 @@ export interface IEntriesClient {
      * @param args.repositoryId The requested repository ID.
      * @param args.entryId The requested document ID.
      * @param args.pageNumber The 1-based page number.
-     * @param args.generateText (optional) If true, triggers server-side text generation (OCR) after writing. Default is false.
+     * @param args.generateText (optional) If true, requests text extraction from the document's electronic document part after writing. This does not OCR the page image being written. Default is false.
      * @param args.imageFile (optional) Optional. The image file to upload to replace the page's image content. See https://doc.laserfiche.com/ for supported image file formats. At least one of imageFile or request (with text) must be provided.
      * @param args.request (optional)
      * @returns Successfully wrote the image content of the specified page. Returned the updated entry.
@@ -2427,17 +2444,26 @@ export interface IEntriesClient {
         select?: string | null | undefined;
     }): Promise<PageWordLocationsResponse>;
     /**
-     * - Triggers server-side text generation for the specified document.
-    - For documents with image pages, this performs OCR to generate searchable text.
-    - For documents with an electronic document part (e.g., PDF), this extracts embedded text.
+     * - Queues a request for the repository's text provider to extract text from the document's electronic document part (e.g., a PDF or Office file).
+    - By default this does not OCR image pages. A document whose pages are images and that has no electronic document part is unchanged by a call with ocrImagePages left at false; text for those pages is otherwise produced by the repository's automatic OCR when a page image is written, not by this endpoint.
+    - Set ocrImagePages to true to also queue an OCR job for the document's image pages. Only pages that have an image and no text are included: a page that already has text is left alone, because OCR replaces a page's text and would discard text that was written through the API or edited by a user. To re-OCR such a page, clear its text first with WritePage, then call this endpoint with ocrImagePages set to true.
+    - When ocrImagePages is true, returns 423 if another user holds a lock on the document and 400 if another user has it checked out; OCR writes its results back under an exclusive lock, so a document that is held cannot be processed. Neither status occurs when ocrImagePages is false.
+    - When ocrImagePages is true, at most 511 pages can be queued in one request. A document with more than 511 image pages that have no text returns 400; that is the number of pages the OCR pipeline accepts in a single job.
+    - When ocrImagePages is true, the optional ocrLanguageOverride names the language for that OCR job, taking precedence over the document's own language and the repository's configured default; omit it and those apply in that order, falling back to en. It is not stored on the document, so it changes this request only. Supplying it with ocrImagePages false returns 400, and so does a language that is not a usable code -- including one inherited from the document or the repository, because a job queued with an unusable language is accepted and then produces no text with nothing reported back.
+    - The repository's automatic OCR setting does not apply to this endpoint. That setting governs only the OCR the repository performs on its own when a page image is written; a request made here is explicit, and its OCR is queued whether that setting is on or off.
+    - A success response means the request was queued for processing, not that text now exists. Extraction and OCR run asynchronously, and the returned entry reflects the document as of the response. Poll hasText on ListPageInfos to observe OCR results; a large document may stay queued for some time.
     - Required OAuth scope: repository.Write
      * @param args.repositoryId The requested repository ID.
      * @param args.entryId The requested document ID.
-     * @returns Successfully triggered text generation for the document. Returned the updated entry.
+     * @param args.ocrImagePages (optional) Set to true to also queue OCR for the document's image pages that have no text. Defaults to false.
+     * @param args.ocrLanguageOverride (optional) Optional. The language the OCR engine should use for this request, as an RFC 4646 code such as en. If omitted, the language is the document's own, then the repository's configured default, then en. Supplying it takes precedence over all three, for this request only: the document's stored language is unchanged, so the repository's automatic OCR keeps using it. A value that is not a usable language code is rejected with 400 rather than queued, whether supplied here or inherited. Only valid when ocrImagePages is true.
+     * @returns Successfully queued the text generation request for the document. Returned the entry. Text is produced asynchronously, so it may not be present in this response.
      */
     generateText(args: {
         repositoryId: string;
         entryId: number;
+        ocrImagePages?: boolean | undefined;
+        ocrLanguageOverride?: string | null | undefined;
     }): Promise<Entry>;
     /**
      * - Returns dynamic field logic values with the current values of the fields in the template.
@@ -2806,6 +2832,15 @@ export declare class EntriesClient implements IEntriesClient {
     /**
      * - Starts an asynchronous export operation to export an entry.
     - If successful, it returns a taskId which can be used to check the status of the export operation or download the export result, otherwise, it returns an error.
+    - When part=Text, a document whose pages carry no text stream is rejected with 400 rather
+      than started and failed later. Text is extracted asynchronously after an import, so a
+      document may briefly have pages but no text; poll hasText on ListPageInfos and retry once
+      it reports true. A document with no pages at all is not rejected here.
+    - The download link the completed task carries in result.uri is **single-use**. The first
+      GET returns the file; any later GET of the same link answers 404, and that 404 carries no
+      problem details because it comes from the download service rather than from this API.
+      Save the content on the first download, and start a new export if a download has to be
+      retried.
     - Required OAuth scope: repository.Read
      * @param args.repositoryId The requested repository ID.
      * @param args.entryId The ID of entry to export.
@@ -2914,7 +2949,7 @@ export declare class EntriesClient implements IEntriesClient {
      * @param args.culture (optional) An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag. This may be used when setting field values with tokens.
      * @param args.file (optional) Optional. The file to import. If the file extension is not in {txt, tif, tiff, bmp, pcx, jpg, jpeg, gif, png}, or if importAsElectronicDocument=true, it is stored as the electronic document. Otherwise (image extension with importAsElectronicDocument=false), it is imported as image pages. A zero-byte file creates an empty document with no electronic document and no pages.
      * @param args.request (optional)
-     * @param args.imageFiles (optional) Optional. Up to 10 image files (100 MB aggregate) that are appended as image pages. Use PUT /Document/Pages to replace existing pages instead of appending. Set generateImagePagesText=false in the request body to skip OCR for these pages (default: true).
+     * @param args.imageFiles (optional) Optional. Up to 10 image files (100 MB aggregate) that are appended as image pages. Use PUT /Document/Pages to replace existing pages instead of appending.
      * @returns Document was created successfully. Returns created entry.
      */
     importEntry(args: {
@@ -2930,12 +2965,20 @@ export declare class EntriesClient implements IEntriesClient {
     /**
      * - Export an entry.
     - The export may time out if it takes longer than 60 seconds. This value is subject to change at anytime. Use the long operation asynchronous export if you run into this restriction.
+    - When part=Text, a document whose pages carry no text stream is rejected with 400 rather
+      than started and failed later. Text is extracted asynchronously after an import, so a
+      document may briefly have pages but no text; poll hasText on ListPageInfos and retry once
+      it reports true. A document with no pages at all is not rejected here.
+    - The returned download link is **single-use**. The first GET returns the file; any later
+      GET of the same link answers 404, and that 404 carries no problem details because it
+      comes from the download service rather than from this API. Save the content on the first
+      download, and start a new export if a download has to be retried.
     - Required OAuth scope: repository.Read
      * @param args.repositoryId The requested repository ID.
      * @param args.entryId The ID of entry to export.
      * @param args.request The request body.
      * @param args.pageRange (optional) A comma-separated range of pages to include. Ex: 1,3,4 or 1-3,5-7,9. This value is ignored when exporting as Edoc or AlternateEdoc.
-     * @returns Export was successful. Returned a link to download the exported entry.
+     * @returns Export was successful. Returned a single-use link to download the exported entry. A second download of the same link returns 404.
      */
     exportEntry(args: {
         repositoryId: string;
@@ -3185,7 +3228,7 @@ export declare class EntriesClient implements IEntriesClient {
      * @param args.culture (optional) An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag. This may be used when setting field values with tokens.
      * @param args.file (optional) Optional. The electronic document or image file to apply to the existing document. If the file extension is not in {txt, tif, tiff, bmp, pcx, jpg, jpeg, gif, png}, or if importAsElectronicDocument=true, it replaces the existing electronic document. Otherwise (image extension with importAsElectronicDocument=false), it is imported as image pages. A zero-byte file is rejected with 400; use DELETE /Document/Edoc to remove the electronic document.
      * @param args.request (optional)
-     * @param args.imageFiles (optional) Optional. Up to 10 image files (100 MB aggregate) that are appended as image pages. Use PUT /Document/Pages to replace existing pages instead of appending. Set generateImagePagesText=false in the request body to skip OCR for these pages (default: true).
+     * @param args.imageFiles (optional) Optional. Up to 10 image files (100 MB aggregate) that are appended as image pages. Use PUT /Document/Pages to replace existing pages instead of appending.
      * @returns Successfully updated the document. Returned the updated entry.
      */
     updateDocument(args: {
@@ -3254,14 +3297,14 @@ export declare class EntriesClient implements IEntriesClient {
     - The number of pages created is max(imageFiles.Count, textPages.Count). If one array is shorter, pages beyond its length are created without that part.
     - If neither imageFiles nor textPages is provided, one empty page is created.
     - If pageNumber is omitted, pages are appended to the end. If provided, pages are inserted at that 1-based position; existing pages shift down.
-    - generateText triggers OCR when imageFiles are provided. When generateText is true and imageFiles are present, textPages is ignored because OCR-generated text would overwrite any provided text.
+    - generateText requests text extraction from the document's electronic document part; it does not OCR the image pages being written. When generateText is true and imageFiles are present, textPages is ignored because generated text would overwrite any provided text.
     - Required OAuth scope: repository.Write
      * @param args.repositoryId The requested repository ID.
      * @param args.entryId The requested document ID.
      * @param args.pageNumber (optional) Optional 1-based page number. If omitted, pages are appended to the end. If provided, pages are inserted at that position.
-     * @param args.generateText (optional) If true, triggers server-side text generation (OCR) for image pages. Default is false.
+     * @param args.generateText (optional) If true, requests text extraction from the document's electronic document part after the pages are written. This does not OCR the image pages being written. Default is false.
      * @param args.request (optional)
-     * @param args.imageFiles (optional) Optional. Up to 10 image files (100 MB aggregate) that are appended as image pages. Use PUT /Document/Pages to replace existing pages instead of appending. Set generateImagePagesText=false in the request body to skip OCR for these pages (default: true).
+     * @param args.imageFiles (optional) Optional. Up to 10 image files (100 MB aggregate) that are appended as image pages. Use PUT /Document/Pages to replace existing pages instead of appending.
      * @returns Successfully created pages in the specified document. Returned the updated entry.
      */
     createPages(args: {
@@ -3280,9 +3323,9 @@ export declare class EntriesClient implements IEntriesClient {
     - Required OAuth scope: repository.Write
      * @param args.repositoryId The requested repository ID.
      * @param args.entryId The requested document ID.
-     * @param args.generateText (optional) If true, triggers server-side text generation (OCR) after creating pages. Default is false.
+     * @param args.generateText (optional) If true, requests text extraction from the document's electronic document part after the pages are created. This does not OCR the image pages being written. Default is false.
      * @param args.request (optional)
-     * @param args.imageFiles (optional) Optional. Up to 10 image files (100 MB aggregate) that are appended as image pages. Use PUT /Document/Pages to replace existing pages instead of appending. Set generateImagePagesText=false in the request body to skip OCR for these pages (default: true).
+     * @param args.imageFiles (optional) Optional. Up to 10 image files (100 MB aggregate) that are appended as image pages. Use PUT /Document/Pages to replace existing pages instead of appending.
      * @returns Successfully replaced all pages in the specified document. Returned the updated entry.
      */
     replacePages(args: {
@@ -3326,7 +3369,7 @@ export declare class EntriesClient implements IEntriesClient {
      * @param args.repositoryId The requested repository ID.
      * @param args.entryId The requested document ID.
      * @param args.pageNumber The 1-based page number.
-     * @param args.generateText (optional) If true, triggers server-side text generation (OCR) after writing. Default is false.
+     * @param args.generateText (optional) If true, requests text extraction from the document's electronic document part after writing. This does not OCR the page image being written. Default is false.
      * @param args.imageFile (optional) Optional. The image file to upload to replace the page's image content. See https://doc.laserfiche.com/ for supported image file formats. At least one of imageFile or request (with text) must be provided.
      * @param args.request (optional)
      * @returns Successfully wrote the image content of the specified page. Returned the updated entry.
@@ -3594,17 +3637,26 @@ export declare class EntriesClient implements IEntriesClient {
     }): Promise<PageWordLocationsResponse>;
     protected processListPageWordLocations(response: Response): Promise<PageWordLocationsResponse>;
     /**
-     * - Triggers server-side text generation for the specified document.
-    - For documents with image pages, this performs OCR to generate searchable text.
-    - For documents with an electronic document part (e.g., PDF), this extracts embedded text.
+     * - Queues a request for the repository's text provider to extract text from the document's electronic document part (e.g., a PDF or Office file).
+    - By default this does not OCR image pages. A document whose pages are images and that has no electronic document part is unchanged by a call with ocrImagePages left at false; text for those pages is otherwise produced by the repository's automatic OCR when a page image is written, not by this endpoint.
+    - Set ocrImagePages to true to also queue an OCR job for the document's image pages. Only pages that have an image and no text are included: a page that already has text is left alone, because OCR replaces a page's text and would discard text that was written through the API or edited by a user. To re-OCR such a page, clear its text first with WritePage, then call this endpoint with ocrImagePages set to true.
+    - When ocrImagePages is true, returns 423 if another user holds a lock on the document and 400 if another user has it checked out; OCR writes its results back under an exclusive lock, so a document that is held cannot be processed. Neither status occurs when ocrImagePages is false.
+    - When ocrImagePages is true, at most 511 pages can be queued in one request. A document with more than 511 image pages that have no text returns 400; that is the number of pages the OCR pipeline accepts in a single job.
+    - When ocrImagePages is true, the optional ocrLanguageOverride names the language for that OCR job, taking precedence over the document's own language and the repository's configured default; omit it and those apply in that order, falling back to en. It is not stored on the document, so it changes this request only. Supplying it with ocrImagePages false returns 400, and so does a language that is not a usable code -- including one inherited from the document or the repository, because a job queued with an unusable language is accepted and then produces no text with nothing reported back.
+    - The repository's automatic OCR setting does not apply to this endpoint. That setting governs only the OCR the repository performs on its own when a page image is written; a request made here is explicit, and its OCR is queued whether that setting is on or off.
+    - A success response means the request was queued for processing, not that text now exists. Extraction and OCR run asynchronously, and the returned entry reflects the document as of the response. Poll hasText on ListPageInfos to observe OCR results; a large document may stay queued for some time.
     - Required OAuth scope: repository.Write
      * @param args.repositoryId The requested repository ID.
      * @param args.entryId The requested document ID.
-     * @returns Successfully triggered text generation for the document. Returned the updated entry.
+     * @param args.ocrImagePages (optional) Set to true to also queue OCR for the document's image pages that have no text. Defaults to false.
+     * @param args.ocrLanguageOverride (optional) Optional. The language the OCR engine should use for this request, as an RFC 4646 code such as en. If omitted, the language is the document's own, then the repository's configured default, then en. Supplying it takes precedence over all three, for this request only: the document's stored language is unchanged, so the repository's automatic OCR keeps using it. A value that is not a usable language code is rejected with 400 rather than queued, whether supplied here or inherited. Only valid when ocrImagePages is true.
+     * @returns Successfully queued the text generation request for the document. Returned the entry. Text is produced asynchronously, so it may not be present in this response.
      */
     generateText(args: {
         repositoryId: string;
         entryId: number;
+        ocrImagePages?: boolean | undefined;
+        ocrLanguageOverride?: string | null | undefined;
     }): Promise<Entry>;
     protected processGenerateText(response: Response): Promise<Entry>;
     /**
@@ -8262,7 +8314,9 @@ For any other file type (PDF, Word, Excel, etc.), the file is always imported as
     metadata?: ImportEntryRequestMetadata | undefined;
     /** The name of the volume to use. Will use the default parent entry volume if not specified. This is ignored in Laserfiche Cloud. */
     volumeName?: string | undefined;
-    /** Whether to generate searchable text (OCR) for image pages added via `imageFiles`. Default: true.
+    /** Whether to request text extraction from the document's electronic document part after the image pages in
+`imageFiles` are added. This does not OCR those image pages — image pages are OCR'd by the repository's
+automatic OCR when the page image is written, regardless of this setting. Default: true.
 Does not affect pages generated from `file` — use `pdfOptions.generateText` for those. */
     generateImagePagesText?: boolean;
     /** An optional folder path, relative to the entry given in the route, that the document is imported into.
@@ -8291,7 +8345,9 @@ For any other file type (PDF, Word, Excel, etc.), the file is always imported as
     metadata?: ImportEntryRequestMetadata | undefined;
     /** The name of the volume to use. Will use the default parent entry volume if not specified. This is ignored in Laserfiche Cloud. */
     volumeName?: string | undefined;
-    /** Whether to generate searchable text (OCR) for image pages added via `imageFiles`. Default: true.
+    /** Whether to request text extraction from the document's electronic document part after the image pages in
+`imageFiles` are added. This does not OCR those image pages — image pages are OCR'd by the repository's
+automatic OCR when the page image is written, regardless of this setting. Default: true.
 Does not affect pages generated from `file` — use `pdfOptions.generateText` for those. */
     generateImagePagesText?: boolean;
     /** An optional folder path, relative to the entry given in the route, that the document is imported into.
@@ -8759,7 +8815,9 @@ For any other file type (PDF, Word, Excel, etc.), the file is always imported as
     metadata?: ImportEntryRequestMetadata | undefined;
     /** The options applied when importing a PDF. */
     pdfOptions?: ImportEntryRequestPdfOptions | undefined;
-    /** Whether to generate searchable text (OCR) for image pages added via `imageFiles`. Default: true.
+    /** Whether to request text extraction from the document's electronic document part after the image pages in
+`imageFiles` are added. This does not OCR those image pages — image pages are OCR'd by the repository's
+automatic OCR when the page image is written, regardless of this setting. Default: true.
 Does not affect pages generated from `file` — use `pdfOptions.generateText` for those. */
     generateImagePagesText?: boolean;
     constructor(data?: IUpdateDocumentRequest);
@@ -8777,7 +8835,9 @@ For any other file type (PDF, Word, Excel, etc.), the file is always imported as
     metadata?: ImportEntryRequestMetadata | undefined;
     /** The options applied when importing a PDF. */
     pdfOptions?: ImportEntryRequestPdfOptions | undefined;
-    /** Whether to generate searchable text (OCR) for image pages added via `imageFiles`. Default: true.
+    /** Whether to request text extraction from the document's electronic document part after the image pages in
+`imageFiles` are added. This does not OCR those image pages — image pages are OCR'd by the repository's
+automatic OCR when the page image is written, regardless of this setting. Default: true.
 Does not affect pages generated from `file` — use `pdfOptions.generateText` for those. */
     generateImagePagesText?: boolean;
 }
@@ -10322,7 +10382,10 @@ export declare enum TaskStatus {
 export declare class TaskResult implements ITaskResult {
     /** The ID of the entry which is affected (e.g. created or modified) by the execution of the associated task. */
     entryId?: number;
-    /** The URI which can be used (via api call) to access the result(s) of the associated task. */
+    /** The URI which can be used (via api call) to access the result(s) of the associated task.
+For an export task this is a download link for the exported file and it is single-use: the
+first GET returns the file and any later GET of the same link answers 404. For every other
+task type it is an ordinary API route and may be called as often as needed. */
     uri?: string | undefined;
     constructor(data?: ITaskResult);
     init(_data?: any): void;
@@ -10333,7 +10396,10 @@ export declare class TaskResult implements ITaskResult {
 export interface ITaskResult {
     /** The ID of the entry which is affected (e.g. created or modified) by the execution of the associated task. */
     entryId?: number;
-    /** The URI which can be used (via api call) to access the result(s) of the associated task. */
+    /** The URI which can be used (via api call) to access the result(s) of the associated task.
+For an export task this is a download link for the exported file and it is single-use: the
+first GET returns the file and any later GET of the same link answers 404. For every other
+task type it is an ordinary API route and may be called as often as needed. */
     uri?: string | undefined;
 }
 /** Response containing a collection of CancelTaskResult. */

package/dist/index.js

@@ -5524,6 +5524,15 @@ export class EntriesClient {
     /**
      * - Starts an asynchronous export operation to export an entry.
     - If successful, it returns a taskId which can be used to check the status of the export operation or download the export result, otherwise, it returns an error.
+    - When part=Text, a document whose pages carry no text stream is rejected with 400 rather
+      than started and failed later. Text is extracted asynchronously after an import, so a
+      document may briefly have pages but no text; poll hasText on ListPageInfos and retry once
+      it reports true. A document with no pages at all is not rejected here.
+    - The download link the completed task carries in result.uri is **single-use**. The first
+      GET returns the file; any later GET of the same link answers 404, and that 404 carries no
+      problem details because it comes from the download service rather than from this API.
+      Save the content on the first download, and start a new export if a download has to be
+      retried.
     - Required OAuth scope: repository.Read
      * @param args.repositoryId The requested repository ID.
      * @param args.entryId The ID of entry to export.
@@ -6123,7 +6132,7 @@ export class EntriesClient {
      * @param args.culture (optional) An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag. This may be used when setting field values with tokens.
      * @param args.file (optional) Optional. The file to import. If the file extension is not in {txt, tif, tiff, bmp, pcx, jpg, jpeg, gif, png}, or if importAsElectronicDocument=true, it is stored as the electronic document. Otherwise (image extension with importAsElectronicDocument=false), it is imported as image pages. A zero-byte file creates an empty document with no electronic document and no pages.
      * @param args.request (optional)
-     * @param args.imageFiles (optional) Optional. Up to 10 image files (100 MB aggregate) that are appended as image pages. Use PUT /Document/Pages to replace existing pages instead of appending. Set generateImagePagesText=false in the request body to skip OCR for these pages (default: true).
+     * @param args.imageFiles (optional) Optional. Up to 10 image files (100 MB aggregate) that are appended as image pages. Use PUT /Document/Pages to replace existing pages instead of appending.
      * @returns Document was created successfully. Returns created entry.
      */
     importEntry(args) {
@@ -6243,12 +6252,20 @@ export class EntriesClient {
     /**
      * - Export an entry.
     - The export may time out if it takes longer than 60 seconds. This value is subject to change at anytime. Use the long operation asynchronous export if you run into this restriction.
+    - When part=Text, a document whose pages carry no text stream is rejected with 400 rather
+      than started and failed later. Text is extracted asynchronously after an import, so a
+      document may briefly have pages but no text; poll hasText on ListPageInfos and retry once
+      it reports true. A document with no pages at all is not rejected here.
+    - The returned download link is **single-use**. The first GET returns the file; any later
+      GET of the same link answers 404, and that 404 carries no problem details because it
+      comes from the download service rather than from this API. Save the content on the first
+      download, and start a new export if a download has to be retried.
     - Required OAuth scope: repository.Read
      * @param args.repositoryId The requested repository ID.
      * @param args.entryId The ID of entry to export.
      * @param args.request The request body.
      * @param args.pageRange (optional) A comma-separated range of pages to include. Ex: 1,3,4 or 1-3,5-7,9. This value is ignored when exporting as Edoc or AlternateEdoc.
-     * @returns Export was successful. Returned a link to download the exported entry.
+     * @returns Export was successful. Returned a single-use link to download the exported entry. A second download of the same link returns 404.
      */
     exportEntry(args) {
         let { repositoryId, entryId, request, pageRange } = args;
@@ -7612,7 +7629,7 @@ export class EntriesClient {
      * @param args.culture (optional) An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag. This may be used when setting field values with tokens.
      * @param args.file (optional) Optional. The electronic document or image file to apply to the existing document. If the file extension is not in {txt, tif, tiff, bmp, pcx, jpg, jpeg, gif, png}, or if importAsElectronicDocument=true, it replaces the existing electronic document. Otherwise (image extension with importAsElectronicDocument=false), it is imported as image pages. A zero-byte file is rejected with 400; use DELETE /Document/Edoc to remove the electronic document.
      * @param args.request (optional)
-     * @param args.imageFiles (optional) Optional. Up to 10 image files (100 MB aggregate) that are appended as image pages. Use PUT /Document/Pages to replace existing pages instead of appending. Set generateImagePagesText=false in the request body to skip OCR for these pages (default: true).
+     * @param args.imageFiles (optional) Optional. Up to 10 image files (100 MB aggregate) that are appended as image pages. Use PUT /Document/Pages to replace existing pages instead of appending.
      * @returns Successfully updated the document. Returned the updated entry.
      */
     updateDocument(args) {
@@ -8078,14 +8095,14 @@ export class EntriesClient {
     - The number of pages created is max(imageFiles.Count, textPages.Count). If one array is shorter, pages beyond its length are created without that part.
     - If neither imageFiles nor textPages is provided, one empty page is created.
     - If pageNumber is omitted, pages are appended to the end. If provided, pages are inserted at that 1-based position; existing pages shift down.
-    - generateText triggers OCR when imageFiles are provided. When generateText is true and imageFiles are present, textPages is ignored because OCR-generated text would overwrite any provided text.
+    - generateText requests text extraction from the document's electronic document part; it does not OCR the image pages being written. When generateText is true and imageFiles are present, textPages is ignored because generated text would overwrite any provided text.
     - Required OAuth scope: repository.Write
      * @param args.repositoryId The requested repository ID.
      * @param args.entryId The requested document ID.
      * @param args.pageNumber (optional) Optional 1-based page number. If omitted, pages are appended to the end. If provided, pages are inserted at that position.
-     * @param args.generateText (optional) If true, triggers server-side text generation (OCR) for image pages. Default is false.
+     * @param args.generateText (optional) If true, requests text extraction from the document's electronic document part after the pages are written. This does not OCR the image pages being written. Default is false.
      * @param args.request (optional)
-     * @param args.imageFiles (optional) Optional. Up to 10 image files (100 MB aggregate) that are appended as image pages. Use PUT /Document/Pages to replace existing pages instead of appending. Set generateImagePagesText=false in the request body to skip OCR for these pages (default: true).
+     * @param args.imageFiles (optional) Optional. Up to 10 image files (100 MB aggregate) that are appended as image pages. Use PUT /Document/Pages to replace existing pages instead of appending.
      * @returns Successfully created pages in the specified document. Returned the updated entry.
      */
     createPages(args) {
@@ -8205,9 +8222,9 @@ export class EntriesClient {
     - Required OAuth scope: repository.Write
      * @param args.repositoryId The requested repository ID.
      * @param args.entryId The requested document ID.
-     * @param args.generateText (optional) If true, triggers server-side text generation (OCR) after creating pages. Default is false.
+     * @param args.generateText (optional) If true, requests text extraction from the document's electronic document part after the pages are created. This does not OCR the image pages being written. Default is false.
      * @param args.request (optional)
-     * @param args.imageFiles (optional) Optional. Up to 10 image files (100 MB aggregate) that are appended as image pages. Use PUT /Document/Pages to replace existing pages instead of appending. Set generateImagePagesText=false in the request body to skip OCR for these pages (default: true).
+     * @param args.imageFiles (optional) Optional. Up to 10 image files (100 MB aggregate) that are appended as image pages. Use PUT /Document/Pages to replace existing pages instead of appending.
      * @returns Successfully replaced all pages in the specified document. Returned the updated entry.
      */
     replacePages(args) {
@@ -8445,7 +8462,7 @@ export class EntriesClient {
      * @param args.repositoryId The requested repository ID.
      * @param args.entryId The requested document ID.
      * @param args.pageNumber The 1-based page number.
-     * @param args.generateText (optional) If true, triggers server-side text generation (OCR) after writing. Default is false.
+     * @param args.generateText (optional) If true, requests text extraction from the document's electronic document part after writing. This does not OCR the page image being written. Default is false.
      * @param args.imageFile (optional) Optional. The image file to upload to replace the page's image content. See https://doc.laserfiche.com/ for supported image file formats. At least one of imageFile or request (with text) must be provided.
      * @param args.request (optional)
      * @returns Successfully wrote the image content of the specified page. Returned the updated entry.
@@ -9971,23 +9988,36 @@ export class EntriesClient {
         return Promise.resolve(null);
     }
     /**
-     * - Triggers server-side text generation for the specified document.
-    - For documents with image pages, this performs OCR to generate searchable text.
-    - For documents with an electronic document part (e.g., PDF), this extracts embedded text.
+     * - Queues a request for the repository's text provider to extract text from the document's electronic document part (e.g., a PDF or Office file).
+    - By default this does not OCR image pages. A document whose pages are images and that has no electronic document part is unchanged by a call with ocrImagePages left at false; text for those pages is otherwise produced by the repository's automatic OCR when a page image is written, not by this endpoint.
+    - Set ocrImagePages to true to also queue an OCR job for the document's image pages. Only pages that have an image and no text are included: a page that already has text is left alone, because OCR replaces a page's text and would discard text that was written through the API or edited by a user. To re-OCR such a page, clear its text first with WritePage, then call this endpoint with ocrImagePages set to true.
+    - When ocrImagePages is true, returns 423 if another user holds a lock on the document and 400 if another user has it checked out; OCR writes its results back under an exclusive lock, so a document that is held cannot be processed. Neither status occurs when ocrImagePages is false.
+    - When ocrImagePages is true, at most 511 pages can be queued in one request. A document with more than 511 image pages that have no text returns 400; that is the number of pages the OCR pipeline accepts in a single job.
+    - When ocrImagePages is true, the optional ocrLanguageOverride names the language for that OCR job, taking precedence over the document's own language and the repository's configured default; omit it and those apply in that order, falling back to en. It is not stored on the document, so it changes this request only. Supplying it with ocrImagePages false returns 400, and so does a language that is not a usable code -- including one inherited from the document or the repository, because a job queued with an unusable language is accepted and then produces no text with nothing reported back.
+    - The repository's automatic OCR setting does not apply to this endpoint. That setting governs only the OCR the repository performs on its own when a page image is written; a request made here is explicit, and its OCR is queued whether that setting is on or off.
+    - A success response means the request was queued for processing, not that text now exists. Extraction and OCR run asynchronously, and the returned entry reflects the document as of the response. Poll hasText on ListPageInfos to observe OCR results; a large document may stay queued for some time.
     - Required OAuth scope: repository.Write
      * @param args.repositoryId The requested repository ID.
      * @param args.entryId The requested document ID.
-     * @returns Successfully triggered text generation for the document. Returned the updated entry.
+     * @param args.ocrImagePages (optional) Set to true to also queue OCR for the document's image pages that have no text. Defaults to false.
+     * @param args.ocrLanguageOverride (optional) Optional. The language the OCR engine should use for this request, as an RFC 4646 code such as en. If omitted, the language is the document's own, then the repository's configured default, then en. Supplying it takes precedence over all three, for this request only: the document's stored language is unchanged, so the repository's automatic OCR keeps using it. A value that is not a usable language code is rejected with 400 rather than queued, whether supplied here or inherited. Only valid when ocrImagePages is true.
+     * @returns Successfully queued the text generation request for the document. Returned the entry. Text is produced asynchronously, so it may not be present in this response.
      */
     generateText(args) {
-        let { repositoryId, entryId } = args;
-        let url_ = this.baseUrl + "/v2/Repositories/{repositoryId}/Entries/{entryId}/Document/GenerateText";
+        let { repositoryId, entryId, ocrImagePages, ocrLanguageOverride } = args;
+        let url_ = this.baseUrl + "/v2/Repositories/{repositoryId}/Entries/{entryId}/Document/GenerateText?";
         if (repositoryId === undefined || repositoryId === null)
             throw new Error("The parameter 'repositoryId' must be defined.");
         url_ = url_.replace("{repositoryId}", encodeURIComponent("" + repositoryId));
         if (entryId === undefined || entryId === null)
             throw new Error("The parameter 'entryId' must be defined.");
         url_ = url_.replace("{entryId}", encodeURIComponent("" + entryId));
+        if (ocrImagePages === null)
+            throw new Error("The parameter 'ocrImagePages' cannot be null.");
+        else if (ocrImagePages !== undefined)
+            url_ += "ocrImagePages=" + encodeURIComponent("" + ocrImagePages) + "&";
+        if (ocrLanguageOverride !== undefined && ocrLanguageOverride !== null)
+            url_ += "ocrLanguageOverride=" + encodeURIComponent("" + ocrLanguageOverride) + "&";
         url_ = url_.replace(/[?&]$/, "");
         let options_ = {
             method: "POST",
@@ -10046,6 +10076,14 @@ export class EntriesClient {
                 return throwException("Entry with requested ID was not found.", status, _responseText, _headers, result404);
             });
         }
+        else if (status === 423) {
+            return response.text().then((_responseText) => {
+                let result423 = null;
+                let resultData423 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
+                result423 = ProblemDetails.fromJS(resultData423);
+                return throwException("The document is locked by another user. OCR writes its results back under an exclusive lock, so a locked document cannot be processed.", status, _responseText, _headers, result423);
+            });
+        }
         else if (status === 429) {
             return response.text().then((_responseText) => {
                 let result429 = null;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@laserfiche/lf-repository-api-client-v2",
   "type": "module",
-  "version": "1.5.0",
+  "version": "1.6.0--preview-35385635256",
   "description": "The TypeScript Laserfiche Repository API Client library for accessing the v2 Laserfiche Repository APIs.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -30,11 +30,11 @@
     "ts-node": "^10.4.0",
     "tslib": "^2.6.3",
     "typescript": "^4.5.5",
-    "vitest": "^4.1.6"
+    "vitest": "^4.1.11"
   },
   "dependencies": {
-    "@laserfiche/lf-api-client-core": "^1.1.22",
-    "@laserfiche/lf-js-utils": "^4.0.16"
+    "@laserfiche/lf-js-utils": "4.0.17--preview-35385635256",
+    "@laserfiche/lf-api-client-core": "1.1.23--preview-35385635256"
   },
   "scripts": {
     "test": "npm run test:all",