Retrieve

models.prompt_guide.retrieve(, ) -> PromptGuideRetrieveResponse

GET/models/{modelId}/prompt-guide

Get the prompt guide of the given modelId

ParametersExpand Collapse

model_id: str

project_id: Optional[str]

The projectId used for ownership resource management. Either to assert ownership or to set the owner of the resource(s)

ReturnsExpand Collapse

class PromptGuideRetrieveResponse: …

prompt_guide: PromptGuide

value: str

The markdown prompt guide used as the system prompt for Prompt Spark.

Instructions and baked-in examples both live in this single markdown document. No runtime templating is performed on it.

Retrieve

import os
from scenario_sdk import Scenario

client = Scenario(
    api_key=os.environ.get("SCENARIO_SDK_API_KEY"),  # This is the default and can be omitted
    api_secret=os.environ.get("SCENARIO_SDK_API_SECRET"),  # This is the default and can be omitted
)
prompt_guide = client.models.prompt_guide.retrieve(
    model_id="modelId",
)
print(prompt_guide.prompt_guide)

{
  "promptGuide": {
    "value": "value"
  }
}

Returns Examples

{
  "promptGuide": {
    "value": "value"
  }
}