跳到主要內容

【Azure OpenAI】o1 模型與 2024-09-01-preview API

距離上篇在 Early Access Playground 試用 o1 模型後又過了兩週，今天終於等到 API 開放使用啦！本篇將紀錄如何使用 Python SDK 存取 o1 模型。 系列文章 【Azure OpenAI】快速試用 o1 模型 模型佈署 在先前開放的 Early Access Playground 中使用 o1 是不需要另外佈署模型的，不過回到使用 API 來存取 o1 模型，就需要像之前的模型一樣先進行佈署才能使用，相信大家都很熟悉了。 使用 Python SDK 一樣使用熟悉的 openai 套件： 2024-09-01-preview 初始化的方式與先前模型都一樣，需要注意的是 o1 模型目前只能使用最新的 API 版本 2024-09-01-preview 來訪問。 Chat Completions 將 model 填入 o1-preview ，或是你的模型佈署名稱， messages 也一樣是歷史對話堆疊的 List。 回應如下： 查看 Token 使用量 內建 Chain of Thought 的 o1 比起過往的模型會消耗較多的 Token，因此我們特別把 Token 使用量拉出來看。 回應如下： 其中 prompt_tokens 、 completion_tokens 、 total_tokens 在先前的 API 就已經存在了，分別代表Token 的 Input、Output 與總使用量，而在新的 completion_tokens_details 中可以看到  reasoning_tokens 使用了 320 個 Tokens，居然佔了總輸出 Token 的 80% 以上！ 控制 Token 成本 已往我們可以使用  max_tokens 參數來控制 Token 的用量，但在 o1 模型中棄用了 max_tokens ，取而代之的是使用  max_completion_tokens 參數，來看看這段程式碼： 回應如下： 沒東西？那再看一次 Token 量。 回應如下： Token 居然是有被使用的！ 這表示 max_completion_tokens 並不像過往使用  max_tokens 這麼簡單，先前在回應遇到...
張貼留言

【Azure Cognitive Search】使用 Python SDK 在認知搜尋中進行向量搜尋（上）

認知搜尋 Azure Cognitive Search，在需要限縮 ChatGPT 回答內容的對話機器人情境中，Cognitive Search 可以作為其中最關鍵的「知識庫」角色，其 PaaS 服務的方便性加上後期與 Azure OpenAI 的整合，可說是 2023 年最受益於 ChatGPT 的 Azure 服務之一。

因應 Cognitive Search 在 10 月份對向量搜尋的最新版更新，本篇參考以下 GitHub 範例程式實作與心得分享；接續前篇由快速入門 Cognitive Search 的角度出發，一樣會使用 Python SDK 建立 Cognitive Search 的 Index ，而測試資料的向量會由 Azure OpenAI 的 Embedding API 產生後，與資料一同存入 Index 中，最後會在 Index 中進行向量搜尋。

完整程式碼於文末 GitHub 連結提供！

相關連結：https://github.com/Azure/cognitive-search-vector-pr/tree/main/demo-python

必要條件

  • 在任何區域或任何層級上的認知搜尋服務 Azure Cognitive Search，記得先複製好金鑰備用

  • Cognitive Search 的官方 Python SDK：azure-search-documents 的 11.4.0b11 版

以上項目如果不知道如何進行，建議可由下方連結的前文開始閱讀，參考如何建立需要的服務與環境。

相關連結：【Azure Cognitive Search】使用 Python SDK 在認知搜尋中進行全文檢索

測試資料

繼續借用以下官方放在 GitHub 上的範例資料，資料中包含了 108 項 Azure 服務的名稱與簡介，並存放於 Json 格式中。

相關連結：https://github.com/Azure/cognitive-search-vector-pr/blob/main/demo-python/data/text-sample.json

建立 Index

我們預計會對測試資料中的 title 與 content 兩欄位各自產生向量，所以在這次建立的 Index 中會新增 titleVector 與 contentVector 兩個欄位，用於存放這些向量。

首先使用以下程式與 Cognitive Search 建立連線，記得將 endpoint 與 credential 替換成自己的。

from azure.search.documents.indexes import SearchIndexClient
from azure.core.credentials import AzureKeyCredential

search_index_client = SearchIndexClient(
    endpoint="https://charlie-test.search.windows.net",
    credential=AzureKeyCredential("YOUR-SEARCH-API-KEY") # 你的 Cognitive Search 金鑰
)

建立 Index 的方式基本上與前文相同，一樣都是透過 Field 設定每個欄位：

