app.bsky.unspecced.search_actors_skeleton#

pydantic model atproto.xrpc_client.models.app.bsky.unspecced.search_actors_skeleton.Params#

Bases: ParamsModelBase

Parameters model for app.bsky.unspecced.searchActorsSkeleton.

Show JSON schema

{
   "title": "Params",
   "description": "Parameters model for :obj:`app.bsky.unspecced.searchActorsSkeleton`.",
   "type": "object",
   "properties": {
      "q": {
         "title": "Q",
         "type": "string"
      },
      "cursor": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Cursor"
      },
      "limit": {
         "anyOf": [
            {
               "maximum": 100,
               "minimum": 1,
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 25,
         "title": "Limit"
      },
      "typeahead": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Typeahead"
      }
   },
   "additionalProperties": false,
   "required": [
      "q"
   ]
}

Fields:

cursor (Optional[str])
limit (Optional[int])
q (str)
typeahead (Optional[bool])

field cursor: Optional[str] = None#: optional pagination mechanism; may not necessarily allow scrolling through entire result set.

field limit: Optional[int] = 25#

Limit.

Constraints:

ge = 1
le = 100

field q: str [Required]#: search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended. For typeahead search, only simple term match is supported, not full syntax.

field typeahead: Optional[bool] = None#: if true, acts as fast/simple ‘typeahead’ query.

class atproto.xrpc_client.models.app.bsky.unspecced.search_actors_skeleton.ParamsDict#

Bases: TypedDict

cursor: typing_extensions.NotRequired[Optional[str]]#: optional pagination mechanism; may not necessarily allow scrolling through entire result set.

limit: typing_extensions.NotRequired[Optional[int]]#: Limit.

q: str#: search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended. For typeahead search, only simple term match is supported, not full syntax.

typeahead: typing_extensions.NotRequired[Optional[bool]]#: if true, acts as fast/simple ‘typeahead’ query.

pydantic model atproto.xrpc_client.models.app.bsky.unspecced.search_actors_skeleton.Response#

Bases: ResponseModelBase

Output data model for app.bsky.unspecced.searchActorsSkeleton.

Show JSON schema

{
   "title": "Response",
   "description": "Output data model for :obj:`app.bsky.unspecced.searchActorsSkeleton`.",
   "type": "object",
   "properties": {
      "actors": {
         "items": {
            "$ref": "#/$defs/SkeletonSearchActor"
         },
         "title": "Actors",
         "type": "array"
      },
      "cursor": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Cursor"
      },
      "hitsTotal": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Hitstotal"
      }
   },
   "$defs": {
      "SkeletonSearchActor": {
         "additionalProperties": false,
         "description": "Definition model for :obj:`app.bsky.unspecced.defs`.",
         "properties": {
            "did": {
               "title": "Did",
               "type": "string"
            },
            "$type": {
               "const": "app.bsky.unspecced.defs#skeletonSearchActor",
               "default": "app.bsky.unspecced.defs#skeletonSearchActor",
               "title": "$Type"
            }
         },
         "required": [
            "did"
         ],
         "title": "SkeletonSearchActor",
         "type": "object"
      }
   },
   "additionalProperties": false,
   "required": [
      "actors"
   ]
}

Fields:

actors (List[models.AppBskyUnspeccedDefs.SkeletonSearchActor])
cursor (Optional[str])
hits_total (Optional[int])

field actors: List[models.AppBskyUnspeccedDefs.SkeletonSearchActor] [Required]#: Actors.

field cursor: Optional[str] = None#: Cursor.

field hits_total: Optional[int] = None (alias 'hitsTotal')#: count of search hits. optional, may be rounded/truncated, and may not be possible to paginate through all hits.