Skip to content

Stream Query

This example assumes using Vectara; is in scope and apiKey contains your Vectara API key.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
using var client = new VectaraClient(apiKey);

// First, list available corpora to get a corpus key.
ListCorporaResponse corporaResponse = await client.Corpora.ListAsync();

if (corporaResponse.Corpora is not { Count: > 0 })
{
    return;
}

var corpusKey = corporaResponse.Corpora[0].Key!;

// Execute a streaming query — results arrive as Server-Sent Events.
var summaryBuilder = new System.Text.StringBuilder();
var searchResultCount = 0;

await foreach (var chunk in client.Queries.Query2AsStreamAsync(
    query: "What is this about?",
    search: new SearchCorporaParameters
    {
        Value1 = new SearchCorporaParametersVariant1
        {
            Corpora =
            [
                new KeyedSearchCorpus
                {
                    Value2 = new KeyedSearchCorpusVariant2
                    {
                        CorpusKey = corpusKey,
                    },
                },
            ],
        },
    },
    generation: new GenerationParameters
    {
        MaxUsedSearchResults = 5,
    }))
{
    // Handle each event type in the stream.
    if (chunk.IsSearchResults)
    {
        searchResultCount = chunk.SearchResults?.SearchResults?.Count ?? 0;
        Console.WriteLine($"Received {searchResultCount} search results");
    }
    else if (chunk.IsGenerationChunk)
    {
        summaryBuilder.Append(chunk.GenerationChunk?.GenerationChunk);
    }
    else if (chunk.IsGenerationEnd)
    {
        Console.WriteLine($"Generation complete");
    }
    else if (chunk.IsFactualConsistencyScore)
    {
        Console.WriteLine($"Factual consistency: {chunk.FactualConsistencyScore?.FactualConsistencyScore1}");
    }
    else if (chunk.IsEnd)
    {
        Console.WriteLine("Stream ended");
    }
}

var summary = summaryBuilder.ToString();
Console.WriteLine($"Summary: {summary}");
Console.WriteLine($"Total search results: {searchResultCount}");