from azure.search.documents.indexes.models import SimpleField, SearchableField, SearchFieldDataType, SearchField
fields = [
    SimpleField(name="id", type=SearchFieldDataType.String, key=True, sortable=True, filterable=True, facetable=True),
    SearchableField(name="title", type=SearchFieldDataType.String),
    SearchableField(name="content", type=SearchFieldDataType.String),
    SearchableField(name="category", type=SearchFieldDataType.String, filterable=True),
    SearchField(name="titleVector", type=SearchFieldDataType.Collection(SearchFieldDataType.Single), vector_search_dimensions=1536, vector_search_profile="HnswProfile"),
    SearchField(name="contentVector", type=SearchFieldDataType.Collection(SearchFieldDataType.Single), vector_search_dimensions=1536, vector_search_profile="HnswProfile"),
]

前四個欄位與之前進行全文檢索時差不多，而 titleVector 與 contentVector 兩個新欄位說明一下：

  • 向量欄位的型態設定必須固定為type=SearchFieldDataType.Collection(SearchFieldDataType.Single)，即單精度的浮點數向量

  • 使用 vector_search_dimensions 設定存放的向量維度，Azure OpenAI 的 text-embedding-ada-002 模型所產生的向量維度即為 1536

  • vector_search_profile 指定要由哪一種演算法來編製 Index，組態名必須要跟後續提供的設定一致

再來還需要一些向量搜尋的設定檔，因為比較繁雜一點，這邊分為三部份說明：

Algorithm

from azure.search.documents.indexes.models import (
    HnswVectorSearchAlgorithmConfiguration, VectorSearchAlgorithmKind, HnswParameters, ExhaustiveKnnVectorSearchAlgorithmConfiguration, ExhaustiveKnnParameters
)
algorithms=[
    HnswVectorSearchAlgorithmConfiguration(
        name="Hnsw",
        kind=VectorSearchAlgorithmKind.HNSW,
        parameters=HnswParameters(
            m=4,
            ef_construction=400,
            ef_search=500,
            metric="cosine",
        )
    ),
    ExhaustiveKnnVectorSearchAlgorithmConfiguration(
        name="ExhaustiveKnn",
        kind=VectorSearchAlgorithmKind.EXHAUSTIVE_KNN,
        parameters=ExhaustiveKnnParameters(
            metric="cosine",
        )
    )
]

algorithms 由多個演算法組態組成，目前在這版本中 Cognitive Search 提供 HNSW 與 Exhaustive KNN 兩種演算法：

  • HNSW：ANN 算法的其中一種，在編制 Index 時會產生額外的資料結構來加快搜尋速度，希望精確度與計算效率之間取得平衡，適用於大部分情況。

  • Exhaustive KNN：基本上是一種暴力演算法，可以找出真正最鄰近的向量，適用於願意以搜尋效能換取高準確度且資料集較小的情境。
其中各自都包含演算法的超參數設定，metric 參數指定計算距離的方式，最常見的設定是餘弦相似度，而其他細項都與演算法本身理論有關，這邊只要儘管用就對了（絕對不是我不會

兩種演算法各有優缺點，大致上就是在速度與準確度上做取捨，兩者也能同時放入設定檔並在執行搜尋時選擇不同演算法，但在編制 Index 時只能選擇其中一種，選擇時有兩點需要注意：

  • 演算法本身是不收費的，但 HNSW 因為有產生額外的資料結構，儲存時會占用較多的空間，也代表可能產生更多的費用，詳細可以了解 Cognitive Search 的計價方式

  • 選擇 HNSW 編制 Index 後兩種演算法都能選擇，但如果選擇了 Exhaustive KNN ，在搜尋時就不能使用 HNSW 了

Vectorizer

from azure.search.documents.indexes.models import AzureOpenAIVectorizer, AzureOpenAIParameters
vectorizers=[
    AzureOpenAIVectorizer(
        name="AzureOpenAI",
        kind="azureOpenAI",
        azure_open_ai_parameters=AzureOpenAIParameters(
            resource_uri="https://xxxxx.openai.azure.com/",  # 你的 Azure OpenAI 端點
            deployment_id="text-embedding-ada-002",
            api_key="OPENAI_API_KEY" # 你的 Azure OpenAI 金鑰
        )
    )  
]

這版的 Cognitive Search 能自動將輸入的文字轉換為向量，在使用上可以少一段呼叫 Embedding 的程式，所以必須在設定中先放入 Azure OpenAI 的各項資訊。

Profile

from azure.search.documents.indexes.models import VectorSearchProfile
profiles=[
    VectorSearchProfile(
        name="HnswProfile",
        algorithm="Hnsw",
        vectorizer="AzureOpenAI"
    ),
    VectorSearchProfile(
        name="ExhaustiveKnnProfile",
        algorithm="ExhaustiveKnn",
        vectorizer="AzureOpenAI"
    )
]

