🚚 Rename questionAnswer to questionAnswering

coyotte508 · coyotte508 · commit 945e6042f966 · 2023-04-14T18:37:37.000+02:00
Fix #145
diff --git a/packages/inference/README.md b/packages/inference/README.md
@@ -45,15 +45,15 @@ await hf.summarization({
   }
 })
 
-await hf.questionAnswer({
+await hf.questionAnswering({
   model: 'deepset/roberta-base-squad2',
   inputs: {
     question: 'What is the capital of France?',
     context: 'The capital of France is Paris.'
   }
 })
 
-await hf.tableQuestionAnswer({
+await hf.tableQuestionAnswering({
   model: 'google/tapas-base-finetuned-wtq',
   inputs: {
     query: 'How many stars does the transformers repository have?',
diff --git a/packages/inference/src/HfInference.ts b/packages/inference/src/HfInference.ts
@@ -102,14 +102,14 @@ export interface SummarizationReturn {
 	summary_text: string;
 }
 
-export type QuestionAnswerArgs = Args & {
+export type QuestionAnsweringArgs = Args & {
 	inputs: {
 		context: string;
 		question: string;
 	};
 };
 
-export interface QuestionAnswerReturn {
+export interface QuestionAnsweringReturn {
 	/**
 	 * A string that’s the answer within the text.
 	 */
@@ -128,7 +128,7 @@ export interface QuestionAnswerReturn {
 	start: number;
 }
 
-export type TableQuestionAnswerArgs = Args & {
+export type TableQuestionAnsweringArgs = Args & {
 	inputs: {
 		/**
 		 * The query in plain text that you want to ask the table
@@ -141,7 +141,7 @@ export type TableQuestionAnswerArgs = Args & {
 	};
 };
 
-export interface TableQuestionAnswerReturn {
+export interface TableQuestionAnsweringReturn {
 	/**
 	 * The aggregator used to get the answer
 	 */
@@ -694,8 +694,8 @@ export class HfInference {
 	/**
 	 * Want to have a nice know-it-all bot that can answer any question?. Recommended model: deepset/roberta-base-squad2
 	 */
-	public async questionAnswer(args: QuestionAnswerArgs, options?: Options): Promise<QuestionAnswerReturn> {
-		const res = await this.request<QuestionAnswerReturn>(args, options);
+	public async questionAnswering(args: QuestionAnsweringArgs, options?: Options): Promise<QuestionAnsweringReturn> {
+		const res = await this.request<QuestionAnsweringReturn>(args, options);
 		const isValidOutput =
 			typeof res.answer === "string" &&
 			typeof res.end === "number" &&
@@ -712,11 +712,11 @@ export class HfInference {
 	/**
 	 * Don’t know SQL? Don’t want to dive into a large spreadsheet? Ask questions in plain english! Recommended model: google/tapas-base-finetuned-wtq.
 	 */
-	public async tableQuestionAnswer(
-		args: TableQuestionAnswerArgs,
+	public async tableQuestionAnswering(
+		args: TableQuestionAnsweringArgs,
 		options?: Options
-	): Promise<TableQuestionAnswerReturn> {
-		const res = await this.request<TableQuestionAnswerReturn>(args, options);
+	): Promise<TableQuestionAnsweringReturn> {
+		const res = await this.request<TableQuestionAnsweringReturn>(args, options);
 		const isValidOutput =
 			typeof res.aggregator === "string" &&
 			typeof res.answer === "string" &&
diff --git a/packages/inference/test/HfInference.spec.ts b/packages/inference/test/HfInference.spec.ts
@@ -60,9 +60,9 @@ describe.concurrent(
 			});
 		});
 
-		it("questionAnswer", async () => {
+		it("questionAnswering", async () => {
 			expect(
-				await hf.questionAnswer({
+				await hf.questionAnswering({
 					model: "deepset/roberta-base-squad2",
 					inputs: {
 						question: "What is the capital of France?",
@@ -77,9 +77,9 @@ describe.concurrent(
 			});
 		});
 
-		it("table question answer", async () => {
+		it("tableQuestionAnswering", async () => {
 			expect(
-				await hf.tableQuestionAnswer({
+				await hf.tableQuestionAnswering({
 					model: "google/tapas-base-finetuned-wtq",
 					inputs: {
 						query: "How many stars does the transformers repository have?",
