[ aws . opensearchmemory ]

search-events

Description

Searches a space’s events by relevance. It works like SearchMemories without the memory type and strategy selector. The query is a subset of the OpenSearch Query DSL. The service validates it, limits the search to the actor in actorId and the sessions in sessionIds , and returns ranked results. Each result is the matching chunk of an event, not the whole event. You can page through only a limited number of results. A request past that limit fails with ValidationException (reason invalidNextToken ), and the message gives the limit.

If the results are larger than 5 MiB, the request fails with ValidationException (reason queryBodyTooLarge ). Lower maxResults .

If the request would exceed the service’s rate for embedding requests, it fails with ThrottlingException . Retry with exponential backoff.

If the space uses a customer managed AWS KMS key, the call can also fail because of the key. It fails with AccessDeniedException if you aren’t allowed to use the key, and with ThrottlingException if AWS KMS throttles the request. It fails with ValidationException if the key is disabled, pending deletion, or deleted.

See also: AWS API Documentation

search-events uses document type values. Document types follow the JSON data model where valid values are: strings, numbers, booleans, null, arrays, and objects. For command input, options and nested parameters that are labeled with the type document must be provided as JSON. Shorthand syntax does not support document types.

search-events is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: events

Synopsis

  search-events
--space-id <value>
--actor-id <value>
[--session-ids <value>]
[--sort <value>]
--search-query <value>
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]
[--help]

Options

--space-id (string) [required]

The space whose events to search. Use actorId and sessionIds to narrow the search within it.

Constraints:

  • min: 1
  • max: 64
  • pattern: sp-[a-f0-9]{12}

--actor-id (string) [required]

The actor whose events to search (exact match). Required: every search covers exactly one actor, and an event stored without an actor is never returned. Narrow the search further with sessionIds , combined by AND. This is the only way to filter by actor: a query that references system_metadata.actor_id fails with ValidationException (reason nonFilterableField ).

Constraints:

  • min: 1
  • max: 255
  • pattern: [a-zA-Z0-9][a-zA-Z0-9-_]*

--session-ids (list)

Returns only events from one of these sessions (exact match). Combined with actorId by AND. Omit for no session filter. An empty list fails validation. An event stored without a session never matches a session filter. This is the only way to filter by session: a query that references system_metadata.session_id fails with ValidationException (reason nonFilterableField ).

Constraints:

  • min: 1
  • max: 10

(string)

The ID of a session, which groups an actor’s events.

Constraints:

  • min: 1
  • max: 255
  • pattern: [a-zA-Z0-9][a-zA-Z0-9-_]*

Syntax:

"string" "string" ...

--sort (document)

The sort order (see SearchSort ). Omit to return the most relevant events first.

JSON Syntax:

{...}

--search-query (document) [required]

The query: a subset of the OpenSearch Query DSL (see SearchQuery ), validated by the same rules as on SearchMemories . Query event text as text and embeddings as vector . A search covers both conversation turns and chunks of documents submitted as a blob . You can’t use actor and session fields here. Use the top-level actorId and sessionIds .

To search only the content of particular events, filter on event_ids with term or terms , for example with the sourceEventIds that a SearchMemories result returns. A terms clause on event_ids can list up to 10 event IDs. More IDs fail with ValidationException (reason queryBodyTooLarge ). You can use event_ids only in term , terms , and exists queries.

JSON Syntax:

{...}

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

Constraints:

  • min: 1
  • max: 100

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream
  • off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

--help (boolean)

Display help for the command/subcommand.

Output

events -> (list)

The matching event chunks, in the order sort requests, or most relevant first when it has none. Empty when nothing matches. Each result is the matching chunk of an event. Call GetEvent for the whole event.

(structure)

A SearchEvents result: the matching chunk of an event and its provenance. Unlike EventSummary from ListEvents , it has a relevance score and the matched content, but not the full payload.

eventId -> (string) [required]

The ID of the event that the chunk belongs to. Use it with GetEvent or DeleteEvent .

Constraints:

  • min: 1
  • max: 128

score -> (double)

The relevance score of the result. A higher score is more relevant. Scores aren’t normalized to a fixed range and can be greater than 1, so use them only to order results.

systemMetadata -> (structure)

Provenance for the chunk: the owning actor and session, and when it was created and last updated. It is the same block that ListMemories and SearchMemories return. Event chunks are never modified, so updatedAt always equals createdAt .

Absent when the service has no provenance for the chunk.

actorId -> (string)

The owning actor. Absent when none was recorded.

Constraints:

  • min: 1
  • max: 255
  • pattern: [a-zA-Z0-9][a-zA-Z0-9-_]*

sessionId -> (string)

The owning session. Absent when none was recorded.

Constraints:

  • min: 1
  • max: 255
  • pattern: [a-zA-Z0-9][a-zA-Z0-9-_]*

createdAt -> (timestamp)

When the record was created. Always present on ListMemories and GetMemory . It can be absent from search results.

updatedAt -> (timestamp)

When the record was last updated. Equals createdAt for a record that has never been updated, and always for a SearchEvents result.

metadata -> (map)

The event’s metadata tags. All values are strings. In a query, filter on a tag as metadata.<key> .

Constraints:

  • min: 0
  • max: 15

key -> (string)

A metadata key: letters, digits, hyphens (- ), and underscores (_ ). Dots are not allowed, because a query uses dots to separate nested field names.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9_-]+

value -> (string)

The value of a metadata entry.

Constraints:

  • min: 0
  • max: 256
  • pattern: [a-zA-Z0-9\s._:\/=+@-]*

matchedContent -> (string)

The text of the matching chunk.

Constraints:

  • min: 0
  • max: 40000

nextToken -> (string)

The token for the next set of results. Absent when there are no more results.

Constraints:

  • min: 1
  • max: 2048