Sdílet prostřednictvím

Referenční informace k vláknům rozhraní API asistentů (Preview)

  • Článek

Poznámka:

  • Hledání souborů může ingestovat až 10 000 souborů na asistenta – 500krát více než dříve. Je to rychlý způsob, podporuje paralelní dotazy prostřednictvím vícevláknového vyhledávání a vylepšeného řazení a přepisování dotazů.
    • Vektorové úložiště je nový objekt v rozhraní API. Jakmile se soubor přidá do úložiště vektorů, automaticky se parsuje, zachytá a vloží a připraví k hledání. Vektorová úložiště se dají používat napříč asistenty a vlákny, což zjednodušuje správu souborů a fakturaci.
  • Přidali jsme podporu parametru tool_choice , který se dá použít k vynucení použití konkrétního nástroje (například vyhledávání souborů, interpret kódu nebo funkce) v určitém spuštění.

Tento článek obsahuje referenční dokumentaci pro Python a REST pro nové rozhraní API asistentů (Preview). Podrobnější podrobné pokyny najdete v úvodní příručce.

Vytvoření vlákna

POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads?api-version=2024-08-01-preview

Vytvořte vlákno.

Text požadavku

Name Type Požadováno Popis
messages pole Volitelné Seznam zpráv, se kterými má vlákno začínat.
metadata map Volitelné Sada 16 párů klíč-hodnota, které lze připojit k objektu. To může být užitečné pro ukládání dalších informací o objektu ve strukturovaném formátu. Klíče můžou mít maximálně 64 znaků a hodnoty můžou mít maximálně 512 znaků.
tool_resources object Volitelné Sada prostředků, které jsou zpřístupněny nástrojům asistenta v tomto vlákně. Prostředky jsou specifické pro typ nástroje. Nástroj například code_interpreter vyžaduje seznam ID souborů, zatímco file_search nástroj vyžaduje seznam ID úložiště vektorů.

tool_resources vlastnosti

code_interpreter

Name Typ Popis Výchozí
file_ids pole Seznam ID souborů zpřístupněných nástroji code_interpreter K nástroji může být přidruženo maximálně 20 souborů. []

file_search

Name Typ Popis Výchozí
vector_store_ids pole Vektorové úložiště připojené k tomuto vláknu. K vláknu může být připojeno maximálně 1 vektorové úložiště. []
vector_stores pole Pomocná rutina pro vytvoření vektorového úložiště s file_ids a jeho připojení k tomuto vláknu. K vláknu může být připojeno maximálně 1 vektorové úložiště. []

Návraty

Objekt vlákna.

Příklad: Vytvoření žádosti o vlákno

from openai import AzureOpenAI
    
client = AzureOpenAI(
    api_key=os.getenv("AZURE_OPENAI_API_KEY"),  
    api_version="2024-08-01-preview",
    azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT")
    )

empty_thread = client.beta.threads.create()
print(empty_thread)

Načtení vlákna

GET https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}?api-version=2024-08-01-preview

Načte vlákno.

Parametry cesty

Parametr Type Požadováno Popis
thread_id string Požaduje se ID vlákna, které se má načíst

Návraty

Objekt vlákna odpovídající zadanému ID.

Příklad: Načtení žádosti o vlákno

from openai import AzureOpenAI
    
client = AzureOpenAI(
    api_key=os.getenv("AZURE_OPENAI_API_KEY"),  
    api_version="2024-08-01-preview",
    azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT")
    )

my_thread = client.beta.threads.retrieve("thread_abc123")
print(my_thread)

Úprava vlákna

POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}?api-version=2024-08-01-preview

Upraví vlákno.

Parametry cesty

Parametr Type Požadováno Popis
thread_id string Požaduje se ID vlákna, které chcete upravit.

Text požadavku

Name Type Požadováno Popis
metadata map Volitelné Sada 16 párů klíč-hodnota, které lze připojit k objektu. To může být užitečné pro ukládání dalších informací o objektu ve strukturovaném formátu. Klíče můžou mít maximálně 64 znaků a hodnoty můžou mít maximálně 512 znaků.
tool_resources object Volitelné Sada prostředků, které jsou zpřístupněny nástrojům asistenta v tomto vlákně. Prostředky jsou specifické pro typ nástroje. Nástroj například code_interpreter vyžaduje seznam ID souborů, zatímco file_search nástroj vyžaduje seznam ID úložiště vektorů.

Návraty

Upravený objekt vlákna odpovídající zadanému ID.

Příklad: Úprava žádosti o vlákno

from openai import AzureOpenAI
    
client = AzureOpenAI(
    api_key=os.getenv("AZURE_OPENAI_API_KEY"),  
    api_version="2024-08-01-preview",
    azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT")
    )

my_updated_thread = client.beta.threads.update(
  "thread_abc123",
  metadata={
    "modified": "true",
    "user": "abc123"
  }
)
print(my_updated_thread)

Odstranit vlákno

DELETE https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}?api-version=2024-05-01-preview

Odstraňte vlákno.

Parametry cesty

Parametr Type Požadováno Popis
thread_id string Požaduje se ID vlákna, které chcete odstranit.

Návraty

Stav odstranění

Příklad: Odstranění žádosti o vlákno

from openai import AzureOpenAI
    
client = AzureOpenAI(
    api_key=os.getenv("AZURE_OPENAI_API_KEY"),  
    api_version="2024-05-01-preview",
    azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT")
    )

response = client.beta.threads.delete("thread_abc123")
print(response)

Objekt vlákna

Pole Typ Description
id string Identifikátor, na který se dá odkazovat v koncových bodech rozhraní API.
object string Typ objektu, který je vždy vlákno.
created_at integer Časové razítko unixu (v sekundách) pro vytvoření vlákna.
metadata map Sada 16 párů klíč-hodnota, které lze připojit k objektu. To může být užitečné pro ukládání dalších informací o objektu ve strukturovaném formátu. Klíče můžou mít maximálně 64 znaků a hodnoty můžou mít maximálně 512 znaků.