Skip to content

OpensearchConfiguration

Source code in docs_src/capo_lex_models_v2/types/opensearch_configuration.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
class OpensearchConfiguration(TypedDict, closed=True):
    domain_endpoint: "capo_lex_models_v2.types.domain_endpoint.DomainEndpoint"
    """<p>The endpoint of the Amazon OpenSearch Service domain.</p>"""
    index_name: "capo_lex_models_v2.types.os_index_name.OSIndexName"
    """<p>The name of the Amazon OpenSearch Service index.</p>"""
    exact_response: "capo_lex_models_v2.types.boolean.Boolean"
    """<p>Specifies whether to return an exact response or to return an answer generated by the model using the fields you specify from the database.</p>"""
    exact_response_fields: NotRequired[
        "capo_lex_models_v2.types.exact_response_fields.ExactResponseFields"
    ]
    """<p>Contains the names of the fields used for an exact response to the user.</p>"""
    include_fields: NotRequired[
        "capo_lex_models_v2.types.os_include_fields.OSIncludeFields"
    ]
    """<p>Contains a list of fields from the Amazon OpenSearch Service that the model can use to generate the answer to the query.</p>"""

domain_endpoint instance-attribute 

domain_endpoint: DomainEndpoint

The endpoint of the Amazon OpenSearch Service domain.

exact_response instance-attribute 

exact_response: Boolean

Specifies whether to return an exact response or to return an answer generated by the model using the fields you specify from the database.

exact_response_fields instance-attribute 

exact_response_fields: NotRequired[ExactResponseFields]

Contains the names of the fields used for an exact response to the user.

include_fields instance-attribute 

include_fields: NotRequired[OSIncludeFields]

Contains a list of fields from the Amazon OpenSearch Service that the model can use to generate the answer to the query.

index_name instance-attribute 

index_name: OSIndexName

The name of the Amazon OpenSearch Service index.