get_semantic_transparency: Get Semantic Transparency Rating

View source: R/chatRater.R

get_semantic_transparencyR Documentation

Get Semantic Transparency Rating

Description

Uses an LLM to obtain a semantic transparency rating for the given linguistic stimulus.

Usage

get_semantic_transparency(
  stimulus,
  model = "gpt-3.5-turbo",
  api_key = "",
  top_p = 1,
  temp = 0
)

Arguments

stimulus

A character string representing the language material.

model

A character string specifying the LLM model (default "gpt-3.5-turbo").

api_key

API key as a character string.

top_p

Numeric value (default 1).

temp

Numeric value (default 0).

Details

Default definition: "Semantic transparency is the degree to which the meaning of a compound or phrase can be inferred from its constituent parts."

Value

An integer rating (1-7) indicating the semantic transparency.

Examples

## Not run: 
  sem_trans <- get_semantic_transparency("blackbird",
                                          model = "gpt-3.5-turbo",
                                          api_key = "your_api_key")
  cat("Semantic Transparency Rating:", sem_trans, "\n")

## End(Not run)

chatRater documentation built on April 4, 2025, 1:03 a.m.