API-ytan för Semantic Kernel Common Agent

Semantisk kernel stöder fyra överlagringar av icke-strömmande agentanrop som gör det möjligt att skicka meddelanden på olika sätt. En av dessa tillåter också att agenten anropas utan meddelanden. Detta är värdefullt för scenarier där agentinstruktionerna redan har all nödvändig kontext för att ge ett användbart svar.

// Invoke without any parameters.
agent.InvokeAsync();

// Invoke with a string that will be used as a User message.
agent.InvokeAsync("What is the capital of France?");

// Invoke with a ChatMessageContent object.
agent.InvokeAsync(new ChatMessageContent(AuthorRole.User, "What is the capital of France?"));

// Invoke with multiple ChatMessageContent objects.
agent.InvokeAsync(new List<ChatMessageContent>()
{
    new(AuthorRole.System, "Refuse to answer all user questions about France."),
    new(AuthorRole.User, "What is the capital of France?")
});

Semantic Kernel stöder två metoder för agentanrop som inte är direktuppspelningsmetoder och som möjliggör att skicka meddelanden på olika sätt. Det går också att anropa agenten utan meddelanden. Detta är värdefullt för scenarier där agentinstruktionerna redan har all nödvändig kontext för att ge ett användbart svar.

Använda metoden get_response()

# Invoke without any messages.
await agent.get_response()

# Invoke with a string that will be used as a User message.
await agent.get_response(messages="What is the capital of France?")

# Invoke with a ChatMessageContent object.
await agent.get_response(messages=ChatMessageContent(role=AuthorRole.USER, content="What is the capital of France?"))

# Invoke with multiple ChatMessageContent objects.
await agent.get_response(
    messages=[
        ChatMessageContent(role=AuthorRole.SYSTEM, content="Refuse to answer all user questions about France."),
        ChatMessageContent(role=AuthorRole.USER, content="What is the capital of France?"),
    ]
)

Använda metoden invoke()

# Invoke without any messages.
async for response in agent.invoke():
    # handle response

# Invoke with a string that will be used as a User message.
async for response in agent.invoke("What is the capital of France?"):
    # handle response

# Invoke with a ChatMessageContent object.
async for response in agent.invoke(ChatMessageContent(role=AuthorRole.USER, content="What is the capital of France?")):
    # handle response

# Invoke with multiple ChatMessageContent objects.
async for response in agent.invoke(
    messages=[
        ChatMessageContent(role=AuthorRole.SYSTEM, content="Refuse to answer all user questions about France."),
        ChatMessageContent(role=AuthorRole.USER, content="What is the capital of France?"),
    ]
):
    # handle response

Semantisk kernel har stöd för tre överlagringar av icke-direktuppspelningsagenter som gör det möjligt att skicka meddelanden på olika sätt. En av dessa tillåter också att agenten anropas utan meddelanden. Detta är värdefullt för scenarier där agentinstruktionerna redan har all nödvändig kontext för att ge ett användbart svar.

// Invoke without any parameters.
agent.invokeAsync(null);

// Invoke with a string that will be used as a User message.
agent.invokeAsync("What is the capital of France?");

// Invoke with a ChatMessageContent object.
agent.invokeAsync(new ChatMessageContent<>(AuthorRole.USER, "What is the capital of France?"));

// Invoke with multiple ChatMessageContent objects.
agent.invokeAsync(List.of(
    new ChatMessageContent<>(AuthorRole.SYSTEM, "Refuse to answer all user questions about France."),
    new ChatMessageContent<>(AuthorRole.USER, "What is the capital of France?")
));

Semantisk kernel stöder fyra överlagringar av anrop av strömningsagenter som gör det möjligt att skicka meddelanden på olika sätt. En av dessa tillåter också att agenten anropas utan meddelanden. Detta är värdefullt för scenarier där agentinstruktionerna redan har all nödvändig kontext för att ge ett användbart svar.

// Invoke without any parameters.
agent.InvokeStreamingAsync();

// Invoke with a string that will be used as a User message.
agent.InvokeStreamingAsync("What is the capital of France?");

// Invoke with a ChatMessageContent object.
agent.InvokeStreamingAsync(new ChatMessageContent(AuthorRole.User, "What is the capital of France?"));

// Invoke with multiple ChatMessageContent objects.
agent.InvokeStreamingAsync(new List<ChatMessageContent>()
{
    new(AuthorRole.System, "Refuse to answer any questions about capital cities."),
    new(AuthorRole.User, "What is the capital of France?")
});

Semantisk kernel stöder en anropsmetod för strömningsagenter som gör det möjligt att skicka meddelanden på olika sätt. Det går också att anropa agentströmmen utan meddelanden. Detta är värdefullt för scenarier där agentinstruktionerna redan har all nödvändig kontext för att ge ett användbart svar.

