@salesforce/plugin-agent 1.41.0 → 1.42.1

package/messages/agent.adl.update.md

@@ -0,0 +1,53 @@
+# summary
+
+Update an Agentforce Data Library.
+
+# description
+
+Updates the label, description, or other mutable properties of an existing data library.
+
+# examples
+
+- Update the label of a data library:
+
+  <%= config.bin %> <%= command.id %> --library-id 1JDSG000007IbWX4A0 --name "New Name" --target-org myOrg
+
+- Update the description:
+
+  <%= config.bin %> <%= command.id %> --library-id 1JDSG000007IbWX4A0 --description "Updated description" --target-org myOrg
+
+- Update Knowledge library content fields (triggers re-indexing):
+
+  <%= config.bin %> <%= command.id %> --library-id 1JDSG000007IbWX4A0 --content-fields "Answer**c,Summary**c" --target-org myOrg
+
+- Restrict Knowledge library to public articles:
+
+  <%= config.bin %> <%= command.id %> --library-id 1JDSG000007IbWX4A0 --restrict-to-public-articles --target-org myOrg
+
+# flags.library-id.summary
+
+Agentforce Data Library ID (18-char Salesforce ID with prefix 1JD).
+
+# flags.name.summary
+
+New display name for the data library (max 80 characters).
+
+# flags.description.summary
+
+New description for the data library (max 255 characters).
+
+# flags.content-fields.summary
+
+Comma-separated list of content fields for KNOWLEDGE libraries (triggers re-indexing).
+
+# flags.restrict-to-public-articles.summary
+
+Restrict to public Knowledge articles only (KNOWLEDGE libraries, triggers re-indexing).
+
+# flags.retriever-id.summary
+
+Swap the retriever for a RETRIEVER library (must be an active Custom Retriever ID).
+
+# error.updateFailed
+
+Failed to update data library: %s

package/messages/agent.adl.upload.md

@@ -0,0 +1,55 @@
+# summary
+
+Upload a file to an SFDRIVE Agentforce Data Library.
+
+# description
+
+Performs the multi-step upload workflow: checks upload readiness, obtains a pre-signed S3 URL, uploads the file, triggers indexing, and optionally polls until the library is ready (retrieverId is populated).
+
+This command only works with SFDRIVE libraries. KNOWLEDGE libraries index automatically after creation, and RETRIEVER libraries require no file upload.
+
+# examples
+
+- Upload a file and wait for indexing to complete:
+
+  <%= config.bin %> <%= command.id %> --library-id 1JDSG000007IbWX4A0 --file ./docs/guide.pdf --target-org myOrg --wait 10
+
+- Upload a file without waiting:
+
+  <%= config.bin %> <%= command.id %> --library-id 1JDSG000007IbWX4A0 --file ./docs/guide.pdf --target-org myOrg
+
+# flags.library-id.summary
+
+Agentforce Data Library ID (18-char Salesforce ID with prefix 1JD).
+
+# flags.file.summary
+
+Path to the file to upload.
+
+# flags.wait.summary
+
+Number of minutes to wait for indexing to complete. If not specified, returns after triggering indexing.
+
+# error.uploadReadiness
+
+Library is not ready for upload: %s
+
+# error.getUploadUrl
+
+Failed to get upload URL: %s
+
+# error.s3Upload
+
+Failed to upload file to storage: %s
+
+# error.indexing
+
+Failed to trigger indexing: %s
+
+# error.polling
+
+Failed to poll library status: %s
+
+# error.timeout
+
+Indexing did not complete within the specified wait time. Use "sf agent adl get --library-id %s" to check status.