Lexicon Garden

us.off-the-clock.searchRecords

Posts, events, bookmarks, polls, documents, listings and reviews of one content space the viewer reads, matching every part of a query and every other condition given: an H3 cell, a radius around a point and a bookmark's domain. The query's words and phrases rank the results and its other parts filter them; the parts read are answered in read. Only records the viewer may see are answered, never another space's. SearchUnavailable is answered for mode=semantic before any other parameter is read, so a call without query tells a client whether meaning search is on.

Repository @off-the-clock.us did:plc:tevv7zpavtjtsvqrrwwipobt namespace authority
Details · query
Kindquery
Authorityoff-the-clock.us
Indexed

Showing version bafyreihqwmpuwp4izvj3uxdi5kqsywxtgbqus62kjga5tqwbbkkxwh4grm. Show the latest

Compare Edit in builder → Fork →

Query

query · GET

Parameters

query string

cursor

string

domain

string

Bookmarks whose subject's host is this domain or a subdomain of it, case-insensitive.

  • maxLength: 253

from

string · datetime

Records sorted at or after this time.

h3

string

An H3 cell index in hexadecimal, at resolution 4 to 10.

  • maxLength: 16

limit

integer
  • minimum: 1
  • maximum: 50
  • default: 25

mode

string

best ranks full text and meaning together; keyword requires every word; text reads the words and phrases as a full-text query; semantic ranks by meaning.

  • maxLength: 16
  • default: "best"
  • knownValues: best | keyword | text | semantic

near

string

A point as decimal degrees, latitude,longitude.

  • maxLength: 64

query

string

The search as a member typed it, read whole (D100): words, "phrases", rating:N/10, @handle, mentions:@handle, type:X (post, reply, event, bookmark, document, poll, listing or review), has:X and no:X (parent, replies, tags; has:mentions), and #tag, combined with AND. Required unless h3, near or domain is given.

  • minLength: 1
  • maxLength: 300

space

requiredstring · tid

The pair's TID.

until

string · datetime

Records sorted before this time.

within

string

The radius around near in kilometres, a decimal from 0.1 to 100; 5 by default.

  • maxLength: 16

Output

application/json

cursor

string

hits

requiredarray
itemsref
Reference

mapUrl

string · uri

For a search by place: a signed map of this page's first ten hits, numbered in order (IMG-14), when a map provider is configured.

noPlaces

boolean

True on a search by place that found nothing in a space where no record has a place yet.

read

requiredarray

The parts of the query as they were read, in reading order.

itemsref
Reference

Errors

InvalidRequest

No description in schema.

NotSpaceMember

No description in schema.

SearchUnavailable

mode=semantic on a site with no embeddings endpoint.

#hit

object

Properties

distanceKm

string

For near: the distance in kilometres from the point to the record's nearest place, a decimal.

  • maxLength: 16

score

requiredstring

The mode's own number as a decimal: BM25 made positive for keyword and text, cosine similarity for semantic, 0 for a search by place alone. Lexicons carry no floats.

  • maxLength: 32

snippet

string

The matched text with each match between [ and ].

  • maxLength: 2000

#part

object

One part of a query as it was read: one word, a phrase without its quotes, a rating's number, a handle or DID without its @, a type's name, a statement's name, or a tag without its #.

Properties

kind

requiredstring
  • maxLength: 16
  • knownValues: words | phrase | rating | author | type | has | hasNo | mentions | tag

value

requiredstring
  • maxLength: 300