# OfficeOcrSessionRequest

One PDF or image OCR task in an explicitly ordered desktop or service session.

Class 

`OfficeIMO.Workflows`

**Namespace**

`OfficeIMO.Workflows`

**Assembly**

`OfficeIMO.Workflows`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[OfficeOcrSessionRequest.cs:6](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/OfficeOcrSessionRequest.cs#L6)

**Modifiers**

sealed

One PDF or image OCR task in an explicitly ordered desktop or service session.

## Inheritance

- object
- OfficeOcrSessionRequest

## Usage

Explore 1 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

### Accepted by parameters 1

- Method [OfficeWorkflowRunner.RunOcrSessionAsync](/api/workflows/officeimo-workflows-officeworkflowrunner/#method-runocrsessionasync-collections-generic-ienumerable-officeimo-workflows-officeocrsessionrequest-officeimo-ocr-iocrengine-iprogress-officeimo-workflows-officeworkflowprogress-iprogress-officeimo-workflows-officeocrsessionresult-threading-cancellationtoken-collections-generic-ireadonlylist-system-string-collections-generic-ireadonlylist-officeimo-workflows-officeworkflowprotectedsource) parameter `requests`

Filter members 

Show inherited

## Constructors

OfficeOcrSessionRequest 2 overloads

`public OfficeOcrSessionRequest(string id, PdfSearchableWorkflowRequest request)` [#](#constructor-ctor-string-officeimo-workflows-pdfsearchableworkflowrequest)

[OfficeOcrSessionRequest.cs:6](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/OfficeOcrSessionRequest.cs#L6)

Creates a searchable-PDF session item.

Parameters

**id string required**

**request OfficeIMO.Workflows.PdfSearchableWorkflowRequest required**

`public OfficeOcrSessionRequest(string id, ImageOcrWorkflowRequest request)` [#](#constructor-ctor-string-officeimo-workflows-imageocrworkflowrequest)

[OfficeOcrSessionRequest.cs:11](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/OfficeOcrSessionRequest.cs#L11)

Creates an image-to-text session item.

Parameters

**id string required**

**request OfficeIMO.Workflows.ImageOcrWorkflowRequest required**

## Inherited Methods

`public virtual bool Equals(object? obj)` [#](#method-equals-object)

Inherited from object

Parameters

**obj object? required**

Returns

`bool`

`public virtual int GetHashCode()` [#](#method-gethashcode)

Inherited from object

Returns

`int`

`public Type GetType()` [#](#method-gettype)

Inherited from object

Returns

`Type`

`public virtual string? ToString()` [#](#method-tostring)

Inherited from object

Returns

`string?`

## Properties

`public string Id { get; }` [#](#property-id)

[OfficeOcrSessionRequest.cs:16](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/OfficeOcrSessionRequest.cs#L16)

Caller identifier, unique within one session.

`public PdfSearchableWorkflowRequest? Pdf { get; }` [#](#property-pdf)

[OfficeOcrSessionRequest.cs:18](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/OfficeOcrSessionRequest.cs#L18)

Searchable-PDF request, or null for an image task.

`public ImageOcrWorkflowRequest? Image { get; }` [#](#property-image)

[OfficeOcrSessionRequest.cs:20](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/OfficeOcrSessionRequest.cs#L20)

Image-to-text request, or null for a PDF task.

<!-- PowerForge markdown artifact sha256:98B32AFA6AC983EC9C871003B5F970F5D523677EBC273CE1582543B71DAA6738 -->
