Package org.opensearch.ml.common.conversation

Class ConversationalIndexConstants

java.lang.Object
org.opensearch.ml.common.conversation.ConversationalIndexConstants
public class ConversationalIndexConstants extends Object
Class containing a bunch of constant defining how the conversational indices are formatted

  • Field Details

    • META_INDEX_SCHEMA_VERSION

      public static final Integer META_INDEX_SCHEMA_VERSION
      Version of the meta index schema

    • META_INDEX_NAME

      public static final String META_INDEX_NAME
      Name of the conversational metadata index
      See Also:

    • META_CREATED_TIME_FIELD

      public static final String META_CREATED_TIME_FIELD
      Name of the metadata field for initial timestamp
      See Also:

    • META_UPDATED_TIME_FIELD

      public static final String META_UPDATED_TIME_FIELD
      Name of the metadata field for updated timestamp
      See Also:

    • META_NAME_FIELD

      public static final String META_NAME_FIELD
      Name of the metadata field for name of the conversation
      See Also:

    • USER_FIELD

      public static final String USER_FIELD
      Name of the owning user field in all indices
      See Also:

    • APPLICATION_TYPE_FIELD

      public static final String APPLICATION_TYPE_FIELD
      Name of the application that created this conversation
      See Also:

    • META_MAPPING

      public static final String META_MAPPING
      Mappings for the conversational metadata index

    • INTERACTIONS_INDEX_SCHEMA_VERSION

      public static final Integer INTERACTIONS_INDEX_SCHEMA_VERSION
      Version of the interactions index schema

    • INTERACTIONS_INDEX_NAME

      public static final String INTERACTIONS_INDEX_NAME
      Name of the conversational interactions index
      See Also:

    • INTERACTIONS_CONVERSATION_ID_FIELD

      public static final String INTERACTIONS_CONVERSATION_ID_FIELD
      Name of the interaction field for the conversation Id
      See Also:

    • INTERACTIONS_INPUT_FIELD

      public static final String INTERACTIONS_INPUT_FIELD
      Name of the interaction field for the human input
      See Also:

    • INTERACTIONS_PROMPT_TEMPLATE_FIELD

      public static final String INTERACTIONS_PROMPT_TEMPLATE_FIELD
      Name of the interaction field for the prompt template
      See Also:

    • INTERACTIONS_RESPONSE_FIELD

      public static final String INTERACTIONS_RESPONSE_FIELD
      Name of the interaction field for the AI response
      See Also:

    • INTERACTIONS_ORIGIN_FIELD

      public static final String INTERACTIONS_ORIGIN_FIELD
      Name of the interaction field for the response's origin
      See Also:

    • INTERACTIONS_ADDITIONAL_INFO_FIELD

      public static final String INTERACTIONS_ADDITIONAL_INFO_FIELD
      Name of the interaction field for additional metadata
      See Also:

    • INTERACTIONS_CREATE_TIME_FIELD

      public static final String INTERACTIONS_CREATE_TIME_FIELD
      Name of the interaction field for the timestamp
      See Also:

    • PARENT_INTERACTIONS_ID_FIELD

      public static final String PARENT_INTERACTIONS_ID_FIELD
      Name of the interaction id
      See Also:

    • INTERACTIONS_TRACE_NUMBER_FIELD

      public static final String INTERACTIONS_TRACE_NUMBER_FIELD
      The trace number of an interaction
      See Also:

    • INTERACTIONS_MAPPINGS

      public static final String INTERACTIONS_MAPPINGS
      Mappings for the interactions index

    • ML_COMMONS_MEMORY_FEATURE_ENABLED

      public static final org.opensearch.common.settings.Setting<Boolean> ML_COMMONS_MEMORY_FEATURE_ENABLED
      Feature Flag setting for conversational memory

  • Constructor Details

    • ConversationalIndexConstants

      public ConversationalIndexConstants()