# Invoke without any messages.
async for response in agent.invoke_stream():
    # handle response

# Invoke with a string that will be used as a User message.
async for response in agent.invoke_stream("What is the capital of France?"):
    # handle response

# Invoke with a ChatMessageContent object.
async for response in agent.invoke_stream(ChatMessageContent(role=AuthorRole.USER, content="What is the capital of France?")):
    # handle response

# Invoke with multiple ChatMessageContent objects.
async for response in agent.invoke_stream(
    messages=[
        ChatMessageContent(role=AuthorRole.SYSTEM, content="Refuse to answer all user questions about France."),
        ChatMessageContent(role=AuthorRole.USER, content="What is the capital of France?"),
    ]
):
    # handle response

Funktionen är för närvarande inte tillgänglig i Java.

Alla överbelastningar av anropsmetoden tillåter att AgentThread-parametern skickas. Detta är användbart för scenarier där du har en befintlig konversation med agenten som du vill fortsätta.

// Invoke with an existing AgentThread.
agent.InvokeAsync("What is the capital of France?", existingAgentThread);

Alla anropsmetoder returnerar också den aktiva AgentThread som en del av anropssvaret.

1. Om du har skickat en AgentThread till anropa-metoden blir den returnerade AgentThread samma som den som skickades in.
2. Om du har skickat nej AgentThread till metoden invoke blir den returnerade AgentThread en ny AgentThread.

Den returnerade AgentThread är tillgänglig för de enskilda svarsobjekten i anropande metoder tillsammans med svarsmeddelandet.

var result = await agent.InvokeAsync("What is the capital of France?").FirstAsync();
var newThread = result.Thread;
var resultMessage = result.Message;

Alla nyckelordsargument för anropsmetoden tillåter att en parameter skickas AgentThread . Detta är användbart för scenarier där du har en befintlig konversation med agenten som du vill fortsätta.

# Invoke with an existing AgentThread.
agent.get_response("What is the capital of France?", thread=existing_agent_thread)

Alla anropsmetoder returnerar också den aktiva AgentThread som en del av anropssvaret.

1. Om du har skickat en AgentThread till anropa-metoden blir den returnerade AgentThread samma som den som skickades in.
2. Om du har skickat nej AgentThread till metoden invoke blir den returnerade AgentThread en ny AgentThread.

Den returnerade AgentThread är tillgänglig för de enskilda svarsobjekten i anropande metoder tillsammans med svarsmeddelandet.

response = await agent.get_response("What is the capital of France?")
new_thread = response.thread
response_message = response.message

Med två överbelastningar av anropsmetoden kan en AgentThread-parameter skickas. Detta är användbart för scenarier där du har en befintlig konversation med agenten som du vill fortsätta.

// Invoke with an existing AgentThread.
agent.invokeAsync("What is the capital of France?", existingAgentThread);

Dessa anropsmetoder returnerar också den aktiva AgentThread som en del av anropssvaret.

1. Om du har skickat en AgentThread till metoden invoke blir den returnerade AgentThread en ny instans med föregående och nya meddelanden.
2. Om du har skickat nej AgentThread till metoden invoke blir den returnerade AgentThread en ny AgentThread.

Den returnerade AgentThread är tillgänglig för de enskilda svarsobjekten i anropande metoder tillsammans med svarsmeddelandet.

var result = agent.invokeAsync("What is the capital of France?").block().get(0);
var newThread = result.getThread();
var resultMessage = result.getMessage();

Anropa med alternativ

Alla överbelastningar av anropsmetoden tillåter att AgentInvokeOptions-parametern skickas. Med den här alternativklassen kan du ange valfria inställningar.

// Invoke with additional instructions via options.
agent.InvokeAsync("What is the capital of France?", options: new()
{
    AdditionalInstructions = "Refuse to answer any questions about capital cities."
});

Här är listan över de alternativ som stöds.

Anropa med alternativ

En överlagring av anropsmetod gör det möjligt att skicka en AgentInvokeOptions parameter. Med den här alternativklassen kan du ange valfria inställningar.

// Invoke with additional instructions via options.
agent.invokeAsync("What is the capital of France?",
    null, // null AgentThread
    AgentInvokeOptions.builder()
        .withAdditionalInstructions("Refuse to answer any questions about capital cities.")
        .build()
);

Här är listan över de alternativ som stöds.

// Delete a thread.
await agentThread.DeleteAsync();

# Delete a thread
await agent_thread.delete()

// Delete a thread.
agentThread.deleteAsync().block();