This API requires a Giver session.
The session ID
The 0-based index of the first Memory object to list
The number of the Memory objects to list
Optional type of the Memory objects to list: ALL, CONTENTS, DEFAULTS, DRAFTS, EXPERT_REFERENCES
Success
This API requires a Giver session. Only non-null (present) fields are considered for update. Null or absent fields are left unaltered. Note that if Answers of Media are present, they replace the corresponding lists.
The session ID
The Memory object ID
Specifications for an Update Person request.
If True updates the LastRead property with the current date.
Memory object ID.
Memory type, e.g. Question, Story or Default. Required during Add operations. Currently possible values are: Question: this Memory is a question, hence its title is expected in interrogative form Story: this Memory is a story, hence its title is expected in affirmative form Default: this Memory is a default answer, hence its title is ignored (empty or null) CompletionDraft: this Memory is draft from a completion, obtained via a generative AI. ExpertReference: this Memory is the results of a question asked to a Board of Experts, and the answer is the name of the Expert that replied to the question.
Timestamp of the last time this Memory has been shown to a Receiver.
This value is also used when picking random memories to avoid showing
memories that have already been shown recently.
Null if the Memory has not been shown yet.
Number of times this Memory has been shown to a Receiver.
Null if the Memory has not been shown yet.
ID of the Person object to whom this Memory belongs.
Null if the Memory is public. When updating,
set it to a single dash character (-) to remove a
previously set association with a Person.
Tag of the Person object to whom this Memory belongs.
Null if the Memory is public.
Name of the Person object to whom this Memory belongs.
Null if the Memory is public.
Title of the Question or Story. Null if this Memory is a Default.
Title variants of this Question or Story. Empty if this Memory is a Default.
Approximate date associated with this Memory.
When updating, set it to midnight Jan. 1st 1 A.D.
(01/01/01 00:00:00) to clear any previously set
Date and DateUncertaintyDays.
Uncertainty in the date associated with this Memory, expressed in days.
Name of the place associated with this Memory.
When updating, set it to a single dash character
(-) to clear any previously set Place (by name or
coordinates) and PlaceUncertaintyKm.
Latitude of the place associated with this Memory.
Longitude of the place associated with this Memory.
Uncertainty of the place associated with this Memory, expressed in kilometers.
If True, when this Memory is emitted it is NOT followed by a continuation prompt,
such as "Is there anything else you want to know?".
If True, this Memory can't be randomly picked with a Timeout Event, or
explicitly searching for random Memory objects.
Ignored for Memory of type Default.
If True, this Memory's content can be emitted if the user fails
to find a question with an answer at the beginning of a session.
Ignored for Memory of type Default.
Hints for this Memory.
Minimum idle timeout, in seconds. If not specified, by default it is set to 20 seconds. The idle timeout is the time after which the client sends a Timeout event and, typically, a random question or story is picked up and proposed to the user. The actual idle timeout is computed as a random number between MinTimeout and MaxTimeout plus the reading time, where the reading time is in turn computed as the time it would take to read the answer at 150 words per minute.
Maximum idle timeout, in seconds. If not specified, by default it is set to 40 seconds. The idle timeout is the time after which the client sends a Timeout event and, typically, a random question or story is picked up and proposed to the user. The actual idle timeout is computed as a random number between MinTimeout and MaxTimeout plus the reading time, where the reading time is in turn computed as the time it would take to read the answer at 150 words per minute.
Optional type of the outcome to be sent to the DCM platform when this Memory is emitted.
Optional code of the outcome to be sent to the DCM platform when this Memory is emitted.
Tags for this Memory.
Timestamp of creation. Always present when reading/receiving an object, ignored when writing/sending an object.
ID of the session that created this object.
Timestamp of latest change. Always present when reading/receiving an object, ignored when writing/sending an object.
ID of the latest session that changed this object.
Success
This API requires a Giver session.
The session ID
Specifications for a Memory search.
Search query. Used only for Search and Filter Memories. Ignored for Random picking and Memory Hints.
How to interpret the search query in the Text property:If "Semantic", the query is interpreted as a full question in natural language, and the search is performed in the same way a question would be posed to the Dialog State Machine.If "Literal", the query is intended as space-separated keywords, and the search is performed by looking for them as a substring in the text and titles of Memories. If omitted the search is Semantic by default. Used only for Search and Filter Memories. Ignored for Random picking and Memory Hints.
Approximate date of Memories to limit the search to. Used for Search, Filter Memories and Random picking. Ignored for Memory Hints.
Uncertainty of the date, in days. Required if Date is specified. Used for Search, Filter Memories and Random picking. Ignored for Memory Hints.
Name of the approximate place of Memories to limit the search to. Used for Search, Filter Memories and Random picking. Ignored for Memory Hints.
Latitude of the approximate place of Memories to limit the search to. Used for Search, Filter Memories and Random picking. Ignored for Memory Hints.
Longitude of the approximate place of Memories to limit the search to. Used for Search, Filter Memories and Random picking. Ignored for Memory Hints.
Uncertainty of place, in kilometers. Required if PlaceName or PlaceLatitude and PlaceLongitude are specified. Used for Search, Filter Memories and Random picking. Ignored for Memory Hints.
Extends or limits the search to Memories associated with a Receiver with this tag, depending on the API called:For Search, Random picking and Memory Hints, the search is extended to Memories associated with a Receiver with this tag. If omitted the search is limited to public Memories. As a special case, if the Giver tag is specified then the search is extended to all Memories, whoever they are associated to.For Filter Memories, the search is limited to Memories associated with a Receiver with this tag.
If set to True, recently picked Memories will not be deprioritized.
This means that a Memory never picked and a Memory picked just moments ago
will have the same probability to be picked again.
If omitted or set to False, recently picked Memories
will be much less probable to be picked again.
Used only for Random picking.
Ignored for Search, Filter Memories and Memory Hints.
Optional list of Memory IDs that must be excluded from the search result.
Optional list of memory tags. If specified, the search is limited to Memories including ALL the specified tags. Used only for Filter Memories. Ignored for Search, Random picking and Memory Hints.
Optional number of results. If omitted defaults to 5.
Optional initial result index, 0-based. If omitted defaults to 0. Used for Search, Filter Memories and Memory Hints. Ignored for Random picking.
Optional parameter, if set, filter returns only selected type of memories. Used only for Filter Memories.
Optional parameter, if set, filter returns only memories that contain media. Used only for Filter Memories.
Success
This API requires a Giver session. The From and HowMany parameters overwrite the StartFrom and NumberOfResults fields of the SearchQuerySpecs object.
The session ID
The 0-based index of the first Memory object to list
The number of the Memory objects to list
Specifications for a Memory search.
Search query. Used only for Search and Filter Memories. Ignored for Random picking and Memory Hints.
How to interpret the search query in the Text property:If "Semantic", the query is interpreted as a full question in natural language, and the search is performed in the same way a question would be posed to the Dialog State Machine.If "Literal", the query is intended as space-separated keywords, and the search is performed by looking for them as a substring in the text and titles of Memories. If omitted the search is Semantic by default. Used only for Search and Filter Memories. Ignored for Random picking and Memory Hints.
Approximate date of Memories to limit the search to. Used for Search, Filter Memories and Random picking. Ignored for Memory Hints.
Uncertainty of the date, in days. Required if Date is specified. Used for Search, Filter Memories and Random picking. Ignored for Memory Hints.
Name of the approximate place of Memories to limit the search to. Used for Search, Filter Memories and Random picking. Ignored for Memory Hints.
Latitude of the approximate place of Memories to limit the search to. Used for Search, Filter Memories and Random picking. Ignored for Memory Hints.
Longitude of the approximate place of Memories to limit the search to. Used for Search, Filter Memories and Random picking. Ignored for Memory Hints.
Uncertainty of place, in kilometers. Required if PlaceName or PlaceLatitude and PlaceLongitude are specified. Used for Search, Filter Memories and Random picking. Ignored for Memory Hints.
Extends or limits the search to Memories associated with a Receiver with this tag, depending on the API called:For Search, Random picking and Memory Hints, the search is extended to Memories associated with a Receiver with this tag. If omitted the search is limited to public Memories. As a special case, if the Giver tag is specified then the search is extended to all Memories, whoever they are associated to.For Filter Memories, the search is limited to Memories associated with a Receiver with this tag.
If set to True, recently picked Memories will not be deprioritized.
This means that a Memory never picked and a Memory picked just moments ago
will have the same probability to be picked again.
If omitted or set to False, recently picked Memories
will be much less probable to be picked again.
Used only for Random picking.
Ignored for Search, Filter Memories and Memory Hints.
Optional list of Memory IDs that must be excluded from the search result.
Optional list of memory tags. If specified, the search is limited to Memories including ALL the specified tags. Used only for Filter Memories. Ignored for Search, Random picking and Memory Hints.
Optional number of results. If omitted defaults to 5.
Optional initial result index, 0-based. If omitted defaults to 0. Used for Search, Filter Memories and Memory Hints. Ignored for Random picking.
Optional parameter, if set, filter returns only selected type of memories. Used only for Filter Memories.
Optional parameter, if set, filter returns only memories that contain media. Used only for Filter Memories.
Success
This API requires a Giver session.
The session ID
Specifications for an Add Memory request.
Memory object ID.
Memory type, e.g. Question, Story or Default. Required during Add operations. Currently possible values are: Question: this Memory is a question, hence its title is expected in interrogative form Story: this Memory is a story, hence its title is expected in affirmative form Default: this Memory is a default answer, hence its title is ignored (empty or null) CompletionDraft: this Memory is draft from a completion, obtained via a generative AI. ExpertReference: this Memory is the results of a question asked to a Board of Experts, and the answer is the name of the Expert that replied to the question.
Timestamp of the last time this Memory has been shown to a Receiver.
This value is also used when picking random memories to avoid showing
memories that have already been shown recently.
Null if the Memory has not been shown yet.
Number of times this Memory has been shown to a Receiver.
Null if the Memory has not been shown yet.
ID of the Person object to whom this Memory belongs.
Null if the Memory is public. When updating,
set it to a single dash character (-) to remove a
previously set association with a Person.
Tag of the Person object to whom this Memory belongs.
Null if the Memory is public.
Name of the Person object to whom this Memory belongs.
Null if the Memory is public.
Title of the Question or Story. Null if this Memory is a Default.
Title variants of this Question or Story. Empty if this Memory is a Default.
Approximate date associated with this Memory.
When updating, set it to midnight Jan. 1st 1 A.D.
(01/01/01 00:00:00) to clear any previously set
Date and DateUncertaintyDays.
Uncertainty in the date associated with this Memory, expressed in days.
Name of the place associated with this Memory.
When updating, set it to a single dash character
(-) to clear any previously set Place (by name or
coordinates) and PlaceUncertaintyKm.
Latitude of the place associated with this Memory.
Longitude of the place associated with this Memory.
Uncertainty of the place associated with this Memory, expressed in kilometers.
If True, when this Memory is emitted it is NOT followed by a continuation prompt,
such as "Is there anything else you want to know?".
If True, this Memory can't be randomly picked with a Timeout Event, or
explicitly searching for random Memory objects.
Ignored for Memory of type Default.
If True, this Memory's content can be emitted if the user fails
to find a question with an answer at the beginning of a session.
Ignored for Memory of type Default.
Hints for this Memory.
Minimum idle timeout, in seconds. If not specified, by default it is set to 20 seconds. The idle timeout is the time after which the client sends a Timeout event and, typically, a random question or story is picked up and proposed to the user. The actual idle timeout is computed as a random number between MinTimeout and MaxTimeout plus the reading time, where the reading time is in turn computed as the time it would take to read the answer at 150 words per minute.
Maximum idle timeout, in seconds. If not specified, by default it is set to 40 seconds. The idle timeout is the time after which the client sends a Timeout event and, typically, a random question or story is picked up and proposed to the user. The actual idle timeout is computed as a random number between MinTimeout and MaxTimeout plus the reading time, where the reading time is in turn computed as the time it would take to read the answer at 150 words per minute.
Optional type of the outcome to be sent to the DCM platform when this Memory is emitted.
Optional code of the outcome to be sent to the DCM platform when this Memory is emitted.
Tags for this Memory.
Timestamp of creation. Always present when reading/receiving an object, ignored when writing/sending an object.
ID of the session that created this object.
Timestamp of latest change. Always present when reading/receiving an object, ignored when writing/sending an object.
ID of the latest session that changed this object.
Success