Skip to content

Commit 603fd58

Browse files
Including examples
1 parent e7a4436 commit 603fd58

File tree

2 files changed

+452
-1
lines changed

2 files changed

+452
-1
lines changed

docs/reference/inference/inference-shared.asciidoc

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ end::chunking-settings[]
4141
tag::chunking-settings-max-chunking-size[]
4242
Specifies the maximum size of a chunk in words.
4343
Defaults to `250`.
44-
This value cannot be higher than `300` or lower than `20` (for `sentence` strategy) or `10` (for `word` strategy).
44+
This value cannot be higher than `300` or lower than `20` (for `sentence` strategy) or `10` (for `word` strategy).
4545
end::chunking-settings-max-chunking-size[]
4646

4747
tag::chunking-settings-overlap[]
@@ -63,4 +63,44 @@ Specifies the chunking strategy.
6363
It could be either `sentence` or `word`.
6464
end::chunking-settings-strategy[]
6565

66+
tag::unified-schema-content-with-examples[]
67+
.Examples
68+
[%collapsible%closed]
69+
======
70+
String example
71+
[source,json]
72+
------------------------------------------------------------
73+
{
74+
"content": "Some string"
75+
}
76+
------------------------------------------------------------
77+
// NOTCONSOLE
78+
79+
Object example
80+
[source,json]
81+
------------------------------------------------------------
82+
{
83+
"content": [
84+
{
85+
"text": "Some text",
86+
"type": "text"
87+
}
88+
]
89+
}
90+
------------------------------------------------------------
91+
// NOTCONSOLE
92+
======
6693
94+
String representation:::
95+
(Required, string)
96+
The text content.
97+
+
98+
Object representation:::
99+
`text`::::
100+
(Required, string)
101+
The text content.
102+
+
103+
`type`::::
104+
(Required, string)
105+
This must be set to the value `text`.
106+
end::unified-schema-content-with-examples[]

0 commit comments

Comments
 (0)