Sign in
context

Search for context data in the context processor

This endpoint sends a search request to the context processor to retrieve relevant context data based on the provided query.

post/api/v1/context/search

Query parameters

metadata'true' | 'false'

Controls whether metadata is included in the response:

  • metadata=true → metadata will be included in each context item in the response.
  • metadata=false (or omitted) → metadata will be excluded from the response for better performance.
mode'fast' | 'standard'

Controls the search mode:

  • mode=fast → prioritizes speed over completeness.
  • mode=standard → performs a comprehensive search (default if omitted).

Request body

user_idstring

The ID of the user making the request

querystring required

The search query used to search for context data

similarity_thresholdnumber required

Maximum similarity threshold (must be >= minimum_similarity_threshold)

minimum_similarity_thresholdnumber required

Minimum similarity threshold

scope'internal' | 'external'

Search scope

body_metadataobject

Additional metadata for the search

Example request

{
  "user_id": "user123",
  "query": "search query for user preferences",
  "similarity_threshold": 0.8,
  "minimum_similarity_threshold": 0.5
}

Response

Context search request successfully processed. Response structure varies based on metadata query parameter: if metadata=true, each context includes metadata; if metadata=false or omitted, metadata is excluded from the response.

Changes

Changed in 13 of the 29 revisions of this API.10120

  • a172a1ab25e532See the full diff
    • ▲

      for the query request parameter metadata, default value was changed from false to false

      request-parameter-default-value-changed

    • ▲

      removed the enum value false from the query request parameter metadata

      request-parameter-enum-value-removed

    • ▲

      removed the enum value true from the query request parameter metadata

      request-parameter-enum-value-removed

    • ○

      added the new enum value false to the query request parameter metadata

      request-parameter-enum-value-added

    • ○

      added the new enum value true to the query request parameter metadata

      request-parameter-enum-value-added

  • e8e44e0e972c32See the full diff
    • ▲

      for the query request parameter metadata, default value was changed from false to false

      request-parameter-default-value-changed

    • ▲

      removed the enum value false from the query request parameter metadata

      request-parameter-enum-value-removed

    • ▲

      removed the enum value true from the query request parameter metadata

      request-parameter-enum-value-removed

    • ○

      added the new enum value false to the query request parameter metadata

      request-parameter-enum-value-added

    • ○

      added the new enum value true to the query request parameter metadata

      request-parameter-enum-value-added

  • 17acc86e90b732See the full diff
    • ▲

      for the query request parameter metadata, default value was changed from false to false

      request-parameter-default-value-changed

    • ▲

      removed the enum value false from the query request parameter metadata

      request-parameter-enum-value-removed

    • ▲

      removed the enum value true from the query request parameter metadata

      request-parameter-enum-value-removed

    • ○

      added the new enum value false to the query request parameter metadata

      request-parameter-enum-value-added

    • ○

      added the new enum value true to the query request parameter metadata

      request-parameter-enum-value-added

  • 9edfda1a76b91See the full diff
    • ○

      endpoint added

      endpoint-added

  • 510cbb709bed1See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

  • 3f676384b4bb1See the full diff
    • ○

      api operation id searchUserContext was added

      api-operation-id-added

  • 3bbf1da3b59311See the full diff
    • ●

      removed the request property

      request-property-removed

    • ○

      added the new optional request property

      new-optional-request-property

  • 601abf4c65181See the full diff
    • ○

      request property reactivated

      request-property-reactivated

  • 3100f04b9a8f1See the full diff
    • ○

      request property deprecated

      request-property-deprecated

  • 4856c8b766e43See the full diff
    • ○

      added the new optional query request parameter metadata

      new-optional-request-parameter

    • ○

      added the new optional query request parameter mode

      new-optional-request-parameter

    • ○

      request property deprecated

      request-property-deprecated