API Request shape to ask the /learn end point to learn from conversation history and pass back "notes" that can be stored in the database for future requests

Constructors

Properties

One or more API keys that are used for AI systems that Skip will access on behalf of the API caller NOTE: This is not where you put in the bearer token for the Skip API server itself, that goes in the header of the request

entities: SkipEntityInfo[]

Summary entity metadata that is passed into the Skip Server so that Skip has knowledge of the schema of the calling MJAPI environment

lastLearningCycleDate: Date

Optional, the date/time of the last learning cycle performed on this dataset

learningCycleId: string

Learning Cycle ID is a unique identifier from the MJ AI Agent Learning Cycles table that will track the details of the API calls and the results for logging purposes and also to track the timestamps for each run to batch the conversations that are being sent

newConversations: SkipConversation[]

An array of conversations that have taken place since the last learning cycle

An array of the possible note types that can be stored in the source MJ system

An array of notes that have been generated by the Skip API server during the learning cycle process in the past

organizationId: string

OrganizationID for Skip to identify the organization

organizationInfo?: string

This is an optional string parameter where you can tell Skip anything you'd like to share about your organization, structure, database schema, and anything else that might be helpful for him to be aware of. Keep in mind that this organizationInfo will be incorprorated into every request Skip makes to the underlying AI services which can add cost and processing time to your requests. Including this information is extremely helpful as a very simple method of contextualizing Skip for your organization. In the Pro and above Skip plans, there are far more granular and effect methods of training Skip beyond this organizationInfo parameter, contact the team at MemberJunction.com for more information if you're interested.

queries: SkipQueryInfo[]

Stored queries in the MJ metadata that Skip can use and learn from

An array of the requests that Skip has previously made. Full history provided including requests of all status conditions.