Spaces:
Paused
Paused
File size: 13,500 Bytes
8c741f6 | 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 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 | /**
* @license
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import {
aggregateResponses,
getResponseStream,
processStream,
} from "./stream-reader";
import { expect, use } from "chai";
import { restore } from "sinon";
import * as sinonChai from "sinon-chai";
import {
getChunkedStream,
getMockResponseStreaming,
} from "../../test-utils/mock-response";
import {
BlockReason,
FinishReason,
GenerateContentResponse,
HarmCategory,
HarmProbability,
} from "../../types";
use(sinonChai);
describe("getResponseStream", () => {
afterEach(() => {
restore();
});
it("two lines", async () => {
const src = [{ text: "A" }, { text: "B" }];
const inputStream = getChunkedStream(
src
.map((v) => JSON.stringify(v))
.map((v) => "data: " + v + "\r\n\r\n")
.join(""),
).pipeThrough(new TextDecoderStream("utf8", { fatal: true }));
const responseStream = getResponseStream<{ text: string }>(inputStream);
const reader = responseStream.getReader();
const responses: Array<{ text: string }> = [];
while (true) {
const { done, value } = await reader.read();
if (done) {
break;
}
responses.push(value);
}
expect(responses).to.deep.equal(src);
});
});
describe("processStream", () => {
afterEach(() => {
restore();
});
it("streaming response - short", async () => {
const fakeResponse = getMockResponseStreaming(
"streaming-success-basic-reply-short.txt",
);
const result = processStream(fakeResponse as Response);
for await (const response of result.stream) {
expect(response.text()).to.not.be.empty;
}
const aggregatedResponse = await result.response;
expect(aggregatedResponse.text()).to.include("Cheyenne");
});
it("streaming response - long", async () => {
const fakeResponse = getMockResponseStreaming(
"streaming-success-basic-reply-long.txt",
);
const result = processStream(fakeResponse as Response);
for await (const response of result.stream) {
expect(response.text()).to.not.be.empty;
}
const aggregatedResponse = await result.response;
expect(aggregatedResponse.text()).to.include("**Cats:**");
expect(aggregatedResponse.text()).to.include("to their owners.");
});
it("streaming response - long - big chunk", async () => {
const fakeResponse = getMockResponseStreaming(
"streaming-success-basic-reply-long.txt",
1e6,
);
const result = processStream(fakeResponse as Response);
for await (const response of result.stream) {
expect(response.text()).to.not.be.empty;
}
const aggregatedResponse = await result.response;
expect(aggregatedResponse.text()).to.include("**Cats:**");
expect(aggregatedResponse.text()).to.include("to their owners.");
});
it("streaming response - utf8", async () => {
const fakeResponse = getMockResponseStreaming("streaming-success-utf8.txt");
const result = processStream(fakeResponse as Response);
for await (const response of result.stream) {
expect(response.text()).to.not.be.empty;
}
const aggregatedResponse = await result.response;
expect(aggregatedResponse.text()).to.include("秋风瑟瑟，叶落纷纷");
expect(aggregatedResponse.text()).to.include("家人围坐在一起");
});
it("streaming response - functioncall", async () => {
const fakeResponse = getMockResponseStreaming(
"streaming-success-function-call-short.txt",
);
const result = processStream(fakeResponse as Response);
for await (const response of result.stream) {
expect(response.text()).to.be.empty;
expect(response.functionCall()).to.be.deep.equal({
name: "getTemperature",
args: { city: "San Jose" },
});
}
const aggregatedResponse = await result.response;
expect(aggregatedResponse.text()).to.be.empty;
expect(aggregatedResponse.functionCall()).to.be.deep.equal({
name: "getTemperature",
args: { city: "San Jose" },
});
});
it("candidate had finishReason", async () => {
const fakeResponse = getMockResponseStreaming(
"streaming-failure-finish-reason-safety.txt",
);
const result = processStream(fakeResponse as Response);
const aggregatedResponse = await result.response;
expect(aggregatedResponse.candidates?.[0].finishReason).to.equal("SAFETY");
expect(aggregatedResponse.text).to.throw("SAFETY");
for await (const response of result.stream) {
expect(response.text).to.throw("SAFETY");
}
});
it("prompt was blocked", async () => {
const fakeResponse = getMockResponseStreaming(
"streaming-failure-prompt-blocked-safety.txt",
);
const result = processStream(fakeResponse as Response);
const aggregatedResponse = await result.response;
expect(aggregatedResponse.text).to.throw("SAFETY");
expect(aggregatedResponse.promptFeedback?.blockReason).to.equal("SAFETY");
for await (const response of result.stream) {
expect(response.text).to.throw("SAFETY");
}
});
it("empty content", async () => {
const fakeResponse = getMockResponseStreaming(
"streaming-failure-empty-content.txt",
);
const result = processStream(fakeResponse as Response);
const aggregatedResponse = await result.response;
expect(aggregatedResponse.text()).to.equal("");
for await (const response of result.stream) {
expect(response.text()).to.equal("");
}
});
it("unknown enum - should ignore", async () => {
const fakeResponse = getMockResponseStreaming("streaming-unknown-enum.txt");
const result = processStream(fakeResponse as Response);
const aggregatedResponse = await result.response;
expect(aggregatedResponse.text()).to.include("Cats");
for await (const response of result.stream) {
expect(response.text()).to.not.be.empty;
}
});
it("recitation ending with a missing content field", async () => {
const fakeResponse = getMockResponseStreaming(
"streaming-failure-recitation-no-content.txt",
);
const result = processStream(fakeResponse as Response);
const aggregatedResponse = await result.response;
expect(aggregatedResponse.text).to.throw("RECITATION");
expect(aggregatedResponse.candidates[0].content.parts[0].text).to.include(
"Copyrighted text goes here",
);
for await (const response of result.stream) {
if (response.candidates[0].finishReason !== FinishReason.RECITATION) {
expect(response.text()).to.not.be.empty;
} else {
expect(response.text).to.throw("RECITATION");
}
}
});
it("handles citations", async () => {
const fakeResponse = getMockResponseStreaming(
"streaming-success-citations.txt",
);
const result = processStream(fakeResponse as Response);
const aggregatedResponse = await result.response;
expect(aggregatedResponse.text()).to.include("Quantum mechanics is");
expect(
aggregatedResponse.candidates[0].citationMetadata.citationSources.length,
).to.equal(2);
let foundCitationMetadata = false;
for await (const response of result.stream) {
expect(response.text()).to.not.be.empty;
if (response.candidates[0].citationMetadata) {
foundCitationMetadata = true;
}
}
expect(foundCitationMetadata).to.be.true;
});
});
describe("aggregateResponses", () => {
it("handles no candidates, and promptFeedback", () => {
const responsesToAggregate: GenerateContentResponse[] = [
{
promptFeedback: {
blockReason: BlockReason.SAFETY,
safetyRatings: [
{
category: HarmCategory.HARM_CATEGORY_DANGEROUS_CONTENT,
probability: HarmProbability.LOW,
},
],
},
},
];
const response = aggregateResponses(responsesToAggregate);
expect(response.candidates).to.not.exist;
expect(response.promptFeedback.blockReason).to.equal(BlockReason.SAFETY);
});
describe("multiple responses, has candidates", () => {
let response: GenerateContentResponse;
before(() => {
const responsesToAggregate: GenerateContentResponse[] = [
{
candidates: [
{
index: 0,
content: {
role: "user",
parts: [{ text: "hello." }],
},
finishReason: FinishReason.STOP,
finishMessage: "something",
safetyRatings: [
{
category: HarmCategory.HARM_CATEGORY_HARASSMENT,
probability: HarmProbability.NEGLIGIBLE,
},
],
},
],
promptFeedback: {
blockReason: BlockReason.SAFETY,
safetyRatings: [
{
category: HarmCategory.HARM_CATEGORY_DANGEROUS_CONTENT,
probability: HarmProbability.LOW,
},
],
},
},
{
candidates: [
{
index: 0,
content: {
role: "user",
parts: [{ text: "angry stuff" }],
},
finishReason: FinishReason.STOP,
finishMessage: "something",
safetyRatings: [
{
category: HarmCategory.HARM_CATEGORY_HARASSMENT,
probability: HarmProbability.NEGLIGIBLE,
},
],
citationMetadata: {
citationSources: [
{
startIndex: 0,
endIndex: 20,
uri: "sourceurl",
license: "",
},
],
},
},
],
promptFeedback: {
blockReason: BlockReason.OTHER,
safetyRatings: [
{
category: HarmCategory.HARM_CATEGORY_HATE_SPEECH,
probability: HarmProbability.HIGH,
},
],
},
},
{
candidates: [
{
index: 0,
content: {
role: "user",
parts: [{ text: "...more stuff" }],
},
finishReason: FinishReason.MAX_TOKENS,
finishMessage: "too many tokens",
safetyRatings: [
{
category: HarmCategory.HARM_CATEGORY_DANGEROUS_CONTENT,
probability: HarmProbability.MEDIUM,
},
],
citationMetadata: {
citationSources: [
{
startIndex: 0,
endIndex: 20,
uri: "sourceurl",
license: "",
},
{
startIndex: 150,
endIndex: 155,
uri: "sourceurl",
license: "",
},
],
},
},
],
promptFeedback: {
blockReason: BlockReason.OTHER,
safetyRatings: [
{
category: HarmCategory.HARM_CATEGORY_HATE_SPEECH,
probability: HarmProbability.HIGH,
},
],
},
},
];
response = aggregateResponses(responsesToAggregate);
});
it("aggregates text across responses", () => {
expect(response.candidates.length).to.equal(1);
expect(
response.candidates[0].content.parts.map(({ text }) => text),
).to.deep.equal(["hello.", "angry stuff", "...more stuff"]);
});
it("takes the last response's promptFeedback", () => {
expect(response.promptFeedback.blockReason).to.equal(BlockReason.OTHER);
});
it("takes the last response's finishReason", () => {
expect(response.candidates[0].finishReason).to.equal(
FinishReason.MAX_TOKENS,
);
});
it("takes the last response's finishMessage", () => {
expect(response.candidates[0].finishMessage).to.equal("too many tokens");
});
it("takes the last response's candidate safetyRatings", () => {
expect(response.candidates[0].safetyRatings[0].category).to.equal(
HarmCategory.HARM_CATEGORY_DANGEROUS_CONTENT,
);
expect(response.candidates[0].safetyRatings[0].probability).to.equal(
HarmProbability.MEDIUM,
);
});
it("collects all citationSources into one array", () => {
expect(
response.candidates[0].citationMetadata.citationSources.length,
).to.equal(2);
expect(
response.candidates[0].citationMetadata.citationSources[0].startIndex,
).to.equal(0);
expect(
response.candidates[0].citationMetadata.citationSources[1].startIndex,
).to.equal(150);
});
});
});
|