Skip to content

Commit 41ed599

Browse files
charlottetaylor-ossclaudeClaraMuller
authored
fix(specs): clarify when _extra and _injectedItemKey are present on hits (#7031)
Co-authored-by: Claude Fable 5 <noreply@anthropic.com> Co-authored-by: Clara Muller <5667350+ClaraMuller@users.noreply.github.com>
1 parent 803d419 commit 41ed599

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

  • specs/composition/common/schemas/responses/runResponseComponents

‎specs/composition/common/schemas/responses/runResponseComponents/Hit.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,12 @@ hit:
2424

2525
hitMetadata:
2626
type: object
27-
description: An object that contains the extra key-value pairs provided in the injectedItem definition.
27+
description: An object that contains the extra key-value pairs provided in the injectedItem definition. Only present on hits inserted by an injectedItem that defines metadata, either in its `metadata` field or sent by an external source.
2828
additionalProperties: true
2929
properties:
3030
_injectedItemKey:
3131
type: string
32-
description: The key of the injectedItem that inserted this metadata.
32+
description: The key of the injectedItem that inserted this metadata. Only present when the injectedItem's `metadata.hits.addItemKey` is `true`.
3333

3434
rankingInfo:
3535
allOf:

0 commit comments

Comments
 (0)