Skip to content

CreateAdapterRequest

Source code in docs_src/capo_textract/types/create_adapter_request.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
class CreateAdapterRequest(TypedDict, closed=True):
    adapter_name: "capo_textract.types.adapter_name.AdapterName"
    """<p>The name to be assigned to the adapter being created.</p>"""
    client_request_token: NotRequired[
        "capo_textract.types.client_request_token.ClientRequestToken"
    ]
    """<p>Idempotent token is used to recognize the request. If the same token is used with multiple CreateAdapter requests, the same session is returned. This token is employed to avoid unintentionally creating the same session multiple times.</p>"""
    description: NotRequired[
        "capo_textract.types.adapter_description.AdapterDescription"
    ]
    """<p>The description to be assigned to the adapter being created.</p>"""
    feature_types: "capo_textract.types.feature_types.FeatureTypes"
    """<p>The type of feature that the adapter is being trained on. Currrenly, supported feature types are: <code>QUERIES</code> </p>"""
    auto_update: NotRequired["capo_textract.types.auto_update.AutoUpdate"]
    """<p>Controls whether or not the adapter should automatically update.</p>"""
    tags: NotRequired["capo_textract.types.tag_map.TagMap"]
    """<p>A list of tags to be added to the adapter.</p>"""

adapter_name instance-attribute 

adapter_name: AdapterName

The name to be assigned to the adapter being created.

auto_update instance-attribute 

auto_update: NotRequired[AutoUpdate]

Controls whether or not the adapter should automatically update.

client_request_token instance-attribute 

client_request_token: NotRequired[ClientRequestToken]

Idempotent token is used to recognize the request. If the same token is used with multiple CreateAdapter requests, the same session is returned. This token is employed to avoid unintentionally creating the same session multiple times.

description instance-attribute 

description: NotRequired[AdapterDescription]

The description to be assigned to the adapter being created.

feature_types instance-attribute 

feature_types: FeatureTypes

The type of feature that the adapter is being trained on. Currrenly, supported feature types are: QUERIES

tags instance-attribute 

tags: NotRequired[TagMap]

A list of tags to be added to the adapter.