## engine.Field


Saved parameters which can generate lucene Fields given values.


Usage

``` python
engine.Field(
    name,
    docValuesType="",
    indexOptions="",
    dimensions=0,
    **settings,
)
```


## Parameters

| Name | Type | Description   | Default |
|------|------|---------------|---------|
| name |      | name of field | \-      |


## Attributes

| Name | Description |
|----|----|
| [settings](#settings) | dict representation of settings |

------------------------------------------------------------------------


#### settings


dict representation of settings


`settings: dict`


## Methods

| Name | Description |
|----|----|
| [String()](#String) | Return Field with default settings for strings. |
| [Text()](#Text) | Return Field with default settings for text. |
| [items()](#items) | Generate lucene Fields suitable for adding to a document. |

------------------------------------------------------------------------


#### String()


Return Field with default settings for strings.


Usage

``` python
String(name, tokenized=False, omitNorms=True, indexOptions="DOCS", **settings)
```


------------------------------------------------------------------------


#### Text()


Return Field with default settings for text.


Usage

``` python
Text(name, indexOptions="DOCS_AND_FREQS_AND_POSITIONS", **settings)
```


------------------------------------------------------------------------


#### items()


Generate lucene Fields suitable for adding to a document.


Usage

``` python
items(*values)
```