Package org.opensearch.ml.common.conversation

Class ActionConstants

java.lang.Object
org.opensearch.ml.common.conversation.ActionConstants
public class ActionConstants extends Object
Constants for conversational actions

  • Field Details

    • CONVERSATION_ID_FIELD

      public static final String CONVERSATION_ID_FIELD
      name of conversation Id field in all responses
      See Also:

    • RESPONSE_CONVERSATION_LIST_FIELD

      public static final String RESPONSE_CONVERSATION_LIST_FIELD
      name of list of conversations in all responses
      See Also:

    • RESPONSE_INTERACTION_LIST_FIELD

      public static final String RESPONSE_INTERACTION_LIST_FIELD
      name of list on interactions in all responses
      See Also:

    • RESPONSE_TRACES_LIST_FIELD

      public static final String RESPONSE_TRACES_LIST_FIELD
      name of list on traces in all responses
      See Also:

    • RESPONSE_INTERACTION_ID_FIELD

      public static final String RESPONSE_INTERACTION_ID_FIELD
      name of interaction Id field in all responses
      See Also:

    • REQUEST_CONVERSATION_NAME_FIELD

      public static final String REQUEST_CONVERSATION_NAME_FIELD
      name of conversation name in all requests
      See Also:

    • REQUEST_MAX_RESULTS_FIELD

      public static final String REQUEST_MAX_RESULTS_FIELD
      name of maxResults field name in all requests
      See Also:

    • NEXT_TOKEN_FIELD

      public static final String NEXT_TOKEN_FIELD
      name of nextToken field name in all messages
      See Also:

    • INPUT_FIELD

      public static final String INPUT_FIELD
      name of input field in all requests
      See Also:

    • AI_RESPONSE_FIELD

      public static final String AI_RESPONSE_FIELD
      name of AI response field in all respopnses
      See Also:

    • RESPONSE_ORIGIN_FIELD

      public static final String RESPONSE_ORIGIN_FIELD
      name of origin field in all requests
      See Also:

    • PROMPT_TEMPLATE_FIELD

      public static final String PROMPT_TEMPLATE_FIELD
      name of prompt template field in all requests
      See Also:

    • ADDITIONAL_INFO_FIELD

      public static final String ADDITIONAL_INFO_FIELD
      name of metadata field in all requests
      See Also:

    • PARENT_INTERACTION_ID_FIELD

      public static final String PARENT_INTERACTION_ID_FIELD
      name of metadata field in all requests
      See Also:

    • TRACE_NUMBER_FIELD

      public static final String TRACE_NUMBER_FIELD
      name of metadata field in all requests
      See Also:

    • SUCCESS_FIELD

      public static final String SUCCESS_FIELD
      name of success field in all requests
      See Also:

    • MEMORY_ID

      public static final String MEMORY_ID
      parameter for memory_id in URLs
      See Also:

    • MESSAGE_ID

      public static final String MESSAGE_ID
      parameter for message_id in URLs
      See Also:

    • CREATE_CONVERSATION_REST_PATH

      public static final String CREATE_CONVERSATION_REST_PATH
      path for create conversation
      See Also:

    • GET_CONVERSATIONS_REST_PATH

      public static final String GET_CONVERSATIONS_REST_PATH
      path for get conversations
      See Also:

    • UPDATE_CONVERSATIONS_REST_PATH

      public static final String UPDATE_CONVERSATIONS_REST_PATH
      path for update conversations
      See Also:

    • CREATE_INTERACTION_REST_PATH

      public static final String CREATE_INTERACTION_REST_PATH
      path for create interaction
      See Also:

    • GET_INTERACTIONS_REST_PATH

      public static final String GET_INTERACTIONS_REST_PATH
      path for get interactions
      See Also:

    • GET_TRACES_REST_PATH

      public static final String GET_TRACES_REST_PATH
      path for get traces
      See Also:

    • DELETE_CONVERSATION_REST_PATH

      public static final String DELETE_CONVERSATION_REST_PATH
      path for delete conversation
      See Also:

    • SEARCH_CONVERSATIONS_REST_PATH

      public static final String SEARCH_CONVERSATIONS_REST_PATH
      path for search conversations
      See Also:

    • SEARCH_INTERACTIONS_REST_PATH

      public static final String SEARCH_INTERACTIONS_REST_PATH
      path for search interactions
      See Also:

    • UPDATE_INTERACTIONS_REST_PATH

      public static final String UPDATE_INTERACTIONS_REST_PATH
      path for update interactions
      See Also:

    • GET_CONVERSATION_REST_PATH

      public static final String GET_CONVERSATION_REST_PATH
      path for get conversation
      See Also:

    • GET_INTERACTION_REST_PATH

      public static final String GET_INTERACTION_REST_PATH
      path for get interaction
      See Also:

    • DEFAULT_MAX_RESULTS

      public static final int DEFAULT_MAX_RESULTS
      default max results returned by get operations
      See Also:

    • DEFAULT_USERNAME_FOR_ERRORS

      public static final String DEFAULT_USERNAME_FOR_ERRORS
      default username for reporting security errors if no or malformed username
      See Also:

  • Constructor Details

    • ActionConstants

      public ActionConstants()