aws / aws-sdk-go-v2

AWS SDK for the Go programming language.
https://aws.github.io/aws-sdk-go-v2/docs/
Apache License 2.0
2.66k stars 636 forks source link

Incorrect description of a field `ParserMode` of `bedrockagent.types.PromptConfiguration` #2492

Closed nrnrk closed 8 months ago

nrnrk commented 8 months ago

Describe the issue

The description of ParserMode is Creation Mode for Prompt Configuration. and it is not suitable. This should be like Creation Mode for parser Lambda function. I tried to fix this by editing codegen/sdk-codegen/aws-models/bedrock-agent.json and generating codes but the PR template says I should create an issue first when I fix this.

--- a/codegen/sdk-codegen/aws-models/bedrock-agent.json
+++ b/codegen/sdk-codegen/aws-models/bedrock-agent.json
@@ -2366,9 +2366,6 @@
                         "smithy.api#enumValue": "OVERRIDDEN"
                     }
                 }
-            },
-            "traits": {
-                "smithy.api#documentation": "Creation Mode for Prompt Configuration."
             }
         },
         "com.amazonaws.bedrockagent#DataSource": {
@@ -5618,7 +5615,10 @@
                     "target": "com.amazonaws.bedrockagent#PromptType"
                 },
                 "promptCreationMode": {
-                    "target": "com.amazonaws.bedrockagent#CreationMode"
+                    "target": "com.amazonaws.bedrockagent#CreationMode",
+                    "traits": {
+                        "smithy.api#documentation": "Creation Mode for Prompt Configuration."
+                    }
                 },
                 "promptState": {
                     "target": "com.amazonaws.bedrockagent#PromptState"
@@ -5630,7 +5630,10 @@
                     "target": "com.amazonaws.bedrockagent#InferenceConfiguration"
                 },
                 "parserMode": {
-                    "target": "com.amazonaws.bedrockagent#CreationMode"
+                    "target": "com.amazonaws.bedrockagent#CreationMode",
+                    "traits": {
+                        "smithy.api#documentation": "Creation Mode for parser Lambda function."
+                    }
                 }
             },

Links

https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/bedrockagent@v1.2.1/types#PromptConfiguration

type PromptConfiguration struct {

    // Base Prompt Template.
    BasePromptTemplate *[string](https://pkg.go.dev/builtin#string)

    // Configuration for inference in prompt configuration
    [InferenceConfiguration](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/bedrockagent@v1.2.1/types#InferenceConfiguration) *InferenceConfiguration

    // Creation Mode for Prompt Configuration.
    ParserMode [CreationMode](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/bedrockagent@v1.2.1/types#CreationMode)

    // Creation Mode for Prompt Configuration.
    Prompt[CreationMode](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/bedrockagent@v1.2.1/types#CreationMode) CreationMode

    // Prompt State.
    [PromptState](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/bedrockagent@v1.2.1/types#PromptState) PromptState

    // Prompt Type.
    [PromptType](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/bedrockagent@v1.2.1/types#PromptType) PromptType
    // contains filtered or unexported fields
}

AWS Go SDK V2 Module Versions Used

github.com/aws/aws-sdk-go-v2/service/bedrockagent@v1.2.1

lucix-aws commented 8 months ago

This documentation comes from the API model owned by the service team. The models as committed to this repo are pushed to us on service updates and cannot be changed directly (that's why there's the "create an issue" redirect).

RanVaknin commented 8 months ago

Hi @nrnrk ,

Adding to what @lucix-aws was saying, you can open documentation fix requests by using the feedback button found on every doc page on AWS.

This will open a ticket directly with the service team that owns that documentation.

Since this is not actionable by the SDK team, I'm inclined to close this. If you need anything else please let us know.

All the best, Ran~

github-actions[bot] commented 8 months ago

This issue is now closed. Comments on closed issues are hard for our team to see. If you need more assistance, please open a new issue that references this one.

nrnrk commented 8 months ago

Thank you. I'll make requests on the doc page.