13399991792

Committed 18 Feb 2025 09:03PM UTC coverage: 88.937% (-0.3%) from 89.252%

Build # 13399991792

Build Type

Pull #293

github

Committed by

web-flow

Commit Message

Merge 65757c63b into ad7ea9357

Pull Request Pull Request #293: Version 2.6.0

Run Details

174 of 203 branches covered (85.71%)

Branch coverage included in aggregate %.

21 of 23 new or added lines in 5 files covered. (91.3%)

236 of 258 relevant lines covered (91.47%)

9.53 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

84.62

/src/infra/GenerativeDirectAnswerServiceImpl.ts

import { defaultApiVersion } from '../provideEndpoints';
import { QueryParams } from '../models/http/params';
import { HttpService } from '../services/HttpService';
import { SearchConfigWithDefaulting } from '../models/core/SearchConfig';
import { ApiResponseValidator } from '../validation/ApiResponseValidator';
import { ApiResponse } from '../models/searchapi/ApiResponse';
import { getClientSdk } from '../utils/getClientSdk';
import { GenerativeDirectAnswerRequest } from '../models/generativedirectanswer/GenerativeDirectAnswerRequest';
import { GenerativeDirectAnswerResponse } from '../models/generativedirectanswer/GenerativeDirectAnswerResponse';
import { GenerativeDirectAnswerService } from '../services/GenerativeDirectAnswerService';
import { createGenerativeDirectAnswerResponse } from '../transformers/generativedirectanswerservice/createGenerativeDirectAnswerResponse';

/**
 * Represents the query params which may be sent in a generative direct answer.
 *
 * @internal
 */
interface GenerativeDirectAnswerQueryParams extends QueryParams {
  experienceKey: string,
  api_key?: string,
  v: number,
  version?: string | number,
  locale?: string
}

export class GenerativeDirectAnswerServiceImpl implements GenerativeDirectAnswerService {
  private config: SearchConfigWithDefaulting;
  private httpService: HttpService;
  private apiResponseValidator: ApiResponseValidator;
  private endpoint: string;

  constructor(
    config: SearchConfigWithDefaulting,
    httpService: HttpService,
    apiResponseValidator: ApiResponseValidator
  ) {
    this.config = config;
    this.httpService = httpService;
    this.apiResponseValidator = apiResponseValidator;
    this.endpoint = this.config.endpoints.generativeDirectAnswer;
  }

  async generateAnswer(request: GenerativeDirectAnswerRequest): Promise<GenerativeDirectAnswerResponse> {
    const queryParams: GenerativeDirectAnswerQueryParams = {
      experienceKey: this.config.experienceKey,
      ...('apiKey' in this.config && { api_key: this.config.apiKey }),
      v: defaultApiVersion,
      version: this.config.experienceVersion,
      locale: this.config.locale,
      visitorId: this.config.visitor?.id,
      visitorIdMethod: this.config.visitor?.idMethod,
      ...this.config?.additionalQueryParams
    };
    let results: NonNullable<unknown> = {};
    if (request.results.length === 1) {
      results = request.results[0];
    } else if (request.results.length > 1) {
      results = { verticals: request.results };
    }
    const body = {
      searchId: request.searchId,
      searchTerm: request.searchTerm,
      results: results
    };
    const response = 'token' in this.config
      ? await this.httpService.post<ApiResponse>(
        this.endpoint,
        queryParams,
        body,
        getClientSdk(request.additionalHttpHeaders),
        this.config.token
      )
      : await this.httpService.post<ApiResponse>(
        this.endpoint,
        queryParams,
        body,
        getClientSdk(request.additionalHttpHeaders)
      );

    const validationResult = this.apiResponseValidator.validate(response);
    if (validationResult instanceof Error) {
      return Promise.reject(validationResult);
    }

    return createGenerativeDirectAnswerResponse(response);
  }
}

1	import { defaultApiVersion } from '../provideEndpoints';
2	import { QueryParams } from '../models/http/params';
3	import { HttpService } from '../services/HttpService';
4	import { SearchConfigWithDefaulting } from '../models/core/SearchConfig';
5	import { ApiResponseValidator } from '../validation/ApiResponseValidator';
6	import { ApiResponse } from '../models/searchapi/ApiResponse';
7	import { getClientSdk } from '../utils/getClientSdk';
8	import { GenerativeDirectAnswerRequest } from '../models/generativedirectanswer/GenerativeDirectAnswerRequest';
9	import { GenerativeDirectAnswerResponse } from '../models/generativedirectanswer/GenerativeDirectAnswerResponse';
10	import { GenerativeDirectAnswerService } from '../services/GenerativeDirectAnswerService';
11	import { createGenerativeDirectAnswerResponse } from '../transformers/generativedirectanswerservice/createGenerativeDirectAnswerResponse';
12
13	/**
14	* Represents the query params which may be sent in a generative direct answer.
15	*
16	* @internal
17	*/
18	interface GenerativeDirectAnswerQueryParams extends QueryParams {
19	experienceKey: string,
20	api_key?: string,
21	v: number,
22	version?: string \| number,
23	locale?: string
24	}
25
26	export class GenerativeDirectAnswerServiceImpl implements GenerativeDirectAnswerService {
27	private config: SearchConfigWithDefaulting;
28	private httpService: HttpService;
29	private apiResponseValidator: ApiResponseValidator;
30	private endpoint: string;
31
32	constructor(
33	config: SearchConfigWithDefaulting,
34	httpService: HttpService,
35	apiResponseValidator: ApiResponseValidator
36	) {
37	this.config = config;	4✔
38	this.httpService = httpService;	4✔
39	this.apiResponseValidator = apiResponseValidator;	4✔
40	this.endpoint = this.config.endpoints.generativeDirectAnswer;	4✔
41	}
42
43	async generateAnswer(request: GenerativeDirectAnswerRequest): Promise<GenerativeDirectAnswerResponse> {
44	const queryParams: GenerativeDirectAnswerQueryParams = {	4✔
45	experienceKey: this.config.experienceKey,
46	...('apiKey' in this.config && { api_key: this.config.apiKey }),	8✔
47	v: defaultApiVersion,
48	version: this.config.experienceVersion,
49	locale: this.config.locale,
50	visitorId: this.config.visitor?.id,
51	visitorIdMethod: this.config.visitor?.idMethod,
52	...this.config?.additionalQueryParams
53	};
54	let results: NonNullable<unknown> = {};	4✔
55	if (request.results.length === 1) {	4✔
56	results = request.results[0];	3✔
57	} else if (request.results.length > 1) {	1!
58	results = { verticals: request.results };	1✔
59	}
60	const body = {	4✔
61	searchId: request.searchId,
62	searchTerm: request.searchTerm,
63	results: results
64	};
65	const response = 'token' in this.config	4!
66	? await this.httpService.post<ApiResponse>(
67	this.endpoint,
68	queryParams,
69	body,
70	getClientSdk(request.additionalHttpHeaders),
71	this.config.token
72	)
73	: await this.httpService.post<ApiResponse>(
74	this.endpoint,
75	queryParams,
76	body,
77	getClientSdk(request.additionalHttpHeaders)
78	);
79
80	const validationResult = this.apiResponseValidator.validate(response);	4✔
81	if (validationResult instanceof Error) {	4!
NEW 82	return Promise.reject(validationResult);	×
83	}
84
85	return createGenerativeDirectAnswerResponse(response);	4✔
86	}
87	}

yext / search-core / 13399991792

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous