Skip to content

feat: add generateAnswer() for AQA support #404

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
118 changes: 118 additions & 0 deletions src/models/generative-model.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ import {
import { getMockResponse } from "../../test-utils/mock-response";
import { match, restore, stub } from "sinon";
import * as request from "../requests/request";
import { Task } from '../requests/request';

use(sinonChai);

Expand Down Expand Up @@ -463,3 +464,120 @@ describe("GenerativeModel", () => {
restore();
});
});

describe('GenerativeModel - generateAnswer()', () => {
const API_KEY = 'test-api-key';
const MODEL_NAME = 'models/aqa';
const TEST_REQUEST = {
input: "What's the capital of France?",
sources: [{
title: "World Facts",
url: "https://example.com",
content: "Paris is the capital of France."
}]
};

afterEach(() => {
restore();
});

it('should make correct API request', async () => {
const mockResponse = {
answer: "Paris",
attributedPassages: [{
text: "Paris is the capital of France.",
source: {
title: "World Facts",
url: "https://example.com",
content: "Paris is the capital of France."
}
}],
confidenceScore: 0.95
};

const makeRequestStub = stub(request, 'makeModelRequest')
.resolves({
json: () => Promise.resolve(mockResponse)
} as Response);

const model = new GenerativeModel(API_KEY, { model: MODEL_NAME });
const result = await model.generateAnswer(TEST_REQUEST);

expect(makeRequestStub).calledWith(
'models/aqa',
Task.GENERATE_ANSWER,
API_KEY,
false,
JSON.stringify(TEST_REQUEST),
{}
);

expect(result).to.deep.equal({
answer: "Paris",
attributedPassages: [{
text: "Paris is the capital of France.",
source: {
title: "World Facts",
url: "https://example.com",
content: "Paris is the capital of France."
}
}],
confidenceScore: 0.95
});
});

it('should handle API errors', async () => {
const errorResponse = {
error: {
message: "Invalid input format",
code: 400
}
};

stub(request, 'makeModelRequest').resolves({
json: () => Promise.resolve(errorResponse)
} as Response);

const model = new GenerativeModel(API_KEY, { model: MODEL_NAME });

try {
await model.generateAnswer(TEST_REQUEST);
expect.fail('Should have thrown error');
} catch (e) {
expect(e.message).to.include('AQA API Error');
expect(e.response).to.deep.equal(errorResponse);
}
});

it('should validate required input field', async () => {
const model = new GenerativeModel(API_KEY, { model: MODEL_NAME });

try {
// @ts-expect-error Testing invalid input
await model.generateAnswer({ sources: [] });
expect.fail('Should have thrown error');
} catch (e) {
expect(e.message).to.include("must contain 'input' field");
}
});

it('should handle partial response data', async () => {
const partialResponse = {
answer: "Paris",
// Missing attributedPassages and confidenceScore
};

stub(request, 'makeModelRequest').resolves({
json: () => Promise.resolve(partialResponse)
} as Response);

const model = new GenerativeModel(API_KEY, { model: MODEL_NAME });
const result = await model.generateAnswer(TEST_REQUEST);

expect(result).to.deep.equal({
answer: "Paris",
attributedPassages: [],
confidenceScore: 0
});
});
});
84 changes: 84 additions & 0 deletions src/models/generative-model.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ import {
CountTokensResponse,
EmbedContentRequest,
EmbedContentResponse,
GenerateAnswerRequest,
GenerateAnswerResponse,
GenerateContentRequest,
GenerateContentResult,
GenerateContentStreamResult,
Expand All @@ -50,6 +52,9 @@ import {
formatGenerateContentInput,
formatSystemInstruction,
} from "../requests/request-helpers";
import { Task, makeModelRequest } from "../requests/request";
import { processAqaResponse } from "../requests/response-helpers";
import { GoogleGenerativeAIRequestInputError, GoogleGenerativeAIResponseError } from "../errors";

/**
* Class for generative model APIs.
Expand Down Expand Up @@ -175,6 +180,85 @@ export class GenerativeModel {
);
}

/**
* Generates an attributed answer based on provided sources and input question.
*
* @public
*
* @param request - The request parameters containing:
* - `input`: Required. The question to be answered
* - `sources`: Array of attributed sources to reference
* - `temperature`: Optional. Controls randomness (0.0-1.0)
*
* @param requestOptions - Optional. Overrides for request configuration
*
* @returns Promise resolving to {@link GenerateAnswerResponse} containing:
* - `answer`: The generated answer text
* - `attributedPassages`: Array of source passages used
* - `confidenceScore`: Model's confidence in the answer (0.0-1.0)
*
* @throws {GoogleGenerativeAIRequestInputError} If invalid request format
* @throws {GoogleGenerativeAIResponseError} If API returns error
*
* @example
* ```
* const model = genAI.getGenerativeModel({ model: 'models/aqa' });
* const request = {
* input: "What's the capital of France?",
* sources: [{
* title: "World Factbook",
* url: "https://example.com/factbook",
* content: "Paris is the administrative and cultural center of France."
* }]
* };
*
* try {
* const result = await model.generateAnswer(request);
* console.log(result.answer); // "Paris"
* console.log(result.attributedPassages[0].source.title); // "World Factbook"
* } catch (err) {
* console.error(err);
* }
* ```
*/
async generateAnswer(
request: GenerateAnswerRequest,
requestOptions: SingleRequestOptions = {},
): Promise<GenerateAnswerResponse> {
const generativeModelRequestOptions: SingleRequestOptions = {
...this._requestOptions,
...requestOptions,
};

if (!request.input) {
throw new GoogleGenerativeAIRequestInputError(
"GenerateAnswerRequest must contain 'input' field"
);
}

try {
const response = await makeModelRequest(
'models/aqa', // Hardcode AQA model path
Task.GENERATE_ANSWER,
this.apiKey,
false,
JSON.stringify(request),
generativeModelRequestOptions
);

const responseJson = await response.json();
return processAqaResponse(responseJson);
} catch (e) {
if (e instanceof GoogleGenerativeAIResponseError) {
throw new GoogleGenerativeAIResponseError<GenerateAnswerResponse>(
`AQA API Error: ${e.message}`,
e.response
);
}
throw e;
}
}

/**
* Counts the tokens in the provided request.
*
Expand Down
1 change: 1 addition & 0 deletions src/requests/request.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ const PACKAGE_LOG_HEADER = "genai-js";
export enum Task {
GENERATE_CONTENT = "generateContent",
STREAM_GENERATE_CONTENT = "streamGenerateContent",
GENERATE_ANSWER = "generateAnswer",
COUNT_TOKENS = "countTokens",
EMBED_CONTENT = "embedContent",
BATCH_EMBED_CONTENTS = "batchEmbedContents",
Expand Down
24 changes: 24 additions & 0 deletions src/requests/response-helpers.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,11 @@
*/

import {
AttributedPassage,
EnhancedGenerateContentResponse,
FinishReason,
FunctionCall,
GenerateAnswerResponse,
GenerateContentCandidate,
GenerateContentResponse,
} from "../../types";
Expand Down Expand Up @@ -206,3 +208,25 @@ export function formatBlockErrorMessage(
}
return message;
}

export function processAqaResponse(response: GenerateAnswerResponse): GenerateAnswerResponse {
if (!response.answer) {
throw new GoogleGenerativeAIResponseError<typeof response>(
"Invalid AQA response format - missing 'answer' field",
response
);
}

return {
answer: response.answer,
attributedPassages: (response.attributedPassages || []).map((p: AttributedPassage) => ({
text: p.text,
source: {
title: p.source?.title || "Unknown",
url: p.source?.url || "",
content: p.source?.content || ""
}
})),
confidenceScore: response.confidenceScore ?? 0
};
}
27 changes: 27 additions & 0 deletions types/requests.ts
Original file line number Diff line number Diff line change
Expand Up @@ -245,3 +245,30 @@ export interface CodeExecutionTool {
*/
codeExecution: {};
}

/**
* Request sent to `generateAnswer` endpoint.
* @public
*/
export interface GenerateAnswerRequest {
input: string;
sources?: AttributedSource[];
temperature?: number;
}

export interface AttributedSource {
title: string;
url: string;
content: string;
}

export interface GenerateAnswerResponse {
answer: string;
attributedPassages: AttributedPassage[];
confidenceScore: number;
}

export interface AttributedPassage {
text: string;
source: AttributedSource;
}