chunk_id stringlengths 36 36 | source stringclasses 35
values | source_url stringlengths 0 290 | upstream_license stringclasses 1
value | document_id stringlengths 36 36 | chunk_index int64 0 324k | retrieved_at stringclasses 2
values | chunker_version stringclasses 4
values | content_hash stringlengths 15 64 | content stringlengths 50 44.7k | namespace stringclasses 9
values | source_name stringclasses 35
values | raw_text stringlengths 50 44.7k | cleaned_text stringlengths 50 44.7k | tags stringclasses 49
values | collection_name stringclasses 11
values |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
8df00dc3-786b-4cd1-aacd-0d7fb30b3112 | OPEA Documentation | file://datasets/opea-docs/developer-guides/OPEA_API.rst | unknown | 314c66a7-1201-4174-8031-55d7de224e64 | 15 | opea-semantic-v1 | a3bcf9b12fa34b48 | { "object": "list", "data": [{ "object": "embedding", "embedding": [ 0.0023064255, ... ], "index": 0 }], "model": "text-embedding-ada-002", "usage": { "prompt_tokens": 8, "total_tokens": 8 }, }
``embedding (float)``
The vector representation for given inputs. | ai_ref_knowledge | OPEA Documentation | { "object": "list", "data": [{ "object": "embedding", "embedding": [ 0.0023064255, ... ], "index": 0 }], "model": "text-embedding-ada-002", "usage": { "prompt_tokens": 8, "total_tokens": 8 }, }
``embedding (float)``
The vector representation for given inputs. | { "object": "list", "data": [{ "object": "embedding", "embedding": [ 0.0023064255, ... ], "index": 0 }], "model": "text-embedding-ada-002", "usage": { "prompt_tokens": 8, "total_tokens": 8 }, }
``embedding (float)``
The vector representation for given inputs. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
8eaca5be-0788-47b4-bc8e-56a314b60087 | OPEA Documentation | file://datasets/opea-docs/developer-guides/OPEA_API.rst | unknown | 314c66a7-1201-4174-8031-55d7de224e64 | 12 | opea-semantic-v1 | 1907359b58f6878e | to use. * - **POST** - ``encoding_format`` - ``string`` - required - The format to return the embeddings in. Can be either ``"float"`` or ``"base64"``.
* - **POST**
- ``dimensions``
- ``integer``
- optional
- The number of dimensions the resulting output embeddings should have. Only supported in text-embedding-3 an... | ai_ref_knowledge | OPEA Documentation | to use. * - **POST** - ``encoding_format`` - ``string`` - required - The format to return the embeddings in. Can be either ``"float"`` or ``"base64"``.
* - **POST**
- ``dimensions``
- ``integer``
- optional
- The number of dimensions the resulting output embeddings should have. Only supported in text-embedding-3 an... | to use. * - **POST** - ``encoding_format`` - ``string`` - required - The format to return the embeddings in. Can be either ``"float"`` or ``"base64"``.
* - **POST**
- ``dimensions``
- ``integer``
- optional
- The number of dimensions the resulting output embeddings should have. Only supported in text-embedding-3 an... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
9163ddc1-f9a4-4b31-903f-d112ff8db78f | OPEA Documentation | file://datasets/opea-docs/developer-guides/OPEA_API.rst | unknown | 314c66a7-1201-4174-8031-55d7de224e64 | 35 | opea-semantic-v1 | 0d643b4d57b8c298 | .. list-table::
* - Type
- Parameters
- Values
- Required
- Description
* - **POST**
- ``input``
- ``string``
- required
- Input text to embed, encoded as a string or array of tokens. To
embed multiple inputs in a single request, pass an array of strings or
array of token arrays. The input must not exceed th... | ai_ref_knowledge | OPEA Documentation | .. list-table::
* - Type
- Parameters
- Values
- Required
- Description
* - **POST**
- ``input``
- ``string``
- required
- Input text to embed, encoded as a string or array of tokens. To
embed multiple inputs in a single request, pass an array of strings or
array of token arrays. The input must not exceed th... | .. list-table::
* - Type
- Parameters
- Values
- Required
- Description
* - **POST**
- ``input``
- ``string``
- required
- Input text to embed, encoded as a string or array of tokens. To
embed multiple inputs in a single request, pass an array of strings or
array of token arrays. The input must not exceed th... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
920aedb4-a475-4ba0-ada5-794193fb9b1f | OPEA Documentation | file://datasets/opea-docs/developer-guides/OPEA_API.rst | unknown | 314c66a7-1201-4174-8031-55d7de224e64 | 65 | opea-semantic-v1 | 830c30246c0305cd | - ``string`` - required - The string to query. * - **POST** - ``json_encoders`` - ``list of float`` - required - The json encoder used.
Response | ai_ref_knowledge | OPEA Documentation | - ``string`` - required - The string to query. * - **POST** - ``json_encoders`` - ``list of float`` - required - The json encoder used.
Response | - ``string`` - required - The string to query. * - **POST** - ``json_encoders`` - ``list of float`` - required - The json encoder used.
Response | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
92da48a8-315b-4a48-9468-855e3b161af8 | OPEA Documentation | file://datasets/opea-docs/developer-guides/OPEA_API.rst | unknown | 314c66a7-1201-4174-8031-55d7de224e64 | 49 | opea-semantic-v1 | 18997acff6f0d606 | "my_function"}}`` forces the model to call that tool. ``"none"`` is the default when no tools are present. ``"auto"`` is the default if tools are present.
Response | ai_ref_knowledge | OPEA Documentation | "my_function"}}`` forces the model to call that tool. ``"none"`` is the default when no tools are present. ``"auto"`` is the default if tools are present.
Response | "my_function"}}`` forces the model to call that tool. ``"none"`` is the default when no tools are present. ``"auto"`` is the default if tools are present.
Response | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
941f0aaf-90df-4c83-a2f6-e40d03f9c4e8 | OPEA Documentation | file://datasets/opea-docs/developer-guides/OPEA_API.rst | unknown | 314c66a7-1201-4174-8031-55d7de224e64 | 40 | opea-semantic-v1 | 5543123a0242daab | ``embedding (list of float)`` The vector representation for given inputs. * - **405** - ``{"error": "The request of getting embedding vector fails."}``
LLM Generation Micro Service | ai_ref_knowledge | OPEA Documentation | ``embedding (list of float)`` The vector representation for given inputs. * - **405** - ``{"error": "The request of getting embedding vector fails."}``
LLM Generation Micro Service | ``embedding (list of float)`` The vector representation for given inputs. * - **405** - ``{"error": "The request of getting embedding vector fails."}``
LLM Generation Micro Service | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
9dc9e104-656c-4b56-9cbf-54db19c15a73 | OPEA Documentation | file://datasets/opea-docs/developer-guides/OPEA_API.rst | unknown | 314c66a7-1201-4174-8031-55d7de224e64 | 33 | opea-semantic-v1 | c24180bcc7bb6818 | OPEA Micro Service API **********************
OPEA Micro Service is the building block of constructing any GenAI applications. The API in OPEA micro service is used by developers to construct OPEA Mega
Service like a DAG chain and is invisible for end user. | ai_ref_knowledge | OPEA Documentation | OPEA Micro Service API **********************
OPEA Micro Service is the building block of constructing any GenAI applications. The API in OPEA micro service is used by developers to construct OPEA Mega
Service like a DAG chain and is invisible for end user. | OPEA Micro Service API **********************
OPEA Micro Service is the building block of constructing any GenAI applications. The API in OPEA micro service is used by developers to construct OPEA Mega
Service like a DAG chain and is invisible for end user. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
a0fc4288-1a33-4616-ac82-a5d426100a27 | OPEA Documentation | file://datasets/opea-docs/developer-guides/OPEA_API.rst | unknown | 314c66a7-1201-4174-8031-55d7de224e64 | 26 | opea-semantic-v1 | 2d047061279ea8e6 | ``id (string)`` A unique identifier for the chat completion.
``choices (array)``
A list of chat completion choices. Can be more than one if ``n`` is greater than 1. | ai_ref_knowledge | OPEA Documentation | ``id (string)`` A unique identifier for the chat completion.
``choices (array)``
A list of chat completion choices. Can be more than one if ``n`` is greater than 1. | ``id (string)`` A unique identifier for the chat completion.
``choices (array)``
A list of chat completion choices. Can be more than one if ``n`` is greater than 1. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
a52d542b-a13a-42ca-8e9c-95a50ee0629c | OPEA Documentation | file://datasets/opea-docs/developer-guides/OPEA_API.rst | unknown | 314c66a7-1201-4174-8031-55d7de224e64 | 16 | opea-semantic-v1 | 93be7d4c37cbe9ae | ``embedding (float)`` The vector representation for given inputs.
``index (integer)``
The index of the embedding in the list of embeddings. | ai_ref_knowledge | OPEA Documentation | ``embedding (float)`` The vector representation for given inputs.
``index (integer)``
The index of the embedding in the list of embeddings. | ``embedding (float)`` The vector representation for given inputs.
``index (integer)``
The index of the embedding in the list of embeddings. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
ab81e7a6-79c3-477e-aefa-4c2522cd9aee | OPEA Documentation | file://datasets/opea-docs/developer-guides/OPEA_API.rst | unknown | 314c66a7-1201-4174-8031-55d7de224e64 | 50 | opea-semantic-v1 | 52a3a049ad9a50bd | * - Status - Response * - **200** - .. code-block::
{
"id": "chatcmpl-123",
"object": "chat.completion",
"created": 1677652288,
"model": "gpt-4o-mini",
"system_fingerprint": "fp_44709d6fcb",
"choices": [{
"index": 0,
"object": "embedding",
"message": {
"role": "assistant",
"content": "\n\nHello there, how ... | ai_ref_knowledge | OPEA Documentation | * - Status - Response * - **200** - .. code-block::
{
"id": "chatcmpl-123",
"object": "chat.completion",
"created": 1677652288,
"model": "gpt-4o-mini",
"system_fingerprint": "fp_44709d6fcb",
"choices": [{
"index": 0,
"object": "embedding",
"message": {
"role": "assistant",
"content": "\n\nHello there, how ... | * - Status - Response * - **200** - .. code-block::
{
"id": "chatcmpl-123",
"object": "chat.completion",
"created": 1677652288,
"model": "gpt-4o-mini",
"system_fingerprint": "fp_44709d6fcb",
"choices": [{
"index": 0,
"object": "embedding",
"message": {
"role": "assistant",
"content": "\n\nHello there, how ... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
b975f5b2-ca5b-4379-a2ef-2c9dc2da8479 | OPEA Documentation | file://datasets/opea-docs/developer-guides/OPEA_API.rst | unknown | 314c66a7-1201-4174-8031-55d7de224e64 | 9 | opea-semantic-v1 | 359a5fc2dd0a10b7 | ``micro_service_name (string)`` The micro service name in OPEA mega service in which some parameters are configurable.
``parameter_name (string)``
The configurable parameter name in OPEA mega service. | ai_ref_knowledge | OPEA Documentation | ``micro_service_name (string)`` The micro service name in OPEA mega service in which some parameters are configurable.
``parameter_name (string)``
The configurable parameter name in OPEA mega service. | ``micro_service_name (string)`` The micro service name in OPEA mega service in which some parameters are configurable.
``parameter_name (string)``
The configurable parameter name in OPEA mega service. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
bcafccba-9b38-4304-81c6-5f739a53b380 | OPEA Documentation | file://datasets/opea-docs/developer-guides/OPEA_API.rst | unknown | 314c66a7-1201-4174-8031-55d7de224e64 | 20 | opea-semantic-v1 | 13b04d38065d8f77 | Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.
* - **POST**
- ``logit_bias``
- ``map``
- optional
- Modify the likelihood of specified tokens appearing in the completion. Accepts a JSON object that maps to... | ai_ref_knowledge | OPEA Documentation | Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.
* - **POST**
- ``logit_bias``
- ``map``
- optional
- Modify the likelihood of specified tokens appearing in the completion. Accepts a JSON object that maps to... | Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.
* - **POST**
- ``logit_bias``
- ``map``
- optional
- Modify the likelihood of specified tokens appearing in the completion. Accepts a JSON object that maps to... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
bf1da244-2398-4b61-98d2-997665eb1663 | OPEA Documentation | file://datasets/opea-docs/developer-guides/OPEA_API.rst | unknown | 314c66a7-1201-4174-8031-55d7de224e64 | 59 | opea-semantic-v1 | 864829aaa2e7b6ec | input string to query. * - **POST** - ``embedding`` - ``list of float`` - required - The list of float for text as vector representation.
Response | ai_ref_knowledge | OPEA Documentation | input string to query. * - **POST** - ``embedding`` - ``list of float`` - required - The list of float for text as vector representation.
Response | input string to query. * - **POST** - ``embedding`` - ``list of float`` - required - The list of float for text as vector representation.
Response | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
c7cce31a-473f-4566-ae3c-74df2b446b6b | OPEA Documentation | file://datasets/opea-docs/developer-guides/OPEA_API.rst | unknown | 314c66a7-1201-4174-8031-55d7de224e64 | 52 | opea-semantic-v1 | 44aadc2098335cdb | "usage": { "prompt_tokens": 9, "completion_tokens": 12, "total_tokens": 21 }, } * - **405** - ``{"error": "The request of LLM generation fails."}``
ASR Micro Service | ai_ref_knowledge | OPEA Documentation | "usage": { "prompt_tokens": 9, "completion_tokens": 12, "total_tokens": 21 }, } * - **405** - ``{"error": "The request of LLM generation fails."}``
ASR Micro Service | "usage": { "prompt_tokens": 9, "completion_tokens": 12, "total_tokens": 21 }, } * - **405** - ``{"error": "The request of LLM generation fails."}``
ASR Micro Service | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
c86de895-0488-461a-ba1a-ee8208fd5db0 | OPEA Documentation | file://datasets/opea-docs/developer-guides/OPEA_API.rst | unknown | 314c66a7-1201-4174-8031-55d7de224e64 | 32 | opea-semantic-v1 | dc28e29b8e2e5a55 | Check the usage description returned in :ref:`list_services` to know what other operations are supported by this OPEA Mega Service.
OPEA Micro Service API
********************** | ai_ref_knowledge | OPEA Documentation | Check the usage description returned in :ref:`list_services` to know what other operations are supported by this OPEA Mega Service.
OPEA Micro Service API
********************** | Check the usage description returned in :ref:`list_services` to know what other operations are supported by this OPEA Mega Service.
OPEA Micro Service API
********************** | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
ca97c21e-5197-497b-8fb0-4229eb82189e | OPEA Documentation | file://datasets/opea-docs/developer-guides/OPEA_API.rst | unknown | 314c66a7-1201-4174-8031-55d7de224e64 | 39 | opea-semantic-v1 | 5cfc82fa00781063 | 0.0023064255, -0.009327292, . . . (1536 floats total for ada-002) -0.0028842222, ], "index": 0 }], "model": "text-embedding-ada-002", "usage": { "prompt_tokens": 8, "total_tokens": 8 }, }
``embedding (list of float)``
The vector representation for given inputs. * - **405**
- ``{"error": "The request of getting embedd... | ai_ref_knowledge | OPEA Documentation | 0.0023064255, -0.009327292, . . . (1536 floats total for ada-002) -0.0028842222, ], "index": 0 }], "model": "text-embedding-ada-002", "usage": { "prompt_tokens": 8, "total_tokens": 8 }, }
``embedding (list of float)``
The vector representation for given inputs. * - **405**
- ``{"error": "The request of getting embedd... | 0.0023064255, -0.009327292, . . . (1536 floats total for ada-002) -0.0028842222, ], "index": 0 }], "model": "text-embedding-ada-002", "usage": { "prompt_tokens": 8, "total_tokens": 8 }, }
``embedding (list of float)``
The vector representation for given inputs. * - **405**
- ``{"error": "The request of getting embedd... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
caeadc40-7604-40bb-a398-df0b390226b2 | OPEA Documentation | file://datasets/opea-docs/developer-guides/OPEA_API.rst | unknown | 314c66a7-1201-4174-8031-55d7de224e64 | 61 | opea-semantic-v1 | c22478de1bc52414 | am the agent of chatbot. What can I do for you?", }, ... ] } * - **405** - ``{"error": "The request of ASR fails."}``
RAG Reranking Micro Service | ai_ref_knowledge | OPEA Documentation | am the agent of chatbot. What can I do for you?", }, ... ] } * - **405** - ``{"error": "The request of ASR fails."}``
RAG Reranking Micro Service | am the agent of chatbot. What can I do for you?", }, ... ] } * - **405** - ``{"error": "The request of ASR fails."}``
RAG Reranking Micro Service | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
cc15210d-e1a2-4aa7-9d81-fd454b343f4c | OPEA Documentation | file://datasets/opea-docs/developer-guides/OPEA_API.rst | unknown | 314c66a7-1201-4174-8031-55d7de224e64 | 55 | opea-semantic-v1 | d877e6f42b3699ec | * - Status - Response * - **200** - .. code-block::
{
"text": string
}
* - **405**
- ``{"error": "The request of ASR fails."}`` | ai_ref_knowledge | OPEA Documentation | * - Status - Response * - **200** - .. code-block::
{
"text": string
}
* - **405**
- ``{"error": "The request of ASR fails."}`` | * - Status - Response * - **200** - .. code-block::
{
"text": string
}
* - **405**
- ``{"error": "The request of ASR fails."}`` | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
cf090aef-7d3d-4303-b3d7-7a205df13efb | OPEA Documentation | file://datasets/opea-docs/developer-guides/OPEA_API.rst | unknown | 314c66a7-1201-4174-8031-55d7de224e64 | 29 | opea-semantic-v1 | ff81badcd1a0097e | ``model (string)`` The model used for the chat completion.
``system_fingerprint (string)``
This fingerprint represents the backend configuration that the model
runs with. Can be used in conjunction with the seed request parameter to
understand when backend changes have been made that might impact
determinism. | ai_ref_knowledge | OPEA Documentation | ``model (string)`` The model used for the chat completion.
``system_fingerprint (string)``
This fingerprint represents the backend configuration that the model
runs with. Can be used in conjunction with the seed request parameter to
understand when backend changes have been made that might impact
determinism. | ``model (string)`` The model used for the chat completion.
``system_fingerprint (string)``
This fingerprint represents the backend configuration that the model
runs with. Can be used in conjunction with the seed request parameter to
understand when backend changes have been made that might impact
determinism. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
cfdd83d4-4b92-441e-9ac3-1ef6596774e8 | OPEA Documentation | file://datasets/opea-docs/developer-guides/OPEA_API.rst | unknown | 314c66a7-1201-4174-8031-55d7de224e64 | 44 | opea-semantic-v1 | 36fd1832b00a6426 | in the chat completion.The total length of input tokens and generated tokens is limited by the model's context length. Example Python code for counting tokens.
* - **POST**
- ``n``
- ``integer``
- optional
- How many chat completion choices to generate for each input message. Note
that you will be charged based on... | ai_ref_knowledge | OPEA Documentation | in the chat completion.The total length of input tokens and generated tokens is limited by the model's context length. Example Python code for counting tokens.
* - **POST**
- ``n``
- ``integer``
- optional
- How many chat completion choices to generate for each input message. Note
that you will be charged based on... | in the chat completion.The total length of input tokens and generated tokens is limited by the model's context length. Example Python code for counting tokens.
* - **POST**
- ``n``
- ``integer``
- optional
- How many chat completion choices to generate for each input message. Note
that you will be charged based on... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
d20fb624-ab45-4159-9ed5-31363130628d | OPEA Documentation | file://datasets/opea-docs/developer-guides/OPEA_API.rst | unknown | 314c66a7-1201-4174-8031-55d7de224e64 | 8 | opea-semantic-v1 | 6f33fd2727961a2d | { <micro_service_name>: { <parameter_name>: data_type, . . . } }
``micro_service_name (string)``
The micro service name in OPEA mega service in which some parameters
are configurable. | ai_ref_knowledge | OPEA Documentation | { <micro_service_name>: { <parameter_name>: data_type, . . . } }
``micro_service_name (string)``
The micro service name in OPEA mega service in which some parameters
are configurable. | { <micro_service_name>: { <parameter_name>: data_type, . . . } }
``micro_service_name (string)``
The micro service name in OPEA mega service in which some parameters
are configurable. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
d32d8586-8201-4dcc-85b4-c0a47d03cf63 | OPEA Documentation | file://datasets/opea-docs/developer-guides/OPEA_API.rst | unknown | 314c66a7-1201-4174-8031-55d7de224e64 | 7 | opea-semantic-v1 | 2a01437d25d0eb31 | * - Status - Response * - **200** - .. code-block::
{
<micro_service_name>:
{
<parameter_name>: data_type,
. . . }
} | ai_ref_knowledge | OPEA Documentation | * - Status - Response * - **200** - .. code-block::
{
<micro_service_name>:
{
<parameter_name>: data_type,
. . . }
} | * - Status - Response * - **200** - .. code-block::
{
<micro_service_name>:
{
<parameter_name>: data_type,
. . . }
} | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
d4b1130f-8686-471a-82a1-1fd44017559e | OPEA Documentation | file://datasets/opea-docs/developer-guides/OPEA_API.rst | unknown | 314c66a7-1201-4174-8031-55d7de224e64 | 0 | opea-semantic-v1 | 1b195dd1521051e8 | * feng.tian@intel.com * liang1.lv@intel.com * haihao.shen@intel.com * kaokao.lv@intel.com
This specification is used to define the Restful API of OPEA Mega
Service for users to access, as long as the input and output definition
of all OPEA Micro Services for developer to build OPEA Mega service. | ai_ref_knowledge | OPEA Documentation | * feng.tian@intel.com * liang1.lv@intel.com * haihao.shen@intel.com * kaokao.lv@intel.com
This specification is used to define the Restful API of OPEA Mega
Service for users to access, as long as the input and output definition
of all OPEA Micro Services for developer to build OPEA Mega service. | * feng.tian@intel.com * liang1.lv@intel.com * haihao.shen@intel.com * kaokao.lv@intel.com
This specification is used to define the Restful API of OPEA Mega
Service for users to access, as long as the input and output definition
of all OPEA Micro Services for developer to build OPEA Mega service. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
d52d0bf2-bc93-4837-b786-8b00455ea501 | OPEA Documentation | file://datasets/opea-docs/developer-guides/OPEA_API.rst | unknown | 314c66a7-1201-4174-8031-55d7de224e64 | 48 | opea-semantic-v1 | 428889a31df1b21a | - **POST** - ``tools`` - ``array`` - optional - A list of tools the model may call. Currently, only functions are supported as a tool.
Use this to provide a list of functions the model
may generate JSON inputs for. A max of 128 functions are supported. * - **POST**
- ``tool_choice``
- ``string``
- optional
- Contr... | ai_ref_knowledge | OPEA Documentation | - **POST** - ``tools`` - ``array`` - optional - A list of tools the model may call. Currently, only functions are supported as a tool.
Use this to provide a list of functions the model
may generate JSON inputs for. A max of 128 functions are supported. * - **POST**
- ``tool_choice``
- ``string``
- optional
- Contr... | - **POST** - ``tools`` - ``array`` - optional - A list of tools the model may call. Currently, only functions are supported as a tool.
Use this to provide a list of functions the model
may generate JSON inputs for. A max of 128 functions are supported. * - **POST**
- ``tool_choice``
- ``string``
- optional
- Contr... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
d8858cf5-6a36-4bda-8cee-c8535ee5cbf9 | OPEA Documentation | file://datasets/opea-docs/developer-guides/OPEA_API.rst | unknown | 314c66a7-1201-4174-8031-55d7de224e64 | 19 | opea-semantic-v1 | 51cba5f54927a7f2 | .. list-table::
* - Type
- Parameters
- Values
- Required
- Description
* - **POST**
- ``message``
- ``array``
- required
- A list of messages comprising the conversation. Refer to the
`detail format <https://platform.openai.com/docs/api-reference/chat/create#chat-create-messages>`_. * - **POST**
- ``model``... | ai_ref_knowledge | OPEA Documentation | .. list-table::
* - Type
- Parameters
- Values
- Required
- Description
* - **POST**
- ``message``
- ``array``
- required
- A list of messages comprising the conversation. Refer to the
`detail format <https://platform.openai.com/docs/api-reference/chat/create#chat-create-messages>`_. * - **POST**
- ``model``... | .. list-table::
* - Type
- Parameters
- Values
- Required
- Description
* - **POST**
- ``message``
- ``array``
- required
- A list of messages comprising the conversation. Refer to the
`detail format <https://platform.openai.com/docs/api-reference/chat/create#chat-create-messages>`_. * - **POST**
- ``model``... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
da4b57b7-369f-4941-b4f1-060106dd663b | OPEA Documentation | file://datasets/opea-docs/developer-guides/OPEA_API.rst | unknown | 314c66a7-1201-4174-8031-55d7de224e64 | 6 | opea-semantic-v1 | 0f7db1cde2fa71d9 | endpoints or urls OPEA mega service is serving, including the request and post format and details. * - **405** - ``{"error": "Retrieve service name wrongly."}``
List Configurable Parameters | ai_ref_knowledge | OPEA Documentation | endpoints or urls OPEA mega service is serving, including the request and post format and details. * - **405** - ``{"error": "Retrieve service name wrongly."}``
List Configurable Parameters | endpoints or urls OPEA mega service is serving, including the request and post format and details. * - **405** - ``{"error": "Retrieve service name wrongly."}``
List Configurable Parameters | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
def431ad-9842-482f-bd59-723f989c27cc | OPEA Documentation | file://datasets/opea-docs/developer-guides/OPEA_API.rst | unknown | 314c66a7-1201-4174-8031-55d7de224e64 | 60 | opea-semantic-v1 | 00e80fb69620ef18 | * - Status - Response * - **200** - .. code-block::
{
"retrieved_docs": list of string,
"initial_query": string,
"json_encoders": [{
"text": "I am the agent of chatbot. What can I do for you?",
},
... ]
}
* - **405**
- ``{"error": "The request of ASR fails."}`` | ai_ref_knowledge | OPEA Documentation | * - Status - Response * - **200** - .. code-block::
{
"retrieved_docs": list of string,
"initial_query": string,
"json_encoders": [{
"text": "I am the agent of chatbot. What can I do for you?",
},
... ]
}
* - **405**
- ``{"error": "The request of ASR fails."}`` | * - Status - Response * - **200** - .. code-block::
{
"retrieved_docs": list of string,
"initial_query": string,
"json_encoders": [{
"text": "I am the agent of chatbot. What can I do for you?",
},
... ]
}
* - **405**
- ``{"error": "The request of ASR fails."}`` | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
e293cb9e-93c2-4dff-b511-c7f6c639bfec | OPEA Documentation | file://datasets/opea-docs/developer-guides/OPEA_API.rst | unknown | 314c66a7-1201-4174-8031-55d7de224e64 | 23 | opea-semantic-v1 | c3e18aab26daea7d | * - Status - Response * - **200** - .. code-block::
{
"id": "chatcmpl-123",
"object": "chat.completion",
"created": 1677652288,
"model": "gpt-3.5-turbo-0125",
"system_fingerprint": "fp_44709d6fcb", | ai_ref_knowledge | OPEA Documentation | * - Status - Response * - **200** - .. code-block::
{
"id": "chatcmpl-123",
"object": "chat.completion",
"created": 1677652288,
"model": "gpt-3.5-turbo-0125",
"system_fingerprint": "fp_44709d6fcb", | * - Status - Response * - **200** - .. code-block::
{
"id": "chatcmpl-123",
"object": "chat.completion",
"created": 1677652288,
"model": "gpt-3.5-turbo-0125",
"system_fingerprint": "fp_44709d6fcb", | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
ef90ecb8-7672-4220-85a3-a4d69a094d66 | OPEA Documentation | file://datasets/opea-docs/developer-guides/OPEA_API.rst | unknown | 314c66a7-1201-4174-8031-55d7de224e64 | 56 | opea-semantic-v1 | 7122bcdd1e09b2b2 | RAG Retrieval Micro Service
The micro service is used to provide RAG retrieval service. It’s usually after
embedding micro sevice and before RAG reranking micro service to build a RAG
Mega service. | ai_ref_knowledge | OPEA Documentation | RAG Retrieval Micro Service
The micro service is used to provide RAG retrieval service. It’s usually after
embedding micro sevice and before RAG reranking micro service to build a RAG
Mega service. | RAG Retrieval Micro Service
The micro service is used to provide RAG retrieval service. It’s usually after
embedding micro sevice and before RAG reranking micro service to build a RAG
Mega service. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
fa888afe-3756-4cb9-905a-5f622696cbc6 | OPEA Documentation | file://datasets/opea-docs/developer-guides/OPEA_API.rst | unknown | 314c66a7-1201-4174-8031-55d7de224e64 | 38 | opea-semantic-v1 | 2edd7ea6950054d3 | * - Status - Response * - **200** - .. code-block::
{
"object": "list",
"data": [{
"object": "embedding",
"embedding": [
0.0023064255,
-0.009327292,
. . . (1536 floats total for ada-002)
-0.0028842222,
],
"index": 0
}],
"model": "text-embedding-ada-002",
"usage": {
"prompt_tokens": 8,
"total_tokens": 8
... | ai_ref_knowledge | OPEA Documentation | * - Status - Response * - **200** - .. code-block::
{
"object": "list",
"data": [{
"object": "embedding",
"embedding": [
0.0023064255,
-0.009327292,
. . . (1536 floats total for ada-002)
-0.0028842222,
],
"index": 0
}],
"model": "text-embedding-ada-002",
"usage": {
"prompt_tokens": 8,
"total_tokens": 8
... | * - Status - Response * - **200** - .. code-block::
{
"object": "list",
"data": [{
"object": "embedding",
"embedding": [
0.0023064255,
-0.009327292,
. . . (1536 floats total for ada-002)
-0.0028842222,
],
"index": 0
}],
"model": "text-embedding-ada-002",
"usage": {
"prompt_tokens": 8,
"total_tokens": 8
... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
fc5fee05-1131-4f63-953d-702275aee452 | OPEA Documentation | file://datasets/opea-docs/developer-guides/OPEA_API.rst | unknown | 314c66a7-1201-4174-8031-55d7de224e64 | 54 | opea-semantic-v1 | 59fab6fabc1db0fa | used to do audio-to-text translation. * - **POST** - ``Language`` - ``string`` - optional - The language that model prefer to detect. Default is ``"auto"``.
Response | ai_ref_knowledge | OPEA Documentation | used to do audio-to-text translation. * - **POST** - ``Language`` - ``string`` - optional - The language that model prefer to detect. Default is ``"auto"``.
Response | used to do audio-to-text translation. * - **POST** - ``Language`` - ``string`` - optional - The language that model prefer to detect. Default is ``"auto"``.
Response | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
fd78d43d-061e-4288-ba1b-3b458e55fc13 | OPEA Documentation | file://datasets/opea-docs/developer-guides/OPEA_API.rst | unknown | 314c66a7-1201-4174-8031-55d7de224e64 | 46 | opea-semantic-v1 | 5ef62ae79a5dc2b3 | default service tier with a lower uptime SLA and no latency guarentee. When this parameter is set, the response body will include the ``service_tier`` utilized.
* - **POST**
- ``stop``
- ``string``
- optional
- Up to 4 sequences where the API will stop generating further tokens. * - **POST**
- ``stream``
- ``bool... | ai_ref_knowledge | OPEA Documentation | default service tier with a lower uptime SLA and no latency guarentee. When this parameter is set, the response body will include the ``service_tier`` utilized.
* - **POST**
- ``stop``
- ``string``
- optional
- Up to 4 sequences where the API will stop generating further tokens. * - **POST**
- ``stream``
- ``bool... | default service tier with a lower uptime SLA and no latency guarentee. When this parameter is set, the response body will include the ``service_tier`` utilized.
* - **POST**
- ``stop``
- ``string``
- optional
- Up to 4 sequences where the API will stop generating further tokens. * - **POST**
- ``stream``
- ``bool... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
02b2c3f9-68ab-4aba-9161-2dc4569db0e0 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 147 | opea-semantic-v1 | 4258f090b70f7c63 | { "firstName": "John", "lastName": "Smith", "age": 25 }
Commonly used languages are: ``bash``, ``console``, ``none``, ``json``,
``python``, ``markdown``, and ``rest``. See this
`complete list of Pygments lexer languages <https://pygments.org/docs/lexers>`_
for more (use the "Short name" shown). | ai_ref_knowledge | OPEA Documentation | { "firstName": "John", "lastName": "Smith", "age": 25 }
Commonly used languages are: ``bash``, ``console``, ``none``, ``json``,
``python``, ``markdown``, and ``rest``. See this
`complete list of Pygments lexer languages <https://pygments.org/docs/lexers>`_
for more (use the "Short name" shown). | { "firstName": "John", "lastName": "Smith", "age": 25 }
Commonly used languages are: ``bash``, ``console``, ``none``, ``json``,
``python``, ``markdown``, and ``rest``. See this
`complete list of Pygments lexer languages <https://pygments.org/docs/lexers>`_
for more (use the "Short name" shown). | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
02ef1440-ad0d-4440-bdae-3d27a800623d | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 150 | opea-semantic-v1 | ef4c0eaefd6ddf96 | least 500 px wide but no more than 1000 px, and no more than 250 KB unless a particularly large image is needed for clarity.
You can also specify an URL to an image file if needed. | ai_ref_knowledge | OPEA Documentation | least 500 px wide but no more than 1000 px, and no more than 250 KB unless a particularly large image is needed for clarity.
You can also specify an URL to an image file if needed. | least 500 px wide but no more than 1000 px, and no more than 250 KB unless a particularly large image is needed for clarity.
You can also specify an URL to an image file if needed. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
02f7b3a8-97b6-4d22-af05-d85dd17a42aa | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 165 | opea-semantic-v1 | 22ad5cf934cfc8a5 | .. group-tab:: markdown
In markdown, we've included the MyST ``mermaid`` extensions to enable that text
description language to render drawings using:: | ai_ref_knowledge | OPEA Documentation | .. group-tab:: markdown
In markdown, we've included the MyST ``mermaid`` extensions to enable that text
description language to render drawings using:: | .. group-tab:: markdown
In markdown, we've included the MyST ``mermaid`` extensions to enable that text
description language to render drawings using:: | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
03e5e44d-a897-4591-a36a-1eb6e92bd9a2 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 142 | opea-semantic-v1 | 2102110f57446cce | end the introductory paragraph with a double colon (``::``) and indent the code block content by three spaces. On output, only one colon will appear.
in the block, which can lead to odd
highlighting in the generated output. | ai_ref_knowledge | OPEA Documentation | end the introductory paragraph with a double colon (``::``) and indent the code block content by three spaces. On output, only one colon will appear.
in the block, which can lead to odd
highlighting in the generated output. | end the introductory paragraph with a double colon (``::``) and indent the code block content by three spaces. On output, only one colon will appear.
in the block, which can lead to odd
highlighting in the generated output. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
04fef364-7b35-49c1-ae3c-0371a3f57722 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 51 | opea-semantic-v1 | 41de232d7be086d6 | directive. The directive will apply to the next non-comment element (for example, paragraph) or to content indented under the directive. For example, this unordered list::
.. rst-class:: rst-columns | ai_ref_knowledge | OPEA Documentation | directive. The directive will apply to the next non-comment element (for example, paragraph) or to content indented under the directive. For example, this unordered list::
.. rst-class:: rst-columns | directive. The directive will apply to the next non-comment element (for example, paragraph) or to content indented under the directive. For example, this unordered list::
.. rst-class:: rst-columns | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
064eb722-2c53-4d55-9344-9b5fd0771fe3 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 159 | opea-semantic-v1 | 1eae20859dbc55d9 | also use the defined ``centered`` style to place the text centered within the element, useful for centering text within a table cell or column span:
.. rst-class:: bg-opea-lightorange centered | ai_ref_knowledge | OPEA Documentation | also use the defined ``centered`` style to place the text centered within the element, useful for centering text within a table cell or column span:
.. rst-class:: bg-opea-lightorange centered | also use the defined ``centered`` style to place the text centered within the element, useful for centering text within a table cell or column span:
.. rst-class:: bg-opea-lightorange centered | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
08a70816-3eb1-4ec4-b82c-402e1cfb5016 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 87 | opea-semantic-v1 | 9ec8ec276d2b57ca | This directive is also used to define a label that's a reference to a URL:
To enable easy cross-page linking within the site, each file should have a
reference label before its title so that it can be referenced from another
file. | ai_ref_knowledge | OPEA Documentation | This directive is also used to define a label that's a reference to a URL:
To enable easy cross-page linking within the site, each file should have a
reference label before its title so that it can be referenced from another
file. | This directive is also used to define a label that's a reference to a URL:
To enable easy cross-page linking within the site, each file should have a
reference label before its title so that it can be referenced from another
file. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
08f3fc7d-b863-4ffe-a29d-1113c524009c | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 154 | opea-semantic-v1 | db300be14fde74b6 | * List item that spans multiple lines of text showing where to indent the continuation line.
1. And for numbered list items, the continuation
line should align with the text of the line above. | ai_ref_knowledge | OPEA Documentation | * List item that spans multiple lines of text showing where to indent the continuation line.
1. And for numbered list items, the continuation
line should align with the text of the line above. | * List item that spans multiple lines of text showing where to indent the continuation line.
1. And for numbered list items, the continuation
line should align with the text of the line above. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
0a3d75bb-398e-4a11-8338-bf1cee58983f | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 8 | opea-semantic-v1 | 74647355602dd3bf | reST files for the documentation "leaves". We rely on reST for the documentation organization trunk and branches, through the use of the reST ``toctree`` directives.
Documentation Organization
************************** | ai_ref_knowledge | OPEA Documentation | reST files for the documentation "leaves". We rely on reST for the documentation organization trunk and branches, through the use of the reST ``toctree`` directives.
Documentation Organization
************************** | reST files for the documentation "leaves". We rely on reST for the documentation organization trunk and branches, through the use of the reST ``toctree`` directives.
Documentation Organization
************************** | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
0a815308-5622-4f89-aa14-2fc7b830136c | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 12 | opea-semantic-v1 | bf076a9274a08ee3 | can be tagged with a ``:orphan:`` roll at the top of the file (sometimes done on README.rst files we don't need in the generated HTML.
See :ref:`docbuild-troubleshooting` for more information. | ai_ref_knowledge | OPEA Documentation | can be tagged with a ``:orphan:`` roll at the top of the file (sometimes done on README.rst files we don't need in the generated HTML.
See :ref:`docbuild-troubleshooting` for more information. | can be tagged with a ``:orphan:`` roll at the top of the file (sometimes done on README.rst files we don't need in the generated HTML.
See :ref:`docbuild-troubleshooting` for more information. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
0a9e0d5a-39ea-4ec7-9e49-c69f4c78d0ad | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 84 | opea-semantic-v1 | 9268919da0ee5bf7 | With Sphinx, we can create link-references to any tagged text within the project documentation.
Target locations within documents are defined with a label directive: | ai_ref_knowledge | OPEA Documentation | With Sphinx, we can create link-references to any tagged text within the project documentation.
Target locations within documents are defined with a label directive: | With Sphinx, we can create link-references to any tagged text within the project documentation.
Target locations within documents are defined with a label directive: | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
0dd6a740-e7db-48ce-9f34-e3d869d4c0f3 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 173 | opea-semantic-v1 | 26ec43650f03c542 | can also be grouped so that changing the current tab in one area changes all tabs with the same name throughout the page. For example:
.. tabs:: | ai_ref_knowledge | OPEA Documentation | can also be grouped so that changing the current tab in one area changes all tabs with the same name throughout the page. For example:
.. tabs:: | can also be grouped so that changing the current tab in one area changes all tabs with the same name throughout the page. For example:
.. tabs:: | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
10fb657c-5ad6-416f-8d96-cfe7380ea5a4 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 157 | opea-semantic-v1 | a91a93fc74268f45 | length for documentation fewer than 80 characters to make it easier for reviewing in GitHub. Long lines due to URL references are an allowed exception.
Background Colors
***************** | ai_ref_knowledge | OPEA Documentation | length for documentation fewer than 80 characters to make it easier for reviewing in GitHub. Long lines due to URL references are an allowed exception.
Background Colors
***************** | length for documentation fewer than 80 characters to make it easier for reviewing in GitHub. Long lines due to URL references are an allowed exception.
Background Colors
***************** | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
11a1834c-b794-4b68-a3a3-a23bc03eb205 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 5 | opea-semantic-v1 | 25dc4f313d2ec595 | Markdown vs. RestructuredText *****************************
Both markdown and ReStructureText (reST) let you create individual documentation files that
GitHub can render when viewing them in your browser on github.com. Markdown is
popular because of it's familiarity with developers and is the default markup
language fo... | ai_ref_knowledge | OPEA Documentation | Markdown vs. RestructuredText *****************************
Both markdown and ReStructureText (reST) let you create individual documentation files that
GitHub can render when viewing them in your browser on github.com. Markdown is
popular because of it's familiarity with developers and is the default markup
language fo... | Markdown vs. RestructuredText *****************************
Both markdown and ReStructureText (reST) let you create individual documentation files that
GitHub can render when viewing them in your browser on github.com. Markdown is
popular because of it's familiarity with developers and is the default markup
language fo... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
11d42394-6d40-4ecc-af48-6e1c0f830148 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 28 | opea-semantic-v1 | 42ca56b6833f6ff5 | quote appears in running text and could be confused with inline markup delimiters, you can eliminate the confusion by adding a backslash (``\``) before it.
Lists
***** | ai_ref_knowledge | OPEA Documentation | quote appears in running text and could be confused with inline markup delimiters, you can eliminate the confusion by adding a backslash (``\``) before it.
Lists
***** | quote appears in running text and could be confused with inline markup delimiters, you can eliminate the confusion by adding a backslash (``\``) before it.
Lists
***** | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
12a6f25b-c591-4be5-b0ae-e9f9f3442128 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 171 | opea-semantic-v1 | b1c1ed6278646c87 | provide alternative content to the reader via a tabbed interface. When the reader clicks a tab, the content for that tab is displayed. For example::
.. tabs:: | ai_ref_knowledge | OPEA Documentation | provide alternative content to the reader via a tabbed interface. When the reader clicks a tab, the content for that tab is displayed. For example::
.. tabs:: | provide alternative content to the reader via a tabbed interface. When the reader clicks a tab, the content for that tab is displayed. For example::
.. tabs:: | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
13049237-297a-41fe-8a30-8903075e17c5 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 20 | opea-semantic-v1 | 9fd6f11788e93640 | * The ``#`` character for a heading must be the first character on the line, then a space, followed by the heading. For example::
# My Document's Title | ai_ref_knowledge | OPEA Documentation | * The ``#`` character for a heading must be the first character on the line, then a space, followed by the heading. For example::
# My Document's Title | * The ``#`` character for a heading must be the first character on the line, then a space, followed by the heading. For example::
# My Document's Title | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
140df1e0-fd3f-4df5-a03d-66b2039db12a | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 91 | opea-semantic-v1 | 3aacb72ab5cfcc0c | to change the link text that's shown in the generated document. In this case, you can specify alternate text using ``:ref:`alternate text <doc_guidelines>``` (renders as
Linking from a reST document to a markdown document is done using the reST
``:doc:`` role, and using the path to the markdown file leaving off the
`... | ai_ref_knowledge | OPEA Documentation | to change the link text that's shown in the generated document. In this case, you can specify alternate text using ``:ref:`alternate text <doc_guidelines>``` (renders as
Linking from a reST document to a markdown document is done using the reST
``:doc:`` role, and using the path to the markdown file leaving off the
`... | to change the link text that's shown in the generated document. In this case, you can specify alternate text using ``:ref:`alternate text <doc_guidelines>``` (renders as
Linking from a reST document to a markdown document is done using the reST
``:doc:`` role, and using the path to the markdown file leaving off the
`... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
14d1242b-8ed7-481c-bd1b-710ffbc820ce | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 110 | opea-semantic-v1 | e4ff0a045fb43913 | You can directly incorporate a document fragment from another file into your reST or markdown content by using an ``include`` directive.
are relative to the file doing the including. For example a relative reference
to an image must be correct from the point-of-view of the file doing the
inclusion, not the point-of-v... | ai_ref_knowledge | OPEA Documentation | You can directly incorporate a document fragment from another file into your reST or markdown content by using an ``include`` directive.
are relative to the file doing the including. For example a relative reference
to an image must be correct from the point-of-view of the file doing the
inclusion, not the point-of-v... | You can directly incorporate a document fragment from another file into your reST or markdown content by using an ``include`` directive.
are relative to the file doing the including. For example a relative reference
to an image must be correct from the point-of-view of the file doing the
inclusion, not the point-of-v... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
151a33e1-6b36-499a-8dd4-04f388761215 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 56 | opea-semantic-v1 | fbcc18de41d7c64c | Tables ******
There are a few ways to create tables, each with their limitations or quirks. `Grid tables
<http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#grid-tables>`_
offer the most capability for defining merged rows and columns (where content
spans multiple rows or columns, but are hard to mainta... | ai_ref_knowledge | OPEA Documentation | Tables ******
There are a few ways to create tables, each with their limitations or quirks. `Grid tables
<http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#grid-tables>`_
offer the most capability for defining merged rows and columns (where content
spans multiple rows or columns, but are hard to mainta... | Tables ******
There are a few ways to create tables, each with their limitations or quirks. `Grid tables
<http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#grid-tables>`_
offer the most capability for defining merged rows and columns (where content
spans multiple rows or columns, but are hard to mainta... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
1985324d-715e-4bf9-b4cd-fb29842cc2bd | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 115 | opea-semantic-v1 | ccf72f0a315959f3 | And now we're back to the original document after the content in the included file, as if that content were directly in the current file.
You can use options to alter how the included file is processed: | ai_ref_knowledge | OPEA Documentation | And now we're back to the original document after the content in the included file, as if that content were directly in the current file.
You can use options to alter how the included file is processed: | And now we're back to the original document after the content in the included file, as if that content were directly in the current file.
You can use options to alter how the included file is processed: | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
1eb83c3d-0028-4359-b5d5-418f40d6f65c | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 183 | opea-semantic-v1 | 6038629af130505d | Instruction Steps *****************
In reST, a numbered instruction steps style makes it easy to create tutorial guides
with clearly identified steps. Add the ``.. rst-class:: numbered-step``
directive immediately before a second-level heading (by project convention, a
heading underlined with asterisks ``******``, and ... | ai_ref_knowledge | OPEA Documentation | Instruction Steps *****************
In reST, a numbered instruction steps style makes it easy to create tutorial guides
with clearly identified steps. Add the ``.. rst-class:: numbered-step``
directive immediately before a second-level heading (by project convention, a
heading underlined with asterisks ``******``, and ... | Instruction Steps *****************
In reST, a numbered instruction steps style makes it easy to create tutorial guides
with clearly identified steps. Add the ``.. rst-class:: numbered-step``
directive immediately before a second-level heading (by project convention, a
heading underlined with asterisks ``******``, and ... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
1ef117f8-d125-4e3d-8833-a01445c36c05 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 120 | opea-semantic-v1 | b3014ba3683a94c6 | \:end-before\: Only the content before the first occurrence of the specified ``text`` in the external file will be included.
These and other options described in the `docutils include directive <https://docutils.sourceforge.io/docs/ref/rst/directives.html#including-an-external-document-fragment>`_
documentation. | ai_ref_knowledge | OPEA Documentation | \:end-before\: Only the content before the first occurrence of the specified ``text`` in the external file will be included.
These and other options described in the `docutils include directive <https://docutils.sourceforge.io/docs/ref/rst/directives.html#including-an-external-document-fragment>`_
documentation. | \:end-before\: Only the content before the first occurrence of the specified ``text`` in the external file will be included.
These and other options described in the `docutils include directive <https://docutils.sourceforge.io/docs/ref/rst/directives.html#including-an-external-document-fragment>`_
documentation. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
227d7497-280b-434e-8932-cea9706f51d8 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 45 | opea-semantic-v1 | e6be0198c915f745 | item in the nested list. #. And a second item back in the containing list. No blank line needed, but it wouldn't hurt for readability.
.. tabs:: | ai_ref_knowledge | OPEA Documentation | item in the nested list. #. And a second item back in the containing list. No blank line needed, but it wouldn't hurt for readability.
.. tabs:: | item in the nested list. #. And a second item back in the containing list. No blank line needed, but it wouldn't hurt for readability.
.. tabs:: | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
22d05145-3f3a-4337-b7aa-f9d176d472e5 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 163 | opea-semantic-v1 | dad74f500679c45b | graph LR; A--> B & C; B--> A & C; C--> A & B;
This will be rendered into this graph drawing: | ai_ref_knowledge | OPEA Documentation | graph LR; A--> B & C; B--> A & C; C--> A & B;
This will be rendered into this graph drawing: | graph LR; A--> B & C; B--> A & C; C--> A & B;
This will be rendered into this graph drawing: | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
23e6a3de-3fab-4ce7-97c5-e9d9d11408c2 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 117 | opea-semantic-v1 | 7dcb601e080c25dc | \:code\: language The included content is treated as a ``code-block`` with ``language`` highlighting.
\:parser\: text
By default, the included content is parsed the same as the current
document (e.g., rst). This option specifies another parser such as
``:parser: myst_parser.sphinx_`` if the included file is markdown... | ai_ref_knowledge | OPEA Documentation | \:code\: language The included content is treated as a ``code-block`` with ``language`` highlighting.
\:parser\: text
By default, the included content is parsed the same as the current
document (e.g., rst). This option specifies another parser such as
``:parser: myst_parser.sphinx_`` if the included file is markdown... | \:code\: language The included content is treated as a ``code-block`` with ``language`` highlighting.
\:parser\: text
By default, the included content is parsed the same as the current
document (e.g., rst). This option specifies another parser such as
``:parser: myst_parser.sphinx_`` if the included file is markdown... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
27ff7186-f37c-4378-a4d4-c7dfb5590120 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 11 | opea-semantic-v1 | 618e235593e9b0a0 | point to other documents that may include additional ``toctree`` directives of their own, ultimately collecting all the content into an organizational structure you can navigate.
Ultimately every document file (``.md`` and ``.rst``) in the project must appear
in the ``toctree`` hierarchy. An orphan document file will b... | ai_ref_knowledge | OPEA Documentation | point to other documents that may include additional ``toctree`` directives of their own, ultimately collecting all the content into an organizational structure you can navigate.
Ultimately every document file (``.md`` and ``.rst``) in the project must appear
in the ``toctree`` hierarchy. An orphan document file will b... | point to other documents that may include additional ``toctree`` directives of their own, ultimately collecting all the content into an organizational structure you can navigate.
Ultimately every document file (``.md`` and ``.rst``) in the project must appear
in the ``toctree`` hierarchy. An orphan document file will b... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
2a18e473-6425-43e1-a418-d6d347715136 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 10 | opea-semantic-v1 | 2bea761af7b0f000 | various repos along with the other files for those components. This is good because it keeps the relevant documentation and code for that component together.
We use the ``docs`` repo to organize the presentation of all these ``README.md``
files, along with other project related documents that are maintained in the
``do... | ai_ref_knowledge | OPEA Documentation | various repos along with the other files for those components. This is good because it keeps the relevant documentation and code for that component together.
We use the ``docs`` repo to organize the presentation of all these ``README.md``
files, along with other project related documents that are maintained in the
``do... | various repos along with the other files for those components. This is good because it keeps the relevant documentation and code for that component together.
We use the ``docs`` repo to organize the presentation of all these ``README.md``
files, along with other project related documents that are maintained in the
``do... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
2b31eb1a-26fe-4ed4-bc07-f22190c9cd61 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 90 | opea-semantic-v1 | c69c17de60361e1c | across multiple files. The link text is obtained from the document source, so if the title changes, the link text will automatically update as well.
There may be times when you'd like to change the link text that's shown in the
generated document. In this case, you can specify alternate text using
``:ref:`alternate t... | ai_ref_knowledge | OPEA Documentation | across multiple files. The link text is obtained from the document source, so if the title changes, the link text will automatically update as well.
There may be times when you'd like to change the link text that's shown in the
generated document. In this case, you can specify alternate text using
``:ref:`alternate t... | across multiple files. The link text is obtained from the document source, so if the title changes, the link text will automatically update as well.
There may be times when you'd like to change the link text that's shown in the
generated document. In this case, you can specify alternate text using
``:ref:`alternate t... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
2b6f269d-a756-4312-9eb1-6d0f647038a3 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 143 | opea-semantic-v1 | 16d51b93d74c15fa | .. group-tab:: markdown
In markdown, fenced code blocks are used to define code blocks. Use three
backticks ``````` on the lines before and after the code block, for
example: | ai_ref_knowledge | OPEA Documentation | .. group-tab:: markdown
In markdown, fenced code blocks are used to define code blocks. Use three
backticks ``````` on the lines before and after the code block, for
example: | .. group-tab:: markdown
In markdown, fenced code blocks are used to define code blocks. Use three
backticks ``````` on the lines before and after the code block, for
example: | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
2b7a1a42-3997-4952-a9a3-1ec5623a2be1 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 86 | opea-semantic-v1 | 98710d2477043954 | label **must** be added immediately before a heading so that there's a natural phrase to show when referencing this label (for example, the heading text).
This directive is also used to define a label that's a reference to a URL: | ai_ref_knowledge | OPEA Documentation | label **must** be added immediately before a heading so that there's a natural phrase to show when referencing this label (for example, the heading text).
This directive is also used to define a label that's a reference to a URL: | label **must** be added immediately before a heading so that there's a natural phrase to show when referencing this label (for example, the heading text).
This directive is also used to define a label that's a reference to a URL: | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
2ba921d6-f8ba-495e-b561-16413aec5dee | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 100 | opea-semantic-v1 | bdc6a54bc0157515 | Refer to the [DocSum helm chart](https://github.com/opea-project/GenAIInfra/tree/main/helm-charts/docsum/README.md) for instructions on deploying DocSum into Kubernetes on Xeon & Gaudi.
That reference would be rendered into a reference to the
https://opea-project.github.io/latest/GenAIInfra/helm-charts/docsum/README.h... | ai_ref_knowledge | OPEA Documentation | Refer to the [DocSum helm chart](https://github.com/opea-project/GenAIInfra/tree/main/helm-charts/docsum/README.md) for instructions on deploying DocSum into Kubernetes on Xeon & Gaudi.
That reference would be rendered into a reference to the
https://opea-project.github.io/latest/GenAIInfra/helm-charts/docsum/README.h... | Refer to the [DocSum helm chart](https://github.com/opea-project/GenAIInfra/tree/main/helm-charts/docsum/README.md) for instructions on deploying DocSum into Kubernetes on Xeon & Gaudi.
That reference would be rendered into a reference to the
https://opea-project.github.io/latest/GenAIInfra/helm-charts/docsum/README.h... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
2d5277f2-7e80-4445-a280-fe5cb58e7319 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 57 | opea-semantic-v1 | e6bda4d423083bc8 | or columns, but are hard to maintain because the grid characters must be aligned throughout the table. They are supported in both reST and markdown::
+------------------------+------------+----------+----------+
| Header row, column 1 | Header 2 | Header 3 | Header 4 |
| (header rows optional) | | | |
+=============... | ai_ref_knowledge | OPEA Documentation | or columns, but are hard to maintain because the grid characters must be aligned throughout the table. They are supported in both reST and markdown::
+------------------------+------------+----------+----------+
| Header row, column 1 | Header 2 | Header 3 | Header 4 |
| (header rows optional) | | | |
+=============... | or columns, but are hard to maintain because the grid characters must be aligned throughout the table. They are supported in both reST and markdown::
+------------------------+------------+----------+----------+
| Header row, column 1 | Header 2 | Header 3 | Header 4 |
| (header rows optional) | | | |
+=============... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
2edea6dc-ab8a-46a5-88b1-d53c8b4608f6 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 50 | opea-semantic-v1 | b3c69b2f64d01ea3 | .. group-tab:: reST
In reST, if you have a long bullet list of items, where each item is short, you can
indicate that the list items should be rendered in multiple columns with a
special ``.. rst-class:: rst-columns`` directive. The directive will apply to
the next non-comment element (for example, paragraph) or to ... | ai_ref_knowledge | OPEA Documentation | .. group-tab:: reST
In reST, if you have a long bullet list of items, where each item is short, you can
indicate that the list items should be rendered in multiple columns with a
special ``.. rst-class:: rst-columns`` directive. The directive will apply to
the next non-comment element (for example, paragraph) or to ... | .. group-tab:: reST
In reST, if you have a long bullet list of items, where each item is short, you can
indicate that the list items should be rendered in multiple columns with a
special ``.. rst-class:: rst-columns`` directive. The directive will apply to
the next non-comment element (for example, paragraph) or to ... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
2fceda70-8fb0-4269-8f35-36f0abdd0136 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 99 | opea-semantic-v1 | e9fa4d5ea272413b | it would be found in a web browser. For example, from a markdown document in the GenAIExamples repo referencing a document in the GenAIInfra repo::
Refer to the [DocSum helm chart](https://github.com/opea-project/GenAIInfra/tree/main/helm-charts/docsum/README.md)
for instructions on deploying DocSum into Kubernetes on... | ai_ref_knowledge | OPEA Documentation | it would be found in a web browser. For example, from a markdown document in the GenAIExamples repo referencing a document in the GenAIInfra repo::
Refer to the [DocSum helm chart](https://github.com/opea-project/GenAIInfra/tree/main/helm-charts/docsum/README.md)
for instructions on deploying DocSum into Kubernetes on... | it would be found in a web browser. For example, from a markdown document in the GenAIExamples repo referencing a document in the GenAIInfra repo::
Refer to the [DocSum helm chart](https://github.com/opea-project/GenAIInfra/tree/main/helm-charts/docsum/README.md)
for instructions on deploying DocSum into Kubernetes on... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
3243f6a8-638c-4d7c-8784-2063a6de6226 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 19 | opea-semantic-v1 | 5970463165e9417c | with additional ``#`` characters indicating a deeper heading level, e.g., ``#`` for H1 (title), ``##`` for H2 headings, ``###`` for H3 headings, and so on.)
* The ``#`` character for a heading must be the first character on the
line, then a space, followed by the heading. For example:: | ai_ref_knowledge | OPEA Documentation | with additional ``#`` characters indicating a deeper heading level, e.g., ``#`` for H1 (title), ``##`` for H2 headings, ``###`` for H3 headings, and so on.)
* The ``#`` character for a heading must be the first character on the
line, then a space, followed by the heading. For example:: | with additional ``#`` characters indicating a deeper heading level, e.g., ``#`` for H1 (title), ``##`` for H2 headings, ``###`` for H3 headings, and so on.)
* The ``#`` character for a heading must be the first character on the
line, then a space, followed by the heading. For example:: | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
35c220b2-653e-44fb-ab14-6607df92aba0 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 66 | opea-semantic-v1 | 89bd2d586388a969 | ``:widths: 1 2 2``. If you'd like the browser to set the column widths automatically based on the column contents, you can use ``:widths: auto``.
.. group-tab:: markdown | ai_ref_knowledge | OPEA Documentation | ``:widths: 1 2 2``. If you'd like the browser to set the column widths automatically based on the column contents, you can use ``:widths: auto``.
.. group-tab:: markdown | ``:widths: 1 2 2``. If you'd like the browser to set the column widths automatically based on the column contents, you can use ``:widths: auto``.
.. group-tab:: markdown | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
37bbcdfd-aac0-47ee-a47c-0d7575a53050 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 72 | opea-semantic-v1 | 4df868e9795b69b1 | for marking :file:`filenames` (``:file:`name```) and command names such as :command:`make` (``:command:`make```). You can also use the \`\`inline code\`\` markup (double backticks) to indicate a ``filename``.
Don't use items within a single backtick, for example ```word```. Instead
use double backticks: ````word````. | ai_ref_knowledge | OPEA Documentation | for marking :file:`filenames` (``:file:`name```) and command names such as :command:`make` (``:command:`make```). You can also use the \`\`inline code\`\` markup (double backticks) to indicate a ``filename``.
Don't use items within a single backtick, for example ```word```. Instead
use double backticks: ````word````. | for marking :file:`filenames` (``:file:`name```) and command names such as :command:`make` (``:command:`make```). You can also use the \`\`inline code\`\` markup (double backticks) to indicate a ``filename``.
Don't use items within a single backtick, for example ```word```. Instead
use double backticks: ````word````. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
38643dc9-7db3-4dd4-ba06-8d17df9c601e | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 13 | opea-semantic-v1 | d125aa253a0b4eab | .. group-tab:: reST
In reST, document sections are identified through their heading titles, indicated with
an underline below the title text. (While reST allows use of both and
overline and matching underline to indicate a heading, we use only an
underline indicator for headings.) For consistency in our documentatio... | ai_ref_knowledge | OPEA Documentation | .. group-tab:: reST
In reST, document sections are identified through their heading titles, indicated with
an underline below the title text. (While reST allows use of both and
overline and matching underline to indicate a heading, we use only an
underline indicator for headings.) For consistency in our documentatio... | .. group-tab:: reST
In reST, document sections are identified through their heading titles, indicated with
an underline below the title text. (While reST allows use of both and
overline and matching underline to indicate a heading, we use only an
underline indicator for headings.) For consistency in our documentatio... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
387e2981-37c9-43be-aef2-99ee95edf5b5 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 98 | opea-semantic-v1 | d2e591f70862b34f | That reference is rendered as a reference to the README_gmc.html found in the directory ``kubernetes/intel`` relative to the document doing the linking.
References to documents in other repos within the OPEA project are made
using an URL to the document in the github.com repo as it would be found
in a web browser. Fo... | ai_ref_knowledge | OPEA Documentation | That reference is rendered as a reference to the README_gmc.html found in the directory ``kubernetes/intel`` relative to the document doing the linking.
References to documents in other repos within the OPEA project are made
using an URL to the document in the github.com repo as it would be found
in a web browser. Fo... | That reference is rendered as a reference to the README_gmc.html found in the directory ``kubernetes/intel`` relative to the document doing the linking.
References to documents in other repos within the OPEA project are made
using an URL to the document in the github.com repo as it would be found
in a web browser. Fo... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
39ec40d2-7938-423b-8c98-d74413b5abf9 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 71 | opea-semantic-v1 | f50ce35702f00cad | "roles") used to tag text with special meanings and enable output formatting. (You can refer to the `Sphinx Inline Markup`_ documentation for the full list).
For example, there are roles for marking :file:`filenames`
(``:file:`name```) and command names such as :command:`make`
(``:command:`make```). You can also use ... | ai_ref_knowledge | OPEA Documentation | "roles") used to tag text with special meanings and enable output formatting. (You can refer to the `Sphinx Inline Markup`_ documentation for the full list).
For example, there are roles for marking :file:`filenames`
(``:file:`name```) and command names such as :command:`make`
(``:command:`make```). You can also use ... | "roles") used to tag text with special meanings and enable output formatting. (You can refer to the `Sphinx Inline Markup`_ documentation for the full list).
For example, there are roles for marking :file:`filenames`
(``:file:`name```) and command names such as :command:`make`
(``:command:`make```). You can also use ... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
3b4772fc-2287-496b-995d-a78945d1349c | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 46 | opea-semantic-v1 | 421629c89408cd7c | .. group-tab:: reST
Definition lists (with one or more terms and their definition) are a
convenient way to document a word or phrase with an explanation. For example,
this reST content: | ai_ref_knowledge | OPEA Documentation | .. group-tab:: reST
Definition lists (with one or more terms and their definition) are a
convenient way to document a word or phrase with an explanation. For example,
this reST content: | .. group-tab:: reST
Definition lists (with one or more terms and their definition) are a
convenient way to document a word or phrase with an explanation. For example,
this reST content: | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
3be86d58-2ff8-46fe-889d-6cf0102a5c5d | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 62 | opea-semantic-v1 | 41b3aadfc58434bd | For reST, `List tables <http://docutils.sourceforge.net/docs/ref/rst/directives.html#list-table>`_ are much easier to maintain, but don't support row or column spans::
.. list-table:: Table title | ai_ref_knowledge | OPEA Documentation | For reST, `List tables <http://docutils.sourceforge.net/docs/ref/rst/directives.html#list-table>`_ are much easier to maintain, but don't support row or column spans::
.. list-table:: Table title | For reST, `List tables <http://docutils.sourceforge.net/docs/ref/rst/directives.html#list-table>`_ are much easier to maintain, but don't support row or column spans::
.. list-table:: Table title | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
3bfd9e9d-fb2e-475e-9bf4-5f0fa0b431c1 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 77 | opea-semantic-v1 | 13b3e30e11f40dc9 | to make this kind of file linking possible, use a special role that creates a hyperlink to that file in the branch currently checked out.
generate the HTML documentation is the same tagged version for all the repos
we want to reference. | ai_ref_knowledge | OPEA Documentation | to make this kind of file linking possible, use a special role that creates a hyperlink to that file in the branch currently checked out.
generate the HTML documentation is the same tagged version for all the repos
we want to reference. | to make this kind of file linking possible, use a special role that creates a hyperlink to that file in the branch currently checked out.
generate the HTML documentation is the same tagged version for all the repos
we want to reference. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
3de5d3a2-989d-4a0f-a8ab-4c4edfc7da96 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 70 | opea-semantic-v1 | adef5737906367bc | .. group-tab:: reST
Sphinx extends reST by supporting additional inline markup elements (called
"roles") used to tag text with special meanings and enable output formatting. (You can refer to the `Sphinx Inline Markup`_ documentation for the full
list). | ai_ref_knowledge | OPEA Documentation | .. group-tab:: reST
Sphinx extends reST by supporting additional inline markup elements (called
"roles") used to tag text with special meanings and enable output formatting. (You can refer to the `Sphinx Inline Markup`_ documentation for the full
list). | .. group-tab:: reST
Sphinx extends reST by supporting additional inline markup elements (called
"roles") used to tag text with special meanings and enable output formatting. (You can refer to the `Sphinx Inline Markup`_ documentation for the full
list). | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
404bd034-0fc1-492c-9a6e-9d9637fff3ed | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 101 | opea-semantic-v1 | ecf8c1dc474c0ded | That reference would be rendered into a reference to the https://opea-project.github.io/latest/GenAIInfra/helm-charts/docsum/README.html document within the github.io website.
Markdown supports linking to a reST document by using the Myst syntax that
mimics the way reST documents link to each other using the ``:ref:``... | ai_ref_knowledge | OPEA Documentation | That reference would be rendered into a reference to the https://opea-project.github.io/latest/GenAIInfra/helm-charts/docsum/README.html document within the github.io website.
Markdown supports linking to a reST document by using the Myst syntax that
mimics the way reST documents link to each other using the ``:ref:``... | That reference would be rendered into a reference to the https://opea-project.github.io/latest/GenAIInfra/helm-charts/docsum/README.html document within the github.io website.
Markdown supports linking to a reST document by using the Myst syntax that
mimics the way reST documents link to each other using the ``:ref:``... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
40f4303f-2d82-47aa-876b-30024c546ce4 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 47 | opea-semantic-v1 | f0838b607d8093d6 | one or more terms and their definition) are a convenient way to document a word or phrase with an explanation. For example, this reST content:
The Makefile has targets that include: | ai_ref_knowledge | OPEA Documentation | one or more terms and their definition) are a convenient way to document a word or phrase with an explanation. For example, this reST content:
The Makefile has targets that include: | one or more terms and their definition) are a convenient way to document a word or phrase with an explanation. For example, this reST content:
The Makefile has targets that include: | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
420f497a-37d6-48e7-ac6c-8b9213d4b396 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 118 | opea-semantic-v1 | edb1a168bb3bf327 | is parsed the same as the current document (e.g., rst). This option specifies another parser such as ``:parser: myst_parser.sphinx_`` if the included file is markdown.
\:start-after\: text
Only the content after the first occurrence of the specified ``text`` in
the external file will be included. | ai_ref_knowledge | OPEA Documentation | is parsed the same as the current document (e.g., rst). This option specifies another parser such as ``:parser: myst_parser.sphinx_`` if the included file is markdown.
\:start-after\: text
Only the content after the first occurrence of the specified ``text`` in
the external file will be included. | is parsed the same as the current document (e.g., rst). This option specifies another parser such as ``:parser: myst_parser.sphinx_`` if the included file is markdown.
\:start-after\: text
Only the content after the first occurrence of the specified ``text`` in
the external file will be included. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
42322529-abb3-4329-9391-c666e74bcb50 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 124 | opea-semantic-v1 | 12ef54c7b612f79e | That's how we showed how a more free-form markdown table syntax would be rendered in another part of this document.
.. group-tab:: markdown | ai_ref_knowledge | OPEA Documentation | That's how we showed how a more free-form markdown table syntax would be rendered in another part of this document.
.. group-tab:: markdown | That's how we showed how a more free-form markdown table syntax would be rendered in another part of this document.
.. group-tab:: markdown | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
430c3630-9a93-48a2-a07b-b070c391ebad | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 73 | opea-semantic-v1 | ecf6d669d86660f6 | .. group-tab:: markdown
MyST extends markdown by supporting additional inline markup elements
(called "roles") used to tag text with special meanings and enable output
formatting. | ai_ref_knowledge | OPEA Documentation | .. group-tab:: markdown
MyST extends markdown by supporting additional inline markup elements
(called "roles") used to tag text with special meanings and enable output
formatting. | .. group-tab:: markdown
MyST extends markdown by supporting additional inline markup elements
(called "roles") used to tag text with special meanings and enable output
formatting. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
454a78ed-1412-4f0c-bf72-ca280574f1ac | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 22 | opea-semantic-v1 | 95b707ba9a6170ae | ``##``. You may skip heading levels on the way back up, for example, from an H4 ``####`` back up to an H2 ``##`` as appropriate.
Sphinx will complain if it finds multiple H1 headings or if you skip a
heading level. | ai_ref_knowledge | OPEA Documentation | ``##``. You may skip heading levels on the way back up, for example, from an H4 ``####`` back up to an H2 ``##`` as appropriate.
Sphinx will complain if it finds multiple H1 headings or if you skip a
heading level. | ``##``. You may skip heading levels on the way back up, for example, from an H4 ``####`` back up to an H2 ``##`` as appropriate.
Sphinx will complain if it finds multiple H1 headings or if you skip a
heading level. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
45fc9f80-5338-482d-8e55-80cce2ccc324 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 15 | opea-semantic-v1 | 3d8308c233579656 | First sub-section heading level (H2) * Use ``=`` for the Second sub-section heading level (H3) * Use ``-`` for the Third sub-section heading level (H4)
Additional heading-level depth is discouraged, but if needed, use ``%``
(H5), ``+`` (H6), and ``@`` (H7). | ai_ref_knowledge | OPEA Documentation | First sub-section heading level (H2) * Use ``=`` for the Second sub-section heading level (H3) * Use ``-`` for the Third sub-section heading level (H4)
Additional heading-level depth is discouraged, but if needed, use ``%``
(H5), ``+`` (H6), and ``@`` (H7). | First sub-section heading level (H2) * Use ``=`` for the Second sub-section heading level (H3) * Use ``-`` for the Third sub-section heading level (H4)
Additional heading-level depth is discouraged, but if needed, use ``%``
(H5), ``+`` (H6), and ``@`` (H7). | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
461d7a33-0199-4d15-b3a5-691aa4040622 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 4 | opea-semantic-v1 | 8fc49037093e82d9 | and Sphinx-defined directives and roles used to create the documentation you're reading. It also provides best-known-methods for working with a mixture of reStructuredText and markdown.
.. rst-class:: rst-columns | ai_ref_knowledge | OPEA Documentation | and Sphinx-defined directives and roles used to create the documentation you're reading. It also provides best-known-methods for working with a mixture of reStructuredText and markdown.
.. rst-class:: rst-columns | and Sphinx-defined directives and roles used to create the documentation you're reading. It also provides best-known-methods for working with a mixture of reStructuredText and markdown.
.. rst-class:: rst-columns | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
46bd9261-bfae-4eb3-b16d-642414803ff5 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 59 | opea-semantic-v1 | e3983bffbbbf1c27 | This example would render as:
+------------------------+------------+----------+----------+
| Header row, column 1 | Header 2 | Header 3 | Header 4 |
| (header rows optional) | | | |
+========================+============+==========+==========+
| body row 1, column 1 | column 2 | column 3 | column 4 |
+----------------... | ai_ref_knowledge | OPEA Documentation | This example would render as:
+------------------------+------------+----------+----------+
| Header row, column 1 | Header 2 | Header 3 | Header 4 |
| (header rows optional) | | | |
+========================+============+==========+==========+
| body row 1, column 1 | column 2 | column 3 | column 4 |
+----------------... | This example would render as:
+------------------------+------------+----------+----------+
| Header row, column 1 | Header 2 | Header 3 | Header 4 |
| (header rows optional) | | | |
+========================+============+==========+==========+
| body row 1, column 1 | column 2 | column 3 | column 4 |
+----------------... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
48fd861e-9b35-49ad-b664-322a6b993d55 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 1 | opea-semantic-v1 | 956513f1684fa250 | using a web browser. These ``.md`` and ``.rst`` files are maintained in the project's GitHub repos and processed to create the `OPEA Project documentation`_ website.
`github.com` site, markdown and reST extensions are not recognized there, so the
best viewing experience is through the `OPEA Project documentation`_ git... | ai_ref_knowledge | OPEA Documentation | using a web browser. These ``.md`` and ``.rst`` files are maintained in the project's GitHub repos and processed to create the `OPEA Project documentation`_ website.
`github.com` site, markdown and reST extensions are not recognized there, so the
best viewing experience is through the `OPEA Project documentation`_ git... | using a web browser. These ``.md`` and ``.rst`` files are maintained in the project's GitHub repos and processed to create the `OPEA Project documentation`_ website.
`github.com` site, markdown and reST extensions are not recognized there, so the
best viewing experience is through the `OPEA Project documentation`_ git... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
4a902806-7ba8-4fe4-ba82-0aeea4ab6712 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 146 | opea-semantic-v1 | 19f65e1486b21ee2 | Syntax highlighting is also supported for fenced code blocks by specifying a language next to the backticks before the fenced code block:
```json
{
"firstName": "John",
"lastName": "Smith",
"age": 25
} | ai_ref_knowledge | OPEA Documentation | Syntax highlighting is also supported for fenced code blocks by specifying a language next to the backticks before the fenced code block:
```json
{
"firstName": "John",
"lastName": "Smith",
"age": 25
} | Syntax highlighting is also supported for fenced code blocks by specifying a language next to the backticks before the fenced code block:
```json
{
"firstName": "John",
"lastName": "Smith",
"age": 25
} | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
4b3bc045-2adf-4e20-90bb-c3b6b28d5f75 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 58 | opea-semantic-v1 | 3eeb4541884e1c6c | with a two column span | ... | span | +------------------------+------------+----------+ rows + | body row 4 | ... | ... | too | +------------------------+------------+----------+----------+
This example would render as: | ai_ref_knowledge | OPEA Documentation | with a two column span | ... | span | +------------------------+------------+----------+ rows + | body row 4 | ... | ... | too | +------------------------+------------+----------+----------+
This example would render as: | with a two column span | ... | span | +------------------------+------------+----------+ rows + | body row 4 | ... | ... | too | +------------------------+------------+----------+----------+
This example would render as: | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
4e20d0ae-7321-46c0-9d71-ed755ba95bea | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 141 | opea-semantic-v1 | 684441943011ddbe | This block of text would be styled with a background and box, but with no syntax highlighting.
There's a shorthand for writing code blocks, too: end the introductory
paragraph with a double colon (``::``) and indent the code block content
by three spaces. On output, only one colon will appear. | ai_ref_knowledge | OPEA Documentation | This block of text would be styled with a background and box, but with no syntax highlighting.
There's a shorthand for writing code blocks, too: end the introductory
paragraph with a double colon (``::``) and indent the code block content
by three spaces. On output, only one colon will appear. | This block of text would be styled with a background and box, but with no syntax highlighting.
There's a shorthand for writing code blocks, too: end the introductory
paragraph with a double colon (``::``) and indent the code block content
by three spaces. On output, only one colon will appear. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
50d4047f-5dda-4e21-8aa3-9c5443feae1b | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 137 | opea-semantic-v1 | eba871c6717c73b5 | struct _k_object { char *name; u8_t perms[CONFIG_MAX_THREAD_BYTES]; u8_t type; u8_t flags; u32_t data; } __packed;
You can specify other languages for the ``code-block`` directive, including
``c``, ``python``, and ``rst``, and also ``console``, ``bash``, or ``shell``. If you want no syntax highlighting, specify ``none... | ai_ref_knowledge | OPEA Documentation | struct _k_object { char *name; u8_t perms[CONFIG_MAX_THREAD_BYTES]; u8_t type; u8_t flags; u32_t data; } __packed;
You can specify other languages for the ``code-block`` directive, including
``c``, ``python``, and ``rst``, and also ``console``, ``bash``, or ``shell``. If you want no syntax highlighting, specify ``none... | struct _k_object { char *name; u8_t perms[CONFIG_MAX_THREAD_BYTES]; u8_t type; u8_t flags; u32_t data; } __packed;
You can specify other languages for the ``code-block`` directive, including
``c``, ``python``, and ``rst``, and also ``console``, ``bash``, or ``shell``. If you want no syntax highlighting, specify ``none... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
524561b9-5cba-4617-af18-4ff24966dbd9 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 82 | opea-semantic-v1 | 6660b697175154bf | refer to the `internal-linking`_ documentation
Note the use of a trailing underscore indicates an **outbound link**. In this
example, the label was added immediately before a heading, so the text that's
displayed is the heading text itself. | ai_ref_knowledge | OPEA Documentation | refer to the `internal-linking`_ documentation
Note the use of a trailing underscore indicates an **outbound link**. In this
example, the label was added immediately before a heading, so the text that's
displayed is the heading text itself. | refer to the `internal-linking`_ documentation
Note the use of a trailing underscore indicates an **outbound link**. In this
example, the label was added immediately before a heading, so the text that's
displayed is the heading text itself. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
5298f9dc-2eb0-4c89-9545-9237a69f9370 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 133 | opea-semantic-v1 | f170b84c99d4c171 | or console commands and output. Smart syntax highlighting is also supported (using the Pygments package). You can also directly specify the highlighting language. For example:
struct _k_object {
char *name;
u8_t perms[CONFIG_MAX_THREAD_BYTES];
u8_t type;
u8_t flags;
u32_t data;
} __packed; | ai_ref_knowledge | OPEA Documentation | or console commands and output. Smart syntax highlighting is also supported (using the Pygments package). You can also directly specify the highlighting language. For example:
struct _k_object {
char *name;
u8_t perms[CONFIG_MAX_THREAD_BYTES];
u8_t type;
u8_t flags;
u32_t data;
} __packed; | or console commands and output. Smart syntax highlighting is also supported (using the Pygments package). You can also directly specify the highlighting language. For example:
struct _k_object {
char *name;
u8_t perms[CONFIG_MAX_THREAD_BYTES];
u8_t type;
u8_t flags;
u32_t data;
} __packed; | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
55c6e0ae-b2bc-4064-92ed-a7af3706a8a9 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 145 | opea-semantic-v1 | a748e222b7ad7816 | { "firstName": "John", "lastName": "Smith", "age": 25 }
Syntax highlighting is also supported for fenced code blocks by specifying
a language next to the backticks before the fenced code block: | ai_ref_knowledge | OPEA Documentation | { "firstName": "John", "lastName": "Smith", "age": 25 }
Syntax highlighting is also supported for fenced code blocks by specifying
a language next to the backticks before the fenced code block: | { "firstName": "John", "lastName": "Smith", "age": 25 }
Syntax highlighting is also supported for fenced code blocks by specifying
a language next to the backticks before the fenced code block: | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
570a25d4-45dc-4f00-849e-1ff3c0ee3cae | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 76 | opea-semantic-v1 | c16fe954c1fc732d | Do not link to files in the main branch because files in that branch could change or even be deleted after the release is made.
In reST, to make this kind of file linking possible, use a special role that
creates a hyperlink to that file in the branch currently checked out. | ai_ref_knowledge | OPEA Documentation | Do not link to files in the main branch because files in that branch could change or even be deleted after the release is made.
In reST, to make this kind of file linking possible, use a special role that
creates a hyperlink to that file in the branch currently checked out. | Do not link to files in the main branch because files in that branch could change or even be deleted after the release is made.
In reST, to make this kind of file linking possible, use a special role that
creates a hyperlink to that file in the branch currently checked out. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
58084fc5-b3a8-4539-b025-8c959c840e10 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 151 | opea-semantic-v1 | f2cba6dd81c66db9 | In reST, images are placed the document using an image directive::
or if you'd like to add an image caption, use the figure directive:: | ai_ref_knowledge | OPEA Documentation | In reST, images are placed the document using an image directive::
or if you'd like to add an image caption, use the figure directive:: | In reST, images are placed the document using an image directive::
or if you'd like to add an image caption, use the figure directive:: | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
58a9561d-79ca-451c-8ce4-ee90b6d59446 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 102 | opea-semantic-v1 | 44602e6dc0051943 | the way reST documents link to each other using the ``:ref:`` role and using the label at the beginning of the reST document. For example::
{ref}`ChatQnA Example Deployment Options <chatqna-example-deployment>` | ai_ref_knowledge | OPEA Documentation | the way reST documents link to each other using the ``:ref:`` role and using the label at the beginning of the reST document. For example::
{ref}`ChatQnA Example Deployment Options <chatqna-example-deployment>` | the way reST documents link to each other using the ``:ref:`` role and using the label at the beginning of the reST document. For example::
{ref}`ChatQnA Example Deployment Options <chatqna-example-deployment>` | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
5939f92f-7f4d-4059-9fa3-cbb6ccaf0926 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 17 | opea-semantic-v1 | aa929e0aa515d412 | The heading underline must be at least as long as the title it's under.
Here's an example of nested heading levels and the appropriate
underlines to use: | ai_ref_knowledge | OPEA Documentation | The heading underline must be at least as long as the title it's under.
Here's an example of nested heading levels and the appropriate
underlines to use: | The heading underline must be at least as long as the title it's under.
Here's an example of nested heading levels and the appropriate
underlines to use: | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
5cb06990-d882-4f07-a674-894400b099d8 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 116 | opea-semantic-v1 | 43e05cfe3cca1b5c | You can use options to alter how the included file is processed:
\:code\: language
The included content is treated as a ``code-block`` with ``language``
highlighting. | ai_ref_knowledge | OPEA Documentation | You can use options to alter how the included file is processed:
\:code\: language
The included content is treated as a ``code-block`` with ``language``
highlighting. | You can use options to alter how the included file is processed:
\:code\: language
The included content is treated as a ``code-block`` with ``language``
highlighting. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
5d974ae1-444e-418d-b8bb-72542a529231 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 103 | opea-semantic-v1 | c757b4cb437064ff | {ref}`ChatQnA Example Deployment Options <chatqna-example-deployment>`
The ChatQnA example deployment options document found at
``examples/ChatQnA/deploy/index.rst`` has that
``chatqna-example-deployment`` label at the top we can
reference instead of knowing the path to the document. | ai_ref_knowledge | OPEA Documentation | {ref}`ChatQnA Example Deployment Options <chatqna-example-deployment>`
The ChatQnA example deployment options document found at
``examples/ChatQnA/deploy/index.rst`` has that
``chatqna-example-deployment`` label at the top we can
reference instead of knowing the path to the document. | {ref}`ChatQnA Example Deployment Options <chatqna-example-deployment>`
The ChatQnA example deployment options document found at
``examples/ChatQnA/deploy/index.rst`` has that
``chatqna-example-deployment`` label at the top we can
reference instead of knowing the path to the document. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.