Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

clarify agent input param #343

Merged
merged 4 commits into from
Aug 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions .wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,31 @@ timepoints
UI
webUiSidebar
xlsx
param
str
ScanResult
timespan
datetime
Datetime
tempfile
TemporaryFile
checksums
FileParam
MultiFileParam
FileTag
txt
AgentModelsAndMethods
SDKSidebar
NodeChip
FileWatcherResult
TriggerFlowParams
params
benchling
Benchling
cron
Dataclass
subdirectories


ApiOutlined
AppstoreOutlined
Expand Down
4 changes: 2 additions & 2 deletions docs/sdk/markdowns/AgentModelsAndMethods.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ TriggerFlowParams specifies the inputs for the Flow executed when all files are
- _param_ **single_file_params**: Optional[Dict[str, FileParam]] - Dict of FileParam objects indexed by `node name`.`param name`. These parameters are used for Nodes that accept a single file as input.
- _param_ **multi_file_params**: Optional[Dict[str, MultiFileParam]] - Dict of MultiFileParam objects indexed by `node name`.`param name`. These parameters are used for Nodes that accept multiple files as input.
- _param_ **benchling_tag**: Optional[Tag] - Additional parameters to be passed to flow. This parameter is used for inputs to the Input_Benchling node.
- _param_ **additional_params**: Optional[Dict[str, str]] - Additional parameters to be passed to flow. This parameter is used for inputs to the Input_Param node.
- _param_ **additional_params**: Optional[Dict[str, str]] - Additional parameters to be passed to flow. This parameter is used for inputs to the Input_Param node; the key is the name if the Node name for the input parameter, and the value is the string to pass into the Node.

### FileParam Class

Expand All @@ -63,7 +63,7 @@ FileParam specifies files to be uploaded to Ganymede Cloud and their correspondi
- _param_ **parent_dir**: str - Path within the Agent watch directory containing the file. For example. if C:/Users/username/watch_dir/ is being watched and C:/Users/username/watch_dir/abc/def/my_file.txt is found, then parent_dir would be "abc/def"
- _param_ **upload_ts**: str - Timestamp string in ISO format of when file was uploaded to the Agent watch directory, e.g. "2021-01-01T00:00:00Z"
- _param_ **upload_path**: Optional[str] - Path in Ganymede storage where file will be uploaded
- _param_ **tags*: Optional[List[FileTag]] - List of tags to be applied to the file
- _param_ **tags**: Optional[List[FileTag]] - List of tags to be applied to the file
- _param_ **bucket_name**: str - Bucket associated with file
- _param_ **files**: str - Alternative method for specifying file contents, where the key is the filename and the value is the file body.

Expand Down