本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。 # 對 Amazon Q Developer 中的程式碼產生案例進行故障診斷 使用 Amazon Q Developer 時，您可能會遇到下列程式碼產生和解析度不正確的常見案例： + [產生空的程式碼](#suggestions-troubleshooting) + [持續註解](#comments-troubleshooting) + [不正確的內嵌程式碼產生](#code-generation-troubleshooting) + [聊天結果不足](#chat-results-troubleshooting) ## 產生空的程式碼 開發程式碼時，您可能會注意到下列問題： + Amazon Q 不提供建議。 + 訊息「無來自 Amazon Q 的建議」會顯示在您的 IDE 中。 您的第一個想法可能是 Amazon Q 無法正常運作。不過，這些問題的根本原因通常與指令碼中的內容或在 IDE 中開啟的專案相關聯。 如果 Amazon Q Developer 未自動提供建議，您可以使用下列捷徑手動執行 Amazon Q 內嵌建議： + PC** **- **Alt\$1C** + MacOS - **Option\$1C** 如需詳細資訊，請參閱《*Amazon Q 開發人員使用者指南*》中的[使用快速鍵](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/actions-and-shortcuts.html)。 在大多數情況下，Amazon Q 會產生建議。當 Amazon Q 傳回「無來自 Amazon Q 的建議」訊息時，請檢閱此問題的下列常見解決方案： + **內容不足** – 確定存在適用的程式庫。確定指令碼中定義的類別和函數與新程式碼相關。 + **模棱兩可的提示** – 如果提示混淆或不明確，Amazon Q 會在提出內嵌程式碼建議時表現不佳。在這些案例中，請在程式碼和註解中更具體地引出適當的回應。 如果您停滯，請盡可能繼續編碼。一般而言，Amazon Q 會辨識您的意圖，這會觸發它提供建議。另一個選項是傳送程式碼片段，其中包含 Amazon Q 聊天中的提示說明。如需詳細資訊，請參閱《[Amazon Q 開發人員使用者指南》中的將程式碼傳送至](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/explain-update-code.html#send-code) *Amazon Q*。 ## 持續註解 您可以使用註解撰寫提示，而且只會從 Amazon Q 接收一般或重複的註解行。 輸入: ``` // Kafka test ``` 結果： ``` // Kafka test // Kafka test // Kafka test // Kafka test ``` 一般而言，此問題是由於指令碼缺乏內容或提示指示不佳所致。我們建議您將標準格式用於指定語言的註解。在此範例中，使用者變更了用於註解區塊`/* */ `的提示，該變更從 Amazon Q 獲得更好的效能。 輸入: ``` /* * Create a unit test to push a message to a Kafka topic */ ``` 結果： 在此結果中，使用者依序接受數個建議。 ``` /* * Create a unit test to push a message to a Kafka topic */ import org.junit.Test; import java.util.Properties; import org.apache.kafka.clients.producer.KafkaProducer; import org.apache.kafka.clients.producer.ProducerRecord; import static org.junit.Assert.assertEquals; // create function for a Kafka test public class KafkaTest { @Test public void testKafka() { // create Kafka producer Properties props = new Properties(); props.put("bootstrap.servers", "localhost:9092"); props.put("key.serializer", "org.apache.kafka.common.serialization.StringSerializer"); props.put("value.serializer", "org.apache.kafka.common.serialization.StringSerializer"); KafkaProducer producer = new KafkaProducer<>(props); // create Kafka topic String topic = "test"; // send message to Kafka topic producer.send(new ProducerRecord<>(topic, "key", "value")); // close Kafka producer producer.close(); // assert that message was sent successfully assertEquals("value", KafkaTest.consumer.poll().value()); } } ``` ## 不正確的內嵌程式碼產生 有時，Amazon Q Developer 內嵌建議沒有用或不符合提示的目標。有時，內嵌程式碼建議可能會提供類似簡單 Hello World 方法的一般函數。 當內嵌程式碼建議沒有幫助時，請嘗試下列最佳實務： + 檢閱指令碼的內容。通常，您提供的內容越多，您從 Amazon Q 獲得的結果就越好。 + 如果內容不同和/或吵雜，請將您的程式碼模組化。將相同指令碼中的類似函數分組。依目標分隔不同的類別和函數。 + 以策略方式撰寫您的類別和函數名稱，以協助 Amazon Q 提供更好的建議。 在此範例中，開發人員從頭開始撰寫指令碼，將檔案上傳至 Hadoop。 輸入: ``` class MyFunction{ // create function to read data locally and upload to HDFS filesystem ``` 結果： ``` class MyFunction{ // create function to read local data file path and upload to HDFS filesystem public void readAndUploadToHDFS(String inputPath, String outputPath) throws IOException { // read data from local file BufferedReader in = new BufferedReader(new FileReader(inputPath)); } ``` 雖然 Amazon Q 提供建議，但不符合開發人員的期望。為了改善效能，開發人員會匯入程式庫，並將類別名稱變更為代表 Hadoop 公用程式。 修正： ``` import java.io.BufferedReader; import java.io.IOException; import java.io.FileReader; // import applicable hadoop libraries for IO operations import org.apache.hadoop.fs.Path; class HadoopUtilities{ // create function to read local data file path and upload to HDFS filesystem } ``` 結果： 在此結果中，開發人員會依序接受數個建議。 ``` class HadoopUtilities{ // create function to read local data file path and upload to HDFS filesystem public static void uploadToHDFS(String localFilePath, String hdfsFilePath) throws IOException { // create HDFS file path object Path hdfsPath = new Path(hdfsFilePath); // create local file path object Path localPath = new Path(localFilePath); // create hadoop file system object org.apache.hadoop.fs.FileSystem hdfs = org.apache.hadoop.fs.FileSystem.get(new org.apache.hadoop.conf.Configuration()); // upload local file to HDFS hdfs.copyFromLocalFile(localPath, hdfsPath); // close HDFS file system hdfs.close(); System.out.println("File uploaded successfully!"); } ``` 在相同的HadoopUtilities指令碼中，開發人員新增註解提示來讀取 Amazon Simple Queue Service (Amazon SQS) 主題。 輸入: ``` // read message from SQS ``` 結果： ``` // read message from SQS public static void readMessageFromSQS(String message) { System.out.println("Received message from SQS: " + message); ``` 與其使用 Java 方法從 Amazon SQS 讀取 SQS 訊息，Amazon Q 建議列印字串方法。不過，此建議不符合開發人員的原始目標。 在這種情況下，最好重新修改程式碼。指令碼的重點是 Hadoop 方法。因此，建立專門用於 SQS 操作的公用程式指令碼可能是更好的方法。 為 SQS 公用程式建立個別類別可改善內嵌建議，此建議可用於HadoopUtilities指令碼。 輸入: ``` // import function for SQS import com.amazonaws.services.sqs.AmazonSQS; import java.util.ArrayList; import java.util.List; class SQSUtils { // instantiate SQS client private AmazonSQS sqsClient; // load SQS object public SQSUtils(AmazonSQS sqsClient) { this.sqsClient = sqsClient; } // poll message from Amazon SQS given queue name } ``` 結果： ``` // poll message from Amazon SQS given queue name public List pollMessages(String queueName) { List messages = new ArrayList<>(); // poll messages from queue receiveMessageResult = sqsClient.receiveMessage(new ReceiveMessageRequest(queueName)); for (Message message : receiveMessageResult.getMessages()) { messages.add(message.getBody()); } return messages; ``` 如果內嵌建議仍然未提供預期結果，請在聊天工作階段中要求 Amazon Q Developer 產生程式碼。 ### 有關產生程式碼的聊天 使用者： 產生 Java 函數以從 Amazon SQS 佇列讀取訊息 Amazon Q： 以下是從 Amazon SQS 佇列讀取訊息的範例 Java 函數： ``` import com.amazonaws.services.sqs.AmazonSQS; import com.amazonaws.services.sqs.model.Message; import com.amazonaws.services.sqs.model.ReceiveMessageRequest; import com.amazonaws.services.sqs.model.ReceiveMessageResult; public class SQSMessageReader { private AmazonSQS sqsClient; private String queueUrl; public SQSMessageReader(AmazonSQS sqsClient, String queueUrl) { this.sqsClient = sqsClient; this.queueUrl = queueUrl; } public String readMessage() { ReceiveMessageRequest receiveMessageRequest = new ReceiveMessageRequest(queueUrl) .withMaxNumberOfMessages(1) .withWaitTimeSeconds(10); ReceiveMessageResult receiveMessageResult = sqsClient.receiveMessage(receiveMessageRequest); if (receiveMessageResult.getMessages().size() > 0) { Message message = receiveMessageResult.getMessages().get(0); String messageBody = message.getBody(); String receiptHandle = message.getReceiptHandle(); // Process the message System.out.println("Received message: " + messageBody); // Delete the message from the queue sqsClient.deleteMessage(queueUrl, receiptHandle); return messageBody; } else { return null; } } ``` 此程式碼會建立採用 AmazonSQS 用戶端和佇列 URL 做為建構函數參數的 SQSMessageReader 類別。readMessage() 方法使用 ReceiveMessageRequest 從佇列擷取最多 1 則訊息，最長等待時間為 10 秒。 如果收到訊息，則會列印訊息內文，並使用 DeleteMessageRequest 從佇列中刪除訊息。接著會傳回訊息內文。如果未收到任何訊息，則會傳回 null。 **結束****有關產生程式碼的 Amazon Q 聊天** ## 聊天結果不足 在開發程式碼時，開發人員可以要求 Amazon Q 產生常見函數、提供建議或解釋程式碼。有時，如果出現提示 （例如問題或程式碼片段），Amazon Q 可能會提供一般意見回饋或不符合您期望的結果。在這些案例中，請嘗試下列動作： + 使用不同的提示進行實驗，以改善您從 Amazon Q 取得的程式碼產生結果。 + 遵循 Amazon Q 在回應您的提示或問題時經常提供的 URLs。 + 提供意見回饋以協助改善 Amazon Q 的未來效能。 例如，開發人員正在建立擷取增強生成 (RAG) 解決方案，他們需要根據句子之間的語意關係來區塊其文件。開發人員與 Amazon Q 聊天，如下所示。 ### 討論 RAG 解決方案 使用者： 對於 RAG 解決方案，產生語意區塊化的程式碼 Amazon Q： 當然，以下範例說明如何Python使用 LangChain 程式庫在 中實作擷取增強生成 (RAG) 解決方案的語意區塊： ``` from langchain.text_splitter import CharacterTextSplitter, TokenTextSplitter from langchain.embeddings import HuggingFaceEmbeddings from langchain.vectorstores import Chroma # Initialize the text splitter text_splitter = TokenTextSplitter( chunk_size=500, chunk_overlap=50, length_function=len ) # Initialize the embeddings model embeddings = HuggingFaceEmbeddings() # Create the vector store vectorstore = Chroma( embedding_function=embeddings.embed_documents, persist_directory="./chroma-data" ) # Chunk the text using semantic similarity def semantic_chunk(text): chunks = text_splitter.split_text(text) embeddings = embeddings.embed_documents(chunks) vectorstore.add_texts(chunks, embeddings) return chunks ``` 在此範例中，我們使用TokenTextSplitter來自 LangChain 的 ，將輸入文字分割為 500 個字元區塊，並重疊 50 個字元。此HuggingFaceEmbeddings模型用於為每個區塊產生內嵌，而Chroma向量存放區用於存放區塊及其內嵌。 semantic\$1chunk 函數採用輸入文字，使用 text\$1splitter 將其分割為區塊，使用內嵌模型為每個區塊產生內嵌，然後將區塊及其內嵌新增至 vectorstore。 此方法可讓您將輸入文字分割為語意有意義的區塊，這對於 RAG 解決方案中的問題回答或摘要等各種任務很有用。 請注意，這是基本範例，您可能需要根據您的特定使用案例和資料來調整參數 （例如 chunk\$1size、chunk\$1overlap) 或文字分割器和內嵌模型的選擇。 有關 RAG 解決方案**的 Amazon Q **聊天結束 **** 不過，此方法只提供使用滑動視窗技術來區塊文件的基本方法。開發人員想要一種依賴於測量內嵌的進階方式。在這些案例中，開發人員必須根據其目標，將更多詳細資訊新增至提示。當開發人員參考 LangChain 的已知 AI21 文字分割器函數時，他們會收到改善的回應，如下列聊天所示。 ### 討論 RAG 解決方案 （有改善的提示） 使用者： 上述提示僅與每個區塊的字符大小分割相關。我想要使用 AI21 語意文字分割器。使用具有 langchain 的 A121 語意文字分割來產生函數。 Amazon Q： 好的，讓我們使用 AI21 語意文字分割器搭配 LangChain 來實作語意區塊。以下是範例：【1】 ``` from langchain.text_splitter import AI21SemanticTextSplitter from langchain.embeddings import HuggingFaceEmbeddings from langchain.vectorstores import Chroma # Initialize the text splitter text_splitter = AI21SemanticTextSplitter() # Initialize the embeddings model embeddings = HuggingFaceEmbeddings() # Create the vector store vectorstore = Chroma( embedding_function=embeddings.embed_documents, persist_directory="./chroma-data" ) # Chunk the text using semantic similarity def semantic_chunk(text): chunks = text_splitter.split_text(text) embeddings = embeddings.embed_documents(chunks) vectorstore.add_texts(chunks, embeddings) return chunks ``` 在此範例中，我們使用來自 LangChain 的 AI21SemanticTextSplitter，將輸入文字分割為語意有意義的區塊。此HuggingFaceEmbeddings模型用於為每個區塊建立內嵌，而Chroma向量存放區用於存放區塊及其內嵌。 semantic\$1chunk 函數採用輸入文字，使用 text\$1splitter 將其分割為區塊，使用內嵌模型為每個區塊建立內嵌，然後將區塊及其內嵌新增至 vectorstore。 此方法可讓您將輸入文字分割為語意有意義的區塊，這對於 RAG 解決方案中的問題回答或摘要等各種任務很有用。 請注意，您可能需要根據您的特定使用案例和資料來調整參數或內嵌模型的選擇。 來源 【1】 了解如何在 LangChain 中使用文字分割器 [soosweb3.hashnode.dev > the-ultimate-langchain-series-text-splitters](https://blog.davideai.dev/the-ultimate-langchain-series-text-splitters) 有關 RAG 解決方案**的 Amazon Q **聊天結束 **（有改善的提示）** **** 根據聊天結果，開發人員可以使用 函數並導覽至資訊來源。 一般而言，當您與 Amazon Q Developer 聊天時，進階主題和問題需要在提示中更具體的內容。如果您認為聊天的結果不正確，請使用拇指向下圖示提供有關 Amazon Q 回應的意見回饋。Amazon Q Developer 會持續使用意見回饋來改善未來的版本。對於產生正面結果的互動，使用大拇指圖示提供意見回饋很有用。