Skip to content

Commit 3eb5a12

Browse files
Add Hugging Face task settings definition
1 parent e73e977 commit 3eb5a12

File tree

6 files changed

+125
-23
lines changed

6 files changed

+125
-23
lines changed

output/openapi/elasticsearch-openapi.json

Lines changed: 16 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/openapi/elasticsearch-serverless-openapi.json

Lines changed: 16 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/schema/schema.json

Lines changed: 69 additions & 23 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/typescript/types.ts

Lines changed: 6 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

specification/inference/_types/CommonTypes.ts

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -908,6 +908,18 @@ export class HuggingFaceServiceSettings {
908908
model_id?: string
909909
}
910910

911+
export class HuggingFaceTaskSettings {
912+
/**
913+
* For a `rerank` task, return doc text within the results.
914+
*/
915+
return_documents?: boolean
916+
/**
917+
* For a `rerank` task, the number of most relevant documents to return.
918+
* It defaults to the number of the documents.
919+
*/
920+
top_n?: integer
921+
}
922+
911923
export enum HuggingFaceTaskType {
912924
chat_completion,
913925
completion,

specification/inference/put_hugging_face/PutHuggingFaceRequest.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ import { Id } from '@_types/common'
2222
import {
2323
HuggingFaceServiceSettings,
2424
HuggingFaceServiceType,
25+
HuggingFaceTaskSettings,
2526
HuggingFaceTaskType
2627
} from '@inference/_types/CommonTypes'
2728
import { InferenceChunkingSettings } from '@inference/_types/Services'
@@ -103,5 +104,10 @@ export interface Request extends RequestBase {
103104
* Settings used to install the inference model. These settings are specific to the `hugging_face` service.
104105
*/
105106
service_settings: HuggingFaceServiceSettings
107+
/**
108+
* Settings to configure the inference task.
109+
* These settings are specific to the task type you specified.
110+
*/
111+
task_settings?: HuggingFaceTaskSettings
106112
}
107113
}

0 commit comments

Comments
 (0)