Skip to content
Metrana Docs

Attributes

ListAttributes

Section titled “ListAttributes”

Lists attribute values.

ListAttributesRequest

Section titled “ListAttributesRequest”
Field JSON Type Description
workspace workspace string Name of the workspace.
organization organization optional string Slug of the organization owning the workspace. Workspace names are unique per organization, so this is required once another organization has a workspace of the same name; until then it may be omitted.
project_source projectSource AttrProjectSource
oneof source
directory_source directorySource AttrDirectorySource
oneof source
experiment_source experimentSource AttrExperimentSource
oneof source
run_source runSource AttrRunSource
oneof source
attr_filter attrFilter ListAttrFilter Controls which attributes are included in the response. If unset, all attributes are returned.
limit limit optional int64 How many attributes to retrieve in this request. Omit or set to 0 to use the server default. Must be between 1 and 10000 if specified.
resume_token resumeToken optional string If specified, resumes from last request. Other params like source must be still included in the request.

ListAttributesResponse

Section titled “ListAttributesResponse”
Field JSON Type Description
attributes attributes repeated Attribute
resume_token resumeToken optional string Optional resume token if more results are there

BrowseAttributes

Section titled “BrowseAttributes”

Lists attribute values within a single attribute directory. Works like ListAttributes but scoped to one directory level, returning subdirectories and leaf attribute values. For example, suppose the following attributes exist:

  • a1/b1/c1

  • a1/b1/c2

  • a1/b1/c3

  • a1/b2

  • a2 If user picks up “/”, response will contain “a1” as a directory and “a2” as an attribute. If user asks for “/a1”, response will contain “b1” as a directory and “b2” as an attribute.

  • gRPC: /metrana_protobuf.query.v1.svc.QueryService/BrowseAttributes (unary)

  • REST: POST /api/query/v1/attributes:browse

  • Request: BrowseAttributesRequest

  • Response: BrowseAttributesResponse

BrowseAttributesRequest

Section titled “BrowseAttributesRequest”
Field JSON Type Description
workspace workspace string Name of the workspace.
organization organization optional string Slug of the organization owning the workspace. Workspace names are unique per organization, so this is required once another organization has a workspace of the same name; until then it may be omitted.
directory directory string Directory to fetch attribute values from. Empty string and “/” are treated equally and interpreted as fetching from root directory only.
project_source projectSource AttrProjectSource
oneof source
directory_source directorySource AttrDirectorySource
oneof source
experiment_source experimentSource AttrExperimentSource
oneof source
run_source runSource AttrRunSource
oneof source
attr_filter attrFilter BrowseAttrFilter Controls which attributes are included in the response. If unset, all attributes are returned.
limit limit optional int64 How many attributes to retrieve in this request. Omit or set to 0 to use the server default. Must be between 1 and 10000 if specified. Limit includes directories too.
resume_token resumeToken optional string If specified, resumes from last request. Other params like source must be still included in the request.

BrowseAttributesResponse

Section titled “BrowseAttributesResponse”
Field JSON Type Description
directories directories repeated string List of subdirectories at this level.
attributes attributes repeated Attribute Leaf attribute values at this level.
resume_token resumeToken optional string Optional resume token if more results are there

ListRLEnvAttributes

Section titled “ListRLEnvAttributes”

Lists RL environment config attribute VALUES for one run + environment. Like ListAttributes but the source is a specific run+environment (both mandatory). An optional episode selects which point on the environment’s episode timeline to read: unset reads the latest config in effect; set reads the (potentially historic) value in effect at that episode (greatest episode <= the requested one wins).

ListRLEnvAttributesRequest

Section titled “ListRLEnvAttributesRequest”

RL env attribute VALUES are read from a single run + environment (both mandatory). episode selects the point on the environment’s episode timeline; unset = latest config in effect, set = value in effect at that episode.

Field JSON Type Description
workspace workspace string Name of the workspace.
organization organization optional string Slug of the organization owning the workspace. Workspace names are unique per organization, so this is required once another organization has a workspace of the same name; until then it may be omitted.
project project string Name of the project.
run run string
environment environment string
episode episode optional uint64 Episode to read the config as of. Unset reads the latest config; set reads the value in effect at that episode (greatest episode <= this one wins).
attr_filter attrFilter ListAttrFilter Controls which attributes are included in the response. If unset, all attributes are returned.
limit limit optional int64 How many attributes to retrieve in this request. Omit or set to 0 to use the server default. Must be between 1 and 10000 if specified.
resume_token resumeToken optional string If specified, resumes from last request. Other params like source must be still included in the request.

ListRLEnvAttributesResponse

Section titled “ListRLEnvAttributesResponse”
Field JSON Type Description
attributes attributes repeated Attribute
resume_token resumeToken optional string Optional resume token if more results are there

BrowseRLEnvAttributes

Section titled “BrowseRLEnvAttributes”

Browses RL environment config attribute values within a single attribute directory (see BrowseAttributes for the tree example). Same run + environment + optional episode resolution as ListRLEnvAttributes.

BrowseRLEnvAttributesRequest

Section titled “BrowseRLEnvAttributesRequest”
Field JSON Type Description
workspace workspace string Name of the workspace.
organization organization optional string Slug of the organization owning the workspace. Workspace names are unique per organization, so this is required once another organization has a workspace of the same name; until then it may be omitted.
project project string Name of the project.
run run string
environment environment string
episode episode optional uint64 See ListRLEnvAttributesRequest.episode.
directory directory string Directory to fetch attribute values from. Empty string and “/” are treated equally and interpreted as fetching from root directory only.
attr_filter attrFilter BrowseAttrFilter Controls which attributes are included in the response. If unset, all attributes are returned.
limit limit optional int64 How many attributes to retrieve in this request. Omit or set to 0 to use the server default. Must be between 1 and 10000 if specified. Limit includes directories too.
resume_token resumeToken optional string If specified, resumes from last request. Other params like source must be still included in the request.

BrowseRLEnvAttributesResponse

Section titled “BrowseRLEnvAttributesResponse”
Field JSON Type Description
directories directories repeated string
attributes attributes repeated Attribute
resume_token resumeToken optional string Optional resume token if more results are there