在 Profile 中把各項設定綁定在一起，首先是參數 algorithm 與 vectorizer，對應到上述兩個設定，而 name 對應到設定 Index 欄位時使用的 vector_search_profile，記得檢查互相的命名有沒有一樣。

最後就照著格式把設定通通丟進去來建立 Index：

from azure.search.documents.indexes.models import VectorSearch, SearchIndex

vector_search = VectorSearch(profiles=profiles, algorithms=algorithms, vectorizers=vectorizers)
index = SearchIndex(name="text-sample-vertor", fields=fields, vector_search=vector_search)
result = search_index_client.create_or_update_index(index)

其中 SearchIndex 的 name 可以自行設定 Index 的名稱。

建立完成後就能在 Portal 上看到該 Index，切換到 Cognitive Search 畫面左邊的「索引」頁籤，其中可以看到所有欄位與相關設定；兩個儲存向量的欄位與其他欄位略有不同，但都符合上述的設定。

由 Portal 查看建立完成的 Index

建立向量

回到測試資料中，我們必須要為每一筆資料建立對應的向量，才能開始使用向量搜尋，其中我們會對標題與內容都各自生成向量，最簡單快速的方法就是使用 text-embedding-ada-002，作法可以參考以下的 Azure OpenAI Embedding 使用方式。

而另一個更快的方式，就是直接使用現成的向量😍，參考以下第二個連結。

相關連結：【Azure OpenAI】Azure OpenAI Python SDK 使用方式：Embedding

相關連結：https://github.com/Azure/cognitive-search-vector-pr/blob/main/demo-python/output/docVectors.json

在 Index 中寫入資料

如果選擇了上述更快的方式，基本上已經把寫入 Index 所需要的 Json 格式都整理好了，直接檔案打開後就能用了。

import json
from azure.search.documents import SearchClient
from azure.core.credentials import AzureKeyCredential

with open('docVectors.json', 'r') as file:  
    documents = json.load(file)

search_client = SearchClient(
    endpoint="https://charlie-test.search.windows.net", 
    index_name="text-sample-vertor",
    # credential=AzureKeyCredential("YOUR-SEARCH-API-KEY") # 你的 Cognitive Search 金鑰
)
result = search_client.upload_documents(documents)

寫入完成，一樣回到 Cognitive Search 畫面左邊的「索引」頁籤，稍等幾分鐘後重新整理畫面，就能看到 108 筆資料成功被載入 Index 了！

108 筆資料成功被載入 Index

總結

到此，我們建立了一個可以儲存向量的 Index，並寫入了包含向量欄位在內的 108 筆資料。

下一篇中會在這個 Index 上開始真正執行向量搜尋，在搜尋時快速地切換兩種演算法，還有與全文檢索的混和搜尋方式，都會在下一篇中詳細介紹，請繼續收看！

系列文章

完整程式碼

標籤：
位置： 407台灣台中市西屯區

留言

張貼留言

這個網誌中的熱門文章

【Azure OpenAI】購買 PTU 時微軟不會告訴你的事

Provisioned Throughput Units 一直是目前在 Azure OpenAI 對於延遲問題的最有效解法，同時也是官方最推薦的方案。有別於基本的隨付即用，PTU 具有穩定、可預測的延遲等優勢，適合用於正式上線的生產環境。 但 PTU 的成本是一個不可忽視的問題，儘管選購最小單位量的 PTU，也是需要應用到達一定規模後才看得出使用效益。在確認是否購買 PTU 時，除了詳細閱讀官方文件並使用官方推出的計算機規劃額度外，以下幾點或許也是你該注意的。 不可自行購買 PTU 首先，是的，截自撰文當日 (2024/07/09) PTU 只能透過微軟業務窗口洽詢購買細節，這可能對於多數用戶是不友善的，但我相信這個過程很快就能得到優化。 相關連結： https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/provisioned-throughput#how-do-i-get-access-to-provisioned PTU 的可用區域僅供參考 在官方文件中記錄了下述表格，其中詳細的呈現各種模型的 PTU 在不同地區的可用性，但這張表只是一個參考，因為當你洽詢業務窗口時你會得到另一張不同的表格。 其中對於台灣用戶可能最有影響的，是我們沒辦法在日本東部購買 gpt-4o 模型的 PTU，對於想透過購買 PTU 以降低模型延遲的用戶來說這是一個矛盾的選擇，當然更不用提隨之產生的跨區傳輸量成本。 一樣截至撰文為止，為何在打勾區域✅無法購買的問題，官方並沒有給出任何理由，或許是我們採購量沒有達到官方需要解釋的程度😔 相關連結： https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/provisioned-throughput#what-models-and-regions-are-available-for-provisioned-throughput 有別於你認知的定價策略 承如前述，PTU 的成本絕對是導入時的重要考量點。 PTU 的售價到底是多少 事實上 PTU 的官方售價早就是公開的秘密，稱之為秘密是因為 PTU 的售價截至目前並沒有被列在官方文件或定價計算機中，但在最新的 Azure OpenAI S...
張貼留言
閱讀完整內容

