Skip to content

Adding batch size to custom service #5523

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Oct 20, 2025
Merged

Adding batch size to custom service #5523

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
95b45f6
Adding batch size
jonathan-buttner Oct 20, 2025
b1a027e
Updating batch size info with link
jonathan-buttner Oct 20, 2025
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
1 change: 1 addition & 0 deletions specification/_doc_ids/table.csv
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -853,6 +853,7 @@ security-saml-guide,https://www.elastic.co/docs/deploy-manage/users-roles/cluste
security-settings-api-keys,https://www.elastic.co/docs/reference/elasticsearch/configuration-reference/security-settings#api-key-service-settings,,
security-settings-hashing,https://www.elastic.co/docs/reference/elasticsearch/configuration-reference/security-settings#hashing-settings,,
security-user-cache,https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/controlling-user-cache,,
sematic-text-chunking,https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/semantic-text#auto-text-chunking,,
service-accounts,https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/service-accounts,,
set-processor,https://www.elastic.co/docs/reference/enrich-processor/set-processor,,
shape,https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/shape,,
Expand Down
7 changes: 7 additions & 0 deletions specification/inference/_types/CommonTypes.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -946,6 +946,13 @@ export class CohereTaskSettings {
}

export class CustomServiceSettings {
/**
* Specifies the batch size used for the semantic_text field. If the field is not provided, the default is 10.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need to expand on this to explain what the batch size is? Something like "the batch size is the maximum number of inputs based on the selected chunking strategy for the semantic_text field" and then link out to the semantic text field? Or is that too much information for this location?

Separately, can we add a link to the semantic text page? it'd be an entry in specification/_doc_ids/table.csv for https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/semantic-text#auto-text-chunking and then here we'd add the id for @ext_doc_id, looks like: https://github.com/elastic/elasticsearch-specification/blob/main/specification/transform/_types/Transform.ts#L139

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah good idea.

* The batch size is the maximum number of inputs in a single request to the upstream service.
* The chunk within the batch are controlled by the selected chunking strategy for the semantic_text field.
* @ext_doc_id sematic-text-chunking
*/
batch_size?: integer
/**
* Specifies the HTTP header parameters – such as `Authentication` or `Content-Type` – that are required to access the custom service.
* For example:
Expand Down
Loading