diff --git a/docs/cloud/azureai/manage-flows.md b/docs/cloud/azureai/manage-flows.md index 8b6e8beb46d..62c10ea1b24 100644 --- a/docs/cloud/azureai/manage-flows.md +++ b/docs/cloud/azureai/manage-flows.md @@ -37,7 +37,7 @@ To create a flow to Azure from local flow directory, you can use pfazure flow create --flow # create the flow with metadata -pfazure flow create --flow --set display-name= description= tags.key1=value1 +pfazure flow create --flow --set display_name= description= tags.key1=value1 ``` After the flow is created successfully, you can see the flow summary in the command line. diff --git a/src/promptflow/promptflow/_cli/_pf_azure/_flow.py b/src/promptflow/promptflow/_cli/_pf_azure/_flow.py index 07ef692f856..a08c0db980a 100644 --- a/src/promptflow/promptflow/_cli/_pf_azure/_flow.py +++ b/src/promptflow/promptflow/_cli/_pf_azure/_flow.py @@ -46,17 +46,21 @@ def add_parser_flow_create(subparsers): """Add flow create parser to the pf flow subparsers.""" epilog = """ Use "--set" to set flow properties like: - display-name: Flow display name that will be created in remote. Default to be flow folder name + timestamp if not specified. + display_name: Flow display name that will be created in remote. Default to be flow folder name + timestamp if not specified. type: Flow type. Default to be "standard" if not specified. Available types are: "standard", "evaluation", "chat". description: Flow description. e.g. "--set description=." tags: Flow tags. e.g. "--set tags.key1=value1 tags.key2=value2." +Note: + In "--set" parameter, if the key name consists of multiple words, use snake-case instead of kebab-case. e.g. "--set display_name=" + Examples: + # Create a flow to azure portal with local flow folder. -pfazure flow create --flow --set display-name= type= +pfazure flow create --flow --set display_name= type= # Create a flow with more properties -pfazure flow create --flow --set display-name= type= description= tags.key1=value1 tags.key2=value2 +pfazure flow create --flow --set display_name= type= description= tags.key1=value1 tags.key2=value2 """ # noqa: E501 add_param_source = lambda parser: parser.add_argument( # noqa: E731 "--flow", type=str, help="Source folder of the flow."