使用帮助

[chenxizhang]

我们为每个命令和参数都提供了详细的帮助说明，也提供了很多具体的范例，你可以通过下面的方式来获取命令的完整帮助。

Get-Help New-ChatGPTConversation -Full

NAME
    New-ChatGPTConversation

SYNOPSIS
    创建一个新的 ChatGPT 对话，或者如果您直接指定了 prompt 参数，则获取聊天完成结果。


SYNTAX
    New-ChatGPTConversation [[-prompt] <String>] [-api_key <String>] [-model <String>] [-endpoint <String>] [-system
    <String>] [-config <PSObject>] [-outFile <String>] [-json] [-context <PSObject>] [-headers <PSObject>]
    [<CommonParameters>]


DESCRIPTION
    创建一个新的 ChatGPT 对话，您可以像与人聊天一样与 OpenAI 服务聊天。 如果您指定了 prompt
    参数，您也可以获得聊天完成结果。


PARAMETERS
    -api_key <String>
        用于访问 OpenAI Service 的 API 密钥，如果未指定，将从环境变量 OPENAI_API_KEY 中读取。 您也可以使用
        "token"、"access_token" 或 "accesstoken" 作为别名。

        Required?                    false
        Position?                    named
        Default value                None
        Accept pipeline input?       False
        Accept wildcard characters?  false

    -model <String>
        用于此请求的模型，您也可以在环境变量 OPENAI_API_MODEL 中设置。 如果您使用的是 Azure OpenAI
        Service，则模型应是您在门户中创建的部署名称。

        Required?                    false
        Position?                    named
        Default value                None
        Accept pipeline input?       False
        Accept wildcard characters?  false

    -endpoint <String>
        用于此请求的端点，您也可以在环境变量 OPENAI_API_ENDPOINT 中设置。 您还可以使用一些特殊值来指定端点，如
        "ollama", "local", "kimi", "zhipu"。

        Required?                    false
        Position?                    named
        Default value                None
        Accept pipeline input?       False
        Accept wildcard characters?  false

    -system <String>
        系统提示，这是一个字符串，您可以使用它定义您希望它扮演的角色，例如，"You are a chatbot, please answer the
        user's question according to the user's language."
        如果您提供一个文件路径到这个参数，我们将读取文件作为系统提示。 您也可以为此参数指定一个 URL，我们将读取 URL
        作为系统提示。 您可以通过使用 "lib:xxxxx" 作为提示从库 (https://github.com/code365opensource/promptlibrary)
        读取提示，例如，"lib:fitness"。

        Required?                    false
        Position?                    named
        Default value                You are a chatbot, please answer the user's question according to the user's
        language.
        Accept pipeline input?       False
        Accept wildcard characters?  false

    -prompt <String>
        如果您希望立即获得结果，您可以使用此参数定义提示。 它不会启动聊天对话。
        如果您提供一个文件路径到这个参数，我们将读取文件作为提示。 您也可以为此参数指定一个 URL，我们将读取 URL
        作为提示。 您可以通过使用 "lib:xxxxx" 作为提示从库 (https://github.com/code365opensource/promptlibrary)
        读取提示，例如，"lib:fitness"。

        Required?                    false
        Position?                    1
        Default value                None
        Accept pipeline input?       True (ByValue)
        Accept wildcard characters?  false

    -config <PSObject>
        API 调用的动态设置，它可以满足每个模型的所有要求。 请传递一个自定义对象到这个参数，如
        @{temperature=1;max_tokens=1024}。

        Required?                    false
        Position?                    named
        Default value                None
        Accept pipeline input?       False
        Accept wildcard characters?  false

    -outFile <String>
        如果您希望将结果保存到文件中，您可以使用此参数设置文件路径。 您也可以使用 "out" 作为别名。

        Required?                    false
        Position?                    named
        Default value                None
        Accept pipeline input?       False
        Accept wildcard characters?  false

    -json [<SwitchParameter>]
        以 json 格式发送响应。

        Required?                    false
        Position?                    named
        Default value                False
        Accept pipeline input?       False
        Accept wildcard characters?  false

    -context <PSObject>
        如果您希望将一些动态值传递给提示，您可以在这里使用 context 参数。
        它可以是任何东西，您只需在这里指定一个自定义的 PowerShell 对象。 您可以通过使用 {{you_variable_name}}
        语法在系统提示或用户提示中定义变量，然后将数据传递给 context 参数，如 @{you_variable_name="your value"}。
        如果有多个变量，您可以使用 @{variable1="value1";variable2="value2"}。

        Required?                    false
        Position?                    named
        Default value                None
        Accept pipeline input?       False
        Accept wildcard characters?  false

    -headers <PSObject>
        如果您希望将一些自定义头传递到 API 调用，您可以使用此参数。 您可以传递一个自定义的哈希表给这个参数，如
        @{header1="value1";header2="value2"}。

        Required?                    false
        Position?                    named
        Default value                None
        Accept pipeline input?       False
        Accept wildcard characters?  false

    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS
    System.String, 完成的结果。



NOTES




    -------------------------- EXAMPLE 1 --------------------------

    New-ChatGPTConversation

    使用所有默认设置的 OpenAI Service，将从环境变量 (OPENAI_API_KEY) 读取 API 密钥，进入聊天模式。
    -------------------------- EXAMPLE 2 --------------------------

    New-ChatGPTConversation -api_key "your api key" -model "gpt-3.5-turbo"

    使用指定的 API 密钥和模型的 OpenAI Service，进入聊天模式。
    -------------------------- EXAMPLE 3 --------------------------

    chat -system "You help me to translate the text to Chinese."

    使用 OpenAI Service 翻译文本（指定系统提示），将从环境变量 (OPENAI_API_KEY) 读取 API 密钥，进入聊天模式。
    -------------------------- EXAMPLE 4 --------------------------

    chat -endpoint "ollama" -model "llama3"

    使用本地模型的 OpenAI Service，进入聊天模式。
    -------------------------- EXAMPLE 5 --------------------------

    chat -endpoint $endpoint $env:OPENAI_API_ENDPOINT_AZURE -model $env:OPENAI_API_MODEL_AZURE -api_key
    $env:OPENAI_API_KEY_AZURE

    使用指定的 API 密钥和模型的 Azure OpenAI Service，进入聊天模式。
    -------------------------- EXAMPLE 6 --------------------------

    gpt -system "Translate the text to Chinese." -prompt "Hello, how are you?"

    使用 OpenAI Service 翻译文本（指定系统提示），将从环境变量 (OPENAI_API_KEY) 读取 API 密钥，模型从 OPENAI_API_MODEL
    读取（如果存在）或默认使用 "gpt-3.5-turbo"，直接获取聊天完成结果。
    -------------------------- EXAMPLE 7 --------------------------

    "Hello, how are you?" | gpt -system "Translate the text to Chinese."

    使用 OpenAI Service 翻译文本（指定系统提示，用户提示将通过管道传递），将从环境变量 (OPENAI_API_KEY) 读取 API
    密钥，模型从 OPENAI_API_MODEL 读取（如果存在）或默认使用 "gpt-3.5-turbo"，直接获取聊天完成结果。

RELATED LINKS
    https://github.com/chenxizhang/openai-powershell

Get-Help New-ImageGeneration -Full

NAME
    New-ImageGeneration

SYNOPSIS
    使用 DALL-E-3 模型从提示生成图像。


SYNTAX
    New-ImageGeneration [[-prompt] <String>] [-api_key <String>] [-endpoint <String>] -azure [-size <String>]
    [-outfolder <String>] [-environment <String>] [<CommonParameters>]


DESCRIPTION
    使用 DALL-E-3 模型从提示生成图像。 图像大小可以是 1024x1024，1792x1024，1024x1792。


PARAMETERS
    -prompt <String>
        生成图像的提示，这是必需的，并且可以从管道传递。 如果您想使用文件作为提示，可以在这里指定文件路径。
        您也可以指定一个 URL 作为提示，我们将读取 URL 作为提示。 您可以通过使用 "lib:xxxxx"
        作为提示，从库（https://github.com/code365opensource/promptlibrary）中读取提示，例如，"lib:fitness"。

        Required?                    false
        Position?                    1
        Default value                None
        Accept pipeline input?       False
        Accept wildcard characters?  false

    -api_key <String>
        访问 OpenAI 服务的 API 密钥，如果没有指定，API 密钥将从环境变量 OPENAI_API_KEY 中读取。 如果您使用 Azure
        OpenAI 服务，您可以通过环境变量 OPENAI_API_KEY_AZURE 或 OPENAI_API_KEY_AZURE_<environment> 指定 API
        密钥，<environment>
        可以是您想要的任何名称，例如，OPENAI_API_KEY_AZURE_DEV，OPENAI_API_KEY_AZURE_PROD，OPENAI_API_KEY_AZURE_TEST
        等。

        Required?                    false
        Position?                    named
        Default value                None
        Accept pipeline input?       False
        Accept wildcard characters?  false

    -endpoint <String>
        访问 OpenAI 服务的端点，如果没有指定，端点将从环境变量 OPENAI_ENDPOINT 中读取。 如果您使用 Azure OpenAI
        服务，您可以通过环境变量 OPENAI_ENDPOINT_AZURE 或 OPENAI_ENDPOINT_AZURE_<environment> 指定端点，<environment>
        可以是您想要的任何名称，例如，OPENAI_ENDPOINT_AZURE_DEV，OPENAI_ENDPOINT_AZURE_PROD，OPENAI_ENDPOINT_AZURE_TEST
         等。

        Required?                    false
        Position?                    named
        Default value                None
        Accept pipeline input?       False
        Accept wildcard characters?  false

    -azure [<SwitchParameter>]
        使用 Azure OpenAI 服务，如果指定，API 密钥和端点将从环境变量 OPENAI_API_KEY_AZURE 或
        OPENAI_API_KEY_AZURE_<environment> 中读取，<environment>
        可以是您想要的任何名称，例如，OPENAI_API_KEY_AZURE_DEV，OPENAI_API_KEY_AZURE_PROD，OPENAI_API_KEY_AZURE_TEST
        等。 和 OPENAI_ENDPOINT_AZURE 或 OPENAI_ENDPOINT_AZURE_<environment>。

        Required?                    true
        Position?                    named
        Default value                False
        Accept pipeline input?       False
        Accept wildcard characters?  false

    -size <String>
        要生成的图像的大小，值可以是 small (1024x1024)，medium(1792x1024)，large(1024x1792)，默认是 small。

        Required?                    false
        Position?                    named
        Default value                Small
        Accept pipeline input?       False
        Accept wildcard characters?  false

    -outfolder <String>
        保存生成的图像的文件夹，默认是当前文件夹。 您可以使用 out 作为此参数的别名。

        Required?                    false
        Position?                    named
        Default value                .
        Accept pipeline input?       False
        Accept wildcard characters?  false

    -environment <String>
        环境名称，如果您使用 Azure OpenAI
        服务，可以通过此参数指定环境，环境名称可以是您想要的任何名称，例如，dev，prod，test
        等，环境名称将用于从环境变量中读取 API 密钥和端点，例如，OPENAI_API_KEY_AZURE_DEV，OPENAI_ENDPOINT_AZURE_DEV
        等。 您可以使用 env 作为此参数的别名。

        Required?                    false
        Position?                    named
        Default value                None
        Accept pipeline input?       False
        Accept wildcard characters?  false

    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS
    System.String, 生成的图像的文件路径。



NOTES




    -------------------------- EXAMPLE 1 --------------------------

    New-ImageGeneration -prompt "A painting of a cat sitting on a chair"

    使用 dall-e-3 模型生成图像，图像大小为 1024x1024，生成的图像将保存到当前文件夹。
    -------------------------- EXAMPLE 2 --------------------------

    image -prompt "A painting of a cat sitting on a chair"

    使用别名（image）生成图像，图像大小为 1024x1024，生成的图像将保存到当前文件夹。
    -------------------------- EXAMPLE 3 --------------------------

    "A painting of a cat sitting on a chair" | New-ImageGeneration

    从管道传递提示，图像大小为 1024x1024，生成的图像将保存到当前文件夹。
    -------------------------- EXAMPLE 4 --------------------------

    New-ImageGeneration -prompt "A painting of a cat sitting on a chair" -size medium -outfolder "c:\temp" -api_key
    "your API key" -endpoint "your endpoint"

    使用 dall-e-3 模型生成图像，图像大小为 1792x1024，生成的图像将保存到 c:\temp 文件夹，使用您自己的 API 密钥和端点。
    -------------------------- EXAMPLE 5 --------------------------

    New-ImageGeneration -prompt "A painting of a cat sitting on a chair" -size small -outfolder "c:\temp" -azure

    使用 dall-e-3 模型生成图像，图像大小为 1024x1024，生成的图像将保存到 c:\temp 文件夹，使用 Azure OpenAI 服务。
    -------------------------- EXAMPLE 6 --------------------------

    New-ImageGeneration -prompt "A painting of a cat sitting on a chair" -size small -outfolder "c:\temp" -azure
    -environment "dev"

    使用 dall-e-3 模型生成图像，图像大小为 1024x1024，生成的图像将保存到 c:\temp 文件夹，使用 Azure OpenAI
    服务，从环境变量 OPENAI_API_KEY_AZURE_DEV 和 OPENAI_ENDPOINT_AZURE_DEV 中读取 API 密钥和端点。
    -------------------------- EXAMPLE 7 --------------------------

    New-ImageGeneration -outfolder "c:\temp" -azure -prompt "c:\temp\prompt.txt"

    使用 dall-e-3 模型生成图像，图像大小为 1024x1024，生成的图像将保存到 c:\temp 文件夹，使用 Azure OpenAI
    服务，并使用文件 c:\temp\prompt.txt 中的提示

RELATED LINKS
    https://github.com/chenxizhang/openai-powershell