Skip to content

Latest commit

 

History

History
32 lines (23 loc) · 2.21 KB

File metadata and controls

32 lines (23 loc) · 2.21 KB

StageDefsTextQueryInput

Text-based query input for text embedding search. Plain text is always treated as literal text, even if it looks like a URL. Perfect for searching text that happens to contain URLs or special characters. Use Cases: - Semantic text search - Question answering - Document search by description - Template-based text queries Examples: Simple text: json {\"input_mode\": \"text\", \"value\": \"machine learning best practices\"} Template-based: json {\"input_mode\": \"text\", \"value\": \"{{INPUT.user_query}}\"} Legacy syntax (backward compatible): json {\"input_mode\": \"text\", \"text\": \"machine learning\"}

Properties

Name Type Description Notes
input_mode str Discriminator field. Always 'text' for text-based queries. [optional] [default to 'text']
value str Plain text query string (RECOMMENDED). Always treated as literal text for embedding, even if it looks like a URL. Supports template variables: {{INPUT.field_name}}. Empty strings are allowed (creates zero vector for optional inputs). [optional]
text str Legacy text field (DEPRECATED - use 'value' instead). Supports template variables: {{INPUT.field_name}}. [optional]

Example

from mixpeek.models.stage_defs_text_query_input import StageDefsTextQueryInput

# TODO update the JSON string below
json = "{}"
# create an instance of StageDefsTextQueryInput from a JSON string
stage_defs_text_query_input_instance = StageDefsTextQueryInput.from_json(json)
# print the JSON string representation of the object
print(StageDefsTextQueryInput.to_json())

# convert the object into a dict
stage_defs_text_query_input_dict = stage_defs_text_query_input_instance.to_dict()
# create an instance of StageDefsTextQueryInput from a dict
stage_defs_text_query_input_from_dict = StageDefsTextQueryInput.from_dict(stage_defs_text_query_input_dict)

[Back to Model list] [Back to API list] [Back to README]