【Azure OpenAI】o1 模型與 2024-09-01-preview API

距離上篇在 Early Access Playground 試用 o1 模型後又過了兩週，今天終於等到 API 開放使用啦！本篇將紀錄如何使用 Python SDK 存取 o1 模型。 系列文章 【Azure OpenAI】快速試用 o1 模型 模型佈署 在先前開放的 Early Access Playground 中使用 o1 是不需要另外佈署模型的，不過回到使用 API 來存取 o1 模型，就需要像之前的模型一樣先進行佈署才能使用，相信大家都很熟悉了。 使用 Python SDK 一樣使用熟悉的 openai 套件： 2024-09-01-preview 初始化的方式與先前模型都一樣，需要注意的是 o1 模型目前只能使用最新的 API 版本 2024-09-01-preview 來訪問。 Chat Completions 將 model 填入 o1-preview ，或是你的模型佈署名稱， messages 也一樣是歷史對話堆疊的 List。 回應如下： 查看 Token 使用量 內建 Chain of Thought 的 o1 比起過往的模型會消耗較多的 Token，因此我們特別把 Token 使用量拉出來看。 回應如下： 其中 prompt_tokens 、 completion_tokens 、 total_tokens 在先前的 API 就已經存在了，分別代表Token 的 Input、Output 與總使用量，而在新的 completion_tokens_details 中可以看到  reasoning_tokens 使用了 320 個 Tokens，居然佔了總輸出 Token 的 80% 以上！ 控制 Token 成本 已往我們可以使用  max_tokens 參數來控制 Token 的用量，但在 o1 模型中棄用了 max_tokens ，取而代之的是使用  max_completion_tokens 參數，來看看這段程式碼： 回應如下： 沒東西？那再看一次 Token 量。 回應如下： Token 居然是有被使用的！ 這表示 max_completion_tokens 並不像過往使用  max_tokens 這麼簡單，先前在回應遇到...
張貼留言
閱讀完整內容

【Document Intelligence】使用 Layout Model 實作 Semantic Chunking

在這個 LLM 時代 RAG 可說是一個非常熱的議題，其中來源資料的品質幾乎決定了整個 RAG 應用的成敗，而在一系列的資料處理流程中，又以 Chunking 做為一個重要的環節，像是常見的固定長度、重疊等等都是基本的 Chunking 策略。 Semantic Chunking 是一種進階的 Chunking 手法，比起基本的固定長度切分，Semantic Chunking 希望藉由語意分析劃分出更具有意義的 Chunk。本篇將使用在 Document Intelligence 中新推出的 Layout Model 文檔分析 API 來實作 Semantic Chunking。 Markdown 與 Semantic Chunking Markdown 是一種具有結構的標記語言，對於人類在閱讀上是非常友好的，而對於 LLM 來說當然也是如此，不過在現實上，我們提供給 RAG 的文件往往都不是 Markdown。 現在我們將使用 Layout Model 來解決這個問題，其提供的文檔分析 API 可以在一次呼叫中將傳入的 PDF、PPT 等常見格式文檔轉換成 Markdown 格式，這個轉換過程中包含了 OCR、文件結構分析等步驟，這也就代表轉換出的 Markdown 結構在某種程度上是蘊含文件語意的。 最後我們將使用這個 Markdown 結構做為 Chunking 的依據，以此來實現 Semantic Chunking。 建立 Document Intelligence 建立 AI 類服務時基本上都不用做太複雜的設定，這邊唯一要注意的是我們預計要使用的 Layout Model API 目前只有在美東、美西 2 與西歐三個地區提供，建議時需要留意選擇的地區。 Document Intelligence Studio 與其他 AI 服務一樣，Document Intelligence 也有提供 Studio 讓我們快速體驗功能，從 Studio 首頁進入「Layout」頁面，我們使用內建的範例文件來看看文檔分析 API 的能力。 首先選擇一篇範例文件，再調整「Output format style」為「Markdown 」後點擊上方的「Run an...
張貼留言
閱讀完整內容