Megjegyzés
Az oldalhoz való hozzáféréshez engedély szükséges. Megpróbálhat bejelentkezni vagy módosítani a címtárat.
Az oldalhoz való hozzáféréshez engedély szükséges. Megpróbálhatja módosítani a címtárat.
Microsoft Ügynök-keretrendszer az AI-környezetszolgáltatók ügynökhöz való hozzáadásával egyszerűen támogatja a lekéréses kiterjesztett generációs (RAG) képességek hozzáadását az ügynökökhöz.
A lekérés mellett a beszélgetési/munkamenet-mintákról a Beszélgetések > Memória áttekintésében olvashat.
A TextSearchProvider használata
Az TextSearchProvider osztály egy RAG-környezetszolgáltató beépített implementációja.
Különböző működési módokat támogat, például az egyes ügynökök keresését a csevegési előzményekkel futtatva, vagy hirdetési függvényeszközöket a keresésekhez.
A beállítással ChatClientAgent könnyen csatlakoztatható egy AIContextProviders adott elemhez.
// Configure the options for the TextSearchProvider.
TextSearchProviderOptions textSearchOptions = new()
{
SearchTime = TextSearchProviderOptions.TextSearchBehavior.BeforeAIInvoke,
};
// Create the AI agent with the TextSearchProvider.
AIAgent agent = azureOpenAIClient
.GetChatClient(deploymentName)
.AsAIAgent(new ChatClientAgentOptions
{
ChatOptions = new() { Instructions = "You are a helpful support specialist. Answer questions using the provided context and cite the source document when available." },
AIContextProviders = [new TextSearchProvider(SearchAdapter, textSearchOptions)]
});
Ehhez TextSearchProvider olyan függvényre van szükség, amely megadja a keresési eredményeket egy lekérdezésben. Ez bármilyen keresési technológiával implementálható, például Azure AI Keresés vagy webes keresőmotor használatával.
Jótanács
A vektortárolók keresési eredményekhez való használatával kapcsolatos további információkért tekintse meg a Vektortárolók integrációs dokumentációját.
Íme egy példa egy modellkeresési függvényre, amely a lekérdezés alapján előre definiált eredményeket ad vissza.
SourceName és SourceLink nem kötelezőek, de ha meg van adva, az ügynök az információ forrására hivatkozik a felhasználó kérdésének megválaszolásakor.
static Task<IEnumerable<TextSearchProvider.TextSearchResult>> SearchAdapter(string query, CancellationToken cancellationToken)
{
// The mock search inspects the user's question and returns pre-defined snippets
// that resemble documents stored in an external knowledge source.
List<TextSearchProvider.TextSearchResult> results = new();
if (query.Contains("return", StringComparison.OrdinalIgnoreCase) || query.Contains("refund", StringComparison.OrdinalIgnoreCase))
{
results.Add(new()
{
SourceName = "Contoso Outdoors Return Policy",
SourceLink = "https://contoso.com/policies/returns",
Text = "Customers may return any item within 30 days of delivery. Items should be unused and include original packaging. Refunds are issued to the original payment method within 5 business days of inspection."
});
}
return Task.FromResult<IEnumerable<TextSearchProvider.TextSearchResult>>(results);
}
TextSearchProvider beállításai
Az TextSearchProvider osztályon keresztül TextSearchProviderOptions testre szabható. Íme egy példa arra, hogy olyan beállításokat hozhat létre, amelyekkel minden modell meghívása előtt futtathatja a keresést, és rövid ideig tarthatja a csevegési előzményeket a keresésekhez.
TextSearchProviderOptions textSearchOptions = new()
{
// Run the search prior to every model invocation and keep a short rolling window of chat history for searches.
SearchTime = TextSearchProviderOptions.TextSearchBehavior.BeforeAIInvoke,
RecentMessageMemoryLimit = 6,
};
Az TextSearchProvider osztály az alábbi lehetőségeket támogatja az TextSearchProviderOptions osztályon keresztül.
| Lehetőség | Típus | Description | Alapértelmezett |
|---|---|---|---|
| SearchTime | TextSearchProviderOptions.TextSearchBehavior |
Azt jelzi, hogy mikor kell végrehajtani a keresést. Két lehetőség közül választhat, minden alkalommal, amikor az ügynök fut, vagy igény szerint függvényhívással. | TextSearchProviderOptions.TextSearchBehavior.BeforeAIInvoke |
| FunctionToolName | string |
A közzétett keresőeszköz neve igény szerinti módban való működéskor. | "Keresés" |
| FunctionToolDescription | string |
A közzétett keresőeszköz leírása igény szerinti módban való működéskor. | "Lehetővé teszi további információk keresését a felhasználói kérdés megválaszolásához." |
| ContextPrompt | string |
A környezeti kérés előtagja az eredményekhez. | "## További környezet\nVegye figyelembe a forrásdokumentumok következő információinak a felhasználónak való megválaszolásakor:" |
| CitationsPrompt | string |
Az idézetek kéréséhez az eredmények után hozzáfűzött utasítás. | "Ha elérhető a dokumentum neve és hivatkozása, hivatkozzon a forrásdokumentumra." |
| ContextFormatter | Func<IList<TextSearchProvider.TextSearchResult>, string> |
Nem kötelező delegálni az eredménylista formázásának teljes testreszabásához. Ha meg van adva, ContextPrompt és CitationsPrompt a rendszer figyelmen kívül hagyja. |
null |
| RecentMessageMemoryLimit | int |
Azoknak a legutóbbi beszélgetési üzeneteknek a száma (mind a felhasználó, mind az asszisztens), amelyek a memóriában maradnak, és belefoglalnak a keresések keresési bemenetének BeforeAIInvoke összeállításakor. |
0 (letiltva) |
| RecentMessageRolesIncluded | List<ChatRole> |
Azoknak a típusoknak a ChatRole listája, amelyekre szűrni szeretné a legutóbbi üzeneteket, amikor eldönti, hogy mely legutóbbi üzeneteket vegye figyelembe a keresési bemenet létrehozásakor. |
ChatRole.User |
Jótanács
A .NET mintákat a teljes futtatható példákért tekintse meg.
Az Ügynök-keretrendszer támogatja Szemantikus kernel VectorStore-gyűjteményeinek használatát, hogy RAG-képességeket biztosítson az ügynökök számára. Ez a bridge funkcióval érhető el, amely Szemantikus kernel keresési függvényeket ügynök-keretrendszer-eszközökké alakítja.
Keresőeszköz létrehozása a VectorStore-ból
A Szemantikus kernel VectorStore-gyűjteményből származó create_search_function metódus egy KernelFunction ad vissza, amely .as_agent_framework_tool() használatával konvertálható ügynök-keretrendszer eszközzé.
A vektortároló-összekötők dokumentációjában megtudhatja , hogyan állíthat be különböző vektortároló-gyűjteményeket.
from semantic_kernel.connectors.ai.open_ai import OpenAITextEmbedding
from semantic_kernel.connectors.azure_ai_search import AzureAISearchCollection
from semantic_kernel.functions import KernelParameterMetadata
from agent_framework.openai import OpenAIChatClient
# Define your data model
class SupportArticle:
article_id: str
title: str
content: str
category: str
# ... other fields
# Create an Azure AI Search collection
collection = AzureAISearchCollection[str, SupportArticle](
record_type=SupportArticle,
embedding_generator=OpenAITextEmbedding()
)
async with collection:
await collection.ensure_collection_exists()
# Load your knowledge base articles into the collection
# await collection.upsert(articles)
# Create a search function from the collection
search_function = collection.create_search_function(
function_name="search_knowledge_base",
description="Search the knowledge base for support articles and product information.",
search_type="keyword_hybrid",
parameters=[
KernelParameterMetadata(
name="query",
description="The search query to find relevant information.",
type="str",
is_required=True,
type_object=str,
),
KernelParameterMetadata(
name="top",
description="Number of results to return.",
type="int",
default_value=3,
type_object=int,
),
],
string_mapper=lambda x: f"[{x.record.category}] {x.record.title}: {x.record.content}",
)
# Convert the search function to an Agent Framework tool
search_tool = search_function.as_agent_framework_tool()
# Create an agent with the search tool
agent = OpenAIChatClient(model="gpt-4o").as_agent(
instructions="You are a helpful support specialist. Use the search tool to find relevant information before answering questions. Always cite your sources.",
tools=search_tool
)
# Use the agent with RAG capabilities
response = await agent.run("How do I return a product?")
print(response.text)
Fontos
Ehhez a funkcióhoz az 1.38-es vagy újabb verzió szükséges semantic-kernel .
Keresési viselkedés testreszabása
A keresési függvényt számos beállítással testre szabhatja:
# Create a search function with filtering and custom formatting
search_function = collection.create_search_function(
function_name="search_support_articles",
description="Search for support articles in specific categories.",
search_type="keyword_hybrid",
# Apply filters to restrict search scope
filter=lambda x: x.is_published == True,
parameters=[
KernelParameterMetadata(
name="query",
description="What to search for in the knowledge base.",
type="str",
is_required=True,
type_object=str,
),
KernelParameterMetadata(
name="category",
description="Filter by category: returns, shipping, products, or billing.",
type="str",
type_object=str,
),
KernelParameterMetadata(
name="top",
description="Maximum number of results to return.",
type="int",
default_value=5,
type_object=int,
),
],
# Customize how results are formatted for the agent
string_mapper=lambda x: f"Article: {x.record.title}\nCategory: {x.record.category}\nContent: {x.record.content}\nSource: {x.record.article_id}",
)
A create_search_function paraméterekkel kapcsolatos részletes információkért tekintse meg a Szemantikus kernel dokumentációját.
Több keresési függvény használata
Több keresőeszközt is megadhat egy ügynöknek különböző tudástartományokhoz:
# Create search functions for different knowledge bases
product_search = product_collection.create_search_function(
function_name="search_products",
description="Search for product information and specifications.",
search_type="semantic_hybrid",
string_mapper=lambda x: f"{x.record.name}: {x.record.description}",
).as_agent_framework_tool()
policy_search = policy_collection.create_search_function(
function_name="search_policies",
description="Search for company policies and procedures.",
search_type="keyword_hybrid",
string_mapper=lambda x: f"Policy: {x.record.title}\n{x.record.content}",
).as_agent_framework_tool()
# Create an agent with multiple search tools
agent = chat_client.as_agent(
instructions="You are a support agent. Use the appropriate search tool to find information before answering. Cite your sources.",
tools=[product_search, policy_search]
)
Több keresési függvényt is létrehozhat ugyanabból a gyűjteményből különböző leírásokkal és paraméterekkel, hogy speciális keresési képességeket biztosítson:
# Create multiple search functions from the same collection
# Generic search for broad queries
general_search = support_collection.create_search_function(
function_name="search_all_articles",
description="Search all support articles for general information.",
search_type="semantic_hybrid",
parameters=[
KernelParameterMetadata(
name="query",
description="The search query.",
type="str",
is_required=True,
type_object=str,
),
],
string_mapper=lambda x: f"{x.record.title}: {x.record.content}",
).as_agent_framework_tool()
# Detailed lookup for specific article IDs
detail_lookup = support_collection.create_search_function(
function_name="get_article_details",
description="Get detailed information for a specific article by its ID.",
search_type="keyword",
top=1,
parameters=[
KernelParameterMetadata(
name="article_id",
description="The specific article ID to retrieve.",
type="str",
is_required=True,
type_object=str,
),
],
string_mapper=lambda x: f"Title: {x.record.title}\nFull Content: {x.record.content}\nLast Updated: {x.record.updated_date}",
).as_agent_framework_tool()
# Create an agent with both search functions
agent = chat_client.as_agent(
instructions="You are a support agent. Use search_all_articles for general queries and get_article_details when you need full details about a specific article.",
tools=[general_search, detail_lookup]
)
Ez a módszer lehetővé teszi az ügynök számára, hogy a felhasználó lekérdezése alapján válassza ki a legmegfelelőbb keresési stratégiát.
Támogatott VectorStore-összekötők
Ez a minta bármilyen Szemantikus kernel VectorStore-összekötővel működik, beleértve a következőket:
- Azure AI Keresés (
AzureAISearchCollection) - Qdrant (
QdrantCollection) - Pinecone (
PineconeCollection) - Redis (
RedisCollection) - Weaviate (
WeaviateCollection) - In-Memory (
InMemoryVectorStoreCollection) - És ez még nem minden
Minden összekötő ugyanazt create_search_function a módszert biztosítja, amely az Agent Framework eszközeihez áthidalható, így kiválaszthatja az igényeinek leginkább megfelelő vektoradatbázist. A teljes listát itt tekintheti meg.
Graph RAG
Ha a GraphRAG-t gráfbejárással bővített kereséssel, Cypher-lekérdezésekkel használja, tekintse meg a Neo4j GraphRAG-szolgáltatót.